CreateEvaluationJobRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.bedrock.model

Class CreateEvaluationJobRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.bedrock.model.CreateEvaluationJobRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEvaluationJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateEvaluationJobRequest ()

Constructors
Constructor and Description
`CreateEvaluationJobRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateEvaluationJobRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getClientRequestToken ()` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`String`	`getCustomerEncryptionKeyId ()` Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
`EvaluationConfig`	`getEvaluationConfig ()` Specifies whether the model evaluation job is automatic or uses human worker.
`EvaluationInferenceConfig`	`getInferenceConfig ()` Specify the models you want to use in your model evaluation job.
`String`	`getJobDescription ()` A description of the model evaluation job.
`String`	`getJobName ()` The name of the model evaluation job.
`List<Tag>`	`getJobTags ()` Tags to attach to the model evaluation job.
`EvaluationOutputDataConfig`	`getOutputDataConfig ()` An object that defines where the results of model evaluation job will be saved in Amazon S3.
`String`	`getRoleArn ()` The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.
`int`	`hashCode ()`
`void`	`setClientRequestToken (String clientRequestToken)` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`void`	`setCustomerEncryptionKeyId (String customerEncryptionKeyId)` Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
`void`	`setEvaluationConfig (EvaluationConfig evaluationConfig)` Specifies whether the model evaluation job is automatic or uses human worker.
`void`	`setInferenceConfig (EvaluationInferenceConfig inferenceConfig)` Specify the models you want to use in your model evaluation job.
`void`	`setJobDescription (String jobDescription)` A description of the model evaluation job.
`void`	`setJobName (String jobName)` The name of the model evaluation job.
`void`	`setJobTags (Collection<Tag> jobTags)` Tags to attach to the model evaluation job.
`void`	`setOutputDataConfig (EvaluationOutputDataConfig outputDataConfig)` An object that defines where the results of model evaluation job will be saved in Amazon S3.
`void`	`setRoleArn (String roleArn)` The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.
`String`	`toString ()` Returns a string representation of this object.
`CreateEvaluationJobRequest`	`withClientRequestToken (String clientRequestToken)` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`CreateEvaluationJobRequest`	`withCustomerEncryptionKeyId (String customerEncryptionKeyId)` Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
`CreateEvaluationJobRequest`	`withEvaluationConfig (EvaluationConfig evaluationConfig)` Specifies whether the model evaluation job is automatic or uses human worker.
`CreateEvaluationJobRequest`	`withInferenceConfig (EvaluationInferenceConfig inferenceConfig)` Specify the models you want to use in your model evaluation job.
`CreateEvaluationJobRequest`	`withJobDescription (String jobDescription)` A description of the model evaluation job.
`CreateEvaluationJobRequest`	`withJobName (String jobName)` The name of the model evaluation job.
`CreateEvaluationJobRequest`	`withJobTags (Collection<Tag> jobTags)` Tags to attach to the model evaluation job.
`CreateEvaluationJobRequest`	`withJobTags (Tag... jobTags)` Tags to attach to the model evaluation job.
`CreateEvaluationJobRequest`	`withOutputDataConfig (EvaluationOutputDataConfig outputDataConfig)` An object that defines where the results of model evaluation job will be saved in Amazon S3.
`CreateEvaluationJobRequest`	`withRoleArn (String roleArn)` The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateEvaluationJobRequest
```
public CreateEvaluationJobRequest()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
    
    Parameters:
    
    jobName - The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
  - getJobName
```
public String getJobName()
```
    The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
    
    Returns:
    
    The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
  - withJobName
```
public CreateEvaluationJobRequest withJobName(String jobName)
```
    The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
    
    Parameters:
    
    jobName - The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobDescription
```
public void setJobDescription(String jobDescription)
```
    A description of the model evaluation job.
    
    Parameters:
    
    jobDescription - A description of the model evaluation job.
  - getJobDescription
```
public String getJobDescription()
```
    A description of the model evaluation job.
    
    Returns:
    
    A description of the model evaluation job.
  - withJobDescription
```
public CreateEvaluationJobRequest withJobDescription(String jobDescription)
```
    A description of the model evaluation job.
    
    Parameters:
    
    jobDescription - A description of the model evaluation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientRequestToken
```
public void setClientRequestToken(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.
    
    Parameters:
    
    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.
  - getClientRequestToken
```
public String getClientRequestToken()
```
    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.
  - withClientRequestToken
```
public CreateEvaluationJobRequest withClientRequestToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
  - withRoleArn
```
public CreateEvaluationJobRequest withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerEncryptionKeyId
```
public void setCustomerEncryptionKeyId(String customerEncryptionKeyId)
```
    Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
    
    Parameters:
    
    customerEncryptionKeyId - Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
  - getCustomerEncryptionKeyId
```
public String getCustomerEncryptionKeyId()
```
    Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
    
    Returns:
    
    Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
  - withCustomerEncryptionKeyId
```
public CreateEvaluationJobRequest withCustomerEncryptionKeyId(String customerEncryptionKeyId)
```
    Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
    
    Parameters:
    
    customerEncryptionKeyId - Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getJobTags
```
public List<Tag> getJobTags()
```
    Tags to attach to the model evaluation job.
    
    Returns:
    
    Tags to attach to the model evaluation job.
  - setJobTags
```
public void setJobTags(Collection<Tag> jobTags)
```
    Tags to attach to the model evaluation job.
    
    Parameters:
    
    jobTags - Tags to attach to the model evaluation job.
  - withJobTags
```
public CreateEvaluationJobRequest withJobTags(Tag... jobTags)
```
    Tags to attach to the model evaluation job.
    
    NOTE: This method appends the values to the existing list (if any). Use setJobTags(java.util.Collection) or withJobTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    jobTags - Tags to attach to the model evaluation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withJobTags
```
public CreateEvaluationJobRequest withJobTags(Collection<Tag> jobTags)
```
    Tags to attach to the model evaluation job.
    
    Parameters:
    
    jobTags - Tags to attach to the model evaluation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEvaluationConfig
```
public void setEvaluationConfig(EvaluationConfig evaluationConfig)
```
    Specifies whether the model evaluation job is automatic or uses human worker.
    
    Parameters:
    
    evaluationConfig - Specifies whether the model evaluation job is automatic or uses human worker.
  - getEvaluationConfig
```
public EvaluationConfig getEvaluationConfig()
```
    Specifies whether the model evaluation job is automatic or uses human worker.
    
    Returns:
    
    Specifies whether the model evaluation job is automatic or uses human worker.
  - withEvaluationConfig
```
public CreateEvaluationJobRequest withEvaluationConfig(EvaluationConfig evaluationConfig)
```
    Specifies whether the model evaluation job is automatic or uses human worker.
    
    Parameters:
    
    evaluationConfig - Specifies whether the model evaluation job is automatic or uses human worker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInferenceConfig
```
public void setInferenceConfig(EvaluationInferenceConfig inferenceConfig)
```
    Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
    
    Parameters:
    
    inferenceConfig - Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
  - getInferenceConfig
```
public EvaluationInferenceConfig getInferenceConfig()
```
    Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
    
    Returns:
    
    Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
  - withInferenceConfig
```
public CreateEvaluationJobRequest withInferenceConfig(EvaluationInferenceConfig inferenceConfig)
```
    Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
    
    Parameters:
    
    inferenceConfig - Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputDataConfig
```
public void setOutputDataConfig(EvaluationOutputDataConfig outputDataConfig)
```
    An object that defines where the results of model evaluation job will be saved in Amazon S3.
    
    Parameters:
    
    outputDataConfig - An object that defines where the results of model evaluation job will be saved in Amazon S3.
  - getOutputDataConfig
```
public EvaluationOutputDataConfig getOutputDataConfig()
```
    An object that defines where the results of model evaluation job will be saved in Amazon S3.
    
    Returns:
    
    An object that defines where the results of model evaluation job will be saved in Amazon S3.
  - withOutputDataConfig
```
public CreateEvaluationJobRequest withOutputDataConfig(EvaluationOutputDataConfig outputDataConfig)
```
    An object that defines where the results of model evaluation job will be saved in Amazon S3.
    
    Parameters:
    
    outputDataConfig - An object that defines where the results of model evaluation job will be saved in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateEvaluationJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreateEvaluationJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateEvaluationJobRequest

Method Detail

setJobName

getJobName

withJobName

setJobDescription

getJobDescription

withJobDescription

setClientRequestToken

getClientRequestToken

withClientRequestToken

setRoleArn

getRoleArn

withRoleArn

setCustomerEncryptionKeyId

getCustomerEncryptionKeyId

withCustomerEncryptionKeyId

getJobTags

setJobTags

withJobTags

withJobTags

setEvaluationConfig

getEvaluationConfig

withEvaluationConfig

setInferenceConfig

getInferenceConfig

withInferenceConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

toString

equals

hashCode

clone