software.amazon.awssdk.services.ecs.model

Class CreateTaskSetRequest

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.CreateTaskSetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTaskSetRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTaskSetRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() An optional non-unique tag that identifies this task set in external systems.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LaunchType	launchType() The launch type that new tasks in the task set will use.
String	launchTypeAsString() The launch type that new tasks in the task set will use.
List<LoadBalancer>	loadBalancers() A load balancer object representing the load balancer to use with the task set.
NetworkConfiguration	networkConfiguration() Returns the value of the NetworkConfiguration property for this object.
String	platformVersion() The platform version that the tasks in the task set should use.
Scale	scale() Returns the value of the Scale property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTaskSetRequest.Builder>	serializableBuilderClass()
String	service() The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
List<ServiceRegistry>	serviceRegistries() The details of the service discovery registries to assign to this task set.
String	taskDefinition() The task definition for the tasks in the task set to use.
CreateTaskSetRequest.Builder	toBuilder()
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

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

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

copy

Method Detail

service

public String service()

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

Returns:

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

cluster

public String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

externalId

public String externalId()

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

Returns:

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

taskDefinition

public String taskDefinition()

The task definition for the tasks in the task set to use.

Returns:

The task definition for the tasks in the task set to use.

networkConfiguration

public NetworkConfiguration networkConfiguration()

Returns the value of the NetworkConfiguration property for this object.

Returns:

The value of the NetworkConfiguration property for this object.

loadBalancers

public List<LoadBalancer> loadBalancers()

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

serviceRegistries

public List<ServiceRegistry> serviceRegistries()

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

launchType

public LaunchType launchType()

The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

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 that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

launchTypeAsString

public String launchTypeAsString()

The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

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 that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

See Also:

LaunchType

platformVersion

public String platformVersion()

The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.

Returns:

The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.

scale

public Scale scale()

Returns the value of the Scale property for this object.

Returns:

The value of the Scale property for this object.

clientToken

public String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

toBuilder

public CreateTaskSetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTaskSetRequest.Builder,CreateTaskSetRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static CreateTaskSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTaskSetRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo