public class RunTaskRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
cluster
The short name or full Amazon Resource Name (ARN) of the cluster on which
to run your task.
|
private java.lang.Integer |
count
The number of instantiations of the specified task to place on your
cluster.
|
private 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.
|
private java.lang.String |
startedBy
An optional tag specified when a task is started.
|
private java.lang.String |
taskDefinition
The
family and revision (
family:revision ) or full Amazon Resource Name (ARN) of the
task definition to run. |
NOOP
Constructor and Description |
---|
RunTaskRequest() |
Modifier and Type | Method and Description |
---|---|
RunTaskRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCluster()
The short name or full Amazon Resource Name (ARN) of the cluster on which
to run your task.
|
java.lang.Integer |
getCount()
The number of instantiations of the specified task to place on your
cluster.
|
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.
|
java.lang.String |
getStartedBy()
An optional tag specified when a task is started.
|
java.lang.String |
getTaskDefinition()
The
family and revision (
family:revision ) or full Amazon Resource Name (ARN) of the
task definition to run. |
int |
hashCode() |
void |
setCluster(java.lang.String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster on which
to run your task.
|
void |
setCount(java.lang.Integer count)
The number of instantiations of the specified task to place on your
cluster.
|
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 |
setStartedBy(java.lang.String startedBy)
An optional tag specified when a task is started.
|
void |
setTaskDefinition(java.lang.String taskDefinition)
The
family and revision (
family:revision ) or full Amazon Resource Name (ARN) of the
task definition to run. |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RunTaskRequest |
withCluster(java.lang.String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster on which
to run your task.
|
RunTaskRequest |
withCount(java.lang.Integer count)
The number of instantiations of the specified task to place on your
cluster.
|
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 |
withStartedBy(java.lang.String startedBy)
An optional tag specified when a task is started.
|
RunTaskRequest |
withTaskDefinition(java.lang.String taskDefinition)
The
family and revision (
family:revision ) or full Amazon Resource Name (ARN) of the
task definition to run. |
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.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..
private java.lang.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.
private 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.
private java.lang.Integer count
The number of instantiations of the specified task to place on your cluster.
The count
parameter is limited to 10 tasks per call.
private java.lang.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.
public void setCluster(java.lang.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..
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..public java.lang.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..
public RunTaskRequest withCluster(java.lang.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..
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..public void setTaskDefinition(java.lang.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.
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.public java.lang.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.
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.public RunTaskRequest withTaskDefinition(java.lang.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.
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.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.
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.
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.
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.
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.
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.
public void setCount(java.lang.Integer count)
The number of instantiations of the specified task to place on your cluster.
The count
parameter is limited to 10 tasks per call.
count
- The number of instantiations of the specified task to place on
your cluster.
The count
parameter is limited to 10 tasks per call.
public java.lang.Integer getCount()
The number of instantiations of the specified task to place on your cluster.
The count
parameter is limited to 10 tasks per call.
The count
parameter is limited to 10 tasks per call.
public RunTaskRequest withCount(java.lang.Integer count)
The number of instantiations of the specified task to place on your cluster.
The count
parameter is limited to 10 tasks per call.
count
- The number of instantiations of the specified task to place on
your cluster.
The count
parameter is limited to 10 tasks per call.
public void setStartedBy(java.lang.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.
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.
public java.lang.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.
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.
public RunTaskRequest withStartedBy(java.lang.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.
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.
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 RunTaskRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()