software.amazon.awssdk.services.rds.model

Class Option

java.lang.Object

software.amazon.awssdk.services.rds.model.Option

All Implemented Interfaces:

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

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

Option details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Option.Builder

Method Summary

Modifier and Type	Method and Description
static Option.Builder	builder()
List<DBSecurityGroupMembership>	dbSecurityGroupMemberships() If the option requires access to a port, then this DB security group allows access to the port.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDbSecurityGroupMemberships() For responses, this returns true if the service returned a value for the DBSecurityGroupMemberships property.
int	hashCode()
boolean	hasOptionSettings() For responses, this returns true if the service returned a value for the OptionSettings property.
boolean	hasVpcSecurityGroupMemberships() For responses, this returns true if the service returned a value for the VpcSecurityGroupMemberships property.
String	optionDescription() The description of the option.
String	optionName() The name of the option.
List<OptionSetting>	optionSettings() The option settings for this option.
String	optionVersion() The version of the option.
Boolean	permanent() Indicate if this option is permanent.
Boolean	persistent() Indicate if this option is persistent.
Integer	port() If required, the port configured for this option to use.
List<SdkField<?>>	sdkFields()
static Class<? extends Option.Builder>	serializableBuilderClass()
Option.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<VpcSecurityGroupMembership>	vpcSecurityGroupMemberships() If the option requires access to a port, then this VPC security group allows access to the port.

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

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()

Indicate if this option is persistent.

Returns:

Indicate if this option is persistent.

permanent

public final Boolean permanent()

Indicate if this option is permanent.

Returns:

Indicate if 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()

Specified by:

toBuilder in interface ToCopyableBuilder<Option.Builder,Option>

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)

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