Class CreatePromptVersionResponse

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

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the version of the prompt.

      Returns:
      The Amazon Resource Name (ARN) of 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.

    • customerEncryptionKeyArn

      public final String customerEncryptionKeyArn()

      The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.

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

    • description

      public final String description()

      A description for the version.

      Returns:
      A description for the version.

    • id

      public final String id()

      The unique identifier of the prompt.

      Returns:
      The unique identifier of the prompt.

    • name

      public final String name()

      The name of the prompt.

      Returns:
      The name of the prompt.

    • updatedAt

      public final Instant updatedAt()

      The time at which the prompt was last updated.

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

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

    • version

      public final String version()

      The version of the prompt that was created. Versions are numbered incrementally, starting from 1.

      Returns:
      The version of the prompt that was created. Versions are numbered incrementally, starting from 1.

    • toBuilder

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

    • builder

      public static CreatePromptVersionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePromptVersionResponse.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)
      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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.