com.amazonaws.services.elasticmapreduce.model

Class NotebookExecution

java.lang.Object

com.amazonaws.services.elasticmapreduce.model.NotebookExecution

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@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 Amazon EMR Notebook is run using the StartNotebookExecution action.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotebookExecution()

Method Summary

Modifier and Type	Method and Description
NotebookExecution	addEnvironmentVariablesEntry(String key, String value) Add a single EnvironmentVariables entry
NotebookExecution	clearEnvironmentVariablesEntries() Removes all the entries added into EnvironmentVariables.
NotebookExecution	clone()
boolean	equals(Object obj)
String	getArn() The Amazon Resource Name (ARN) of the notebook execution.
String	getEditorId() The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
Date	getEndTime() The timestamp when notebook execution ended.
Map<String,String>	getEnvironmentVariables() The environment variables associated with the notebook execution.
ExecutionEngineConfig	getExecutionEngine() The execution engine, such as an Amazon EMR cluster, used to run the Amazon 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 Amazon EC2 security group associated with the Amazon EMR Notebook instance.
String	getNotebookParams() Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
NotebookS3LocationForOutput	getNotebookS3Location() The Amazon S3 location that stores the notebook execution input.
String	getOutputNotebookFormat() The output format for the notebook execution.
OutputNotebookS3LocationForOutput	getOutputNotebookS3Location() The Amazon S3 location for the notebook execution output.
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 Amazon EMR Notebook that is used for the notebook execution.
void	setEndTime(Date endTime) The timestamp when notebook execution ended.
void	setEnvironmentVariables(Map<String,String> environmentVariables) The environment variables associated with the notebook execution.
void	setExecutionEngine(ExecutionEngineConfig executionEngine) The execution engine, such as an Amazon EMR cluster, used to run the Amazon 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 Amazon EC2 security group associated with the Amazon EMR Notebook instance.
void	setNotebookParams(String notebookParams) Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
void	setNotebookS3Location(NotebookS3LocationForOutput notebookS3Location) The Amazon S3 location that stores the notebook execution input.
void	setOutputNotebookFormat(String outputNotebookFormat) The output format for the notebook execution.
void	setOutputNotebookS3Location(OutputNotebookS3LocationForOutput outputNotebookS3Location) The Amazon S3 location for the notebook execution output.
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 Amazon EMR Notebook that is used for the notebook execution.
NotebookExecution	withEndTime(Date endTime) The timestamp when notebook execution ended.
NotebookExecution	withEnvironmentVariables(Map<String,String> environmentVariables) The environment variables associated with the notebook execution.
NotebookExecution	withExecutionEngine(ExecutionEngineConfig executionEngine) The execution engine, such as an Amazon EMR cluster, used to run the Amazon 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 Amazon EC2 security group associated with the Amazon EMR Notebook instance.
NotebookExecution	withNotebookParams(String notebookParams) Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
NotebookExecution	withNotebookS3Location(NotebookS3LocationForOutput notebookS3Location) The Amazon S3 location that stores the notebook execution input.
NotebookExecution	withOutputNotebookFormat(OutputNotebookFormat outputNotebookFormat) The output format for the notebook execution.
NotebookExecution	withOutputNotebookFormat(String outputNotebookFormat) The output format for the notebook execution.
NotebookExecution	withOutputNotebookS3Location(OutputNotebookS3LocationForOutput outputNotebookS3Location) The Amazon S3 location for the notebook execution output.
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotebookExecution

public NotebookExecution()

Method Detail

setNotebookExecutionId

public void setNotebookExecutionId(String notebookExecutionId)

The unique identifier of a notebook execution.

Parameters:

notebookExecutionId - The unique identifier of a notebook execution.

getNotebookExecutionId

public String getNotebookExecutionId()

The unique identifier of a notebook execution.

Returns:

The unique identifier of a notebook execution.

withNotebookExecutionId

public NotebookExecution withNotebookExecutionId(String notebookExecutionId)

The unique identifier of a notebook execution.

Parameters:

notebookExecutionId - The unique identifier of a notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEditorId

public void setEditorId(String editorId)

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

Parameters:

editorId - The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

getEditorId

public String getEditorId()

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

Returns:

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

withEditorId

public NotebookExecution withEditorId(String editorId)

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

Parameters:

editorId - The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExecutionEngine

public void setExecutionEngine(ExecutionEngineConfig executionEngine)

The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

Parameters:

executionEngine - The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

getExecutionEngine

public ExecutionEngineConfig getExecutionEngine()

The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

Returns:

The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

withExecutionEngine

public NotebookExecution withExecutionEngine(ExecutionEngineConfig executionEngine)

The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

Parameters:

executionEngine - The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotebookExecutionName

public void setNotebookExecutionName(String notebookExecutionName)

A name for the notebook execution.

Parameters:

notebookExecutionName - A name for the notebook execution.

getNotebookExecutionName

public String getNotebookExecutionName()

A name for the notebook execution.

Returns:

A name for the notebook execution.

withNotebookExecutionName

public NotebookExecution withNotebookExecutionName(String notebookExecutionName)

A name for the notebook execution.

Parameters:

notebookExecutionName - A name for the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotebookParams

public void setNotebookParams(String notebookParams)

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

Parameters:

notebookParams - Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

getNotebookParams

public String getNotebookParams()

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

Returns:

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

withNotebookParams

public NotebookExecution withNotebookParams(String notebookParams)

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

Parameters:

notebookParams - Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

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.

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.

See Also:

NotebookExecutionStatus

getStatus

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.

Returns:

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.

See Also:

NotebookExecutionStatus

withStatus

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.

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:

NotebookExecutionStatus

withStatus

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.

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:

NotebookExecutionStatus

setStartTime

public void setStartTime(Date startTime)

The timestamp when notebook execution started.

Parameters:

startTime - The timestamp when notebook execution started.

getStartTime

public Date getStartTime()

The timestamp when notebook execution started.

Returns:

The timestamp when notebook execution started.

withStartTime

public NotebookExecution withStartTime(Date 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.

setEndTime

public void setEndTime(Date endTime)

The timestamp when notebook execution ended.

Parameters:

endTime - The timestamp when notebook execution ended.

getEndTime

public Date getEndTime()

The timestamp when notebook execution ended.

Returns:

The timestamp when notebook execution ended.

withEndTime

public NotebookExecution withEndTime(Date endTime)

The timestamp when notebook execution ended.

Parameters:

endTime - The timestamp when notebook execution ended.

Returns:

Returns a reference to this object so that method calls can be chained together.

setArn

public void setArn(String arn)

The Amazon Resource Name (ARN) of the notebook execution.

Parameters:

arn - The Amazon Resource Name (ARN) of the notebook execution.

getArn

public String getArn()

The Amazon Resource Name (ARN) of the notebook execution.

Returns:

The Amazon Resource Name (ARN) of the notebook execution.

withArn

public NotebookExecution withArn(String arn)

The Amazon Resource Name (ARN) of the notebook execution.

Parameters:

arn - The Amazon Resource Name (ARN) of the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputNotebookURI

public void setOutputNotebookURI(String outputNotebookURI)

The location of the notebook execution's output file in Amazon S3.

Parameters:

outputNotebookURI - The location of the notebook execution's output file in Amazon S3.

getOutputNotebookURI

public String getOutputNotebookURI()

The location of the notebook execution's output file in Amazon S3.

Returns:

The location of the notebook execution's output file in Amazon S3.

withOutputNotebookURI

public NotebookExecution withOutputNotebookURI(String outputNotebookURI)

The location of the notebook execution's output file in Amazon S3.

Parameters:

outputNotebookURI - The location of the notebook execution's output file in Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLastStateChangeReason

public void setLastStateChangeReason(String lastStateChangeReason)

The reason for the latest status change of the notebook execution.

Parameters:

lastStateChangeReason - The reason for the latest status change of the notebook execution.

getLastStateChangeReason

public String getLastStateChangeReason()

The reason for the latest status change of the notebook execution.

Returns:

The reason for the latest status change of the notebook execution.

withLastStateChangeReason

public NotebookExecution withLastStateChangeReason(String lastStateChangeReason)

The reason for the latest status change of the notebook execution.

Parameters:

lastStateChangeReason - The reason for the latest status change of the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotebookInstanceSecurityGroupId

public void setNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)

The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

Parameters:

notebookInstanceSecurityGroupId - The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

getNotebookInstanceSecurityGroupId

public String getNotebookInstanceSecurityGroupId()

The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

Returns:

The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

withNotebookInstanceSecurityGroupId

public NotebookExecution withNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)

The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

Parameters:

notebookInstanceSecurityGroupId - The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

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.

Returns:

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.

setTags

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.

Parameters:

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.

withTags

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotebookS3Location

public void setNotebookS3Location(NotebookS3LocationForOutput notebookS3Location)

The Amazon S3 location that stores the notebook execution input.

Parameters:

notebookS3Location - The Amazon S3 location that stores the notebook execution input.

getNotebookS3Location

public NotebookS3LocationForOutput getNotebookS3Location()

The Amazon S3 location that stores the notebook execution input.

Returns:

The Amazon S3 location that stores the notebook execution input.

withNotebookS3Location

public NotebookExecution withNotebookS3Location(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.

setOutputNotebookS3Location

public void setOutputNotebookS3Location(OutputNotebookS3LocationForOutput outputNotebookS3Location)

The Amazon S3 location for the notebook execution output.

Parameters:

outputNotebookS3Location - The Amazon S3 location for the notebook execution output.

getOutputNotebookS3Location

public OutputNotebookS3LocationForOutput getOutputNotebookS3Location()

The Amazon S3 location for the notebook execution output.

Returns:

The Amazon S3 location for the notebook execution output.

withOutputNotebookS3Location

public NotebookExecution withOutputNotebookS3Location(OutputNotebookS3LocationForOutput outputNotebookS3Location)

The Amazon S3 location for the notebook execution output.

Parameters:

outputNotebookS3Location - The Amazon S3 location for the notebook execution output.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputNotebookFormat

public void setOutputNotebookFormat(String outputNotebookFormat)

The output format for the notebook execution.

Parameters:

outputNotebookFormat - The output format for the notebook execution.

See Also:

OutputNotebookFormat

getOutputNotebookFormat

public String getOutputNotebookFormat()

The output format for the notebook execution.

Returns:

The output format for the notebook execution.

See Also:

OutputNotebookFormat

withOutputNotebookFormat

public NotebookExecution withOutputNotebookFormat(String outputNotebookFormat)

The output format for the notebook execution.

Parameters:

outputNotebookFormat - The output format for the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OutputNotebookFormat

withOutputNotebookFormat

public NotebookExecution withOutputNotebookFormat(OutputNotebookFormat outputNotebookFormat)

The output format for the notebook execution.

Parameters:

outputNotebookFormat - The output format for the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OutputNotebookFormat

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()

The environment variables associated with the notebook execution.

Returns:

The environment variables associated with the notebook execution.

setEnvironmentVariables

public void setEnvironmentVariables(Map<String,String> environmentVariables)

The environment variables associated with the notebook execution.

Parameters:

environmentVariables - The environment variables associated with the notebook execution.

withEnvironmentVariables

public NotebookExecution withEnvironmentVariables(Map<String,String> environmentVariables)

The environment variables associated with the notebook execution.

Parameters:

environmentVariables - The environment variables associated with the notebook execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

addEnvironmentVariablesEntry

public NotebookExecution addEnvironmentVariablesEntry(String key,
                                                      String value)

Add a single EnvironmentVariables entry

See Also:

withEnvironmentVariables(java.util.Map<java.lang.String, java.lang.String>)

clearEnvironmentVariablesEntries

public NotebookExecution clearEnvironmentVariablesEntries()

Removes all the entries added into EnvironmentVariables.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public NotebookExecution clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.