software.amazon.awssdk.services.ecs.model

Interface DescribeClustersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>, EcsRequest.Builder, SdkBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeClustersRequest

public static interface DescribeClustersRequest.Builder
extends EcsRequest.Builder, SdkPojo, CopyableBuilder<DescribeClustersRequest.Builder,DescribeClustersRequest>

Method Summary

Modifier and Type	Method and Description
DescribeClustersRequest.Builder	clusters(Collection<String> clusters) A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.
DescribeClustersRequest.Builder	clusters(String... clusters) A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.
DescribeClustersRequest.Builder	include(ClusterField... include) Whether to include additional information about your clusters in the response.
DescribeClustersRequest.Builder	include(Collection<ClusterField> include) Whether to include additional information about your clusters in the response.
DescribeClustersRequest.Builder	includeWithStrings(Collection<String> include) Whether to include additional information about your clusters in the response.
DescribeClustersRequest.Builder	includeWithStrings(String... include) Whether to include additional information about your clusters in the response.
DescribeClustersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeClustersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clusters

DescribeClustersRequest.Builder clusters(Collection<String> clusters)

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Parameters:

clusters - A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. 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.

clusters

DescribeClustersRequest.Builder clusters(String... clusters)

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

Parameters:

clusters - A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. 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.

includeWithStrings

DescribeClustersRequest.Builder includeWithStrings(Collection<String> include)

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Parameters:

include - Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

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

includeWithStrings

DescribeClustersRequest.Builder includeWithStrings(String... include)

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Parameters:

include - Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

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

include

DescribeClustersRequest.Builder include(Collection<ClusterField> include)

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Parameters:

include - Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

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

include

DescribeClustersRequest.Builder include(ClusterField... include)

Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Parameters:

include - Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included.

If SETTINGS is specified, the settings for the cluster are included.

If STATISTICS is specified, the following additional information, separated by launch type, is included:

• runningEC2TasksCount

• runningFargateTasksCount

• pendingEC2TasksCount

• pendingFargateTasksCount

• activeEC2ServiceCount

• activeFargateServiceCount

• drainingEC2ServiceCount

• drainingFargateServiceCount

If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

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

overrideConfiguration

DescribeClustersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeClustersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder