Interface GetTrainedModelResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CleanRoomsMlResponse.Builder, CopyableBuilder<GetTrainedModelResponse.Builder,GetTrainedModelResponse>, SdkBuilder<GetTrainedModelResponse.Builder,GetTrainedModelResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetTrainedModelResponse
@Mutable @NotThreadSafe public static interface GetTrainedModelResponse.Builder extends CleanRoomsMlResponse.Builder, SdkPojo, CopyableBuilder<GetTrainedModelResponse.Builder,GetTrainedModelResponse>

  • Method Details

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

    • versionIdentifier

      GetTrainedModelResponse.Builder versionIdentifier(String versionIdentifier)

      The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.

      Parameters:
      versionIdentifier - The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • incrementalTrainingDataChannels

      GetTrainedModelResponse.Builder incrementalTrainingDataChannels(Collection<IncrementalTrainingDataChannelOutput> incrementalTrainingDataChannels)

      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

      Parameters:
      incrementalTrainingDataChannels - Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • incrementalTrainingDataChannels

      GetTrainedModelResponse.Builder incrementalTrainingDataChannels(IncrementalTrainingDataChannelOutput... incrementalTrainingDataChannels)

      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

      Parameters:
      incrementalTrainingDataChannels - Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • incrementalTrainingDataChannels

      GetTrainedModelResponse.Builder incrementalTrainingDataChannels(Consumer<IncrementalTrainingDataChannelOutput.Builder>... incrementalTrainingDataChannels)

      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

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

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

      Parameters:
      incrementalTrainingDataChannels - a consumer that will call methods on IncrementalTrainingDataChannelOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • 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:

    • 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 the StatusDetails.Builder avoiding the need to create one manually via StatusDetails.builder().

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

      Parameters:
      statusDetails - a consumer that will call methods on StatusDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the ResourceConfig.Builder avoiding the need to create one manually via ResourceConfig.builder().

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

      Parameters:
      resourceConfig - a consumer that will call methods on ResourceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingInputMode

      GetTrainedModelResponse.Builder trainingInputMode(String trainingInputMode)

      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

      Parameters:
      trainingInputMode - The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingInputMode

      GetTrainedModelResponse.Builder trainingInputMode(TrainingInputMode trainingInputMode)

      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

      Parameters:
      trainingInputMode - The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the StoppingCondition.Builder avoiding the need to create one manually via StoppingCondition.builder().

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

      Parameters:
      stoppingCondition - a consumer that will call methods on StoppingCondition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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

      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:

    • 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 the ModelTrainingDataChannel.Builder avoiding the need to create one manually via ModelTrainingDataChannel.builder().

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

      Parameters:
      dataChannels - a consumer that will call methods on ModelTrainingDataChannel.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: