software.amazon.awssdk.services.rds.model

Class OptionGroup

java.lang.Object

software.amazon.awssdk.services.rds.model.OptionGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OptionGroup.Builder,OptionGroup>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OptionGroup.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowsVpcAndNonVpcInstanceMemberships() Indicates whether this option group can be applied to both VPC and non-VPC instances.
static OptionGroup.Builder	builder()
String	engineName() Indicates the name of the engine that this option group can be applied to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptions() For responses, this returns true if the service returned a value for the Options property.
String	majorEngineVersion() Indicates the major engine version associated with this option group.
String	optionGroupArn() The Amazon Resource Name (ARN) for the option group.
String	optionGroupDescription() Provides a description of the option group.
String	optionGroupName() Specifies the name of the option group.
List<Option>	options() Indicates what options are available in the option group.
List<SdkField<?>>	sdkFields()
static Class<? extends OptionGroup.Builder>	serializableBuilderClass()
OptionGroup.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	vpcId() If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

optionGroupName

public final String optionGroupName()

Specifies the name of the option group.

Returns:

Specifies the name of the option group.

optionGroupDescription

public final String optionGroupDescription()

Provides a description of the option group.

Returns:

Provides a description of the option group.

engineName

public final String engineName()

Indicates the name of the engine that this option group can be applied to.

Returns:

Indicates the name of the engine that this option group can be applied to.

majorEngineVersion

public final String majorEngineVersion()

Indicates the major engine version associated with this option group.

Returns:

Indicates the major engine version associated with this option group.

hasOptions

public final boolean hasOptions()

For responses, this returns true if the service returned a value for the Options 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.

options

public final List<Option> options()

Indicates what options are available in the 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 hasOptions() method.

Returns:

Indicates what options are available in the option group.

allowsVpcAndNonVpcInstanceMemberships

public final Boolean allowsVpcAndNonVpcInstanceMemberships()

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

Returns:

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

vpcId

public final String vpcId()

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

Returns:

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

optionGroupArn

public final String optionGroupArn()

The Amazon Resource Name (ARN) for the option group.

Returns:

The Amazon Resource Name (ARN) for the option group.

toBuilder

public OptionGroup.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<OptionGroup.Builder,OptionGroup>

Returns:

a builder for type T

builder

public static OptionGroup.Builder builder()

serializableBuilderClass

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