Class DescribeDbRecommendationsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeDbRecommendationsRequest.Builder,
DescribeDbRecommendationsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
A filter that specifies one or more recommendations to describe.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final Instant
A filter to include only the recommendations that were updated after this specified time.final Instant
A filter to include only the recommendations that were updated before this specified time.final String
locale()
The language that you choose to return the list of recommendations.final String
marker()
An optional pagination token provided by a previousDescribeDBRecommendations
request.final Integer
The maximum number of recommendations to include in the response.static Class
<? extends DescribeDbRecommendationsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
lastUpdatedAfter
A filter to include only the recommendations that were updated after this specified time.
- Returns:
- A filter to include only the recommendations that were updated after this specified time.
-
lastUpdatedBefore
A filter to include only the recommendations that were updated before this specified time.
- Returns:
- A filter to include only the recommendations that were updated before this specified time.
-
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:
- 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
-
-
-
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 theisEmpty()
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
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.
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:
- 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.
-
-
-
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.- Returns:
- 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.
-
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
.- Returns:
- 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
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeDbRecommendationsRequest.Builder,
DescribeDbRecommendationsRequest> - Specified by:
toBuilder
in classRdsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-