Class StartNotebookExecutionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.emr.model.EmrRequest
software.amazon.awssdk.services.emr.model.StartNotebookExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartNotebookExecutionRequest.Builder,StartNotebookExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartNotebookExecutionRequest extends EmrRequest implements ToCopyableBuilder<StartNotebookExecutionRequest.Builder,StartNotebookExecutionRequest>

  • Method Details

    • editorId

      public final String editorId()

      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.

    • relativePath

      public final 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 .

      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 .

    • notebookExecutionName

      public final String notebookExecutionName()

      An optional name for the notebook execution.

      Returns:
      An optional name for the notebook execution.

    • notebookParams

      public final String notebookParams()

      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.

    • executionEngine

      public final ExecutionEngineConfig executionEngine()

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

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

    • serviceRole

      public final 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.

      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.

    • notebookInstanceSecurityGroupId

      public final String notebookInstanceSecurityGroupId()

      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      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.

    • notebookS3Location

      public final NotebookS3LocationFromInput notebookS3Location()

      The Amazon S3 location for the notebook execution input.

      Returns:
      The Amazon S3 location for the notebook execution input.

    • outputNotebookS3Location

      public final OutputNotebookS3LocationFromInput outputNotebookS3Location()

      The Amazon S3 location for the notebook execution output.

      Returns:
      The Amazon S3 location for the notebook execution output.

    • outputNotebookFormat

      public final OutputNotebookFormat outputNotebookFormat()

      The output format for the notebook execution.

      If the service returns an enum value that is not available in the current SDK version, outputNotebookFormat will return OutputNotebookFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputNotebookFormatAsString().

      Returns:
      The output format for the notebook execution.
      See Also:

    • outputNotebookFormatAsString

      public final String outputNotebookFormatAsString()

      The output format for the notebook execution.

      If the service returns an enum value that is not available in the current SDK version, outputNotebookFormat will return OutputNotebookFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputNotebookFormatAsString().

      Returns:
      The output format for the notebook execution.
      See Also:

    • hasEnvironmentVariables

      public final boolean hasEnvironmentVariables()
      For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environmentVariables

      public final Map<String,String> environmentVariables()

      The environment variables associated with the notebook execution.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentVariables() method.

      Returns:
      The environment variables associated with the notebook execution.

    • toBuilder

      public StartNotebookExecutionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartNotebookExecutionRequest.Builder,StartNotebookExecutionRequest>
      Specified by:
      toBuilder in class EmrRequest
      Returns:
      a builder for type T

    • builder

      public static StartNotebookExecutionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartNotebookExecutionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.