public class TaskDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Details of a task definition.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<ContainerDefinition> |
containerDefinitions
A list of container definitions in JSON format that describe the
different containers that make up your task.
|
private java.lang.String |
family
The family of your task definition, used as the definition name.
|
private SdkInternalList<Attribute> |
requiresAttributes
The container instance attributes required by your task.
|
private java.lang.Integer |
revision
The revision of the task in a particular family.
|
private java.lang.String |
status
The status of the task definition.
|
private java.lang.String |
taskDefinitionArn
The full Amazon Resource Name (ARN) of the task definition.
|
private SdkInternalList<Volume> |
volumes
The list of volumes in a task.
|
Constructor and Description |
---|
TaskDefinition() |
Modifier and Type | Method and Description |
---|---|
TaskDefinition |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.List<ContainerDefinition> |
getContainerDefinitions()
A list of container definitions in JSON format that describe the
different containers that make up your task.
|
java.lang.String |
getFamily()
The family of your task definition, used as the definition name.
|
java.util.List<Attribute> |
getRequiresAttributes()
The container instance attributes required by your task.
|
java.lang.Integer |
getRevision()
The revision of the task in a particular family.
|
java.lang.String |
getStatus()
The status of the task definition.
|
java.lang.String |
getTaskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
|
java.util.List<Volume> |
getVolumes()
The list of volumes in a task.
|
int |
hashCode() |
void |
setContainerDefinitions(java.util.Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the
different containers that make up your task.
|
void |
setFamily(java.lang.String family)
The family of your task definition, used as the definition name.
|
void |
setRequiresAttributes(java.util.Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
|
void |
setRevision(java.lang.Integer revision)
The revision of the task in a particular family.
|
void |
setStatus(java.lang.String status)
The status of the task definition.
|
void |
setStatus(TaskDefinitionStatus status)
The status of the task definition.
|
void |
setTaskDefinitionArn(java.lang.String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
|
void |
setVolumes(java.util.Collection<Volume> volumes)
The list of volumes in a task.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
TaskDefinition |
withContainerDefinitions(java.util.Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the
different containers that make up your task.
|
TaskDefinition |
withContainerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the
different containers that make up your task.
|
TaskDefinition |
withFamily(java.lang.String family)
The family of your task definition, used as the definition name.
|
TaskDefinition |
withRequiresAttributes(Attribute... requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition |
withRequiresAttributes(java.util.Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
|
TaskDefinition |
withRevision(java.lang.Integer revision)
The revision of the task in a particular family.
|
TaskDefinition |
withStatus(java.lang.String status)
The status of the task definition.
|
TaskDefinition |
withStatus(TaskDefinitionStatus status)
The status of the task definition.
|
TaskDefinition |
withTaskDefinitionArn(java.lang.String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
|
TaskDefinition |
withVolumes(java.util.Collection<Volume> volumes)
The list of volumes in a task.
|
TaskDefinition |
withVolumes(Volume... volumes)
The list of volumes in a task.
|
private java.lang.String taskDefinitionArn
The full Amazon Resource Name (ARN) of the task definition.
private SdkInternalList<ContainerDefinition> containerDefinitions
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
private java.lang.String family
The family of your task definition, used as the definition name.
private java.lang.Integer revision
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a task
definition for the first time, the revision is 1
; each time
you register a new revision of a task definition in the same family, the
revision value always increases by one (even if you have deregistered
previous revisions in this family).
private SdkInternalList<Volume> volumes
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
private java.lang.String status
The status of the task definition.
private SdkInternalList<Attribute> requiresAttributes
The container instance attributes required by your task.
public void setTaskDefinitionArn(java.lang.String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
taskDefinitionArn
- The full Amazon Resource Name (ARN) of the task definition.public java.lang.String getTaskDefinitionArn()
The full Amazon Resource Name (ARN) of the task definition.
public TaskDefinition withTaskDefinitionArn(java.lang.String taskDefinitionArn)
The full Amazon Resource Name (ARN) of the task definition.
taskDefinitionArn
- The full Amazon Resource Name (ARN) of the task definition.public java.util.List<ContainerDefinition> getContainerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
public void setContainerDefinitions(java.util.Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
containerDefinitions
- A list of container definitions in JSON format that describe the
different containers that make up your task. For more information
about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container
Service Developer Guide.public TaskDefinition withContainerDefinitions(ContainerDefinition... containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
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.
containerDefinitions
- A list of container definitions in JSON format that describe the
different containers that make up your task. For more information
about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container
Service Developer Guide.public TaskDefinition withContainerDefinitions(java.util.Collection<ContainerDefinition> containerDefinitions)
A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
containerDefinitions
- A list of container definitions in JSON format that describe the
different containers that make up your task. For more information
about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container
Service Developer Guide.public void setFamily(java.lang.String family)
The family of your task definition, used as the definition name.
family
- The family of your task definition, used as the definition name.public java.lang.String getFamily()
The family of your task definition, used as the definition name.
public TaskDefinition withFamily(java.lang.String family)
The family of your task definition, used as the definition name.
family
- The family of your task definition, used as the definition name.public void setRevision(java.lang.Integer revision)
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a task
definition for the first time, the revision is 1
; each time
you register a new revision of a task definition in the same family, the
revision value always increases by one (even if you have deregistered
previous revisions in this family).
revision
- The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register
a task definition for the first time, the revision is
1
; each time you register a new revision of a task
definition in the same family, the revision value always increases
by one (even if you have deregistered previous revisions in this
family).public java.lang.Integer getRevision()
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a task
definition for the first time, the revision is 1
; each time
you register a new revision of a task definition in the same family, the
revision value always increases by one (even if you have deregistered
previous revisions in this family).
1
; each time you register a new revision of a task
definition in the same family, the revision value always
increases by one (even if you have deregistered previous
revisions in this family).public TaskDefinition withRevision(java.lang.Integer revision)
The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register a task
definition for the first time, the revision is 1
; each time
you register a new revision of a task definition in the same family, the
revision value always increases by one (even if you have deregistered
previous revisions in this family).
revision
- The revision of the task in a particular family. The revision is a
version number of a task definition in a family. When you register
a task definition for the first time, the revision is
1
; each time you register a new revision of a task
definition in the same family, the revision value always increases
by one (even if you have deregistered previous revisions in this
family).public java.util.List<Volume> getVolumes()
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
public void setVolumes(java.util.Collection<Volume> volumes)
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
volumes
- The list of volumes in a task. For more information about volume
definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container
Service Developer Guide.public TaskDefinition withVolumes(Volume... volumes)
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
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.
volumes
- The list of volumes in a task. For more information about volume
definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container
Service Developer Guide.public TaskDefinition withVolumes(java.util.Collection<Volume> volumes)
The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.
volumes
- The list of volumes in a task. For more information about volume
definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container
Service Developer Guide.public void setStatus(java.lang.String status)
The status of the task definition.
status
- The status of the task definition.TaskDefinitionStatus
public java.lang.String getStatus()
The status of the task definition.
TaskDefinitionStatus
public TaskDefinition withStatus(java.lang.String status)
The status of the task definition.
status
- The status of the task definition.TaskDefinitionStatus
public void setStatus(TaskDefinitionStatus status)
The status of the task definition.
status
- The status of the task definition.TaskDefinitionStatus
public TaskDefinition withStatus(TaskDefinitionStatus status)
The status of the task definition.
status
- The status of the task definition.TaskDefinitionStatus
public java.util.List<Attribute> getRequiresAttributes()
The container instance attributes required by your task.
public void setRequiresAttributes(java.util.Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
requiresAttributes
- The container instance attributes required by your task.public TaskDefinition withRequiresAttributes(Attribute... requiresAttributes)
The container instance attributes required by your task.
NOTE: This method appends the values to the existing list (if
any). Use setRequiresAttributes(java.util.Collection)
or
withRequiresAttributes(java.util.Collection)
if you want to
override the existing values.
requiresAttributes
- The container instance attributes required by your task.public TaskDefinition withRequiresAttributes(java.util.Collection<Attribute> requiresAttributes)
The container instance attributes required by your task.
requiresAttributes
- The container instance attributes required by your task.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public TaskDefinition clone()
clone
in class java.lang.Object