Class ListModelPackageGroupsRequest

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

  • Method Details

    • creationTimeAfter

      public final Instant creationTimeAfter()

      A filter that returns only model groups created after the specified time.

      Returns:
      A filter that returns only model groups created after the specified time.

    • creationTimeBefore

      public final Instant creationTimeBefore()

      A filter that returns only model groups created before the specified time.

      Returns:
      A filter that returns only model groups created before the specified time.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in the response.

      Returns:
      The maximum number of results to return in the response.

    • nameContains

      public final String nameContains()

      A string in the model group name. This filter returns only model groups whose name contains the specified string.

      Returns:
      A string in the model group name. This filter returns only model groups whose name contains the specified string.

    • nextToken

      public final String nextToken()

      If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

      Returns:
      If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

    • sortBy

      public final ModelPackageGroupSortBy sortBy()

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

      If the service returns an enum value that is not available in the current SDK version, sortBy will return ModelPackageGroupSortBy.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 CreationTime.
      See Also:

    • sortByAsString

      public final String sortByAsString()

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

      If the service returns an enum value that is not available in the current SDK version, sortBy will return ModelPackageGroupSortBy.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 CreationTime.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

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

    • sortOrderAsString

      public final String sortOrderAsString()

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

    • crossAccountFilterOption

      public final CrossAccountFilterOption crossAccountFilterOption()

      A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.

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

      Returns:
      A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.
      See Also:

    • crossAccountFilterOptionAsString

      public final String crossAccountFilterOptionAsString()

      A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.

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

      Returns:
      A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.
      See Also:

    • toBuilder

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

    • builder

      public static ListModelPackageGroupsRequest.Builder builder()

    • serializableBuilderClass

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