Class Option

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

The details of an option.

See Also:

  • Method Details

    • optionName

      public final String optionName()

      The name of the option.

      Returns:
      The name of the option.

    • optionDescription

      public final String optionDescription()

      The description of the option.

      Returns:
      The description of the option.

    • persistent

      public final Boolean persistent()

      Indicates whether this option is persistent.

      Returns:
      Indicates whether this option is persistent.

    • permanent

      public final Boolean permanent()

      Indicates whether this option is permanent.

      Returns:
      Indicates whether this option is permanent.

    • port

      public final Integer port()

      If required, the port configured for this option to use.

      Returns:
      If required, the port configured for this option to use.

    • optionVersion

      public final String optionVersion()

      The version of the option.

      Returns:
      The version of the option.

    • hasOptionSettings

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

    • optionSettings

      public final List<OptionSetting> optionSettings()

      The option settings for this option.

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

      Returns:
      The option settings for this option.

    • hasDbSecurityGroupMemberships

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

    • dbSecurityGroupMemberships

      public final List<DBSecurityGroupMembership> dbSecurityGroupMemberships()

      If the option requires access to a port, then this DB security group allows access to the port.

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

      Returns:
      If the option requires access to a port, then this DB security group allows access to the port.

    • hasVpcSecurityGroupMemberships

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

    • vpcSecurityGroupMemberships

      public final List<VpcSecurityGroupMembership> vpcSecurityGroupMemberships()

      If the option requires access to a port, then this VPC security group allows access to the port.

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

      Returns:
      If the option requires access to a port, then this VPC security group allows access to the port.

    • toBuilder

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

    • builder

      public static Option.Builder builder()

    • serializableBuilderClass

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