/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateTrialComponentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the component to update. *
*/ private String trialComponentName; /** *
* The name of the component as displayed. The name doesn't need to be unique. If DisplayName
isn't
* specified, TrialComponentName
is displayed.
*
* The new status of the component. *
*/ private TrialComponentStatus status; /** ** When the component started. *
*/ private java.util.Date startTime; /** ** When the component ended. *
*/ private java.util.Date endTime; /** ** 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. *
*/ private java.util.Map* The hyperparameters to remove from the component. *
*/ private java.util.List* 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. *
*/ private java.util.Map* The input artifacts to remove from the component. *
*/ private java.util.List* 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. *
*/ private java.util.Map* The output artifacts to remove from the component. *
*/ private java.util.List* The name of the component to update. *
* * @param trialComponentName * The name of the component to update. */ public void setTrialComponentName(String trialComponentName) { this.trialComponentName = trialComponentName; } /** ** The name of the component to update. *
* * @return The name of the component to update. */ public String getTrialComponentName() { return this.trialComponentName; } /** ** The name of the component to update. *
* * @param trialComponentName * The name of the component to update. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withTrialComponentName(String trialComponentName) { setTrialComponentName(trialComponentName); return this; } /** *
* The name of the component as displayed. The name doesn't need to be unique. If DisplayName
isn't
* specified, TrialComponentName
is displayed.
*
DisplayName
* isn't specified, TrialComponentName
is displayed.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The name of the component as displayed. The name doesn't need to be unique. If DisplayName
isn't
* specified, TrialComponentName
is displayed.
*
DisplayName
* isn't specified, TrialComponentName
is displayed.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The name of the component as displayed. The name doesn't need to be unique. If DisplayName
isn't
* specified, TrialComponentName
is displayed.
*
DisplayName
* isn't specified, TrialComponentName
is displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateTrialComponentRequest withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
* * The new status of the component. *
* * @param status * The new status of the component. */ public void setStatus(TrialComponentStatus status) { this.status = status; } /** ** The new status of the component. *
* * @return The new status of the component. */ public TrialComponentStatus getStatus() { return this.status; } /** ** The new status of the component. *
* * @param status * The new status of the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withStatus(TrialComponentStatus status) { setStatus(status); return this; } /** ** When the component started. *
* * @param startTime * When the component started. */ public void setStartTime(java.util.Date startTime) { this.startTime = startTime; } /** ** When the component started. *
* * @return When the component started. */ public java.util.Date getStartTime() { return this.startTime; } /** ** When the component started. *
* * @param startTime * When the component started. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withStartTime(java.util.Date startTime) { setStartTime(startTime); return this; } /** ** When the component ended. *
* * @param endTime * When the component ended. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** When the component ended. *
* * @return When the component ended. */ public java.util.Date getEndTime() { return this.endTime; } /** ** When the component ended. *
* * @param endTime * When the component ended. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** ** 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. *
* * @return 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. */ public java.util.Map* 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. *
* * @param 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. */ public void setParameters(java.util.Map* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withParameters(java.util.Map* The hyperparameters to remove from the component. *
* * @return The hyperparameters to remove from the component. */ public java.util.List* The hyperparameters to remove from the component. *
* * @param parametersToRemove * The hyperparameters to remove from the component. */ public void setParametersToRemove(java.util.Collection* The hyperparameters to remove from the component. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setParametersToRemove(java.util.Collection)} or {@link #withParametersToRemove(java.util.Collection)} if * you want to override the existing values. *
* * @param parametersToRemove * The hyperparameters to remove from the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withParametersToRemove(String... parametersToRemove) { if (this.parametersToRemove == null) { setParametersToRemove(new java.util.ArrayList* The hyperparameters to remove from the component. *
* * @param parametersToRemove * The hyperparameters to remove from the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withParametersToRemove(java.util.Collection* 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. *
* * @return 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. */ public java.util.Map* 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. *
* * @param 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. */ public void setInputArtifacts(java.util.Map* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withInputArtifacts(java.util.Map* The input artifacts to remove from the component. *
* * @return The input artifacts to remove from the component. */ public java.util.List* The input artifacts to remove from the component. *
* * @param inputArtifactsToRemove * The input artifacts to remove from the component. */ public void setInputArtifactsToRemove(java.util.Collection* The input artifacts to remove from the component. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setInputArtifactsToRemove(java.util.Collection)} or * {@link #withInputArtifactsToRemove(java.util.Collection)} if you want to override the existing values. *
* * @param inputArtifactsToRemove * The input artifacts to remove from the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withInputArtifactsToRemove(String... inputArtifactsToRemove) { if (this.inputArtifactsToRemove == null) { setInputArtifactsToRemove(new java.util.ArrayList* The input artifacts to remove from the component. *
* * @param inputArtifactsToRemove * The input artifacts to remove from the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withInputArtifactsToRemove(java.util.Collection* 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. *
* * @return 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. */ public java.util.Map* 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. *
* * @param 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. */ public void setOutputArtifacts(java.util.Map* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withOutputArtifacts(java.util.Map* The output artifacts to remove from the component. *
* * @return The output artifacts to remove from the component. */ public java.util.List* The output artifacts to remove from the component. *
* * @param outputArtifactsToRemove * The output artifacts to remove from the component. */ public void setOutputArtifactsToRemove(java.util.Collection* The output artifacts to remove from the component. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setOutputArtifactsToRemove(java.util.Collection)} or * {@link #withOutputArtifactsToRemove(java.util.Collection)} if you want to override the existing values. *
* * @param outputArtifactsToRemove * The output artifacts to remove from the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withOutputArtifactsToRemove(String... outputArtifactsToRemove) { if (this.outputArtifactsToRemove == null) { setOutputArtifactsToRemove(new java.util.ArrayList* The output artifacts to remove from the component. *
* * @param outputArtifactsToRemove * The output artifacts to remove from the component. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateTrialComponentRequest withOutputArtifactsToRemove(java.util.Collection