Class CreateEvaluationJobRequest

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

  • Method Details

    • jobName

      public final String jobName()

      A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

      Returns:
      A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

    • jobDescription

      public final String jobDescription()

      A description of the evaluation job.

      Returns:
      A description of the evaluation job.

    • clientRequestToken

      public final String clientRequestToken()

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      Returns:
      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

      Returns:
      The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

    • customerEncryptionKeyId

      public final String customerEncryptionKeyId()

      Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

      Returns:
      Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

    • hasJobTags

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

    • jobTags

      public final List<Tag> jobTags()

      Tags to attach to the model evaluation 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 hasJobTags() method.

      Returns:
      Tags to attach to the model evaluation job.

    • 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 for the evaluation job.

      For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

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

      For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

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

    • toBuilder

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

    • builder

      public static CreateEvaluationJobRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.