Interface DescribeOptionGroupsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeOptionGroupsRequest.Builder,
,DescribeOptionGroupsRequest> RdsRequest.Builder
,SdkBuilder<DescribeOptionGroupsRequest.Builder,
,DescribeOptionGroupsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeOptionGroupsRequest
-
Method Summary
Modifier and TypeMethodDescriptionengineName
(String engineName) A filter to only include option groups associated with this database engine.filters
(Collection<Filter> filters) This parameter isn't currently supported.filters
(Consumer<Filter.Builder>... filters) This parameter isn't currently supported.This parameter isn't currently supported.majorEngineVersion
(String majorEngineVersion) Filters the list of option groups to only include groups associated with a specific database engine version.An optional pagination token provided by a previous DescribeOptionGroups request.maxRecords
(Integer maxRecords) The maximum number of records to include in the response.optionGroupName
(String optionGroupName) The name of the option group to describe.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
optionGroupName
The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
- Parameters:
optionGroupName
- The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
This parameter isn't currently supported.
- Parameters:
filters
- This parameter isn't currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
This parameter isn't currently supported.
- Parameters:
filters
- This parameter isn't currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
This parameter isn't currently supported.
This is a convenience method that creates an instance of theFilter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 byMaxRecords
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
-
overrideConfiguration
DescribeOptionGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeOptionGroupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-