Interface NotebookExecution.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NotebookExecution.Builder,NotebookExecution>, SdkBuilder<NotebookExecution.Builder,NotebookExecution>, SdkPojo
Enclosing class:
NotebookExecution
@Mutable @NotThreadSafe public static interface NotebookExecution.Builder extends SdkPojo, CopyableBuilder<NotebookExecution.Builder,NotebookExecution>

  • Method Details

    • notebookExecutionId

      NotebookExecution.Builder notebookExecutionId(String notebookExecutionId)

      The unique identifier of a notebook execution.

      Parameters:
      notebookExecutionId - The unique identifier of a notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • editorId

      NotebookExecution.Builder editorId(String editorId)

      The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

      Parameters:
      editorId - The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionEngine

      NotebookExecution.Builder executionEngine(ExecutionEngineConfig executionEngine)

      The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

      Parameters:
      executionEngine - The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionEngine

      default NotebookExecution.Builder executionEngine(Consumer<ExecutionEngineConfig.Builder> executionEngine)

      The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

      This is a convenience method that creates an instance of the ExecutionEngineConfig.Builder avoiding the need to create one manually via ExecutionEngineConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to executionEngine(ExecutionEngineConfig).

      Parameters:
      executionEngine - a consumer that will call methods on ExecutionEngineConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notebookExecutionName

      NotebookExecution.Builder notebookExecutionName(String notebookExecutionName)

      A name for the notebook execution.

      Parameters:
      notebookExecutionName - A name for the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notebookParams

      NotebookExecution.Builder notebookParams(String notebookParams)

      Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

      Parameters:
      notebookParams - Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      NotebookExecution.Builder status(String status)

      The status of the notebook execution.

      • START_PENDING indicates that the cluster has received the execution request but execution has not begun.

      • STARTING indicates that the execution is starting on the cluster.

      • RUNNING indicates that the execution is being processed by the cluster.

      • FINISHING indicates that execution processing is in the final stages.

      • FINISHED indicates that the execution has completed without error.

      • FAILING indicates that the execution is failing and will not finish successfully.

      • FAILED indicates that the execution failed.

      • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.

      • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.

      • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

      Parameters:
      status - The status of the notebook execution.

      • START_PENDING indicates that the cluster has received the execution request but execution has not begun.

      • STARTING indicates that the execution is starting on the cluster.

      • RUNNING indicates that the execution is being processed by the cluster.

      • FINISHING indicates that execution processing is in the final stages.

      • FINISHED indicates that the execution has completed without error.

      • FAILING indicates that the execution is failing and will not finish successfully.

      • FAILED indicates that the execution failed.

      • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.

      • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.

      • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      NotebookExecution.Builder status(NotebookExecutionStatus status)

      The status of the notebook execution.

      • START_PENDING indicates that the cluster has received the execution request but execution has not begun.

      • STARTING indicates that the execution is starting on the cluster.

      • RUNNING indicates that the execution is being processed by the cluster.

      • FINISHING indicates that execution processing is in the final stages.

      • FINISHED indicates that the execution has completed without error.

      • FAILING indicates that the execution is failing and will not finish successfully.

      • FAILED indicates that the execution failed.

      • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.

      • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.

      • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

      Parameters:
      status - The status of the notebook execution.

      • START_PENDING indicates that the cluster has received the execution request but execution has not begun.

      • STARTING indicates that the execution is starting on the cluster.

      • RUNNING indicates that the execution is being processed by the cluster.

      • FINISHING indicates that execution processing is in the final stages.

      • FINISHED indicates that the execution has completed without error.

      • FAILING indicates that the execution is failing and will not finish successfully.

      • FAILED indicates that the execution failed.

      • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.

      • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.

      • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTime

      NotebookExecution.Builder startTime(Instant startTime)

      The timestamp when notebook execution started.

      Parameters:
      startTime - The timestamp when notebook execution started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      NotebookExecution.Builder endTime(Instant endTime)

      The timestamp when notebook execution ended.

      Parameters:
      endTime - The timestamp when notebook execution ended.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      NotebookExecution.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the notebook execution.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputNotebookURI

      NotebookExecution.Builder outputNotebookURI(String outputNotebookURI)

      The location of the notebook execution's output file in Amazon S3.

      Parameters:
      outputNotebookURI - The location of the notebook execution's output file in Amazon S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastStateChangeReason

      NotebookExecution.Builder lastStateChangeReason(String lastStateChangeReason)

      The reason for the latest status change of the notebook execution.

      Parameters:
      lastStateChangeReason - The reason for the latest status change of the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notebookInstanceSecurityGroupId

      NotebookExecution.Builder notebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)

      The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

      Parameters:
      notebookInstanceSecurityGroupId - The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NotebookExecution.Builder tags(Collection<Tag> tags)

      A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

      Parameters:
      tags - A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NotebookExecution.Builder tags(Tag... tags)

      A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

      Parameters:
      tags - A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NotebookExecution.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notebookS3Location

      NotebookExecution.Builder notebookS3Location(NotebookS3LocationForOutput notebookS3Location)

      The Amazon S3 location that stores the notebook execution input.

      Parameters:
      notebookS3Location - The Amazon S3 location that stores the notebook execution input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notebookS3Location

      default NotebookExecution.Builder notebookS3Location(Consumer<NotebookS3LocationForOutput.Builder> notebookS3Location)

      The Amazon S3 location that stores the notebook execution input.

      This is a convenience method that creates an instance of the NotebookS3LocationForOutput.Builder avoiding the need to create one manually via NotebookS3LocationForOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notebookS3Location(NotebookS3LocationForOutput).

      Parameters:
      notebookS3Location - a consumer that will call methods on NotebookS3LocationForOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputNotebookS3Location

      NotebookExecution.Builder outputNotebookS3Location(OutputNotebookS3LocationForOutput outputNotebookS3Location)

      The Amazon S3 location for the notebook execution output.

      Parameters:
      outputNotebookS3Location - The Amazon S3 location for the notebook execution output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputNotebookS3Location

      default NotebookExecution.Builder outputNotebookS3Location(Consumer<OutputNotebookS3LocationForOutput.Builder> outputNotebookS3Location)

      The Amazon S3 location for the notebook execution output.

      This is a convenience method that creates an instance of the OutputNotebookS3LocationForOutput.Builder avoiding the need to create one manually via OutputNotebookS3LocationForOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputNotebookS3Location(OutputNotebookS3LocationForOutput).

      Parameters:
      outputNotebookS3Location - a consumer that will call methods on OutputNotebookS3LocationForOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputNotebookFormat

      NotebookExecution.Builder outputNotebookFormat(String outputNotebookFormat)

      The output format for the notebook execution.

      Parameters:
      outputNotebookFormat - The output format for the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputNotebookFormat

      NotebookExecution.Builder outputNotebookFormat(OutputNotebookFormat outputNotebookFormat)

      The output format for the notebook execution.

      Parameters:
      outputNotebookFormat - The output format for the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • environmentVariables

      NotebookExecution.Builder environmentVariables(Map<String,String> environmentVariables)

      The environment variables associated with the notebook execution.

      Parameters:
      environmentVariables - The environment variables associated with the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.