Class ListModelsRequest

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

  • Method Details

    • assistantId

      public final String assistantId()

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. The assistant's region determines which models are available.

      Returns:
      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. The assistant's region determines which models are available.

    • aiPromptType

      public final AIPromptType aiPromptType()

      The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.

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

      Returns:
      The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.
      See Also:

    • aiPromptTypeAsString

      public final String aiPromptTypeAsString()

      The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.

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

      Returns:
      The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.
      See Also:

    • modelLifecycle

      public final ModelLifecycle modelLifecycle()

      The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.

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

      Returns:
      The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.
      See Also:

    • modelLifecycleAsString

      public final String modelLifecycleAsString()

      The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.

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

      Returns:
      The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.
      See Also:

    • nextToken

      public final String nextToken()

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      Returns:
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per page.

      Returns:
      The maximum number of results to return per page.

    • toBuilder

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

    • builder

      public static ListModelsRequest.Builder builder()

    • serializableBuilderClass

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