Class ListSpacesRequest

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

  • Method Details

    • nextToken

      public final String nextToken()

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

      Returns:
      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

    • maxResults

      public final Integer maxResults()

      This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

      Returns:
      This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

    • sortOrder

      public final SortOrder sortOrder()

      The sort order for the results. The default is Ascending.

      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. The default is Ascending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for the results. The default is Ascending.

      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. The default is Ascending.
      See Also:

    • sortBy

      public final SpaceSortKey sortBy()

      The parameter by which to sort the results. The default is CreationTime.

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

      Returns:
      The parameter by which to sort the results. The default is CreationTime.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The parameter by which to sort the results. The default is CreationTime.

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

      Returns:
      The parameter by which to sort the results. The default is CreationTime.
      See Also:

    • domainIdEquals

      public final String domainIdEquals()

      A parameter to search for the domain ID.

      Returns:
      A parameter to search for the domain ID.

    • spaceNameContains

      public final String spaceNameContains()

      A parameter by which to filter the results.

      Returns:
      A parameter by which to filter the results.

    • toBuilder

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

    • builder

      public static ListSpacesRequest.Builder builder()

    • serializableBuilderClass

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