Class CreateAiPromptRequest

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

  • Method Details

    • apiFormat

      public final AIPromptAPIFormat apiFormat()

      The API Format of the AI Prompt.

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

      Returns:
      The API Format of the AI Prompt.
      See Also:

    • apiFormatAsString

      public final String apiFormatAsString()

      The API Format of the AI Prompt.

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

      Returns:
      The API Format of the AI Prompt.
      See Also:

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

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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 AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    • description

      public final String description()

      The description of the AI Prompt.

      Returns:
      The description of the AI Prompt.

    • modelId

      public final String modelId()

      The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1

      Returns:
      The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1

    • name

      public final String name()

      The name of the AI Prompt.

      Returns:
      The name of the AI Prompt.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags used to organize, track, or control access for this resource.

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

    • templateType

      public final AIPromptTemplateType templateType()

      The type of the prompt template for this AI Prompt.

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

      Returns:
      The type of the prompt template for this AI Prompt.
      See Also:

    • templateTypeAsString

      public final String templateTypeAsString()

      The type of the prompt template for this AI Prompt.

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

      Returns:
      The type of the prompt template for this AI Prompt.
      See Also:

    • type

      public final AIPromptType type()

      The type of this AI Prompt.

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

      Returns:
      The type of this AI Prompt.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of this AI Prompt.

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

      Returns:
      The type of this AI Prompt.
      See Also:

    • visibilityStatus

      public final VisibilityStatus visibilityStatus()

      The visibility status of the 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 AI Prompt.
      See Also:

    • visibilityStatusAsString

      public final String visibilityStatusAsString()

      The visibility status of the 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 AI Prompt.
      See Also:

    • toBuilder

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

    • builder

      public static CreateAiPromptRequest.Builder builder()

    • serializableBuilderClass

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