Class UpdateAiPromptRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

    • 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.

      Returns:
      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • aiPromptId

      public final String aiPromptId()

      The identifier of the Amazon Q in Connect AI Prompt.

      Returns:
      The identifier of the Amazon Q in Connect AI Prompt.

    • visibilityStatus

      public final VisibilityStatus visibilityStatus()

      The visibility status of the Amazon Q in Connect AI prompt.

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

      Returns:
      The visibility status of the Amazon Q in Connect AI prompt.
      See Also:

    • visibilityStatusAsString

      public final String visibilityStatusAsString()

      The visibility status of the Amazon Q in Connect AI prompt.

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

      Returns:
      The visibility status of the Amazon Q in Connect AI prompt.
      See Also:

    • templateConfiguration

      public final AIPromptTemplateConfiguration templateConfiguration()

      The configuration of the prompt template for this AI Prompt.

      Returns:
      The configuration of the prompt template for this AI Prompt.

    • description

      public final String description()

      The description of the Amazon Q in Connect AI Prompt.

      Returns:
      The description of the Amazon Q in Connect AI Prompt.

    • modelId

      public final String modelId()

      The identifier of the model used for this AI Prompt.

      For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.

      Returns:
      The identifier of the model used for this AI Prompt.

      For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.

    • toBuilder

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

    • builder

      public static UpdateAiPromptRequest.Builder builder()

    • serializableBuilderClass

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