com.amazonaws.services.sagemaker.model

Class UpdateTrialComponentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.UpdateTrialComponentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateTrialComponentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateTrialComponentRequest()

Method Summary

Modifier and Type	Method and Description
UpdateTrialComponentRequest	addInputArtifactsEntry(String key, TrialComponentArtifact value) Add a single InputArtifacts entry
UpdateTrialComponentRequest	addOutputArtifactsEntry(String key, TrialComponentArtifact value) Add a single OutputArtifacts entry
UpdateTrialComponentRequest	addParametersEntry(String key, TrialComponentParameterValue value) Add a single Parameters entry
UpdateTrialComponentRequest	clearInputArtifactsEntries() Removes all the entries added into InputArtifacts.
UpdateTrialComponentRequest	clearOutputArtifactsEntries() Removes all the entries added into OutputArtifacts.
UpdateTrialComponentRequest	clearParametersEntries() Removes all the entries added into Parameters.
UpdateTrialComponentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDisplayName() The name of the component as displayed.
Date	getEndTime() When the component ended.
Map<String,TrialComponentArtifact>	getInputArtifacts() Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts.
List<String>	getInputArtifactsToRemove() The input artifacts to remove from the component.
Map<String,TrialComponentArtifact>	getOutputArtifacts() Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts.
List<String>	getOutputArtifactsToRemove() The output artifacts to remove from the component.
Map<String,TrialComponentParameterValue>	getParameters() Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters.
List<String>	getParametersToRemove() The hyperparameters to remove from the component.
Date	getStartTime() When the component started.
TrialComponentStatus	getStatus() The new status of the component.
String	getTrialComponentName() The name of the component to update.
int	hashCode()
void	setDisplayName(String displayName) The name of the component as displayed.
void	setEndTime(Date endTime) When the component ended.
void	setInputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts) Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts.
void	setInputArtifactsToRemove(Collection<String> inputArtifactsToRemove) The input artifacts to remove from the component.
void	setOutputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts) Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts.
void	setOutputArtifactsToRemove(Collection<String> outputArtifactsToRemove) The output artifacts to remove from the component.
void	setParameters(Map<String,TrialComponentParameterValue> parameters) Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters.
void	setParametersToRemove(Collection<String> parametersToRemove) The hyperparameters to remove from the component.
void	setStartTime(Date startTime) When the component started.
void	setStatus(TrialComponentStatus status) The new status of the component.
void	setTrialComponentName(String trialComponentName) The name of the component to update.
String	toString() Returns a string representation of this object.
UpdateTrialComponentRequest	withDisplayName(String displayName) The name of the component as displayed.
UpdateTrialComponentRequest	withEndTime(Date endTime) When the component ended.
UpdateTrialComponentRequest	withInputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts) Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts.
UpdateTrialComponentRequest	withInputArtifactsToRemove(Collection<String> inputArtifactsToRemove) The input artifacts to remove from the component.
UpdateTrialComponentRequest	withInputArtifactsToRemove(String... inputArtifactsToRemove) The input artifacts to remove from the component.
UpdateTrialComponentRequest	withOutputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts) Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts.
UpdateTrialComponentRequest	withOutputArtifactsToRemove(Collection<String> outputArtifactsToRemove) The output artifacts to remove from the component.
UpdateTrialComponentRequest	withOutputArtifactsToRemove(String... outputArtifactsToRemove) The output artifacts to remove from the component.
UpdateTrialComponentRequest	withParameters(Map<String,TrialComponentParameterValue> parameters) Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters.
UpdateTrialComponentRequest	withParametersToRemove(Collection<String> parametersToRemove) The hyperparameters to remove from the component.
UpdateTrialComponentRequest	withParametersToRemove(String... parametersToRemove) The hyperparameters to remove from the component.
UpdateTrialComponentRequest	withStartTime(Date startTime) When the component started.
UpdateTrialComponentRequest	withStatus(TrialComponentStatus status) The new status of the component.
UpdateTrialComponentRequest	withTrialComponentName(String trialComponentName) The name of the component to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateTrialComponentRequest

public UpdateTrialComponentRequest()

Method Detail

setTrialComponentName

public void setTrialComponentName(String trialComponentName)

The name of the component to update.

Parameters:

trialComponentName - The name of the component to update.

getTrialComponentName

public String getTrialComponentName()

The name of the component to update.

Returns:

The name of the component to update.

withTrialComponentName

public UpdateTrialComponentRequest withTrialComponentName(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.

setDisplayName

public void setDisplayName(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.

getDisplayName

public String getDisplayName()

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

Returns:

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

withDisplayName

public UpdateTrialComponentRequest withDisplayName(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.

setStatus

public void setStatus(TrialComponentStatus status)

The new status of the component.

Parameters:

status - The new status of the component.

getStatus

public TrialComponentStatus getStatus()

The new status of the component.

Returns:

The new status of the component.

withStatus

public UpdateTrialComponentRequest withStatus(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.

setStartTime

public void setStartTime(Date startTime)

When the component started.

Parameters:

startTime - When the component started.

getStartTime

public Date getStartTime()

When the component started.

Returns:

When the component started.

withStartTime

public UpdateTrialComponentRequest withStartTime(Date 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.

setEndTime

public void setEndTime(Date endTime)

When the component ended.

Parameters:

endTime - When the component ended.

getEndTime

public Date getEndTime()

When the component ended.

Returns:

When the component ended.

withEndTime

public UpdateTrialComponentRequest withEndTime(Date 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.

getParameters

public Map<String,TrialComponentParameterValue> getParameters()

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:

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.

setParameters

public void setParameters(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.

withParameters

public UpdateTrialComponentRequest withParameters(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.

addParametersEntry

public UpdateTrialComponentRequest addParametersEntry(String key,
                                                      TrialComponentParameterValue value)

Add a single Parameters entry

See Also:

withParameters(java.util.Map<java.lang.String, com.amazonaws.services.sagemaker.model.TrialComponentParameterValue>)

clearParametersEntries

public UpdateTrialComponentRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

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

getParametersToRemove

public List<String> getParametersToRemove()

The hyperparameters to remove from the component.

Returns:

The hyperparameters to remove from the component.

setParametersToRemove

public void setParametersToRemove(Collection<String> parametersToRemove)

The hyperparameters to remove from the component.

Parameters:

parametersToRemove - The hyperparameters to remove from the component.

withParametersToRemove

public UpdateTrialComponentRequest withParametersToRemove(String... parametersToRemove)

The hyperparameters to remove from the component.

NOTE: This method appends the values to the existing list (if any). Use setParametersToRemove(java.util.Collection) or withParametersToRemove(java.util.Collection) if you want to override the existing values.

Parameters:

parametersToRemove - The hyperparameters to remove from the component.

Returns:

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

withParametersToRemove

public UpdateTrialComponentRequest withParametersToRemove(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.

getInputArtifacts

public Map<String,TrialComponentArtifact> getInputArtifacts()

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:

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.

setInputArtifacts

public void setInputArtifacts(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.

withInputArtifacts

public UpdateTrialComponentRequest withInputArtifacts(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.

addInputArtifactsEntry

public UpdateTrialComponentRequest addInputArtifactsEntry(String key,
                                                          TrialComponentArtifact value)

Add a single InputArtifacts entry

See Also:

withInputArtifacts(java.util.Map<java.lang.String, com.amazonaws.services.sagemaker.model.TrialComponentArtifact>)

clearInputArtifactsEntries

public UpdateTrialComponentRequest clearInputArtifactsEntries()

Removes all the entries added into InputArtifacts.

Returns:

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

getInputArtifactsToRemove

public List<String> getInputArtifactsToRemove()

The input artifacts to remove from the component.

Returns:

The input artifacts to remove from the component.

setInputArtifactsToRemove

public void setInputArtifactsToRemove(Collection<String> inputArtifactsToRemove)

The input artifacts to remove from the component.

Parameters:

inputArtifactsToRemove - The input artifacts to remove from the component.

withInputArtifactsToRemove

public UpdateTrialComponentRequest withInputArtifactsToRemove(String... inputArtifactsToRemove)

The input artifacts to remove from the component.

NOTE: This method appends the values to the existing list (if any). Use setInputArtifactsToRemove(java.util.Collection) or withInputArtifactsToRemove(java.util.Collection) if you want to override the existing values.

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.

withInputArtifactsToRemove

public UpdateTrialComponentRequest withInputArtifactsToRemove(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.

getOutputArtifacts

public Map<String,TrialComponentArtifact> getOutputArtifacts()

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:

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.

setOutputArtifacts

public void setOutputArtifacts(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.

withOutputArtifacts

public UpdateTrialComponentRequest withOutputArtifacts(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.

addOutputArtifactsEntry

public UpdateTrialComponentRequest addOutputArtifactsEntry(String key,
                                                           TrialComponentArtifact value)

Add a single OutputArtifacts entry

See Also:

withOutputArtifacts(java.util.Map<java.lang.String, com.amazonaws.services.sagemaker.model.TrialComponentArtifact>)

clearOutputArtifactsEntries

public UpdateTrialComponentRequest clearOutputArtifactsEntries()

Removes all the entries added into OutputArtifacts.

Returns:

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

getOutputArtifactsToRemove

public List<String> getOutputArtifactsToRemove()

The output artifacts to remove from the component.

Returns:

The output artifacts to remove from the component.

setOutputArtifactsToRemove

public void setOutputArtifactsToRemove(Collection<String> outputArtifactsToRemove)

The output artifacts to remove from the component.

Parameters:

outputArtifactsToRemove - The output artifacts to remove from the component.

withOutputArtifactsToRemove

public UpdateTrialComponentRequest withOutputArtifactsToRemove(String... outputArtifactsToRemove)

The output artifacts to remove from the component.

NOTE: This method appends the values to the existing list (if any). Use setOutputArtifactsToRemove(java.util.Collection) or withOutputArtifactsToRemove(java.util.Collection) if you want to override the existing values.

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.

withOutputArtifactsToRemove

public UpdateTrialComponentRequest withOutputArtifactsToRemove(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateTrialComponentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()