com.amazonaws.services.ecs.model

Class RegisterTaskDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RegisterTaskDefinitionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RegisterTaskDefinitionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RegisterTaskDefinition operation.

Registers a new task definition from the supplied family and containerDefinitions . Optionally, you can add data volumes to your containers with the volumes parameter. For more information on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

See Also:

AmazonECS.registerTaskDefinition(RegisterTaskDefinitionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterTaskDefinitionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RegisterTaskDefinitionRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<ContainerDefinition>	getContainerDefinitions() A list of container definitions in JSON format that describe the different containers that make up your task.
String	getFamily() You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
List<Volume>	getVolumes() A list of volume definitions in JSON format that containers in your task may use.
int	hashCode()
void	setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
void	setFamily(String family) You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
void	setVolumes(Collection<Volume> volumes) A list of volume definitions in JSON format that containers in your task may use.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterTaskDefinitionRequest	withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
RegisterTaskDefinitionRequest	withContainerDefinitions(ContainerDefinition... containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.
RegisterTaskDefinitionRequest	withFamily(String family) You must specify a family for a task definition, which allows you to track multiple versions of the same task definition.
RegisterTaskDefinitionRequest	withVolumes(Collection<Volume> volumes) A list of volume definitions in JSON format that containers in your task may use.
RegisterTaskDefinitionRequest	withVolumes(Volume... volumes) A list of volume definitions in JSON format that containers in your task may use.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterTaskDefinitionRequest

public RegisterTaskDefinitionRequest()

Method Detail

getFamily

public String getFamily()

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

setFamily

public void setFamily(String family)

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Parameters:

family - You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

withFamily

public RegisterTaskDefinitionRequest withFamily(String family)

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

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

Parameters:

family - You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

A reference to this updated object so that method calls can be chained together.

getContainerDefinitions

public List<ContainerDefinition> getContainerDefinitions()

A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:

A list of container definitions in JSON format that describe the different containers that make up your task.

setContainerDefinitions

public void setContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task.

Parameters:

containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task.

withContainerDefinitions

public RegisterTaskDefinitionRequest withContainerDefinitions(ContainerDefinition... containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task.

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

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

Parameters:

containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:

A reference to this updated object so that method calls can be chained together.

withContainerDefinitions

public RegisterTaskDefinitionRequest withContainerDefinitions(Collection<ContainerDefinition> containerDefinitions)

A list of container definitions in JSON format that describe the different containers that make up your task.

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

Parameters:

containerDefinitions - A list of container definitions in JSON format that describe the different containers that make up your task.

Returns:

A reference to this updated object so that method calls can be chained together.

getVolumes

public List<Volume> getVolumes()

A list of volume definitions in JSON format that containers in your task may use.

Returns:

A list of volume definitions in JSON format that containers in your task may use.

setVolumes

public void setVolumes(Collection<Volume> volumes)

A list of volume definitions in JSON format that containers in your task may use.

Parameters:

volumes - A list of volume definitions in JSON format that containers in your task may use.

withVolumes

public RegisterTaskDefinitionRequest withVolumes(Volume... volumes)

A list of volume definitions in JSON format that containers in your task may use.

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

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

Parameters:

volumes - A list of volume definitions in JSON format that containers in your task may use.

Returns:

A reference to this updated object so that method calls can be chained together.

withVolumes

public RegisterTaskDefinitionRequest withVolumes(Collection<Volume> volumes)

A list of volume definitions in JSON format that containers in your task may use.

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

Parameters:

volumes - A list of volume definitions in JSON format that containers in your task may use.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RegisterTaskDefinitionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()