Interface NotebookExecutionSummary.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<NotebookExecutionSummary.Builder,NotebookExecutionSummary>,SdkBuilder<NotebookExecutionSummary.Builder,NotebookExecutionSummary>,SdkPojo
- Enclosing class:
- NotebookExecutionSummary
public static interface NotebookExecutionSummary.Builder extends SdkPojo, CopyableBuilder<NotebookExecutionSummary.Builder,NotebookExecutionSummary>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description NotebookExecutionSummary.BuildereditorId(String editorId)The unique identifier of the editor associated with the notebook execution.NotebookExecutionSummary.BuilderendTime(Instant endTime)The timestamp when notebook execution started.NotebookExecutionSummary.BuilderexecutionEngineId(String executionEngineId)The unique ID of the execution engine for the notebook execution.NotebookExecutionSummary.BuildernotebookExecutionId(String notebookExecutionId)The unique identifier of the notebook execution.NotebookExecutionSummary.BuildernotebookExecutionName(String notebookExecutionName)The name of the notebook execution.default NotebookExecutionSummary.BuildernotebookS3Location(Consumer<NotebookS3LocationForOutput.Builder> notebookS3Location)The Amazon S3 location that stores the notebook execution input.NotebookExecutionSummary.BuildernotebookS3Location(NotebookS3LocationForOutput notebookS3Location)The Amazon S3 location that stores the notebook execution input.NotebookExecutionSummary.BuilderstartTime(Instant startTime)The timestamp when notebook execution started.NotebookExecutionSummary.Builderstatus(String status)The status of the notebook execution.NotebookExecutionSummary.Builderstatus(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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
- Parameters:
status- The status of the notebook execution.-
START_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
NotebookExecutionStatus,NotebookExecutionStatus
-
-
status
NotebookExecutionSummary.Builder status(NotebookExecutionStatus status)
The status of the notebook execution.
-
START_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
- Parameters:
status- The status of the notebook execution.-
START_PENDINGindicates that the cluster has received the execution request but execution has not begun. -
STARTINGindicates that the execution is starting on the cluster. -
RUNNINGindicates that the execution is being processed by the cluster. -
FINISHINGindicates that execution processing is in the final stages. -
FINISHEDindicates that the execution has completed without error. -
FAILINGindicates that the execution is failing and will not finish successfully. -
FAILEDindicates that the execution failed. -
STOP_PENDINGindicates that the cluster has received aStopNotebookExecutionrequest and the stop is pending. -
STOPPINGindicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecutionrequest. -
STOPPEDindicates that the execution stopped because of aStopNotebookExecutionrequest.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
NotebookExecutionStatus,NotebookExecutionStatus
-
-
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 theNotebookS3LocationForOutput.Builderavoiding the need to create one manually viaNotebookS3LocationForOutput.builder().When the
Consumercompletes,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:
notebookS3Location(NotebookS3LocationForOutput)
-
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.
-
-