Package software.amazon.awssdk.services.emr.model

Class NotebookExecution

java.lang.Object
software.amazon.awssdk.services.emr.model.NotebookExecution
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NotebookExecution.Builder,NotebookExecution>
@Generated("software.amazon.awssdk:codegen") public final class NotebookExecution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NotebookExecution.Builder,NotebookExecution>

A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution action.

See Also:

  • Method Details

    • notebookExecutionId

      public final String notebookExecutionId()

      The unique identifier of a notebook execution.

      Returns:
      The unique identifier of a notebook execution.

    • editorId

      public final String editorId()

      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.

    • executionEngine

      public final ExecutionEngineConfig executionEngine()

      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.

    • notebookExecutionName

      public final String notebookExecutionName()

      A name for the notebook execution.

      Returns:
      A 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.

    • status

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

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

      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:

    • statusAsString

      public final String statusAsString()

      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.

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

      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:

    • startTime

      public final Instant startTime()

      The timestamp when notebook execution started.

      Returns:
      The timestamp when notebook execution started.

    • endTime

      public final Instant endTime()

      The timestamp when notebook execution ended.

      Returns:
      The timestamp when notebook execution ended.

    • arn

      public final String arn()

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

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

    • outputNotebookURI

      public final String outputNotebookURI()

      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.

    • lastStateChangeReason

      public final String lastStateChangeReason()

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

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

    • notebookInstanceSecurityGroupId

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

      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.

    • 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 NotebookS3LocationForOutput notebookS3Location()

      The Amazon S3 location that stores the notebook execution input.

      Returns:
      The Amazon S3 location that stores the notebook execution input.

    • outputNotebookS3Location

      public final OutputNotebookS3LocationForOutput 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 NotebookExecution.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<NotebookExecution.Builder,NotebookExecution>
      Returns:
      a builder for type T

    • builder

      public static NotebookExecution.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.