Class GetAdvancedPromptOptimizationJobResponse

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

Get Advanced Prompt Optimization Job Response

  • Method Details

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the advanced prompt optimization job.

      Returns:
      The Amazon Resource Name (ARN) of the advanced prompt optimization job.

    • jobName

      public final String jobName()

      The name of the advanced prompt optimization job.

      Returns:
      The name of the advanced prompt optimization job.

    • jobDescription

      public final String jobDescription()

      The description of the advanced prompt optimization job.

      Returns:
      The description of the advanced prompt optimization job.

    • jobStatus

      public final AdvancedPromptOptimizationJobStatus jobStatus()

      The status of the advanced prompt optimization job.

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

      Returns:
      The status of the advanced prompt optimization job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The status of the advanced prompt optimization job.

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

      Returns:
      The status of the advanced prompt optimization job.
      See Also:

    • inputConfig

      public final AdvancedPromptOptimizationInputConfig inputConfig()

      The input data configuration for the optimization job.

      Returns:
      The input data configuration for the optimization job.

    • outputConfig

      public final AdvancedPromptOptimizationOutputConfig outputConfig()

      The output data configuration for the optimization job.

      Returns:
      The output data configuration for the optimization job.

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data.

    • creationTime

      public final Instant creationTime()

      The time at which the advanced prompt optimization job was created.

      Returns:
      The time at which the advanced prompt optimization job was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time at which the advanced prompt optimization job was last modified.

      Returns:
      The time at which the advanced prompt optimization job was last modified.

    • failureMessage

      public final String failureMessage()

      If the job failed, a message describing the reason for the failure.

      Returns:
      If the job failed, a message describing the reason for the failure.

    • hasModelConfigurations

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

    • modelConfigurations

      public final List<ModelConfiguration> modelConfigurations()

      The model configurations used in the optimization job.

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

      Returns:
      The model configurations used in the optimization job.

    • toBuilder

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

    • builder

      public static GetAdvancedPromptOptimizationJobResponse.Builder builder()

    • serializableBuilderClass

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