software.amazon.awssdk.services.rds.model

Interface DescribeOptionGroupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>, RDSRequest.Builder, SdkBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>, SdkRequest.Builder

Enclosing class:

DescribeOptionGroupsRequest

public static interface DescribeOptionGroupsRequest.Builder
extends RDSRequest.Builder, CopyableBuilder<DescribeOptionGroupsRequest.Builder,DescribeOptionGroupsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeOptionGroupsRequest.Builder	engineName(String engineName) Filters the list of option groups to only include groups associated with a specific database engine.
DescribeOptionGroupsRequest.Builder	filters(Collection<Filter> filters) This parameter is not currently supported.
DescribeOptionGroupsRequest.Builder	filters(Consumer<Filter.Builder>... filters) This parameter is not currently supported.
DescribeOptionGroupsRequest.Builder	filters(Filter... filters) This parameter is not currently supported.
DescribeOptionGroupsRequest.Builder	majorEngineVersion(String majorEngineVersion) Filters the list of option groups to only include groups associated with a specific database engine version.
DescribeOptionGroupsRequest.Builder	marker(String marker) An optional pagination token provided by a previous DescribeOptionGroups request.
DescribeOptionGroupsRequest.Builder	maxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeOptionGroupsRequest.Builder	optionGroupName(String optionGroupName) The name of the option group to describe.
DescribeOptionGroupsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeOptionGroupsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RDSRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

optionGroupName

DescribeOptionGroupsRequest.Builder optionGroupName(String optionGroupName)

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

Parameters:

optionGroupName - The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeOptionGroupsRequest.Builder filters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeOptionGroupsRequest.Builder filters(Filter... filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeOptionGroupsRequest.Builder filters(Consumer<Filter.Builder>... filters)

This parameter is not currently supported.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(List)

marker

DescribeOptionGroupsRequest.Builder marker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maxRecords

DescribeOptionGroupsRequest.Builder maxRecords(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

engineName

DescribeOptionGroupsRequest.Builder engineName(String engineName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

majorEngineVersion

DescribeOptionGroupsRequest.Builder majorEngineVersion(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

DescribeOptionGroupsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeOptionGroupsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.