software.amazon.awssdk.services.elasticache.model

Class PendingModifiedValues

java.lang.Object

software.amazon.awssdk.services.elasticache.model.PendingModifiedValues

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PendingModifiedValues.Builder,PendingModifiedValues>

@Generated(value="software.amazon.awssdk:codegen")
public final class PendingModifiedValues
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PendingModifiedValues.Builder,PendingModifiedValues>

A group of settings that are applied to the cluster in the future, or that are currently being applied.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PendingModifiedValues.Builder

Method Summary

Modifier and Type	Method and Description
AuthTokenUpdateStatus	authTokenStatus() The auth token status
String	authTokenStatusAsString() The auth token status
static PendingModifiedValues.Builder	builder()
List<String>	cacheNodeIdsToRemove() A list of cache node IDs that are being removed (or will be removed) from the cluster.
String	cacheNodeType() The cache node type that this cluster or replication group is scaled to.
String	engineVersion() The new cache engine version that the cluster runs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCacheNodeIdsToRemove() For responses, this returns true if the service returned a value for the CacheNodeIdsToRemove property.
int	hashCode()
boolean	hasLogDeliveryConfigurations() For responses, this returns true if the service returned a value for the LogDeliveryConfigurations property.
List<PendingLogDeliveryConfiguration>	logDeliveryConfigurations() The log delivery configurations being modified
Integer	numCacheNodes() The new number of cache nodes for the cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends PendingModifiedValues.Builder>	serializableBuilderClass()
PendingModifiedValues.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	transitEncryptionEnabled() A flag that enables in-transit encryption when set to true.
TransitEncryptionMode	transitEncryptionMode() A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
String	transitEncryptionModeAsString() A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

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

numCacheNodes

public final Integer numCacheNodes()

The new number of cache nodes for the cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

Returns:

The new number of cache nodes for the cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

hasCacheNodeIdsToRemove

public final boolean hasCacheNodeIdsToRemove()

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

cacheNodeIdsToRemove

public final List<String> cacheNodeIdsToRemove()

A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

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

Returns:

A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

engineVersion

public final String engineVersion()

The new cache engine version that the cluster runs.

Returns:

The new cache engine version that the cluster runs.

cacheNodeType

public final String cacheNodeType()

The cache node type that this cluster or replication group is scaled to.

Returns:

The cache node type that this cluster or replication group is scaled to.

authTokenStatus

public final AuthTokenUpdateStatus authTokenStatus()

The auth token status

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

Returns:

The auth token status

See Also:

AuthTokenUpdateStatus

authTokenStatusAsString

public final String authTokenStatusAsString()

The auth token status

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

Returns:

The auth token status

See Also:

AuthTokenUpdateStatus

hasLogDeliveryConfigurations

public final boolean hasLogDeliveryConfigurations()

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

logDeliveryConfigurations

public final List<PendingLogDeliveryConfiguration> logDeliveryConfigurations()

The log delivery configurations being modified

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

Returns:

The log delivery configurations being modified

transitEncryptionEnabled

public final Boolean transitEncryptionEnabled()

A flag that enables in-transit encryption when set to true.

Returns:

A flag that enables in-transit encryption when set to true.

transitEncryptionMode

public final TransitEncryptionMode transitEncryptionMode()

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

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

Returns:

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

See Also:

TransitEncryptionMode

transitEncryptionModeAsString

public final String transitEncryptionModeAsString()

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

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

Returns:

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

See Also:

TransitEncryptionMode

toBuilder

public PendingModifiedValues.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PendingModifiedValues.Builder,PendingModifiedValues>

builder

public static PendingModifiedValues.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo