Interface GetCustomModelResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockResponse.Builder, Buildable, CopyableBuilder<GetCustomModelResponse.Builder,GetCustomModelResponse>, SdkBuilder<GetCustomModelResponse.Builder,GetCustomModelResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetCustomModelResponse

@Mutable
@NotThreadSafe
public static interface GetCustomModelResponse.Builder
extends BedrockResponse.Builder, SdkPojo, CopyableBuilder<GetCustomModelResponse.Builder,GetCustomModelResponse>

Method Summary

Modifier and Type	Method	Description
GetCustomModelResponse.Builder	baseModelArn(String baseModelArn)	Amazon Resource Name (ARN) of the base model.
GetCustomModelResponse.Builder	creationTime(Instant creationTime)	Creation time of the model.
default GetCustomModelResponse.Builder	customizationConfig(Consumer<CustomizationConfig.Builder> customizationConfig)	The customization configuration for the custom model.
GetCustomModelResponse.Builder	customizationConfig(CustomizationConfig customizationConfig)	The customization configuration for the custom model.
GetCustomModelResponse.Builder	customizationType(String customizationType)	The type of model customization.
GetCustomModelResponse.Builder	customizationType(CustomizationType customizationType)	The type of model customization.
GetCustomModelResponse.Builder	failureMessage(String failureMessage)	A failure message for any issues that occurred when creating the custom model.
GetCustomModelResponse.Builder	hyperParameters(Map<String,String> hyperParameters)	Hyperparameter values associated with this model.
GetCustomModelResponse.Builder	jobArn(String jobArn)	Job Amazon Resource Name (ARN) associated with this model.
GetCustomModelResponse.Builder	jobName(String jobName)	Job name associated with this model.
GetCustomModelResponse.Builder	modelArn(String modelArn)	Amazon Resource Name (ARN) associated with this model.
GetCustomModelResponse.Builder	modelKmsKeyArn(String modelKmsKeyArn)	The custom model is encrypted at rest using this key.
GetCustomModelResponse.Builder	modelName(String modelName)	Model name associated with this model.
GetCustomModelResponse.Builder	modelStatus(String modelStatus)	The current status of the custom model.
GetCustomModelResponse.Builder	modelStatus(ModelStatus modelStatus)	The current status of the custom model.
default GetCustomModelResponse.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)	Output data configuration associated with this custom model.
GetCustomModelResponse.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Output data configuration associated with this custom model.
default GetCustomModelResponse.Builder	trainingDataConfig(Consumer<TrainingDataConfig.Builder> trainingDataConfig)	Contains information about the training dataset.
GetCustomModelResponse.Builder	trainingDataConfig(TrainingDataConfig trainingDataConfig)	Contains information about the training dataset.
default GetCustomModelResponse.Builder	trainingMetrics(Consumer<TrainingMetrics.Builder> trainingMetrics)	Contains training metrics from the job creation.
GetCustomModelResponse.Builder	trainingMetrics(TrainingMetrics trainingMetrics)	Contains training metrics from the job creation.
default GetCustomModelResponse.Builder	validationDataConfig(Consumer<ValidationDataConfig.Builder> validationDataConfig)	Contains information about the validation dataset.
GetCustomModelResponse.Builder	validationDataConfig(ValidationDataConfig validationDataConfig)	Contains information about the validation dataset.
GetCustomModelResponse.Builder	validationMetrics(Collection<ValidatorMetric> validationMetrics)	The validation metrics from the job creation.
GetCustomModelResponse.Builder	validationMetrics(Consumer<ValidatorMetric.Builder>... validationMetrics)	The validation metrics from the job creation.
GetCustomModelResponse.Builder	validationMetrics(ValidatorMetric... validationMetrics)	The validation metrics from the job creation.

Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockResponse.Builder

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

modelArn

GetCustomModelResponse.Builder modelArn(String modelArn)

Amazon Resource Name (ARN) associated with this model.

Parameters:

modelArn - Amazon Resource Name (ARN) associated with this model.

Returns:

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

modelName

GetCustomModelResponse.Builder modelName(String modelName)

Model name associated with this model.

Parameters:

modelName - Model name associated with this model.

Returns:

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

jobName

GetCustomModelResponse.Builder jobName(String jobName)

Job name associated with this model.

Parameters:

jobName - Job name associated with this model.

Returns:

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

jobArn

GetCustomModelResponse.Builder jobArn(String jobArn)

Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is NULL.

Parameters:

jobArn - Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is NULL.

Returns:

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

baseModelArn

GetCustomModelResponse.Builder baseModelArn(String baseModelArn)

Amazon Resource Name (ARN) of the base model.

Parameters:

baseModelArn - Amazon Resource Name (ARN) of the base model.

Returns:

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

customizationType

GetCustomModelResponse.Builder customizationType(String customizationType)

The type of model customization.

Parameters:

customizationType - The type of model customization.

Returns:

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

See Also:

• CustomizationType
• CustomizationType

customizationType

GetCustomModelResponse.Builder customizationType(CustomizationType customizationType)

The type of model customization.

Parameters:

customizationType - The type of model customization.

Returns:

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

See Also:

• CustomizationType
• CustomizationType

modelKmsKeyArn

GetCustomModelResponse.Builder modelKmsKeyArn(String modelKmsKeyArn)

The custom model is encrypted at rest using this key.

Parameters:

modelKmsKeyArn - The custom model is encrypted at rest using this key.

Returns:

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

hyperParameters

GetCustomModelResponse.Builder hyperParameters(Map<String,String> hyperParameters)

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

Parameters:

hyperParameters - Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

Returns:

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

trainingDataConfig

GetCustomModelResponse.Builder trainingDataConfig(TrainingDataConfig trainingDataConfig)

Contains information about the training dataset.

Parameters:

trainingDataConfig - Contains information about the training dataset.

Returns:

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

trainingDataConfig

default GetCustomModelResponse.Builder trainingDataConfig(Consumer<TrainingDataConfig.Builder> trainingDataConfig)

Contains information about the training dataset.

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

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

Parameters:

trainingDataConfig - a consumer that will call methods on TrainingDataConfig.Builder

Returns:

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

See Also:

• trainingDataConfig(TrainingDataConfig)

validationDataConfig

GetCustomModelResponse.Builder validationDataConfig(ValidationDataConfig validationDataConfig)

Contains information about the validation dataset.

Parameters:

validationDataConfig - Contains information about the validation dataset.

Returns:

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

validationDataConfig

default GetCustomModelResponse.Builder validationDataConfig(Consumer<ValidationDataConfig.Builder> validationDataConfig)

Contains information about the validation dataset.

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

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

Parameters:

validationDataConfig - a consumer that will call methods on ValidationDataConfig.Builder

Returns:

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

See Also:

• validationDataConfig(ValidationDataConfig)

outputDataConfig

GetCustomModelResponse.Builder outputDataConfig(OutputDataConfig outputDataConfig)

Output data configuration associated with this custom model.

Parameters:

outputDataConfig - Output data configuration associated with this custom model.

Returns:

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

outputDataConfig

default GetCustomModelResponse.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

Output data configuration associated with this custom model.

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

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

Parameters:

outputDataConfig - a consumer that will call methods on OutputDataConfig.Builder

Returns:

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

See Also:

• outputDataConfig(OutputDataConfig)

trainingMetrics

GetCustomModelResponse.Builder trainingMetrics(TrainingMetrics trainingMetrics)

Contains training metrics from the job creation.

Parameters:

trainingMetrics - Contains training metrics from the job creation.

Returns:

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

trainingMetrics

default GetCustomModelResponse.Builder trainingMetrics(Consumer<TrainingMetrics.Builder> trainingMetrics)

Contains training metrics from the job creation.

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

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

Parameters:

trainingMetrics - a consumer that will call methods on TrainingMetrics.Builder

Returns:

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

See Also:

• trainingMetrics(TrainingMetrics)

validationMetrics

GetCustomModelResponse.Builder validationMetrics(Collection<ValidatorMetric> validationMetrics)

The validation metrics from the job creation.

Parameters:

validationMetrics - The validation metrics from the job creation.

Returns:

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

validationMetrics

GetCustomModelResponse.Builder validationMetrics(ValidatorMetric... validationMetrics)

The validation metrics from the job creation.

Parameters:

validationMetrics - The validation metrics from the job creation.

Returns:

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

validationMetrics

GetCustomModelResponse.Builder validationMetrics(Consumer<ValidatorMetric.Builder>... validationMetrics)

The validation metrics from the job creation.

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

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

Parameters:

validationMetrics - a consumer that will call methods on ValidatorMetric.Builder

Returns:

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

See Also:

• validationMetrics(java.util.Collection<ValidatorMetric>)

creationTime

GetCustomModelResponse.Builder creationTime(Instant creationTime)

Creation time of the model.

Parameters:

creationTime - Creation time of the model.

Returns:

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

customizationConfig

GetCustomModelResponse.Builder customizationConfig(CustomizationConfig customizationConfig)

The customization configuration for the custom model.

Parameters:

customizationConfig - The customization configuration for the custom model.

Returns:

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

customizationConfig

default GetCustomModelResponse.Builder customizationConfig(Consumer<CustomizationConfig.Builder> customizationConfig)

The customization configuration for the custom model.

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

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

Parameters:

customizationConfig - a consumer that will call methods on CustomizationConfig.Builder

Returns:

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

See Also:

• customizationConfig(CustomizationConfig)

modelStatus

GetCustomModelResponse.Builder modelStatus(String modelStatus)

The current status of the custom model. Possible values include:

• Creating - The model is being created and validated.

• Active - The model has been successfully created and is ready for use.

• Failed - The model creation process failed. Check the failureMessage field for details.

Parameters:

modelStatus - The current status of the custom model. Possible values include:

• Creating - The model is being created and validated.

• Active - The model has been successfully created and is ready for use.

• Failed - The model creation process failed. Check the failureMessage field for details.

Returns:

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

See Also:

• ModelStatus
• ModelStatus

modelStatus

GetCustomModelResponse.Builder modelStatus(ModelStatus modelStatus)

The current status of the custom model. Possible values include:

• Creating - The model is being created and validated.

• Active - The model has been successfully created and is ready for use.

• Failed - The model creation process failed. Check the failureMessage field for details.

Parameters:

modelStatus - The current status of the custom model. Possible values include:

• Creating - The model is being created and validated.

• Active - The model has been successfully created and is ready for use.

• Failed - The model creation process failed. Check the failureMessage field for details.

Returns:

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

See Also:

• ModelStatus
• ModelStatus

failureMessage

GetCustomModelResponse.Builder failureMessage(String failureMessage)

A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.

Parameters:

failureMessage - A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.

Returns:

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