Interface GetEvaluatorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<GetEvaluatorRequest.Builder,GetEvaluatorRequest>, SdkBuilder<GetEvaluatorRequest.Builder,GetEvaluatorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetEvaluatorRequest
@Mutable @NotThreadSafe public static interface GetEvaluatorRequest.Builder extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<GetEvaluatorRequest.Builder,GetEvaluatorRequest>

  • Method Details

    • evaluatorId

      GetEvaluatorRequest.Builder evaluatorId(String evaluatorId)

      The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.

      Parameters:
      evaluatorId - The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includedData

      GetEvaluatorRequest.Builder includedData(String includedData)

      Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.

      Parameters:
      includedData - Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includedData

      GetEvaluatorRequest.Builder includedData(IncludedData includedData)

      Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.

      Parameters:
      includedData - Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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