Interface DescribeDbRecommendationsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeDbRecommendationsRequest.Builder,DescribeDbRecommendationsRequest>
,RdsRequest.Builder
,SdkBuilder<DescribeDbRecommendationsRequest.Builder,DescribeDbRecommendationsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeDbRecommendationsRequest
public static interface DescribeDbRecommendationsRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeDbRecommendationsRequest.Builder,DescribeDbRecommendationsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DescribeDbRecommendationsRequest.Builder
filters(Collection<Filter> filters)
A filter that specifies one or more recommendations to describe.DescribeDbRecommendationsRequest.Builder
filters(Consumer<Filter.Builder>... filters)
A filter that specifies one or more recommendations to describe.DescribeDbRecommendationsRequest.Builder
filters(Filter... filters)
A filter that specifies one or more recommendations to describe.DescribeDbRecommendationsRequest.Builder
lastUpdatedAfter(Instant lastUpdatedAfter)
A filter to include only the recommendations that were updated after this specified time.DescribeDbRecommendationsRequest.Builder
lastUpdatedBefore(Instant lastUpdatedBefore)
A filter to include only the recommendations that were updated before this specified time.DescribeDbRecommendationsRequest.Builder
locale(String locale)
The language that you choose to return the list of recommendations.DescribeDbRecommendationsRequest.Builder
marker(String marker)
An optional pagination token provided by a previousDescribeDBRecommendations
request.DescribeDbRecommendationsRequest.Builder
maxRecords(Integer maxRecords)
The maximum number of recommendations to include in the response.DescribeDbRecommendationsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeDbRecommendationsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
-
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, sdkFields
-
-
-
-
Method Detail
-
lastUpdatedAfter
DescribeDbRecommendationsRequest.Builder lastUpdatedAfter(Instant lastUpdatedAfter)
A filter to include only the recommendations that were updated after this specified time.
- Parameters:
lastUpdatedAfter
- A filter to include only the recommendations that were updated after this specified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedBefore
DescribeDbRecommendationsRequest.Builder lastUpdatedBefore(Instant lastUpdatedBefore)
A filter to include only the recommendations that were updated before this specified time.
- Parameters:
lastUpdatedBefore
- A filter to include only the recommendations that were updated before this specified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locale
DescribeDbRecommendationsRequest.Builder locale(String locale)
The language that you choose to return the list of recommendations.
Valid values:
-
en
-
en_UK
-
de
-
es
-
fr
-
id
-
it
-
ja
-
ko
-
pt_BR
-
zh_TW
-
zh_CN
- Parameters:
locale
- The language that you choose to return the list of recommendations.Valid values:
-
en
-
en_UK
-
de
-
es
-
fr
-
id
-
it
-
ja
-
ko
-
pt_BR
-
zh_TW
-
zh_CN
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeDbRecommendationsRequest.Builder filters(Collection<Filter> filters)
A filter that specifies one or more recommendations to describe.
Supported Filters:
-
recommendation-id
- Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. -
status
- Accepts a list of recommendation statuses.Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
-
-
severity
- Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.Valid values:
-
high
-
medium
-
low
-
informational
-
-
type-id
- Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. -
dbi-resource-id
- Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. -
cluster-resource-id
- Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. -
pg-arn
- Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. -
cluster-pg-arn
- Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
- Parameters:
filters
- A filter that specifies one or more recommendations to describe.Supported Filters:
-
recommendation-id
- Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. -
status
- Accepts a list of recommendation statuses.Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
-
-
severity
- Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.Valid values:
-
high
-
medium
-
low
-
informational
-
-
type-id
- Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. -
dbi-resource-id
- Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. -
cluster-resource-id
- Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. -
pg-arn
- Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. -
cluster-pg-arn
- Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeDbRecommendationsRequest.Builder filters(Filter... filters)
A filter that specifies one or more recommendations to describe.
Supported Filters:
-
recommendation-id
- Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. -
status
- Accepts a list of recommendation statuses.Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
-
-
severity
- Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.Valid values:
-
high
-
medium
-
low
-
informational
-
-
type-id
- Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. -
dbi-resource-id
- Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. -
cluster-resource-id
- Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. -
pg-arn
- Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. -
cluster-pg-arn
- Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
- Parameters:
filters
- A filter that specifies one or more recommendations to describe.Supported Filters:
-
recommendation-id
- Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. -
status
- Accepts a list of recommendation statuses.Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
-
-
severity
- Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.Valid values:
-
high
-
medium
-
low
-
informational
-
-
type-id
- Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. -
dbi-resource-id
- Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. -
cluster-resource-id
- Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. -
pg-arn
- Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. -
cluster-pg-arn
- Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeDbRecommendationsRequest.Builder filters(Consumer<Filter.Builder>... filters)
A filter that specifies one or more recommendations to describe.
Supported Filters:
-
recommendation-id
- Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. -
status
- Accepts a list of recommendation statuses.Valid values:
-
active
- The recommendations which are ready for you to apply. -
pending
- The applied or scheduled recommendations which are in progress. -
resolved
- The recommendations which are completed. -
dismissed
- The recommendations that you dismissed.
The results list only includes the recommendations whose status is one of the specified filter values.
-
-
severity
- Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.Valid values:
-
high
-
medium
-
low
-
informational
-
-
type-id
- Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. -
dbi-resource-id
- Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. -
cluster-resource-id
- Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. -
pg-arn
- Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. -
cluster-pg-arn
- Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#filters(List
.) - 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:
#filters(java.util.Collection
)
-
-
maxRecords
DescribeDbRecommendationsRequest.Builder maxRecords(Integer maxRecords)
The maximum number of recommendations 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.- Parameters:
maxRecords
- The maximum number of recommendations 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
marker
DescribeDbRecommendationsRequest.Builder marker(String marker)
An optional pagination token provided by a previous
DescribeDBRecommendations
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBRecommendations
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.
-
overrideConfiguration
DescribeDbRecommendationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeDbRecommendationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-