Package software.amazon.awssdk.services.rds.model

Class DescribeOptionGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.DescribeOptionGroupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeOptionGroupsRequest
extends RdsRequest
implements ToCopyableBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeOptionGroupsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeOptionGroupsRequest.Builder	builder()
String	engineName()	A filter to only include option groups associated with this database engine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	This parameter isn't currently supported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
String	majorEngineVersion()	Filters the list of option groups to only include groups associated with a specific database engine version.
String	marker()	An optional pagination token provided by a previous DescribeOptionGroups request.
Integer	maxRecords()	The maximum number of records to include in the response.
String	optionGroupName()	The name of the option group to describe.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeOptionGroupsRequest.Builder>	serializableBuilderClass()
DescribeOptionGroupsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

optionGroupName

public final String optionGroupName()

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Returns:

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

hasFilters

public final boolean hasFilters()

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

filters

public final List<Filter> filters()

This parameter isn't currently supported.

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

Returns:

This parameter isn't currently supported.

marker

public final String marker()

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

engineName

public final String engineName()

A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Returns:

A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

majorEngineVersion

public final String majorEngineVersion()

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Returns:

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

toBuilder

public DescribeOptionGroupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeOptionGroupsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeOptionGroupsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo