Package software.amazon.awssdk.services.elasticache.model

Class DecreaseReplicaCountRequest

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>

  • Method Details

    • 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 Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (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:

      • Redis (cluster mode disabled)

        • If Multi-AZ is enabled: 1

        • If Multi-AZ is not enabled: 0

      • Redis (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 Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (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:

      • Redis (cluster mode disabled)

        • If Multi-AZ is enabled: 1

        • If Multi-AZ is not enabled: 0

      • Redis (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 Redis (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 Redis (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()
      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<DecreaseReplicaCountRequest.Builder,DecreaseReplicaCountRequest>
      Specified by:
      toBuilder in class ElastiCacheRequest
      Returns:
      a builder for type T

    • 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)
      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.