Package software.amazon.awssdk.services.sagemaker.model

Class ListNotebookInstancesRequest

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

  • Method Details

    • nextToken

      public final String nextToken()

      If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

      You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

      Returns:
      If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

      You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

    • maxResults

      public final Integer maxResults()

      The maximum number of notebook instances to return.

      Returns:
      The maximum number of notebook instances to return.

    • sortBy

      public final NotebookInstanceSortKey sortBy()

      The field to sort results by. The default is Name.

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

      Returns:
      The field to sort results by. The default is Name.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field to sort results by. The default is Name.

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

      Returns:
      The field to sort results by. The default is Name.
      See Also:

    • sortOrder

      public final NotebookInstanceSortOrder sortOrder()

      The sort order for results.

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

      Returns:
      The sort order for results.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for results.

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

      Returns:
      The sort order for results.
      See Also:

    • nameContains

      public final String nameContains()

      A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

      Returns:
      A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

    • creationTimeBefore

      public final Instant creationTimeBefore()

      A filter that returns only notebook instances that were created before the specified time (timestamp).

      Returns:
      A filter that returns only notebook instances that were created before the specified time (timestamp).

    • creationTimeAfter

      public final Instant creationTimeAfter()

      A filter that returns only notebook instances that were created after the specified time (timestamp).

      Returns:
      A filter that returns only notebook instances that were created after the specified time (timestamp).

    • lastModifiedTimeBefore

      public final Instant lastModifiedTimeBefore()

      A filter that returns only notebook instances that were modified before the specified time (timestamp).

      Returns:
      A filter that returns only notebook instances that were modified before the specified time (timestamp).

    • lastModifiedTimeAfter

      public final Instant lastModifiedTimeAfter()

      A filter that returns only notebook instances that were modified after the specified time (timestamp).

      Returns:
      A filter that returns only notebook instances that were modified after the specified time (timestamp).

    • statusEquals

      public final NotebookInstanceStatus statusEquals()

      A filter that returns only notebook instances with the specified status.

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

      Returns:
      A filter that returns only notebook instances with the specified status.
      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      A filter that returns only notebook instances with the specified status.

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

      Returns:
      A filter that returns only notebook instances with the specified status.
      See Also:

    • notebookInstanceLifecycleConfigNameContains

      public final String notebookInstanceLifecycleConfigNameContains()

      A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

      Returns:
      A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

    • defaultCodeRepositoryContains

      public final String defaultCodeRepositoryContains()

      A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

      Returns:
      A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

    • additionalCodeRepositoryEquals

      public final String additionalCodeRepositoryEquals()

      A filter that returns only notebook instances with associated with the specified git repository.

      Returns:
      A filter that returns only notebook instances with associated with the specified git repository.

    • toBuilder

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

    • builder

      public static ListNotebookInstancesRequest.Builder builder()

    • serializableBuilderClass

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