Class ListNotebookRunsRequest

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

  • Method Details

    • domainIdentifier

      public final String domainIdentifier()

      The identifier of the Amazon SageMaker Unified Studio domain in which to list notebook runs.

      Returns:
      The identifier of the Amazon SageMaker Unified Studio domain in which to list notebook runs.

    • owningProjectIdentifier

      public final String owningProjectIdentifier()

      The identifier of the project that owns the notebook runs.

      Returns:
      The identifier of the project that owns the notebook runs.

    • notebookIdentifier

      public final String notebookIdentifier()

      The identifier of the notebook to filter runs by.

      Returns:
      The identifier of the notebook to filter runs by.

    • status

      public final NotebookRunStatus status()

      The status to filter notebook runs by.

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

      Returns:
      The status to filter notebook runs by.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status to filter notebook runs by.

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

      Returns:
      The status to filter notebook runs by.
      See Also:

    • scheduleIdentifier

      public final String scheduleIdentifier()

      The identifier of the schedule to filter notebook runs by.

      Returns:
      The identifier of the schedule to filter notebook runs by.

    • maxResults

      public final Integer maxResults()

      The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.

      Returns:
      The maximum number of notebook runs to return in a single call. When the number of notebook runs exceeds the value of MaxResults, the response contains a NextToken value.

    • sortOrder

      public final SortOrder sortOrder()

      The sort order for the results.

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

      Returns:
      The sort order for the results.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for the results.

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

      Returns:
      The sort order for the results.
      See Also:

    • nextToken

      public final String nextToken()

      When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

      Returns:
      When the number of notebook runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebook runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebookRuns to list the next set of notebook runs.

    • toBuilder

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

    • builder

      public static ListNotebookRunsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.