Class Option

    • Method Detail

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