![JAR search and dependency download from the Maven repository](/logo.png)
software.amazon.awssdk.services.rds.model.DescribeDbRecommendationsRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeDbRecommendationsRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField LAST_UPDATED_AFTER_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdatedAfter").getter(getter(DescribeDbRecommendationsRequest::lastUpdatedAfter))
.setter(setter(Builder::lastUpdatedAfter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdatedAfter").build()).build();
private static final SdkField LAST_UPDATED_BEFORE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdatedBefore").getter(getter(DescribeDbRecommendationsRequest::lastUpdatedBefore))
.setter(setter(Builder::lastUpdatedBefore))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdatedBefore").build()).build();
private static final SdkField LOCALE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Locale")
.getter(getter(DescribeDbRecommendationsRequest::locale)).setter(setter(Builder::locale))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Locale").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeDbRecommendationsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").build()).build()).build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeDbRecommendationsRequest::maxRecords))
.setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeDbRecommendationsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LAST_UPDATED_AFTER_FIELD,
LAST_UPDATED_BEFORE_FIELD, LOCALE_FIELD, FILTERS_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD));
private final Instant lastUpdatedAfter;
private final Instant lastUpdatedBefore;
private final String locale;
private final List filters;
private final Integer maxRecords;
private final String marker;
private DescribeDbRecommendationsRequest(BuilderImpl builder) {
super(builder);
this.lastUpdatedAfter = builder.lastUpdatedAfter;
this.lastUpdatedBefore = builder.lastUpdatedBefore;
this.locale = builder.locale;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* A filter to include only the recommendations that were updated after this specified time.
*
*
* @return A filter to include only the recommendations that were updated after this specified time.
*/
public final Instant lastUpdatedAfter() {
return lastUpdatedAfter;
}
/**
*
* A filter to include only the recommendations that were updated before this specified time.
*
*
* @return A filter to include only the recommendations that were updated before this specified time.
*/
public final Instant lastUpdatedBefore() {
return lastUpdatedBefore;
}
/**
*
* 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
*
*
*
*
* @return 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
*
*
*/
public final String locale() {
return locale;
}
/**
* 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 {@code 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.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasFilters} method.
*
*
* @return 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.
*
*
*/
public final List filters() {
return filters;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* 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
.
*
*
* @return 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
.
*/
public final String marker() {
return marker;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedAfter());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedBefore());
hashCode = 31 * hashCode + Objects.hashCode(locale());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeDbRecommendationsRequest)) {
return false;
}
DescribeDbRecommendationsRequest other = (DescribeDbRecommendationsRequest) obj;
return Objects.equals(lastUpdatedAfter(), other.lastUpdatedAfter())
&& Objects.equals(lastUpdatedBefore(), other.lastUpdatedBefore()) && Objects.equals(locale(), other.locale())
&& hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(marker(), other.marker());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeDbRecommendationsRequest").add("LastUpdatedAfter", lastUpdatedAfter())
.add("LastUpdatedBefore", lastUpdatedBefore()).add("Locale", locale())
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "LastUpdatedAfter":
return Optional.ofNullable(clazz.cast(lastUpdatedAfter()));
case "LastUpdatedBefore":
return Optional.ofNullable(clazz.cast(lastUpdatedBefore()));
case "Locale":
return Optional.ofNullable(clazz.cast(locale()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function