com.amazonaws.services.sagemaker.model

Class CreateExperimentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateExperimentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateExperimentRequest
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
CreateExperimentRequest()

Method Summary

Modifier and Type	Method and Description
CreateExperimentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() The description of the experiment.
String	getDisplayName() The name of the experiment as displayed.
String	getExperimentName() The name of the experiment.
List<Tag>	getTags() A list of tags to associate with the experiment.
int	hashCode()
void	setDescription(String description) The description of the experiment.
void	setDisplayName(String displayName) The name of the experiment as displayed.
void	setExperimentName(String experimentName) The name of the experiment.
void	setTags(Collection<Tag> tags) A list of tags to associate with the experiment.
String	toString() Returns a string representation of this object.
CreateExperimentRequest	withDescription(String description) The description of the experiment.
CreateExperimentRequest	withDisplayName(String displayName) The name of the experiment as displayed.
CreateExperimentRequest	withExperimentName(String experimentName) The name of the experiment.
CreateExperimentRequest	withTags(Collection<Tag> tags) A list of tags to associate with the experiment.
CreateExperimentRequest	withTags(Tag... tags) A list of tags to associate with the experiment.

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

CreateExperimentRequest

public CreateExperimentRequest()

Method Detail

setExperimentName

public void setExperimentName(String experimentName)

The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

Parameters:

experimentName - The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

getExperimentName

public String getExperimentName()

The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

Returns:

The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

withExperimentName

public CreateExperimentRequest withExperimentName(String experimentName)

The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

Parameters:

experimentName - The name of the experiment. The name must be unique in your AWS account and is not case-sensitive.

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 experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

Parameters:

displayName - The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

getDisplayName

public String getDisplayName()

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

Returns:

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

withDisplayName

public CreateExperimentRequest withDisplayName(String displayName)

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

Parameters:

displayName - The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

Returns:

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

setDescription

public void setDescription(String description)

The description of the experiment.

Parameters:

description - The description of the experiment.

getDescription

public String getDescription()

The description of the experiment.

Returns:

The description of the experiment.

withDescription

public CreateExperimentRequest withDescription(String description)

The description of the experiment.

Parameters:

description - The description of the experiment.

Returns:

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

getTags

public List<Tag> getTags()

A list of tags to associate with the experiment. You can use Search API to search on the tags.

Returns:

A list of tags to associate with the experiment. You can use Search API to search on the tags.

setTags

public void setTags(Collection<Tag> tags)

A list of tags to associate with the experiment. You can use Search API to search on the tags.

Parameters:

tags - A list of tags to associate with the experiment. You can use Search API to search on the tags.

withTags

public CreateExperimentRequest withTags(Tag... tags)

A list of tags to associate with the experiment. You can use Search API to search on the tags.

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

Parameters:

tags - A list of tags to associate with the experiment. You can use Search API to search on the tags.

Returns:

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

withTags

public CreateExperimentRequest withTags(Collection<Tag> tags)

A list of tags to associate with the experiment. You can use Search API to search on the tags.

Parameters:

tags - A list of tags to associate with the experiment. You can use Search API to search on the tags.

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 CreateExperimentRequest 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()