Class DecreaseNodeGroupsInGlobalReplicationGroupRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder,
DecreaseNodeGroupsInGlobalReplicationGroupRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates that the shard reconfiguration process begins immediately.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.final String
The name of the Global datastorefinal boolean
For responses, this returns true if the service returned a value for the GlobalNodeGroupsToRemove property.final boolean
For responses, this returns true if the service returned a value for the GlobalNodeGroupsToRetain property.final int
hashCode()
final Integer
The number of node groups (shards) that results from the modification of the shard configurationstatic Class
<? extends DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
globalReplicationGroupId
The name of the Global datastore
- Returns:
- The name of the Global datastore
-
nodeGroupCount
The number of node groups (shards) that results from the modification of the shard configuration
- Returns:
- The number of node groups (shards) that results from the modification of the shard configuration
-
hasGlobalNodeGroupsToRemove
public final boolean hasGlobalNodeGroupsToRemove()For responses, this returns true if the service returned a value for the GlobalNodeGroupsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
globalNodeGroupsToRemove
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
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
hasGlobalNodeGroupsToRemove()
method.- Returns:
- If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
-
hasGlobalNodeGroupsToRetain
public final boolean hasGlobalNodeGroupsToRetain()For responses, this returns true if the service returned a value for the GlobalNodeGroupsToRetain property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
globalNodeGroupsToRetain
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
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
hasGlobalNodeGroupsToRetain()
method.- Returns:
- If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
-
applyImmediately
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
- Returns:
- Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
-
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 interfaceToCopyableBuilder<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder,
DecreaseNodeGroupsInGlobalReplicationGroupRequest> - Specified by:
toBuilder
in classElastiCacheRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-