Interface GetTrainedModelResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CleanRoomsMlResponse.Builder,CopyableBuilder<GetTrainedModelResponse.Builder,GetTrainedModelResponse>,SdkBuilder<GetTrainedModelResponse.Builder,GetTrainedModelResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- GetTrainedModelResponse
public static interface GetTrainedModelResponse.Builder extends CleanRoomsMlResponse.Builder, SdkPojo, CopyableBuilder<GetTrainedModelResponse.Builder,GetTrainedModelResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GetTrainedModelResponse.BuildercollaborationIdentifier(String collaborationIdentifier)The collaboration ID of the collaboration that contains the trained model.GetTrainedModelResponse.BuilderconfiguredModelAlgorithmAssociationArn(String configuredModelAlgorithmAssociationArn)The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.GetTrainedModelResponse.BuildercreateTime(Instant createTime)The time at which the trained model was created.GetTrainedModelResponse.BuilderdataChannels(Collection<ModelTrainingDataChannel> dataChannels)The data channels that were used for the trained model.GetTrainedModelResponse.BuilderdataChannels(Consumer<ModelTrainingDataChannel.Builder>... dataChannels)The data channels that were used for the trained model.GetTrainedModelResponse.BuilderdataChannels(ModelTrainingDataChannel... dataChannels)The data channels that were used for the trained model.GetTrainedModelResponse.Builderdescription(String description)The description of the trained model.GetTrainedModelResponse.Builderenvironment(Map<String,String> environment)The EC2 environment that was used to create the trained model.GetTrainedModelResponse.Builderhyperparameters(Map<String,String> hyperparameters)The hyperparameters that were used to create the trained model.GetTrainedModelResponse.BuilderkmsKeyArn(String kmsKeyArn)The Amazon Resource Name (ARN) of the KMS key.GetTrainedModelResponse.BuilderlogsStatus(String logsStatus)The logs status for the trained model.GetTrainedModelResponse.BuilderlogsStatus(LogsStatus logsStatus)The logs status for the trained model.GetTrainedModelResponse.BuilderlogsStatusDetails(String logsStatusDetails)Details about the logs status for the trained model.GetTrainedModelResponse.BuildermembershipIdentifier(String membershipIdentifier)The membership ID of the member that created the trained model.GetTrainedModelResponse.BuildermetricsStatus(String metricsStatus)The status of the model metrics.GetTrainedModelResponse.BuildermetricsStatus(MetricsStatus metricsStatus)The status of the model metrics.GetTrainedModelResponse.BuildermetricsStatusDetails(String metricsStatusDetails)Details about the metrics status for the trained model.GetTrainedModelResponse.Buildername(String name)The name of the trained model.default GetTrainedModelResponse.BuilderresourceConfig(Consumer<ResourceConfig.Builder> resourceConfig)The EC2 resource configuration that was used to create the trained model.GetTrainedModelResponse.BuilderresourceConfig(ResourceConfig resourceConfig)The EC2 resource configuration that was used to create the trained model.GetTrainedModelResponse.Builderstatus(String status)The status of the trained model.GetTrainedModelResponse.Builderstatus(TrainedModelStatus status)The status of the trained model.default GetTrainedModelResponse.BuilderstatusDetails(Consumer<StatusDetails.Builder> statusDetails)Sets the value of the StatusDetails property for this object.GetTrainedModelResponse.BuilderstatusDetails(StatusDetails statusDetails)Sets the value of the StatusDetails property for this object.default GetTrainedModelResponse.BuilderstoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)The stopping condition that was used to terminate model training.GetTrainedModelResponse.BuilderstoppingCondition(StoppingCondition stoppingCondition)The stopping condition that was used to terminate model training.GetTrainedModelResponse.Buildertags(Map<String,String> tags)The optional metadata that you applied to the resource to help you categorize and organize them.GetTrainedModelResponse.BuildertrainedModelArn(String trainedModelArn)The Amazon Resource Name (ARN) of the trained model.GetTrainedModelResponse.BuildertrainingContainerImageDigest(String trainingContainerImageDigest)Information about the training image container.GetTrainedModelResponse.BuilderupdateTime(Instant updateTime)The most recent time at which the trained model was updated.-
Methods inherited from interface software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse.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 Detail
-
membershipIdentifier
GetTrainedModelResponse.Builder membershipIdentifier(String membershipIdentifier)
The membership ID of the member that created the trained model.
- Parameters:
membershipIdentifier- The membership ID of the member that created the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
collaborationIdentifier
GetTrainedModelResponse.Builder collaborationIdentifier(String collaborationIdentifier)
The collaboration ID of the collaboration that contains the trained model.
- Parameters:
collaborationIdentifier- The collaboration ID of the collaboration that contains the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainedModelArn
GetTrainedModelResponse.Builder trainedModelArn(String trainedModelArn)
The Amazon Resource Name (ARN) of the trained model.
- Parameters:
trainedModelArn- The Amazon Resource Name (ARN) of the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
GetTrainedModelResponse.Builder name(String name)
The name of the trained model.
- Parameters:
name- The name of the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
GetTrainedModelResponse.Builder description(String description)
The description of the trained model.
- Parameters:
description- The description of the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
GetTrainedModelResponse.Builder status(String status)
The status of the trained model.
- Parameters:
status- The status of the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainedModelStatus,TrainedModelStatus
-
status
GetTrainedModelResponse.Builder status(TrainedModelStatus status)
The status of the trained model.
- Parameters:
status- The status of the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainedModelStatus,TrainedModelStatus
-
statusDetails
GetTrainedModelResponse.Builder statusDetails(StatusDetails statusDetails)
Sets the value of the StatusDetails property for this object.- Parameters:
statusDetails- The new value for the StatusDetails property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusDetails
default GetTrainedModelResponse.Builder statusDetails(Consumer<StatusDetails.Builder> statusDetails)
Sets the value of the StatusDetails property for this object. This is a convenience method that creates an instance of theStatusDetails.Builderavoiding the need to create one manually viaStatusDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tostatusDetails(StatusDetails).- Parameters:
statusDetails- a consumer that will call methods onStatusDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
statusDetails(StatusDetails)
-
configuredModelAlgorithmAssociationArn
GetTrainedModelResponse.Builder configuredModelAlgorithmAssociationArn(String configuredModelAlgorithmAssociationArn)
The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.
- Parameters:
configuredModelAlgorithmAssociationArn- The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceConfig
GetTrainedModelResponse.Builder resourceConfig(ResourceConfig resourceConfig)
The EC2 resource configuration that was used to create the trained model.
- Parameters:
resourceConfig- The EC2 resource configuration that was used to create the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceConfig
default GetTrainedModelResponse.Builder resourceConfig(Consumer<ResourceConfig.Builder> resourceConfig)
The EC2 resource configuration that was used to create the trained model.
This is a convenience method that creates an instance of theResourceConfig.Builderavoiding the need to create one manually viaResourceConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toresourceConfig(ResourceConfig).- Parameters:
resourceConfig- a consumer that will call methods onResourceConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
resourceConfig(ResourceConfig)
-
stoppingCondition
GetTrainedModelResponse.Builder stoppingCondition(StoppingCondition stoppingCondition)
The stopping condition that was used to terminate model training.
- Parameters:
stoppingCondition- The stopping condition that was used to terminate model training.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stoppingCondition
default GetTrainedModelResponse.Builder stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)
The stopping condition that was used to terminate model training.
This is a convenience method that creates an instance of theStoppingCondition.Builderavoiding the need to create one manually viaStoppingCondition.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tostoppingCondition(StoppingCondition).- Parameters:
stoppingCondition- a consumer that will call methods onStoppingCondition.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
stoppingCondition(StoppingCondition)
-
metricsStatus
GetTrainedModelResponse.Builder metricsStatus(String metricsStatus)
The status of the model metrics.
- Parameters:
metricsStatus- The status of the model metrics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
MetricsStatus,MetricsStatus
-
metricsStatus
GetTrainedModelResponse.Builder metricsStatus(MetricsStatus metricsStatus)
The status of the model metrics.
- Parameters:
metricsStatus- The status of the model metrics.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
MetricsStatus,MetricsStatus
-
metricsStatusDetails
GetTrainedModelResponse.Builder metricsStatusDetails(String metricsStatusDetails)
Details about the metrics status for the trained model.
- Parameters:
metricsStatusDetails- Details about the metrics status for the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logsStatus
GetTrainedModelResponse.Builder logsStatus(String logsStatus)
The logs status for the trained model.
- Parameters:
logsStatus- The logs status for the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
LogsStatus,LogsStatus
-
logsStatus
GetTrainedModelResponse.Builder logsStatus(LogsStatus logsStatus)
The logs status for the trained model.
- Parameters:
logsStatus- The logs status for the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
LogsStatus,LogsStatus
-
logsStatusDetails
GetTrainedModelResponse.Builder logsStatusDetails(String logsStatusDetails)
Details about the logs status for the trained model.
- Parameters:
logsStatusDetails- Details about the logs status for the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingContainerImageDigest
GetTrainedModelResponse.Builder trainingContainerImageDigest(String trainingContainerImageDigest)
Information about the training image container.
- Parameters:
trainingContainerImageDigest- Information about the training image container.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTime
GetTrainedModelResponse.Builder createTime(Instant createTime)
The time at which the trained model was created.
- Parameters:
createTime- The time at which the trained model was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updateTime
GetTrainedModelResponse.Builder updateTime(Instant updateTime)
The most recent time at which the trained model was updated.
- Parameters:
updateTime- The most recent time at which the trained model was updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hyperparameters
GetTrainedModelResponse.Builder hyperparameters(Map<String,String> hyperparameters)
The hyperparameters that were used to create the trained model.
- Parameters:
hyperparameters- The hyperparameters that were used to create the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environment
GetTrainedModelResponse.Builder environment(Map<String,String> environment)
The EC2 environment that was used to create the trained model.
- Parameters:
environment- The EC2 environment that was used to create the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyArn
GetTrainedModelResponse.Builder kmsKeyArn(String kmsKeyArn)
The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.
- Parameters:
kmsKeyArn- The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
GetTrainedModelResponse.Builder tags(Map<String,String> tags)
The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50.
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8.
-
Maximum value length - 256 Unicode characters in UTF-8.
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case sensitive.
-
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
- Parameters:
tags- The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50.
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8.
-
Maximum value length - 256 Unicode characters in UTF-8.
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case sensitive.
-
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dataChannels
GetTrainedModelResponse.Builder dataChannels(Collection<ModelTrainingDataChannel> dataChannels)
The data channels that were used for the trained model.
- Parameters:
dataChannels- The data channels that were used for the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataChannels
GetTrainedModelResponse.Builder dataChannels(ModelTrainingDataChannel... dataChannels)
The data channels that were used for the trained model.
- Parameters:
dataChannels- The data channels that were used for the trained model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataChannels
GetTrainedModelResponse.Builder dataChannels(Consumer<ModelTrainingDataChannel.Builder>... dataChannels)
The data channels that were used for the trained model.
This is a convenience method that creates an instance of theModelTrainingDataChannel.Builderavoiding the need to create one manually viaModelTrainingDataChannel.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#dataChannels(List.) - Parameters:
dataChannels- a consumer that will call methods onModelTrainingDataChannel.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#dataChannels(java.util.Collection)
-
-