Class GetEvaluationJobResponse

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

  • Method Details

    • jobName

      public final String jobName()

      The name for the evaluation job.

      Returns:
      The name for the evaluation job.

    • status

      public final EvaluationJobStatus status()

      The current status of the evaluation job.

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

      Returns:
      The current status of the evaluation job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the evaluation job.

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

      Returns:
      The current status of the evaluation job.
      See Also:

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the evaluation job.

      Returns:
      The Amazon Resource Name (ARN) of the evaluation job.

    • jobDescription

      public final String jobDescription()

      The description of the evaluation job.

      Returns:
      The description of the evaluation job.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.

      Returns:
      The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.

    • customerEncryptionKeyId

      public final String customerEncryptionKeyId()

      The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.

      Returns:
      The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.

    • jobType

      public final EvaluationJobType jobType()

      Specifies whether the evaluation job is automated or human-based.

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

      Returns:
      Specifies whether the evaluation job is automated or human-based.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      Specifies whether the evaluation job is automated or human-based.

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

      Returns:
      Specifies whether the evaluation job is automated or human-based.
      See Also:

    • applicationType

      public final ApplicationType applicationType()

      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

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

      Returns:
      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
      See Also:

    • applicationTypeAsString

      public final String applicationTypeAsString()

      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

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

      Returns:
      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
      See Also:

    • evaluationConfig

      public final EvaluationConfig evaluationConfig()

      Contains the configuration details of either an automated or human-based evaluation job.

      Returns:
      Contains the configuration details of either an automated or human-based evaluation job.

    • inferenceConfig

      public final EvaluationInferenceConfig inferenceConfig()

      Contains the configuration details of the inference model used for the evaluation job.

      Returns:
      Contains the configuration details of the inference model used for the evaluation job.

    • outputDataConfig

      public final EvaluationOutputDataConfig outputDataConfig()

      Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

      Returns:
      Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

    • creationTime

      public final Instant creationTime()

      The time the evaluation job was created.

      Returns:
      The time the evaluation job was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time the evaluation job was last modified.

      Returns:
      The time the evaluation job was last modified.

    • hasFailureMessages

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

    • failureMessages

      public final List<String> failureMessages()

      A list of strings that specify why the evaluation job failed to create.

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

      Returns:
      A list of strings that specify why the evaluation job failed to create.

    • toBuilder

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

    • builder

      public static GetEvaluationJobResponse.Builder builder()

    • serializableBuilderClass

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