software.amazon.awssdk.services.elasticache.model

Class DescribeCacheEngineVersionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCacheEngineVersionsRequest.Builder,DescribeCacheEngineVersionsRequest>

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

Represents the input of a DescribeCacheEngineVersions operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCacheEngineVersionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCacheEngineVersionsRequest.Builder	builder()
String	cacheParameterGroupFamily() The name of a specific cache parameter group family to return details for.
Boolean	defaultOnly() If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
String	engine() The cache engine to return.
String	engineVersion() The cache engine version to return.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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()
String	marker() An optional marker returned from a prior request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCacheEngineVersionsRequest.Builder>	serializableBuilderClass()
DescribeCacheEngineVersionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

engine

public final String engine()

The cache engine to return. Valid values: memcached | redis

Returns:

The cache engine to return. Valid values: memcached | redis

engineVersion

public final String engineVersion()

The cache engine version to return.

Example: 1.4.14

Returns:

The cache engine version to return.

Example: 1.4.14

cacheParameterGroupFamily

public final String cacheParameterGroupFamily()

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

marker

public final String marker()

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

defaultOnly

public final Boolean defaultOnly()

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Returns:

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

toBuilder

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

Specified by:

toBuilder in class ElastiCacheRequest

Returns:

a builder for type T

builder

public static DescribeCacheEngineVersionsRequest.Builder builder()

serializableBuilderClass

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

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.