Class DecreaseNodeGroupsInGlobalReplicationGroupRequest

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.DecreaseNodeGroupsInGlobalReplicationGroupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder,DecreaseNodeGroupsInGlobalReplicationGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class DecreaseNodeGroupsInGlobalReplicationGroupRequest extends ElastiCacheRequest implements ToCopyableBuilder<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder,DecreaseNodeGroupsInGlobalReplicationGroupRequest>

  • Method Details

    • globalReplicationGroupId

      public final String globalReplicationGroupId()

      The name of the Global datastore

      Returns:
      The name of the Global datastore

    • nodeGroupCount

      public final Integer 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 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.

    • globalNodeGroupsToRemove

      public final List<String> 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 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 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 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.

    • globalNodeGroupsToRetain

      public final List<String> 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 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 will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

    • applyImmediately

      public final Boolean 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

      public DecreaseNodeGroupsInGlobalReplicationGroupRequest.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<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder,DecreaseNodeGroupsInGlobalReplicationGroupRequest>
      Specified by:
      toBuilder in class ElastiCacheRequest
      Returns:
      a builder for type T

    • builder

      public static DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder builder()

    • serializableBuilderClass

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