Class DescribeCapacityProvidersRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeCapacityProvidersRequest.Builder,
DescribeCapacityProvidersRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The short name or full Amazon Resource Name (ARN) of one or more capacity providers.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the CapacityProviders property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Include property.final List
<CapacityProviderField> include()
Specifies whether or not you want to see the resource tags for the capacity provider.Specifies whether or not you want to see the resource tags for the capacity provider.final Integer
The maximum number of account setting results returned byDescribeCapacityProviders
in paginated output.final String
ThenextToken
value returned from a previous paginatedDescribeCapacityProviders
request wheremaxResults
was used and the results exceeded the value of that parameter.static Class
<? extends DescribeCapacityProvidersRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasCapacityProviders
public final boolean hasCapacityProviders()For responses, this returns true if the service returned a value for the CapacityProviders property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCapacityProviders()
method.- 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
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 aren't included in the response.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInclude()
method.- 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 aren't included in the response.
-
hasInclude
public final boolean hasInclude()For responses, this returns true if the service returned a value for the Include property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 aren't included in the response.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInclude()
method.- 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 aren't included in the response.
-
maxResults
The maximum number of account setting results returned by
DescribeCapacityProviders
in paginated output. When this parameter is used,DescribeCapacityProviders
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeCapacityProviders
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter is not used, thenDescribeCapacityProviders
returns up to 10 results and anextToken
value if applicable.- Returns:
- The maximum number of account setting results returned by
DescribeCapacityProviders
in paginated output. When this parameter is used,DescribeCapacityProviders
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeCapacityProviders
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter is not used, thenDescribeCapacityProviders
returns up to 10 results and anextToken
value if applicable.
-
nextToken
The
nextToken
value returned from a previous paginatedDescribeCapacityProviders
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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 paginatedDescribeCapacityProviders
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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
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 interfaceToCopyableBuilder<DescribeCapacityProvidersRequest.Builder,
DescribeCapacityProvidersRequest> - Specified by:
toBuilder
in classEcsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-