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(value="software.amazon.awssdk:codegen")
public final class DescribeOptionGroupsRequest
extends RdsRequest
implements ToCopyableBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeOptionGroupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeOptionGroupsRequest.Builder	builder()
String	engineName() Filters the list of option groups to only include groups associated with a specific database engine.
boolean	equals(Object obj)
List<Filter>	filters() This parameter is not currently supported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeOptionGroupsRequest.Builder>	serializableBuilderClass()
DescribeOptionGroupsRequest.Builder	toBuilder()
String	toString()

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

filters

public List<Filter> filters()

This parameter is not currently supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

This parameter is not currently supported.

marker

public 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 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 the remaining results can be retrieved.

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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

engineName

public String engineName()

Filters the list of option groups to only include groups associated with a specific database engine.

Returns:

Filters the list of option groups to only include groups associated with a specific database engine.

majorEngineVersion

public 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo