Interface UpdateTrialComponentRequest.Builder

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

  • Method Details

    • trialComponentName

      UpdateTrialComponentRequest.Builder trialComponentName(String trialComponentName)

      The name of the component to update.

      Parameters:
      trialComponentName - The name of the component to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      UpdateTrialComponentRequest.Builder displayName(String displayName)

      The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

      Parameters:
      displayName - The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      UpdateTrialComponentRequest.Builder status(TrialComponentStatus status)

      The new status of the component.

      Parameters:
      status - The new status of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      default UpdateTrialComponentRequest.Builder status(Consumer<TrialComponentStatus.Builder> status)

      The new status of the component.

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

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

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

    • startTime

      UpdateTrialComponentRequest.Builder startTime(Instant startTime)

      When the component started.

      Parameters:
      startTime - When the component started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      UpdateTrialComponentRequest.Builder endTime(Instant endTime)

      When the component ended.

      Parameters:
      endTime - When the component ended.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      UpdateTrialComponentRequest.Builder parameters(Map<String,TrialComponentParameterValue> parameters)

      Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

      Parameters:
      parameters - Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parametersToRemove

      UpdateTrialComponentRequest.Builder parametersToRemove(Collection<String> parametersToRemove)

      The hyperparameters to remove from the component.

      Parameters:
      parametersToRemove - The hyperparameters to remove from the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parametersToRemove

      UpdateTrialComponentRequest.Builder parametersToRemove(String... parametersToRemove)

      The hyperparameters to remove from the component.

      Parameters:
      parametersToRemove - The hyperparameters to remove from the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputArtifacts

      UpdateTrialComponentRequest.Builder inputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts)

      Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

      Parameters:
      inputArtifacts - Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputArtifactsToRemove

      UpdateTrialComponentRequest.Builder inputArtifactsToRemove(Collection<String> inputArtifactsToRemove)

      The input artifacts to remove from the component.

      Parameters:
      inputArtifactsToRemove - The input artifacts to remove from the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputArtifactsToRemove

      UpdateTrialComponentRequest.Builder inputArtifactsToRemove(String... inputArtifactsToRemove)

      The input artifacts to remove from the component.

      Parameters:
      inputArtifactsToRemove - The input artifacts to remove from the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputArtifacts

      UpdateTrialComponentRequest.Builder outputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts)

      Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

      Parameters:
      outputArtifacts - Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputArtifactsToRemove

      UpdateTrialComponentRequest.Builder outputArtifactsToRemove(Collection<String> outputArtifactsToRemove)

      The output artifacts to remove from the component.

      Parameters:
      outputArtifactsToRemove - The output artifacts to remove from the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputArtifactsToRemove

      UpdateTrialComponentRequest.Builder outputArtifactsToRemove(String... outputArtifactsToRemove)

      The output artifacts to remove from the component.

      Parameters:
      outputArtifactsToRemove - The output artifacts to remove from the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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