software.amazon.awssdk.services.opsworks.model

Class DescribeEcsClustersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworks.model.OpsWorksRequest

software.amazon.awssdk.services.opsworks.model.DescribeEcsClustersRequest

All Implemented Interfaces:

ToCopyableBuilder<DescribeEcsClustersRequest.Builder,DescribeEcsClustersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEcsClustersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeEcsClustersRequest.Builder	builder()
List<String>	ecsClusterArns() A list of ARNs, one for each cluster to be described.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call.
String	nextToken() If the previous paginated request did not return all of the remaining results, the response object's NextToken parameter value is set to a token.
static Class<? extends DescribeEcsClustersRequest.Builder>	serializableBuilderClass()
String	stackId() A stack ID.
DescribeEcsClustersRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

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

ecsClusterArns

public List<String> ecsClusterArns()

A list of ARNs, one for each cluster to be described.

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

Returns:

A list of ARNs, one for each cluster to be described.

stackId

public String stackId()

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Returns:

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

nextToken

public String nextToken()

If the previous paginated request did not return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Returns:

If the previous paginated request did not return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

maxResults

public Integer maxResults()

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Returns:

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

toBuilder

public DescribeEcsClustersRequest.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<DescribeEcsClustersRequest.Builder,DescribeEcsClustersRequest>

Specified by:

toBuilder in class OpsWorksRequest

Returns:

a builder for type T

builder

public static DescribeEcsClustersRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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