Interface NotebookExecutionSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<NotebookExecutionSummary.Builder,
,NotebookExecutionSummary> SdkBuilder<NotebookExecutionSummary.Builder,
,NotebookExecutionSummary> SdkPojo
- Enclosing class:
NotebookExecutionSummary
-
Method Summary
Modifier and TypeMethodDescriptionThe unique identifier of the editor associated with the notebook execution.The timestamp when notebook execution started.executionEngineId
(String executionEngineId) The unique ID of the execution engine for the notebook execution.notebookExecutionId
(String notebookExecutionId) The unique identifier of the notebook execution.notebookExecutionName
(String notebookExecutionName) The name of the notebook execution.default NotebookExecutionSummary.Builder
notebookS3Location
(Consumer<NotebookS3LocationForOutput.Builder> notebookS3Location) The Amazon S3 location that stores the notebook execution input.notebookS3Location
(NotebookS3LocationForOutput notebookS3Location) The Amazon S3 location that stores the notebook execution input.The timestamp when notebook execution started.The status of the notebook execution.status
(NotebookExecutionStatus status) The status of the notebook execution.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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
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 theNotebookS3LocationForOutput.Builder
avoiding the need to create one manually viaNotebookS3LocationForOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotebookS3Location(NotebookS3LocationForOutput)
.- Parameters:
notebookS3Location
- a consumer that will call methods onNotebookS3LocationForOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-