Class ListNotebookExecutionsRequest

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.ListNotebookExecutionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListNotebookExecutionsRequest.Builder,ListNotebookExecutionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListNotebookExecutionsRequest extends EmrRequest implements ToCopyableBuilder<ListNotebookExecutionsRequest.Builder,ListNotebookExecutionsRequest>

  • Method Details

    • editorId

      public final String editorId()

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

      Returns:
      The unique ID of the editor associated with the notebook execution.

    • status

      public final NotebookExecutionStatus status()

      The status filter for listing notebook executions.

      • 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 filter for listing notebook executions.

      • 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 filter for listing notebook executions.

      • 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 filter for listing notebook executions.

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

    • from

      public final Instant from()

      The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

      Returns:
      The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

    • to

      public final Instant to()

      The end of time range filter for listing notebook executions. The default is the current timestamp.

      Returns:
      The end of time range filter for listing notebook executions. The default is the current timestamp.

    • marker

      public final String marker()

      The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

      Returns:
      The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

    • executionEngineId

      public final String executionEngineId()

      The unique ID of the execution engine.

      Returns:
      The unique ID of the execution engine.

    • toBuilder

      public ListNotebookExecutionsRequest.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<ListNotebookExecutionsRequest.Builder,ListNotebookExecutionsRequest>
      Specified by:
      toBuilder in class EmrRequest
      Returns:
      a builder for type T

    • builder

      public static ListNotebookExecutionsRequest.Builder builder()

    • serializableBuilderClass

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