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.DecreaseReplicaCountRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DecreaseReplicaCountRequest.Builder,DecreaseReplicaCountRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DecreaseReplicaCountRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`applyImmediately()`	If `True`, the number of replica nodes is decreased immediately.
`static DecreaseReplicaCountRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReplicaConfiguration()`	For responses, this returns true if the service returned a value for the ReplicaConfiguration property.
`boolean`	`hasReplicasToRemove()`	For responses, this returns true if the service returned a value for the ReplicasToRemove property.
`Integer`	`newReplicaCount()`	The number of read replica nodes you want at the completion of this operation.
`List<ConfigureShard>`	`replicaConfiguration()`	A list of `ConfigureShard` objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group.
`List<String>`	`replicasToRemove()`	A list of the node ids to remove from the replication group or node group (shard).
`String`	`replicationGroupId()`	The id of the replication group from which you want to remove replica nodes.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DecreaseReplicaCountRequest.Builder>`	`serializableBuilderClass()`
`DecreaseReplicaCountRequest.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
  - replicationGroupId
```
public final String replicationGroupId()
```
    The id of the replication group from which you want to remove replica nodes.
    
    Returns:
    
    The id of the replication group from which you want to remove replica nodes.
  - newReplicaCount
```
public final Integer newReplicaCount()
```
    The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
    
    The minimum number of replicas in a shard or replication group is:
    
    Valkey or Redis OSS (cluster mode disabled)
    
    If Multi-AZ is enabled: 1
    
    If Multi-AZ is not enabled: 0
    
    Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
    Returns:
    
    The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
    
    The minimum number of replicas in a shard or replication group is:
    
    Valkey or Redis OSS (cluster mode disabled)
    
    If Multi-AZ is enabled: 1
    
    If Multi-AZ is not enabled: 0
    
    Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
  - hasReplicaConfiguration
```
public final boolean hasReplicaConfiguration()
```
    For responses, this returns true if the service returned a value for the ReplicaConfiguration 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.
  - replicaConfiguration
```
public final List<ConfigureShard> replicaConfiguration()
```
    A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
    
    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 hasReplicaConfiguration() method.
    
    Returns:
    
    A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
  - hasReplicasToRemove
```
public final boolean hasReplicasToRemove()
```
    For responses, this returns true if the service returned a value for the ReplicasToRemove 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.
  - replicasToRemove
```
public final List<String> replicasToRemove()
```
    A list of the node ids to remove from the replication group or node group (shard).
    
    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 hasReplicasToRemove() method.
    
    Returns:
    
    A list of the node ids to remove from the replication group or node group (shard).
  - applyImmediately
```
public final Boolean applyImmediately()
```
    If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
    
    Returns:
    
    If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
  - toBuilder
```
public DecreaseReplicaCountRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DecreaseReplicaCountRequest.Builder,DecreaseReplicaCountRequest>
    
    Specified by:
    
    toBuilder in class ElastiCacheRequest
  - builder
```
public static DecreaseReplicaCountRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DecreaseReplicaCountRequest.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

Class DecreaseReplicaCountRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

replicationGroupId

newReplicaCount

hasReplicaConfiguration

replicaConfiguration

hasReplicasToRemove

replicasToRemove

applyImmediately

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField