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

Class ListInferenceComponentsRequest

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

  • Method Details

    • sortBy

      public final InferenceComponentSortKey sortBy()

      The field by which to sort the inference components in the response. The default is CreationTime.

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

      Returns:
      The field by which to sort the inference components in the response. The default is CreationTime.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field by which to sort the inference components in the response. The default is CreationTime.

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

      Returns:
      The field by which to sort the inference components in the response. The default is CreationTime.
      See Also:

    • sortOrder

      public final OrderKey sortOrder()

      The sort order for results. The default is Descending.

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

      Returns:
      The sort order for results. The default is Descending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order for results. The default is Descending.

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

      Returns:
      The sort order for results. The default is Descending.
      See Also:

    • nextToken

      public final String nextToken()

      A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

      Returns:
      A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

    • maxResults

      public final Integer maxResults()

      The maximum number of inference components to return in the response. This value defaults to 10.

      Returns:
      The maximum number of inference components to return in the response. This value defaults to 10.

    • nameContains

      public final String nameContains()

      Filters the results to only those inference components with a name that contains the specified string.

      Returns:
      Filters the results to only those inference components with a name that contains the specified string.

    • creationTimeBefore

      public final Instant creationTimeBefore()

      Filters the results to only those inference components that were created before the specified time.

      Returns:
      Filters the results to only those inference components that were created before the specified time.

    • creationTimeAfter

      public final Instant creationTimeAfter()

      Filters the results to only those inference components that were created after the specified time.

      Returns:
      Filters the results to only those inference components that were created after the specified time.

    • lastModifiedTimeBefore

      public final Instant lastModifiedTimeBefore()

      Filters the results to only those inference components that were updated before the specified time.

      Returns:
      Filters the results to only those inference components that were updated before the specified time.

    • lastModifiedTimeAfter

      public final Instant lastModifiedTimeAfter()

      Filters the results to only those inference components that were updated after the specified time.

      Returns:
      Filters the results to only those inference components that were updated after the specified time.

    • statusEquals

      public final InferenceComponentStatus statusEquals()

      Filters the results to only those inference components with the specified status.

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

      Returns:
      Filters the results to only those inference components with the specified status.
      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      Filters the results to only those inference components with the specified status.

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

      Returns:
      Filters the results to only those inference components with the specified status.
      See Also:

    • endpointNameEquals

      public final String endpointNameEquals()

      An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

      Returns:
      An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

    • variantNameEquals

      public final String variantNameEquals()

      A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

      Returns:
      A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

    • toBuilder

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

    • builder

      public static ListInferenceComponentsRequest.Builder builder()

    • serializableBuilderClass

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