All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartNotebookExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  StartNotebookExecutionRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StartNotebookExecutionRequest	addEnvironmentVariablesEntry (String key, String value) Add a single EnvironmentVariables entry
  StartNotebookExecutionRequest	clearEnvironmentVariablesEntries () Removes all the entries added into EnvironmentVariables.
  StartNotebookExecutionRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getEditorId () The unique identifier of the Amazon EMR Notebook to use for notebook execution.
  Map<String,String>	getEnvironmentVariables () The environment variables associated with the notebook execution.
  ExecutionEngineConfig	getExecutionEngine () Specifies the execution engine (cluster) that runs the notebook execution.
  String	getNotebookExecutionName () An optional name for the notebook execution.
  String	getNotebookInstanceSecurityGroupId () The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
  String	getNotebookParams () Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
  NotebookS3LocationFromInput	getNotebookS3Location () The Amazon S3 location for the notebook execution input.
  String	getOutputNotebookFormat () The output format for the notebook execution.
  OutputNotebookS3LocationFromInput	getOutputNotebookS3Location () The Amazon S3 location for the notebook execution output.
  String	getRelativePath () The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook.
  String	getServiceRole () The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
  List<Tag>	getTags () A list of tags associated with a notebook execution.
  int	hashCode ()
  void	setEditorId (String editorId) The unique identifier of the Amazon EMR Notebook to use for notebook execution.
  void	setEnvironmentVariables (Map<String,String> environmentVariables) The environment variables associated with the notebook execution.
  void	setExecutionEngine (ExecutionEngineConfig executionEngine) Specifies the execution engine (cluster) that runs the notebook execution.
  void	setNotebookExecutionName (String notebookExecutionName) An optional name for the notebook execution.
  void	setNotebookInstanceSecurityGroupId (String notebookInstanceSecurityGroupId) The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
  void	setNotebookParams (String notebookParams) Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
  void	setNotebookS3Location (NotebookS3LocationFromInput notebookS3Location) The Amazon S3 location for the notebook execution input.
  void	setOutputNotebookFormat (String outputNotebookFormat) The output format for the notebook execution.
  void	setOutputNotebookS3Location (OutputNotebookS3LocationFromInput outputNotebookS3Location) The Amazon S3 location for the notebook execution output.
  void	setRelativePath (String relativePath) The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook.
  void	setServiceRole (String serviceRole) The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for 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.
  StartNotebookExecutionRequest	withEditorId (String editorId) The unique identifier of the Amazon EMR Notebook to use for notebook execution.
  StartNotebookExecutionRequest	withEnvironmentVariables (Map<String,String> environmentVariables) The environment variables associated with the notebook execution.
  StartNotebookExecutionRequest	withExecutionEngine (ExecutionEngineConfig executionEngine) Specifies the execution engine (cluster) that runs the notebook execution.
  StartNotebookExecutionRequest	withNotebookExecutionName (String notebookExecutionName) An optional name for the notebook execution.
  StartNotebookExecutionRequest	withNotebookInstanceSecurityGroupId (String notebookInstanceSecurityGroupId) The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
  StartNotebookExecutionRequest	withNotebookParams (String notebookParams) Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
  StartNotebookExecutionRequest	withNotebookS3Location (NotebookS3LocationFromInput notebookS3Location) The Amazon S3 location for the notebook execution input.
  StartNotebookExecutionRequest	withOutputNotebookFormat (OutputNotebookFormat outputNotebookFormat) The output format for the notebook execution.
  StartNotebookExecutionRequest	withOutputNotebookFormat (String outputNotebookFormat) The output format for the notebook execution.
  StartNotebookExecutionRequest	withOutputNotebookS3Location (OutputNotebookS3LocationFromInput outputNotebookS3Location) The Amazon S3 location for the notebook execution output.
  StartNotebookExecutionRequest	withRelativePath (String relativePath) The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook.
  StartNotebookExecutionRequest	withServiceRole (String serviceRole) The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
  StartNotebookExecutionRequest	withTags (Collection<Tag> tags) A list of tags associated with a notebook execution.
  StartNotebookExecutionRequest	withTags (Tag... tags) A list of tags associated with a notebook execution.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • StartNotebookExecutionRequest

    public StartNotebookExecutionRequest()

• Method Detail

  • setEditorId

    public void setEditorId(String editorId)

    The unique identifier of the Amazon EMR Notebook to use for notebook execution.

    Parameters:

    editorId - The unique identifier of the Amazon EMR Notebook to use for notebook execution.

  • getEditorId

    public String getEditorId()

    The unique identifier of the Amazon EMR Notebook to use for notebook execution.

    Returns:

    The unique identifier of the Amazon EMR Notebook to use for notebook execution.

  • withEditorId

    public StartNotebookExecutionRequest withEditorId(String editorId)

    The unique identifier of the Amazon EMR Notebook to use for notebook execution.

    Parameters:

    editorId - The unique identifier of the Amazon EMR Notebook to use for notebook execution.

    Returns:

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

  • setRelativePath

    public void setRelativePath(String relativePath)

    The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

    Parameters:

    relativePath - The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

  • getRelativePath

    public String getRelativePath()

    The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

    Returns:

    The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

  • withRelativePath

    public StartNotebookExecutionRequest withRelativePath(String relativePath)

    The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

    Parameters:

    relativePath - The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .

    Returns:

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

  • setNotebookExecutionName

    public void setNotebookExecutionName(String notebookExecutionName)

    An optional name for the notebook execution.

    Parameters:

    notebookExecutionName - An optional name for the notebook execution.

  • getNotebookExecutionName

    public String getNotebookExecutionName()

    An optional name for the notebook execution.

    Returns:

    An optional name for the notebook execution.

  • withNotebookExecutionName

    public StartNotebookExecutionRequest withNotebookExecutionName(String notebookExecutionName)

    An optional name for the notebook execution.

    Parameters:

    notebookExecutionName - An optional 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 StartNotebookExecutionRequest 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.

  • setExecutionEngine

    public void setExecutionEngine(ExecutionEngineConfig executionEngine)

    Specifies the execution engine (cluster) that runs the notebook execution.

    Parameters:

    executionEngine - Specifies the execution engine (cluster) that runs the notebook execution.

  • getExecutionEngine

    public ExecutionEngineConfig getExecutionEngine()

    Specifies the execution engine (cluster) that runs the notebook execution.

    Returns:

    Specifies the execution engine (cluster) that runs the notebook execution.

  • withExecutionEngine

    public StartNotebookExecutionRequest withExecutionEngine(ExecutionEngineConfig executionEngine)

    Specifies the execution engine (cluster) that runs the notebook execution.

    Parameters:

    executionEngine - Specifies the execution engine (cluster) that runs the notebook execution.

    Returns:

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

  • setServiceRole

    public void setServiceRole(String serviceRole)

    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

    Parameters:

    serviceRole - The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

  • getServiceRole

    public String getServiceRole()

    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

    Returns:

    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

  • withServiceRole

    public StartNotebookExecutionRequest withServiceRole(String serviceRole)

    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

    Parameters:

    serviceRole - The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for 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 to associate with the Amazon EMR Notebook for this notebook execution.

    Parameters:

    notebookInstanceSecurityGroupId - The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

  • getNotebookInstanceSecurityGroupId

    public String getNotebookInstanceSecurityGroupId()

    The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

    Returns:

    The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

  • withNotebookInstanceSecurityGroupId

    public StartNotebookExecutionRequest withNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId)

    The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

    Parameters:

    notebookInstanceSecurityGroupId - The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

    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 StartNotebookExecutionRequest 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 StartNotebookExecutionRequest 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(NotebookS3LocationFromInput notebookS3Location)

    The Amazon S3 location for the notebook execution input.

    Parameters:

    notebookS3Location - The Amazon S3 location for the notebook execution input.

  • getNotebookS3Location

    public NotebookS3LocationFromInput getNotebookS3Location()

    The Amazon S3 location for the notebook execution input.

    Returns:

    The Amazon S3 location for the notebook execution input.

  • withNotebookS3Location

    public StartNotebookExecutionRequest withNotebookS3Location(NotebookS3LocationFromInput notebookS3Location)

    The Amazon S3 location for the notebook execution input.

    Parameters:

    notebookS3Location - The Amazon S3 location for the notebook execution input.

    Returns:

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

  • setOutputNotebookS3Location

    public void setOutputNotebookS3Location(OutputNotebookS3LocationFromInput outputNotebookS3Location)

    The Amazon S3 location for the notebook execution output.

    Parameters:

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

  • getOutputNotebookS3Location

    public OutputNotebookS3LocationFromInput getOutputNotebookS3Location()

    The Amazon S3 location for the notebook execution output.

    Returns:

    The Amazon S3 location for the notebook execution output.

  • withOutputNotebookS3Location

    public StartNotebookExecutionRequest withOutputNotebookS3Location(OutputNotebookS3LocationFromInput 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 StartNotebookExecutionRequest 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 StartNotebookExecutionRequest 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 StartNotebookExecutionRequest 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 StartNotebookExecutionRequest addEnvironmentVariablesEntry(String key,
     String value)

    Add a single EnvironmentVariables entry

    See Also:

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

  • clearEnvironmentVariablesEntries

    public StartNotebookExecutionRequest 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 StartNotebookExecutionRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()