Class CacheNodeTypeSpecificParameter

java.lang.Object
software.amazon.awssdk.services.elasticache.model.CacheNodeTypeSpecificParameter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CacheNodeTypeSpecificParameter.Builder,CacheNodeTypeSpecificParameter>

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

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

See Also:
  • Method Details

    • parameterName

      public final String parameterName()

      The name of the parameter.

      Returns:
      The name of the parameter.
    • description

      public final String description()

      A description of the parameter.

      Returns:
      A description of the parameter.
    • source

      public final String source()

      The source of the parameter value.

      Returns:
      The source of the parameter value.
    • dataType

      public final String dataType()

      The valid data type for the parameter.

      Returns:
      The valid data type for the parameter.
    • allowedValues

      public final String allowedValues()

      The valid range of values for the parameter.

      Returns:
      The valid range of values for the parameter.
    • isModifiable

      public final Boolean isModifiable()

      Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      Returns:
      Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    • minimumEngineVersion

      public final String minimumEngineVersion()

      The earliest cache engine version to which the parameter can apply.

      Returns:
      The earliest cache engine version to which the parameter can apply.
    • hasCacheNodeTypeSpecificValues

      public final boolean hasCacheNodeTypeSpecificValues()
      For responses, this returns true if the service returned a value for the CacheNodeTypeSpecificValues 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.
    • cacheNodeTypeSpecificValues

      public final List<CacheNodeTypeSpecificValue> cacheNodeTypeSpecificValues()

      A list of cache node types and their corresponding values for this parameter.

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

      Returns:
      A list of cache node types and their corresponding values for this parameter.
    • changeType

      public final ChangeType changeType()

      Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

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

      Returns:
      Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
      See Also:
    • changeTypeAsString

      public final String changeTypeAsString()

      Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

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

      Returns:
      Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
      See Also:
    • 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<CacheNodeTypeSpecificParameter.Builder,CacheNodeTypeSpecificParameter>
      Returns:
      a builder for type T
    • builder

      public static CacheNodeTypeSpecificParameter.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CacheNodeTypeSpecificParameter.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)
      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)
    • 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.