Interface CreateOnlineEvaluationConfigRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<CreateOnlineEvaluationConfigRequest.Builder,CreateOnlineEvaluationConfigRequest>, SdkBuilder<CreateOnlineEvaluationConfigRequest.Builder,CreateOnlineEvaluationConfigRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateOnlineEvaluationConfigRequest

@Mutable
@NotThreadSafe
public static interface CreateOnlineEvaluationConfigRequest.Builder
extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<CreateOnlineEvaluationConfigRequest.Builder,CreateOnlineEvaluationConfigRequest>

Method Summary

Modifier and Type	Method	Description
CreateOnlineEvaluationConfigRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
default CreateOnlineEvaluationConfigRequest.Builder	clusteringConfig(Consumer<ClusteringConfig.Builder> clusteringConfig)	Configuration for periodic batch evaluation clustering of insight results.
CreateOnlineEvaluationConfigRequest.Builder	clusteringConfig(ClusteringConfig clusteringConfig)	Configuration for periodic batch evaluation clustering of insight results.
default CreateOnlineEvaluationConfigRequest.Builder	dataSourceConfig(Consumer<DataSourceConfig.Builder> dataSourceConfig)	The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.
CreateOnlineEvaluationConfigRequest.Builder	dataSourceConfig(DataSourceConfig dataSourceConfig)	The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.
CreateOnlineEvaluationConfigRequest.Builder	description(String description)	The description of the online evaluation configuration that explains its monitoring purpose and scope.
CreateOnlineEvaluationConfigRequest.Builder	enableOnCreate(Boolean enableOnCreate)	Whether to enable the online evaluation configuration immediately upon creation.
CreateOnlineEvaluationConfigRequest.Builder	evaluationExecutionRoleArn(String evaluationExecutionRoleArn)	The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation.
CreateOnlineEvaluationConfigRequest.Builder	evaluators(Collection<EvaluatorReference> evaluators)	The list of evaluators to apply during online evaluation.
CreateOnlineEvaluationConfigRequest.Builder	evaluators(Consumer<EvaluatorReference.Builder>... evaluators)	The list of evaluators to apply during online evaluation.
CreateOnlineEvaluationConfigRequest.Builder	evaluators(EvaluatorReference... evaluators)	The list of evaluators to apply during online evaluation.
CreateOnlineEvaluationConfigRequest.Builder	insights(Collection<Insight> insights)	The list of insight types to run against agent sessions.
CreateOnlineEvaluationConfigRequest.Builder	insights(Consumer<Insight.Builder>... insights)	The list of insight types to run against agent sessions.
CreateOnlineEvaluationConfigRequest.Builder	insights(Insight... insights)	The list of insight types to run against agent sessions.
CreateOnlineEvaluationConfigRequest.Builder	onlineEvaluationConfigName(String onlineEvaluationConfigName)	The name of the online evaluation configuration.
default CreateOnlineEvaluationConfigRequest.Builder	outputConfig(Consumer<OutputConfig.Builder> outputConfig)	Sets the value of the OutputConfig property for this object.
CreateOnlineEvaluationConfigRequest.Builder	outputConfig(OutputConfig outputConfig)	Sets the value of the OutputConfig property for this object.
CreateOnlineEvaluationConfigRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateOnlineEvaluationConfigRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateOnlineEvaluationConfigRequest.Builder	rule(Consumer<Rule.Builder> rule)	The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.
CreateOnlineEvaluationConfigRequest.Builder	rule(Rule rule)	The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.
CreateOnlineEvaluationConfigRequest.Builder	tags(Map<String,String> tags)	A map of tag keys and values to assign to an AgentCore Online Evaluation Config.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

CreateOnlineEvaluationConfigRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

Returns:

Returns a reference to this object so that method calls can be chained together.

onlineEvaluationConfigName

CreateOnlineEvaluationConfigRequest.Builder onlineEvaluationConfigName(String onlineEvaluationConfigName)

The name of the online evaluation configuration. Must be unique within your account.

Parameters:

onlineEvaluationConfigName - The name of the online evaluation configuration. Must be unique within your account.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateOnlineEvaluationConfigRequest.Builder description(String description)

The description of the online evaluation configuration that explains its monitoring purpose and scope.

Parameters:

description - The description of the online evaluation configuration that explains its monitoring purpose and scope.

Returns:

Returns a reference to this object so that method calls can be chained together.

rule

CreateOnlineEvaluationConfigRequest.Builder rule(Rule rule)

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

Parameters:

rule - The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

Returns:

Returns a reference to this object so that method calls can be chained together.

rule

default CreateOnlineEvaluationConfigRequest.Builder rule(Consumer<Rule.Builder> rule)

The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.

This is a convenience method that creates an instance of the Rule.Builder avoiding the need to create one manually via Rule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rule(Rule).

Parameters:

rule - a consumer that will call methods on Rule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• rule(Rule)

dataSourceConfig

CreateOnlineEvaluationConfigRequest.Builder dataSourceConfig(DataSourceConfig dataSourceConfig)

The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

Parameters:

dataSourceConfig - The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataSourceConfig

default CreateOnlineEvaluationConfigRequest.Builder dataSourceConfig(Consumer<DataSourceConfig.Builder> dataSourceConfig)

The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.

This is a convenience method that creates an instance of the DataSourceConfig.Builder avoiding the need to create one manually via DataSourceConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSourceConfig(DataSourceConfig).

Parameters:

dataSourceConfig - a consumer that will call methods on DataSourceConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dataSourceConfig(DataSourceConfig)

evaluators

CreateOnlineEvaluationConfigRequest.Builder evaluators(Collection<EvaluatorReference> evaluators)

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

Parameters:

evaluators - The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluators

CreateOnlineEvaluationConfigRequest.Builder evaluators(EvaluatorReference... evaluators)

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

Parameters:

evaluators - The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

Returns:

Returns a reference to this object so that method calls can be chained together.

evaluators

CreateOnlineEvaluationConfigRequest.Builder evaluators(Consumer<EvaluatorReference.Builder>... evaluators)

The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.

This is a convenience method that creates an instance of the EvaluatorReference.Builder avoiding the need to create one manually via EvaluatorReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to evaluators(List<EvaluatorReference>).

Parameters:

evaluators - a consumer that will call methods on EvaluatorReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• evaluators(java.util.Collection<EvaluatorReference>)

insights

CreateOnlineEvaluationConfigRequest.Builder insights(Collection<Insight> insights)

The list of insight types to run against agent sessions.

Parameters:

insights - The list of insight types to run against agent sessions.

Returns:

Returns a reference to this object so that method calls can be chained together.

insights

CreateOnlineEvaluationConfigRequest.Builder insights(Insight... insights)

The list of insight types to run against agent sessions.

Parameters:

insights - The list of insight types to run against agent sessions.

Returns:

Returns a reference to this object so that method calls can be chained together.

insights

CreateOnlineEvaluationConfigRequest.Builder insights(Consumer<Insight.Builder>... insights)

The list of insight types to run against agent sessions.

This is a convenience method that creates an instance of the Insight.Builder avoiding the need to create one manually via Insight.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to insights(List<Insight>).

Parameters:

insights - a consumer that will call methods on Insight.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• insights(java.util.Collection<Insight>)

clusteringConfig

CreateOnlineEvaluationConfigRequest.Builder clusteringConfig(ClusteringConfig clusteringConfig)

Configuration for periodic batch evaluation clustering of insight results.

Parameters:

clusteringConfig - Configuration for periodic batch evaluation clustering of insight results.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusteringConfig

default CreateOnlineEvaluationConfigRequest.Builder clusteringConfig(Consumer<ClusteringConfig.Builder> clusteringConfig)

Configuration for periodic batch evaluation clustering of insight results.

This is a convenience method that creates an instance of the ClusteringConfig.Builder avoiding the need to create one manually via ClusteringConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusteringConfig(ClusteringConfig).

Parameters:

clusteringConfig - a consumer that will call methods on ClusteringConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• clusteringConfig(ClusteringConfig)

outputConfig

CreateOnlineEvaluationConfigRequest.Builder outputConfig(OutputConfig outputConfig)

Sets the value of the OutputConfig property for this object.

Parameters:

outputConfig - The new value for the OutputConfig property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputConfig

default CreateOnlineEvaluationConfigRequest.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

Sets the value of the OutputConfig property for this object. This is a convenience method that creates an instance of the OutputConfig.Builder avoiding the need to create one manually via OutputConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(OutputConfig).

Parameters:

outputConfig - a consumer that will call methods on OutputConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• outputConfig(OutputConfig)

evaluationExecutionRoleArn

CreateOnlineEvaluationConfigRequest.Builder evaluationExecutionRoleArn(String evaluationExecutionRoleArn)

The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.

Parameters:

evaluationExecutionRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableOnCreate

CreateOnlineEvaluationConfigRequest.Builder enableOnCreate(Boolean enableOnCreate)

Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

Parameters:

enableOnCreate - Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateOnlineEvaluationConfigRequest.Builder tags(Map<String,String> tags)

A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Parameters:

tags - A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateOnlineEvaluationConfigRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateOnlineEvaluationConfigRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.