Package software.amazon.awssdk.services.rds.model

Class DescribeDbRecommendationsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbRecommendationsRequest.Builder,DescribeDbRecommendationsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeDbRecommendationsRequest
extends RdsRequest
implements ToCopyableBuilder<DescribeDbRecommendationsRequest.Builder,DescribeDbRecommendationsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDbRecommendationsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDbRecommendationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	A filter that specifies one or more recommendations to describe.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Instant	lastUpdatedAfter()	A filter to include only the recommendations that were updated after this specified time.
Instant	lastUpdatedBefore()	A filter to include only the recommendations that were updated before this specified time.
String	locale()	The language that you choose to return the list of recommendations.
String	marker()	An optional pagination token provided by a previous DescribeDBRecommendations request.
Integer	maxRecords()	The maximum number of recommendations to include in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbRecommendationsRequest.Builder>	serializableBuilderClass()
DescribeDbRecommendationsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

lastUpdatedAfter

public final Instant 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

public final Instant 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

public final 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

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 the isEmpty() 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

public final List<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.

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

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

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

public final 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 by MaxRecords.

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

toBuilder

public DescribeDbRecommendationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDbRecommendationsRequest.Builder,DescribeDbRecommendationsRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeDbRecommendationsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDbRecommendationsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo