public static interface NotebookExecution.Builder extends SdkPojo, CopyableBuilder<NotebookExecution.Builder,NotebookExecution>
Modifier and Type | Method and Description |
---|---|
NotebookExecution.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the notebook execution.
|
NotebookExecution.Builder |
editorId(String editorId)
The unique identifier of the EMR Notebook that is used for the notebook execution.
|
NotebookExecution.Builder |
endTime(Instant endTime)
The timestamp when notebook execution ended.
|
default NotebookExecution.Builder |
executionEngine(Consumer<ExecutionEngineConfig.Builder> executionEngine)
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook
execution.
|
NotebookExecution.Builder |
executionEngine(ExecutionEngineConfig executionEngine)
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook
execution.
|
NotebookExecution.Builder |
lastStateChangeReason(String lastStateChangeReason)
The reason for the latest status change of the notebook execution.
|
NotebookExecution.Builder |
notebookExecutionId(String notebookExecutionId)
The unique identifier of a notebook execution.
|
NotebookExecution.Builder |
notebookExecutionName(String notebookExecutionName)
A name for the notebook execution.
|
NotebookExecution.Builder |
notebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)
The unique identifier of the EC2 security group associated with the EMR Notebook instance.
|
NotebookExecution.Builder |
notebookParams(String notebookParams)
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
|
NotebookExecution.Builder |
outputNotebookURI(String outputNotebookURI)
The location of the notebook execution's output file in Amazon S3.
|
NotebookExecution.Builder |
startTime(Instant startTime)
The timestamp when notebook execution started.
|
NotebookExecution.Builder |
status(NotebookExecutionStatus status)
The status of the notebook execution.
|
NotebookExecution.Builder |
status(String status)
The status of the notebook execution.
|
NotebookExecution.Builder |
tags(Collection<Tag> tags)
A list of tags associated with a notebook execution.
|
NotebookExecution.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of tags associated with a notebook execution.
|
NotebookExecution.Builder |
tags(Tag... tags)
A list of tags associated with a notebook execution.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
NotebookExecution.Builder notebookExecutionId(String notebookExecutionId)
The unique identifier of a notebook execution.
notebookExecutionId
- The unique identifier of a notebook execution.NotebookExecution.Builder editorId(String editorId)
The unique identifier of the EMR Notebook that is used for the notebook execution.
editorId
- The unique identifier of the EMR Notebook that is used for the notebook execution.NotebookExecution.Builder executionEngine(ExecutionEngineConfig executionEngine)
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
executionEngine
- The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook
execution.default NotebookExecution.Builder executionEngine(Consumer<ExecutionEngineConfig.Builder> executionEngine)
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
This is a convenience that creates an instance of theExecutionEngineConfig.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)
.executionEngine
- a consumer that will call methods on ExecutionEngineConfig.Builder
executionEngine(ExecutionEngineConfig)
NotebookExecution.Builder notebookExecutionName(String notebookExecutionName)
A name for the notebook execution.
notebookExecutionName
- A name for the notebook execution.NotebookExecution.Builder notebookParams(String notebookParams)
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
notebookParams
- Input parameters in JSON format passed to the EMR Notebook at runtime for execution.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.
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.
NotebookExecutionStatus
,
NotebookExecutionStatus
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.
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.
NotebookExecutionStatus
,
NotebookExecutionStatus
NotebookExecution.Builder startTime(Instant startTime)
The timestamp when notebook execution started.
startTime
- The timestamp when notebook execution started.NotebookExecution.Builder endTime(Instant endTime)
The timestamp when notebook execution ended.
endTime
- The timestamp when notebook execution ended.NotebookExecution.Builder arn(String arn)
The Amazon Resource Name (ARN) of the notebook execution.
arn
- The Amazon Resource Name (ARN) of the notebook execution.NotebookExecution.Builder outputNotebookURI(String outputNotebookURI)
The location of the notebook execution's output file in Amazon S3.
outputNotebookURI
- The location of the notebook execution's output file in Amazon S3.NotebookExecution.Builder lastStateChangeReason(String lastStateChangeReason)
The reason for the latest status change of the notebook execution.
lastStateChangeReason
- The reason for the latest status change of the notebook execution.NotebookExecution.Builder notebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)
The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.
notebookInstanceSecurityGroupId
- The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more
information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.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.
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.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.
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.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 that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)