Interface NotebookExecutionSummary.Builder

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

  • Method Details

    • notebookExecutionId

      NotebookExecutionSummary.Builder notebookExecutionId(String notebookExecutionId)

      The unique identifier of the notebook execution.

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

    • editorId

      NotebookExecutionSummary.Builder editorId(String editorId)

      The unique identifier of the editor associated with the notebook execution.

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

    • notebookExecutionName

      NotebookExecutionSummary.Builder notebookExecutionName(String notebookExecutionName)

      The name of the notebook execution.

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

    • status

      NotebookExecutionSummary.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

      NotebookExecutionSummary.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

      NotebookExecutionSummary.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

      NotebookExecutionSummary.Builder endTime(Instant endTime)

      The timestamp when notebook execution started.

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

    • notebookS3Location

      NotebookExecutionSummary.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 NotebookExecutionSummary.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:

    • executionEngineId

      NotebookExecutionSummary.Builder executionEngineId(String executionEngineId)

      The unique ID of the execution engine for the notebook execution.

      Parameters:
      executionEngineId - The unique ID of the execution engine for the notebook execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.