Class ListCustomModelsRequest

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

  • Method Details

    • creationTimeBefore

      public final Instant creationTimeBefore()

      Return custom models created before the specified time.

      Returns:
      Return custom models created before the specified time.

    • creationTimeAfter

      public final Instant creationTimeAfter()

      Return custom models created after the specified time.

      Returns:
      Return custom models created after the specified time.

    • nameContains

      public final String nameContains()

      Return custom models only if the job name contains these characters.

      Returns:
      Return custom models only if the job name contains these characters.

    • baseModelArnEquals

      public final String baseModelArnEquals()

      Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

      Returns:
      Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

    • foundationModelArnEquals

      public final String foundationModelArnEquals()

      Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

      Returns:
      Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

      Returns:
      The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

    • nextToken

      public final String nextToken()

      If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

      Returns:
      If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    • sortBy

      public final SortModelsBy sortBy()

      The field to sort by in the returned list of models.

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

      Returns:
      The field to sort by in the returned list of models.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field to sort by in the returned list of models.

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

      Returns:
      The field to sort by in the returned list of models.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      The sort order of 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 of the results.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order of 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 of the results.
      See Also:

    • isOwned

      public final Boolean isOwned()

      Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

      Returns:
      Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

    • modelStatus

      public final ModelStatus modelStatus()

      The status of them model to filter results by. Possible values include:

      • Creating - Include only models that are currently being created and validated.

      • Active - Include only models that have been successfully created and are ready for use.

      • Failed - Include only models where the creation process failed.

      If you don't specify a status, the API returns models in all states.

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

      Returns:
      The status of them model to filter results by. Possible values include:

      • Creating - Include only models that are currently being created and validated.

      • Active - Include only models that have been successfully created and are ready for use.

      • Failed - Include only models where the creation process failed.

      If you don't specify a status, the API returns models in all states.

      See Also:

    • modelStatusAsString

      public final String modelStatusAsString()

      The status of them model to filter results by. Possible values include:

      • Creating - Include only models that are currently being created and validated.

      • Active - Include only models that have been successfully created and are ready for use.

      • Failed - Include only models where the creation process failed.

      If you don't specify a status, the API returns models in all states.

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

      Returns:
      The status of them model to filter results by. Possible values include:

      • Creating - Include only models that are currently being created and validated.

      • Active - Include only models that have been successfully created and are ready for use.

      • Failed - Include only models where the creation process failed.

      If you don't specify a status, the API returns models in all states.

      See Also:

    • toBuilder

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

    • builder

      public static ListCustomModelsRequest.Builder builder()

    • serializableBuilderClass

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