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:

SdkPojo, ToCopyableBuilder<DescribeEcsClustersRequest.Builder,DescribeEcsClustersRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEcsClusterArns() For responses, this returns true if the service returned a value for the EcsClusterArns property.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEcsClustersRequest.Builder>	serializableBuilderClass()
String	stackId() A stack ID.
DescribeEcsClustersRequest.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

hasEcsClusterArns

public final boolean hasEcsClusterArns()

For responses, this returns true if the service returned a value for the EcsClusterArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

ecsClusterArns

public final 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.

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 hasEcsClusterArns() method.

Returns:

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

stackId

public final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEcsClustersRequest.Builder,DescribeEcsClustersRequest>

Specified by:

toBuilder in class OpsWorksRequest

builder

public static DescribeEcsClustersRequest.Builder builder()

serializableBuilderClass

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