Package software.amazon.awssdk.services.eks.model

Class DescribeClusterVersionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eks.model.EksRequest

software.amazon.awssdk.services.eks.model.DescribeClusterVersionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeClusterVersionsRequest.Builder,DescribeClusterVersionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeClusterVersionsRequest
extends EksRequest
implements ToCopyableBuilder<DescribeClusterVersionsRequest.Builder,DescribeClusterVersionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeClusterVersionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeClusterVersionsRequest.Builder	builder()
String	clusterType()	The type of cluster to filter versions by.
List<String>	clusterVersions()	List of specific cluster versions to describe.
Boolean	defaultOnly()	Filter to show only default versions.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClusterVersions()	For responses, this returns true if the service returned a value for the ClusterVersions property.
int	hashCode()
Boolean	includeAll()	Include all available versions in the response.
Integer	maxResults()	Maximum number of results to return.
String	nextToken()	Pagination token for the next set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeClusterVersionsRequest.Builder>	serializableBuilderClass()
ClusterVersionStatus	status()	Deprecated. status has been replaced by versionStatus
String	statusAsString()	Deprecated. status has been replaced by versionStatus
DescribeClusterVersionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VersionStatus	versionStatus()	Filter versions by their current status.
String	versionStatusAsString()	Filter versions by their current status.

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

clusterType

public final String clusterType()

The type of cluster to filter versions by.

Returns:

The type of cluster to filter versions by.

maxResults

public final Integer maxResults()

Maximum number of results to return.

Returns:

Maximum number of results to return.

nextToken

public final String nextToken()

Pagination token for the next set of results.

Returns:

Pagination token for the next set of results.

defaultOnly

public final Boolean defaultOnly()

Filter to show only default versions.

Returns:

Filter to show only default versions.

includeAll

public final Boolean includeAll()

Include all available versions in the response.

Returns:

Include all available versions in the response.

hasClusterVersions

public final boolean hasClusterVersions()

For responses, this returns true if the service returned a value for the ClusterVersions 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.

clusterVersions

public final List<String> clusterVersions()

List of specific cluster versions to describe.

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

Returns:

List of specific cluster versions to describe.

status

@Deprecated
public final ClusterVersionStatus status()

Deprecated.

status has been replaced by versionStatus

This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

Filter versions by their current status.

If the service returns an enum value that is not available in the current SDK version, status will return ClusterVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

Filter versions by their current status.

See Also:

ClusterVersionStatus

statusAsString

@Deprecated
public final String statusAsString()

Deprecated.

status has been replaced by versionStatus

This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

Filter versions by their current status.

If the service returns an enum value that is not available in the current SDK version, status will return ClusterVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action.

Filter versions by their current status.

See Also:

ClusterVersionStatus

versionStatus

public final VersionStatus versionStatus()

Filter versions by their current status.

If the service returns an enum value that is not available in the current SDK version, versionStatus will return VersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionStatusAsString().

Returns:

Filter versions by their current status.

See Also:

VersionStatus

versionStatusAsString

public final String versionStatusAsString()

Filter versions by their current status.

If the service returns an enum value that is not available in the current SDK version, versionStatus will return VersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionStatusAsString().

Returns:

Filter versions by their current status.

See Also:

VersionStatus

toBuilder

public DescribeClusterVersionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeClusterVersionsRequest.Builder,DescribeClusterVersionsRequest>

Specified by:

toBuilder in class EksRequest

builder

public static DescribeClusterVersionsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo