com.amazonaws.services.ecs.model

Class RunTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.RunTaskRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
RunTaskRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
Integer	getCount() The number of instantiations of the specified task to place on your cluster.
String	getGroup() The name of the task group to associate with the task.
TaskOverride	getOverrides() A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive.
List<PlacementConstraint>	getPlacementConstraints() An array of placement constraint objects to use for the task.
List<PlacementStrategy>	getPlacementStrategy() The placement strategy objects to use for the task.
String	getStartedBy() An optional tag specified when a task is started.
String	getTaskDefinition() The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
void	setCount(Integer count) The number of instantiations of the specified task to place on your cluster.
void	setGroup(String group) The name of the task group to associate with the task.
void	setOverrides(TaskOverride overrides) A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive.
void	setPlacementConstraints(Collection<PlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
void	setPlacementStrategy(Collection<PlacementStrategy> placementStrategy) The placement strategy objects to use for the task.
void	setStartedBy(String startedBy) An optional tag specified when a task is started.
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RunTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
RunTaskRequest	withCount(Integer count) The number of instantiations of the specified task to place on your cluster.
RunTaskRequest	withGroup(String group) The name of the task group to associate with the task.
RunTaskRequest	withOverrides(TaskOverride overrides) A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive.
RunTaskRequest	withPlacementConstraints(Collection<PlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.
RunTaskRequest	withPlacementConstraints(PlacementConstraint... placementConstraints) An array of placement constraint objects to use for the task.
RunTaskRequest	withPlacementStrategy(Collection<PlacementStrategy> placementStrategy) The placement strategy objects to use for the task.
RunTaskRequest	withPlacementStrategy(PlacementStrategy... placementStrategy) The placement strategy objects to use for the task.
RunTaskRequest	withStartedBy(String startedBy) An optional tag specified when a task is started.
RunTaskRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run.

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, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RunTaskRequest

public RunTaskRequest()

Method Detail

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

withCluster

public RunTaskRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

Returns:

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

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

getTaskDefinition

public String getTaskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

withTaskDefinition

public RunTaskRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

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

setOverrides

public void setOverrides(TaskOverride overrides)

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

Parameters:

overrides - A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

getOverrides

public TaskOverride getOverrides()

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

Returns:

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

withOverrides

public RunTaskRequest withOverrides(TaskOverride overrides)

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

Parameters:

overrides - A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

Returns:

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

setCount

public void setCount(Integer count)

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Parameters:

count - The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

getCount

public Integer getCount()

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Returns:

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

withCount

public RunTaskRequest withCount(Integer count)

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Parameters:

count - The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

Returns:

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

setStartedBy

public void setStartedBy(String startedBy)

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Parameters:

startedBy - An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

getStartedBy

public String getStartedBy()

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns:

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

withStartedBy

public RunTaskRequest withStartedBy(String startedBy)

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Parameters:

startedBy - An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Returns:

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

setGroup

public void setGroup(String group)

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

Parameters:

group - The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

getGroup

public String getGroup()

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

Returns:

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

withGroup

public RunTaskRequest withGroup(String group)

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

Parameters:

group - The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

Returns:

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

getPlacementConstraints

public List<PlacementConstraint> getPlacementConstraints()

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

Returns:

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

setPlacementConstraints

public void setPlacementConstraints(Collection<PlacementConstraint> placementConstraints)

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

Parameters:

placementConstraints - An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

withPlacementConstraints

public RunTaskRequest withPlacementConstraints(PlacementConstraint... placementConstraints)

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

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

Parameters:

placementConstraints - An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

Returns:

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

withPlacementConstraints

public RunTaskRequest withPlacementConstraints(Collection<PlacementConstraint> placementConstraints)

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

Parameters:

placementConstraints - An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

Returns:

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

getPlacementStrategy

public List<PlacementStrategy> getPlacementStrategy()

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

Returns:

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

setPlacementStrategy

public void setPlacementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

withPlacementStrategy

public RunTaskRequest withPlacementStrategy(PlacementStrategy... placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

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

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

Returns:

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

withPlacementStrategy

public RunTaskRequest withPlacementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

Parameters:

placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

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; useful for testing and debugging.

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