@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class NotebookExecution extends Object implements Serializable, Cloneable, StructuredPojo
A notebook execution. An execution is a specific instance that an EMR Notebook is run using the
StartNotebookExecution
action.
Constructor and Description |
---|
NotebookExecution() |
Modifier and Type | Method and Description |
---|---|
NotebookExecution |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the notebook execution.
|
String |
getEditorId()
The unique identifier of the EMR Notebook that is used for the notebook execution.
|
Date |
getEndTime()
The timestamp when notebook execution ended.
|
ExecutionEngineConfig |
getExecutionEngine()
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
|
String |
getLastStateChangeReason()
The reason for the latest status change of the notebook execution.
|
String |
getNotebookExecutionId()
The unique identifier of a notebook execution.
|
String |
getNotebookExecutionName()
A name for the notebook execution.
|
String |
getNotebookInstanceSecurityGroupId()
The unique identifier of the EC2 security group associated with the EMR Notebook instance.
|
String |
getNotebookParams()
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
|
String |
getOutputNotebookURI()
The location of the notebook execution's output file in Amazon S3.
|
Date |
getStartTime()
The timestamp when notebook execution started.
|
String |
getStatus()
The status of the notebook execution.
|
List<Tag> |
getTags()
A list of tags associated with a notebook execution.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the notebook execution.
|
void |
setEditorId(String editorId)
The unique identifier of the EMR Notebook that is used for the notebook execution.
|
void |
setEndTime(Date endTime)
The timestamp when notebook execution ended.
|
void |
setExecutionEngine(ExecutionEngineConfig executionEngine)
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
|
void |
setLastStateChangeReason(String lastStateChangeReason)
The reason for the latest status change of the notebook execution.
|
void |
setNotebookExecutionId(String notebookExecutionId)
The unique identifier of a notebook execution.
|
void |
setNotebookExecutionName(String notebookExecutionName)
A name for the notebook execution.
|
void |
setNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)
The unique identifier of the EC2 security group associated with the EMR Notebook instance.
|
void |
setNotebookParams(String notebookParams)
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
|
void |
setOutputNotebookURI(String outputNotebookURI)
The location of the notebook execution's output file in Amazon S3.
|
void |
setStartTime(Date startTime)
The timestamp when notebook execution started.
|
void |
setStatus(String status)
The status of the notebook execution.
|
void |
setTags(Collection<Tag> tags)
A list of tags associated with a notebook execution.
|
String |
toString()
Returns a string representation of this object.
|
NotebookExecution |
withArn(String arn)
The Amazon Resource Name (ARN) of the notebook execution.
|
NotebookExecution |
withEditorId(String editorId)
The unique identifier of the EMR Notebook that is used for the notebook execution.
|
NotebookExecution |
withEndTime(Date endTime)
The timestamp when notebook execution ended.
|
NotebookExecution |
withExecutionEngine(ExecutionEngineConfig executionEngine)
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
|
NotebookExecution |
withLastStateChangeReason(String lastStateChangeReason)
The reason for the latest status change of the notebook execution.
|
NotebookExecution |
withNotebookExecutionId(String notebookExecutionId)
The unique identifier of a notebook execution.
|
NotebookExecution |
withNotebookExecutionName(String notebookExecutionName)
A name for the notebook execution.
|
NotebookExecution |
withNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)
The unique identifier of the EC2 security group associated with the EMR Notebook instance.
|
NotebookExecution |
withNotebookParams(String notebookParams)
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
|
NotebookExecution |
withOutputNotebookURI(String outputNotebookURI)
The location of the notebook execution's output file in Amazon S3.
|
NotebookExecution |
withStartTime(Date startTime)
The timestamp when notebook execution started.
|
NotebookExecution |
withStatus(NotebookExecutionStatus status)
The status of the notebook execution.
|
NotebookExecution |
withStatus(String status)
The status of the notebook execution.
|
NotebookExecution |
withTags(Collection<Tag> tags)
A list of tags associated with a notebook execution.
|
NotebookExecution |
withTags(Tag... tags)
A list of tags associated with a notebook execution.
|
public void setNotebookExecutionId(String notebookExecutionId)
The unique identifier of a notebook execution.
notebookExecutionId
- The unique identifier of a notebook execution.public String getNotebookExecutionId()
The unique identifier of a notebook execution.
public NotebookExecution withNotebookExecutionId(String notebookExecutionId)
The unique identifier of a notebook execution.
notebookExecutionId
- The unique identifier of a notebook execution.public void setEditorId(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.public String getEditorId()
The unique identifier of the EMR Notebook that is used for the notebook execution.
public NotebookExecution withEditorId(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.public void setExecutionEngine(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.public ExecutionEngineConfig getExecutionEngine()
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
public NotebookExecution withExecutionEngine(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.public void setNotebookExecutionName(String notebookExecutionName)
A name for the notebook execution.
notebookExecutionName
- A name for the notebook execution.public String getNotebookExecutionName()
A name for the notebook execution.
public NotebookExecution withNotebookExecutionName(String notebookExecutionName)
A name for the notebook execution.
notebookExecutionName
- A name for the notebook execution.public void setNotebookParams(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.public String getNotebookParams()
Input parameters in JSON format passed to the EMR Notebook at runtime for execution.
public NotebookExecution withNotebookParams(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.public void setStatus(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
public String getStatus()
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.
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
public NotebookExecution withStatus(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
public NotebookExecution withStatus(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
public void setStartTime(Date startTime)
The timestamp when notebook execution started.
startTime
- The timestamp when notebook execution started.public Date getStartTime()
The timestamp when notebook execution started.
public NotebookExecution withStartTime(Date startTime)
The timestamp when notebook execution started.
startTime
- The timestamp when notebook execution started.public void setEndTime(Date endTime)
The timestamp when notebook execution ended.
endTime
- The timestamp when notebook execution ended.public Date getEndTime()
The timestamp when notebook execution ended.
public NotebookExecution withEndTime(Date endTime)
The timestamp when notebook execution ended.
endTime
- The timestamp when notebook execution ended.public void setArn(String arn)
The Amazon Resource Name (ARN) of the notebook execution.
arn
- The Amazon Resource Name (ARN) of the notebook execution.public String getArn()
The Amazon Resource Name (ARN) of the notebook execution.
public NotebookExecution withArn(String arn)
The Amazon Resource Name (ARN) of the notebook execution.
arn
- The Amazon Resource Name (ARN) of the notebook execution.public void setOutputNotebookURI(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.public String getOutputNotebookURI()
The location of the notebook execution's output file in Amazon S3.
public NotebookExecution withOutputNotebookURI(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.public void setLastStateChangeReason(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.public String getLastStateChangeReason()
The reason for the latest status change of the notebook execution.
public NotebookExecution withLastStateChangeReason(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.public void setNotebookInstanceSecurityGroupId(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.public String getNotebookInstanceSecurityGroupId()
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.
public NotebookExecution withNotebookInstanceSecurityGroupId(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.public List<Tag> getTags()
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.
public void setTags(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.public NotebookExecution withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.public NotebookExecution withTags(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.public String toString()
toString
in class Object
Object.toString()
public NotebookExecution clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.