Class GetRdsDatabaseRecommendationsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetRdsDatabaseRecommendationsRequest.Builder,GetRdsDatabaseRecommendationsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionReturn the Amazon RDS recommendations to the specified Amazon Web Services account IDs.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List<RDSDBRecommendationFilter> filters()An array of objects to specify a filter that returns a more specific list of Amazon RDS recommendations.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the AccountIds property.final booleanFor responses, this returns true if the service returned a value for the Filters property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the ResourceArns property.final IntegerThe maximum number of Amazon RDS recommendations to return with a single request.final StringThe token to advance to the next page of Amazon RDS recommendations.Returns the value of the RecommendationPreferences property for this object.The ARN that identifies the Amazon RDS.static Class<? extends GetRdsDatabaseRecommendationsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasResourceArns
public final boolean hasResourceArns()For responses, this returns true if the service returned a value for the ResourceArns 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. -
resourceArns
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}The following is the format of a DB Cluster ARN:
arn:aws:rds:{region}:{accountId}:cluster:{resourceName}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
hasResourceArns()method.- Returns:
- The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}The following is the format of a DB Cluster ARN:
arn:aws:rds:{region}:{accountId}:cluster:{resourceName}
-
nextToken
The token to advance to the next page of Amazon RDS recommendations.
- Returns:
- The token to advance to the next page of Amazon RDS recommendations.
-
maxResults
The maximum number of Amazon RDS recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextTokenvalue.- Returns:
- The maximum number of Amazon RDS recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextTokenvalue.
-
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
An array of objects to specify a filter that returns a more specific list of Amazon RDS recommendations.
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:
- An array of objects to specify a filter that returns a more specific list of Amazon RDS recommendations.
-
hasAccountIds
public final boolean hasAccountIds()For responses, this returns true if the service returned a value for the AccountIds 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. -
accountIds
Return the Amazon RDS recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon RDS recommendations to specific member accounts.
You can only specify one account ID per request.
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
hasAccountIds()method.- Returns:
- Return the Amazon RDS recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon RDS recommendations to specific member accounts.
You can only specify one account ID per request.
-
recommendationPreferences
Returns the value of the RecommendationPreferences property for this object.- Returns:
- The value of the RecommendationPreferences property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetRdsDatabaseRecommendationsRequest.Builder,GetRdsDatabaseRecommendationsRequest> - Specified by:
toBuilderin classComputeOptimizerRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetRdsDatabaseRecommendationsRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkRequestUsed 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:
getValueForFieldin 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
-