Class OptionGroupOptionSetting

java.lang.Object
software.amazon.awssdk.services.rds.model.OptionGroupOptionSetting
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OptionGroupOptionSetting.Builder,OptionGroupOptionSetting>
@Generated("software.amazon.awssdk:codegen") public final class OptionGroupOptionSetting extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OptionGroupOptionSetting.Builder,OptionGroupOptionSetting>

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

See Also:

  • Method Details

    • settingName

      public final String settingName()

      The name of the option group option.

      Returns:
      The name of the option group option.

    • settingDescription

      public final String settingDescription()

      The description of the option group option.

      Returns:
      The description of the option group option.

    • defaultValue

      public final String defaultValue()

      The default value for the option group option.

      Returns:
      The default value for the option group option.

    • applyType

      public final String applyType()

      The DB engine specific parameter type for the option group option.

      Returns:
      The DB engine specific parameter type for the option group option.

    • allowedValues

      public final String allowedValues()

      Indicates the acceptable values for the option group option.

      Returns:
      Indicates the acceptable values for the option group option.

    • isModifiable

      public final Boolean isModifiable()

      Indicates whether this option group option can be changed from the default value.

      Returns:
      Indicates whether this option group option can be changed from the default value.

    • isRequired

      public final Boolean isRequired()

      Indicates whether a value must be specified for this option setting of the option group option.

      Returns:
      Indicates whether a value must be specified for this option setting of the option group option.

    • hasMinimumEngineVersionPerAllowedValue

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

    • minimumEngineVersionPerAllowedValue

      public final List<MinimumEngineVersionPerAllowedValue> minimumEngineVersionPerAllowedValue()

      The minimum DB engine version required for the corresponding allowed value for this option setting.

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

      Returns:
      The minimum DB engine version required for the corresponding allowed value for this option setting.

    • toBuilder

      public OptionGroupOptionSetting.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<OptionGroupOptionSetting.Builder,OptionGroupOptionSetting>
      Returns:
      a builder for type T

    • builder

      public static OptionGroupOptionSetting.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.