OptionGroupOption (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.rds.model.OptionGroupOption

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<OptionGroupOption.Builder,OptionGroupOption>

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

Available option.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface OptionGroupOption.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OptionGroupOption.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OptionGroupOption.Builder`	`builder()`
`Boolean`	`copyableCrossAccount()` Specifies whether the option can be copied across Amazon Web Services accounts.
`Integer`	`defaultPort()` If the option requires a port, specifies the default port for the option.
`String`	`description()` The description of the option.
`String`	`engineName()` The name of the engine that this option can be applied to.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasOptionGroupOptionSettings()` For responses, this returns true if the service returned a value for the OptionGroupOptionSettings property.
`boolean`	`hasOptionGroupOptionVersions()` For responses, this returns true if the service returned a value for the OptionGroupOptionVersions property.
`boolean`	`hasOptionsConflictsWith()` For responses, this returns true if the service returned a value for the OptionsConflictsWith property.
`boolean`	`hasOptionsDependedOn()` For responses, this returns true if the service returned a value for the OptionsDependedOn property.
`String`	`majorEngineVersion()` Indicates the major engine version that the option is available for.
`String`	`minimumRequiredMinorEngineVersion()` The minimum required engine version for the option to be applied.
`String`	`name()` The name of the option.
`List<OptionGroupOptionSetting>`	`optionGroupOptionSettings()` The option settings that are available (and the default value) for each option in an option group.
`List<OptionVersion>`	`optionGroupOptionVersions()` The versions that are available for the option.
`List<String>`	`optionsConflictsWith()` The options that conflict with this option.
`List<String>`	`optionsDependedOn()` The options that are prerequisites for this option.
`Boolean`	`permanent()` Permanent options can never be removed from an option group.
`Boolean`	`persistent()` Persistent options can't be removed from an option group while DB instances are associated with the option group.
`Boolean`	`portRequired()` Specifies whether the option requires a port.
`Boolean`	`requiresAutoMinorEngineVersionUpgrade()` If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OptionGroupOption.Builder>`	`serializableBuilderClass()`
`Boolean`	`supportsOptionVersionDowngrade()` If true, you can change the option to an earlier version of the option.
`OptionGroupOption.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`vpcOnly()` If true, you can only use this option with a DB instance that is in a VPC.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the option.
    
    Returns:
    
    The name of the option.
  - description
```
public final String description()
```
    The description of the option.
    
    Returns:
    
    The description of the option.
  - engineName
```
public final String engineName()
```
    The name of the engine that this option can be applied to.
    
    Returns:
    
    The name of the engine that this option can be applied to.
  - majorEngineVersion
```
public final String majorEngineVersion()
```
    Indicates the major engine version that the option is available for.
    
    Returns:
    
    Indicates the major engine version that the option is available for.
  - minimumRequiredMinorEngineVersion
```
public final String minimumRequiredMinorEngineVersion()
```
    The minimum required engine version for the option to be applied.
    
    Returns:
    
    The minimum required engine version for the option to be applied.
  - portRequired
```
public final Boolean portRequired()
```
    Specifies whether the option requires a port.
    
    Returns:
    
    Specifies whether the option requires a port.
  - defaultPort
```
public final Integer defaultPort()
```
    If the option requires a port, specifies the default port for the option.
    
    Returns:
    
    If the option requires a port, specifies the default port for the option.
  - hasOptionsDependedOn
```
public final boolean hasOptionsDependedOn()
```
    For responses, this returns true if the service returned a value for the OptionsDependedOn 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.
  - optionsDependedOn
```
public final List<String> optionsDependedOn()
```
    The options that are prerequisites 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 hasOptionsDependedOn() method.
    
    Returns:
    
    The options that are prerequisites for this option.
  - hasOptionsConflictsWith
```
public final boolean hasOptionsConflictsWith()
```
    For responses, this returns true if the service returned a value for the OptionsConflictsWith 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.
  - optionsConflictsWith
```
public final List<String> optionsConflictsWith()
```
    The options that conflict with 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 hasOptionsConflictsWith() method.
    
    Returns:
    
    The options that conflict with this option.
  - persistent
```
public final Boolean persistent()
```
    Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
    
    Returns:
    
    Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
  - permanent
```
public final Boolean permanent()
```
    Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
    
    Returns:
    
    Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
  - requiresAutoMinorEngineVersionUpgrade
```
public final Boolean requiresAutoMinorEngineVersionUpgrade()
```
    If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
    
    Returns:
    
    If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
  - vpcOnly
```
public final Boolean vpcOnly()
```
    If true, you can only use this option with a DB instance that is in a VPC.
    
    Returns:
    
    If true, you can only use this option with a DB instance that is in a VPC.
  - supportsOptionVersionDowngrade
```
public final Boolean supportsOptionVersionDowngrade()
```
    If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
    
    Returns:
    
    If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
  - hasOptionGroupOptionSettings
```
public final boolean hasOptionGroupOptionSettings()
```
    For responses, this returns true if the service returned a value for the OptionGroupOptionSettings 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.
  - optionGroupOptionSettings
```
public final List<OptionGroupOptionSetting> optionGroupOptionSettings()
```
    The option settings that are available (and the default value) for each option in an option group.
    
    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 hasOptionGroupOptionSettings() method.
    
    Returns:
    
    The option settings that are available (and the default value) for each option in an option group.
  - hasOptionGroupOptionVersions
```
public final boolean hasOptionGroupOptionVersions()
```
    For responses, this returns true if the service returned a value for the OptionGroupOptionVersions 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.
  - optionGroupOptionVersions
```
public final List<OptionVersion> optionGroupOptionVersions()
```
    The versions that are available for the 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 hasOptionGroupOptionVersions() method.
    
    Returns:
    
    The versions that are available for the option.
  - copyableCrossAccount
```
public final Boolean copyableCrossAccount()
```
    Specifies whether the option can be copied across Amazon Web Services accounts.
    
    Returns:
    
    Specifies whether the option can be copied across Amazon Web Services accounts.
  - toBuilder
```
public OptionGroupOption.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OptionGroupOption.Builder,OptionGroupOption>
  - builder
```
public static OptionGroupOption.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OptionGroupOption.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class OptionGroupOption

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

engineName

majorEngineVersion

minimumRequiredMinorEngineVersion

portRequired

defaultPort

hasOptionsDependedOn

optionsDependedOn

hasOptionsConflictsWith

optionsConflictsWith

persistent

permanent

requiresAutoMinorEngineVersionUpgrade

vpcOnly

supportsOptionVersionDowngrade

hasOptionGroupOptionSettings

optionGroupOptionSettings

hasOptionGroupOptionVersions

optionGroupOptionVersions

copyableCrossAccount

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields