Package software.amazon.awssdk.services.bedrockagent.model

Class GetPromptResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagent.model.BedrockAgentResponse
software.amazon.awssdk.services.bedrockagent.model.GetPromptResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPromptResponse.Builder,GetPromptResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPromptResponse extends BedrockAgentResponse implements ToCopyableBuilder<GetPromptResponse.Builder,GetPromptResponse>

  • Method Details

    • name

      public final String name()

      The name of the prompt.

      Returns:
      The name of the prompt.

    • description

      public final String description()

      The descriptino of the prompt.

      Returns:
      The descriptino of the prompt.

    • customerEncryptionKeyArn

      public final String customerEncryptionKeyArn()

      The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

    • defaultVariant

      public final String defaultVariant()

      The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

      Returns:
      The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

    • hasVariants

      public final boolean hasVariants()
      For responses, this returns true if the service returned a value for the Variants 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.

    • variants

      public final List<PromptVariant> variants()

      A list of objects, each containing details about a variant of the prompt.

      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 hasVariants() method.

      Returns:
      A list of objects, each containing details about a variant of the prompt.

    • id

      public final String id()

      The unique identifier of the prompt.

      Returns:
      The unique identifier of the prompt.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

      Returns:
      The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

    • version

      public final String version()

      The version of the prompt.

      Returns:
      The version of the prompt.

    • createdAt

      public final Instant createdAt()

      The time at which the prompt was created.

      Returns:
      The time at which the prompt was created.

    • updatedAt

      public final Instant updatedAt()

      The time at which the prompt was last updated.

      Returns:
      The time at which the prompt was last updated.

    • toBuilder

      public GetPromptResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetPromptResponse.Builder,GetPromptResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetPromptResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetPromptResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo