software.amazon.awssdk.services.ecs.model

Class DescribeCapacityProvidersRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCapacityProvidersRequest.Builder,DescribeCapacityProvidersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCapacityProvidersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCapacityProvidersRequest.Builder	builder()
List<String>	capacityProviders() The short name or full Amazon Resource Name (ARN) of one or more capacity providers.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCapacityProviders() Returns true if the CapacityProviders 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	hasInclude() Returns true if the Include property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<CapacityProviderField>	include() Specifies whether or not you want to see the resource tags for the capacity provider.
List<String>	includeAsStrings() Specifies whether or not you want to see the resource tags for the capacity provider.
Integer	maxResults() The maximum number of account setting results returned by DescribeCapacityProviders in paginated output.
String	nextToken() The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCapacityProvidersRequest.Builder>	serializableBuilderClass()
DescribeCapacityProvidersRequest.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

hasCapacityProviders

public final boolean hasCapacityProviders()

Returns true if the CapacityProviders 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.

capacityProviders

public final List<String> capacityProviders()

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

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

You can use hasCapacityProviders() to see if a value was sent in this field.

Returns:

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

include

public final List<CapacityProviderField> include()

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

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

You can use hasInclude() to see if a value was sent in this field.

Returns:

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

hasInclude

public final boolean hasInclude()

Returns true if the Include 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.

includeAsStrings

public final List<String> includeAsStrings()

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

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

You can use hasInclude() to see if a value was sent in this field.

Returns:

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

maxResults

public final Integer maxResults()

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

Returns:

The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

nextToken

public final String nextToken()

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

toBuilder

public DescribeCapacityProvidersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCapacityProvidersRequest.Builder,DescribeCapacityProvidersRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static DescribeCapacityProvidersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeCapacityProvidersRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo