RunTaskRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ecs.model.EcsRequest
    - - software.amazon.awssdk.services.ecs.model.RunTaskRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RunTaskRequest
extends EcsRequest
implements ToCopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RunTaskRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RunTaskRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RunTaskRequest.Builder`	`builder()`
`List<CapacityProviderStrategyItem>`	`capacityProviderStrategy()` The capacity provider strategy to use for the task.
`String`	`cluster()` The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.
`Integer`	`count()` The number of instantiations of the specified task to place on your cluster.
`Boolean`	`enableECSManagedTags()` Specifies whether to enable Amazon ECS managed tags for the task.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`String`	`group()` The name of the task group to associate with the task.
`boolean`	`hasCapacityProviderStrategy()` Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasPlacementConstraints()` Returns true if the PlacementConstraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPlacementStrategy()` Returns true if the PlacementStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`LaunchType`	`launchType()` The launch type on which to run your task.
`String`	`launchTypeAsString()` The launch type on which to run your task.
`NetworkConfiguration`	`networkConfiguration()` The network configuration for the task.
`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.
`List<PlacementConstraint>`	`placementConstraints()` An array of placement constraint objects to use for the task.
`List<PlacementStrategy>`	`placementStrategy()` The placement strategy objects to use for the task.
`String`	`platformVersion()` The platform version the task should run.
`PropagateTags`	`propagateTags()` Specifies whether to propagate the tags from the task definition to the task.
`String`	`propagateTagsAsString()` Specifies whether to propagate the tags from the task definition to the task.
`String`	`referenceId()` The reference ID to use for the task.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RunTaskRequest.Builder>`	`serializableBuilderClass()`
`String`	`startedBy()` An optional tag specified when a task is started.
`List<Tag>`	`tags()` The metadata that you apply to the task to help you categorize and organize them.
`String`	`taskDefinition()` The `family` and `revision` (`family:revision`) or full ARN of the task definition to run.
`RunTaskRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasCapacityProviderStrategy
```
public boolean hasCapacityProviderStrategy()
```
    Returns true if the CapacityProviderStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - capacityProviderStrategy
```
public List<CapacityProviderStrategyItem> capacityProviderStrategy()
```
    The capacity provider strategy to use for the task.
    
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    
    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
    
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    
    To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCapacityProviderStrategy() to see if a value was sent in this field.
    
    Returns:
    
    The capacity provider strategy to use for the task.
    
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    
    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
    
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    
    To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
  - cluster
```
public 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.
    
    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.
  - count
```
public Integer count()
```
    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.
  - enableECSManagedTags
```
public Boolean enableECSManagedTags()
```
    Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
  - group
```
public 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).
    
    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).
  - launchType
```
public LaunchType launchType()
```
    The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    See Also:
    
    LaunchType
  - launchTypeAsString
```
public String launchTypeAsString()
```
    The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    If the service returns an enum value that is not available in the current SDK version, launchType will return LaunchType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from launchTypeAsString().
    
    Returns:
    
    The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
    
    See Also:
    
    LaunchType
  - networkConfiguration
```
public NetworkConfiguration networkConfiguration()
```
    The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
  - overrides
```
public 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.
    
    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.
  - hasPlacementConstraints
```
public boolean hasPlacementConstraints()
```
    Returns true if the PlacementConstraints property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - placementConstraints
```
public List<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 runtime).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPlacementConstraints() to see if a value was sent in this field.
    
    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 runtime).
  - hasPlacementStrategy
```
public boolean hasPlacementStrategy()
```
    Returns true if the PlacementStrategy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - placementStrategy
```
public List<PlacementStrategy> placementStrategy()
```
    The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasPlacementStrategy() to see if a value was sent in this field.
    
    Returns:
    
    The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
  - platformVersion
```
public String platformVersion()
```
    The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
  - propagateTags
```
public PropagateTags propagateTags()
```
    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
    
    An error will be received if you specify the SERVICE option when running a task.
    
    If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().
    
    Returns:
    
    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
    
    An error will be received if you specify the SERVICE option when running a task.
    
    See Also:
    
    PropagateTags
  - propagateTagsAsString
```
public String propagateTagsAsString()
```
    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
    
    An error will be received if you specify the SERVICE option when running a task.
    
    If the service returns an enum value that is not available in the current SDK version, propagateTags will return PropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().
    
    Returns:
    
    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
    
    An error will be received if you specify the SERVICE option when running a task.
    
    See Also:
    
    PropagateTags
  - referenceId
```
public String referenceId()
```
    The reference ID to use for the task.
    
    Returns:
    
    The reference ID to use for the task.
  - startedBy
```
public 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.
    
    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.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public List<Tag> tags()
```
    The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    Returns:
    The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - taskDefinition
```
public String taskDefinition()
```
    The family and revision (family:revision) or full 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 ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.
  - toBuilder
```
public RunTaskRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RunTaskRequest.Builder,RunTaskRequest>
    
    Specified by:
    
    toBuilder in class EcsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RunTaskRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RunTaskRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.15.18

Class RunTaskRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasCapacityProviderStrategy

capacityProviderStrategy

cluster

count

enableECSManagedTags

group

launchType

launchTypeAsString

networkConfiguration

overrides

hasPlacementConstraints

placementConstraints

hasPlacementStrategy

placementStrategy

platformVersion

propagateTags

propagateTagsAsString

referenceId

startedBy

hasTags

tags

taskDefinition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.