com.amazonaws.services.ecs.model

Class StartTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.StartTaskRequest

All Implemented Interfaces:

Serializable

public class StartTaskRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the StartTask operation.

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

See Also:

AmazonECS.startTask(StartTaskRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartTaskRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on.
List<String>	getContainerInstances() The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
TaskOverride	getOverrides()
String	getTaskDefinition() The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.
int	hashCode()
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on.
void	setContainerInstances(Collection<String> containerInstances) The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
void	setOverrides(TaskOverride overrides)
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartTaskRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on.
StartTaskRequest	withContainerInstances(Collection<String> containerInstances) The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
StartTaskRequest	withContainerInstances(String... containerInstances) The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
StartTaskRequest	withOverrides(TaskOverride overrides) Returns a reference to this object so that method calls can be chained together.
StartTaskRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StartTaskRequest

public StartTaskRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. 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 that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. 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 that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..

withCluster

public StartTaskRequest withCluster(String cluster)

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

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

Parameters:

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

Returns:

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

getTaskDefinition

public String getTaskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

Returns:

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

withTaskDefinition

public StartTaskRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

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

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to start.

Returns:

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

getOverrides

public TaskOverride getOverrides()

Returns:

setOverrides

public void setOverrides(TaskOverride overrides)

Parameters:

overrides -

withOverrides

public StartTaskRequest withOverrides(TaskOverride overrides)

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

Parameters:

overrides -

Returns:

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

getContainerInstances

public List<String> getContainerInstances()

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

Returns:

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

setContainerInstances

public void setContainerInstances(Collection<String> containerInstances)

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

Parameters:

containerInstances - The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

withContainerInstances

public StartTaskRequest withContainerInstances(String... containerInstances)

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

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

Parameters:

containerInstances - The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

Returns:

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

withContainerInstances

public StartTaskRequest withContainerInstances(Collection<String> containerInstances)

The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

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

Parameters:

containerInstances - The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

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