Class NotebookExecutionSummary

java.lang.Object
software.amazon.awssdk.services.emr.model.NotebookExecutionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NotebookExecutionSummary.Builder,NotebookExecutionSummary>

@Generated("software.amazon.awssdk:codegen") public final class NotebookExecutionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NotebookExecutionSummary.Builder,NotebookExecutionSummary>

Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.

See Also:
  • Method Details

    • notebookExecutionId

      public final String notebookExecutionId()

      The unique identifier of the notebook execution.

      Returns:
      The unique identifier of the notebook execution.
    • editorId

      public final String editorId()

      The unique identifier of the editor associated with the notebook execution.

      Returns:
      The unique identifier of the editor associated with the notebook execution.
    • notebookExecutionName

      public final String notebookExecutionName()

      The name of the notebook execution.

      Returns:
      The name of the notebook 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 started.

      Returns:
      The timestamp when notebook execution started.
    • 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.
    • executionEngineId

      public final String executionEngineId()

      The unique ID of the execution engine for the notebook execution.

      Returns:
      The unique ID of the execution engine for the notebook execution.
    • 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<NotebookExecutionSummary.Builder,NotebookExecutionSummary>
      Returns:
      a builder for type T
    • builder

      public static NotebookExecutionSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends NotebookExecutionSummary.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.