software.amazon.awssdk.services.rds.model.DescribeReservedDbInstancesRequest 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.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 DescribeReservedDbInstancesRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField RESERVED_DB_INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReservedDBInstanceId").getter(getter(DescribeReservedDbInstancesRequest::reservedDBInstanceId))
.setter(setter(Builder::reservedDBInstanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedDBInstanceId").build())
.build();
private static final SdkField RESERVED_DB_INSTANCES_OFFERING_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReservedDBInstancesOfferingId")
.getter(getter(DescribeReservedDbInstancesRequest::reservedDBInstancesOfferingId))
.setter(setter(Builder::reservedDBInstancesOfferingId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedDBInstancesOfferingId")
.build()).build();
private static final SdkField DB_INSTANCE_CLASS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceClass").getter(getter(DescribeReservedDbInstancesRequest::dbInstanceClass))
.setter(setter(Builder::dbInstanceClass))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceClass").build()).build();
private static final SdkField DURATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Duration").getter(getter(DescribeReservedDbInstancesRequest::duration))
.setter(setter(Builder::duration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Duration").build()).build();
private static final SdkField PRODUCT_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProductDescription").getter(getter(DescribeReservedDbInstancesRequest::productDescription))
.setter(setter(Builder::productDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProductDescription").build())
.build();
private static final SdkField OFFERING_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OfferingType").getter(getter(DescribeReservedDbInstancesRequest::offeringType))
.setter(setter(Builder::offeringType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OfferingType").build()).build();
private static final SdkField MULTI_AZ_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("MultiAZ").getter(getter(DescribeReservedDbInstancesRequest::multiAZ)).setter(setter(Builder::multiAZ))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MultiAZ").build()).build();
private static final SdkField LEASE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LeaseId").getter(getter(DescribeReservedDbInstancesRequest::leaseId)).setter(setter(Builder::leaseId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LeaseId").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeReservedDbInstancesRequest::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(DescribeReservedDbInstancesRequest::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(DescribeReservedDbInstancesRequest::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(RESERVED_DB_INSTANCE_ID_FIELD,
RESERVED_DB_INSTANCES_OFFERING_ID_FIELD, DB_INSTANCE_CLASS_FIELD, DURATION_FIELD, PRODUCT_DESCRIPTION_FIELD,
OFFERING_TYPE_FIELD, MULTI_AZ_FIELD, LEASE_ID_FIELD, FILTERS_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD));
private final String reservedDBInstanceId;
private final String reservedDBInstancesOfferingId;
private final String dbInstanceClass;
private final String duration;
private final String productDescription;
private final String offeringType;
private final Boolean multiAZ;
private final String leaseId;
private final List filters;
private final Integer maxRecords;
private final String marker;
private DescribeReservedDbInstancesRequest(BuilderImpl builder) {
super(builder);
this.reservedDBInstanceId = builder.reservedDBInstanceId;
this.reservedDBInstancesOfferingId = builder.reservedDBInstancesOfferingId;
this.dbInstanceClass = builder.dbInstanceClass;
this.duration = builder.duration;
this.productDescription = builder.productDescription;
this.offeringType = builder.offeringType;
this.multiAZ = builder.multiAZ;
this.leaseId = builder.leaseId;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that
* matches the specified reservation ID.
*
*
* @return The reserved DB instance identifier filter value. Specify this parameter to show only the reservation
* that matches the specified reservation ID.
*/
public final String reservedDBInstanceId() {
return reservedDBInstanceId;
}
/**
*
* The offering identifier filter value. Specify this parameter to show only purchased reservations matching the
* specified offering identifier.
*
*
* @return The offering identifier filter value. Specify this parameter to show only purchased reservations matching
* the specified offering identifier.
*/
public final String reservedDBInstancesOfferingId() {
return reservedDBInstancesOfferingId;
}
/**
*
* The DB instance class filter value. Specify this parameter to show only those reservations matching the specified
* DB instances class.
*
*
* @return The DB instance class filter value. Specify this parameter to show only those reservations matching the
* specified DB instances class.
*/
public final String dbInstanceClass() {
return dbInstanceClass;
}
/**
*
* The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for
* this duration.
*
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*
*
* @return The duration filter value, specified in years or seconds. Specify this parameter to show only
* reservations for this duration.
*
* Valid Values: 1 | 3 | 31536000 | 94608000
*/
public final String duration() {
return duration;
}
/**
*
* The product description filter value. Specify this parameter to show only those reservations matching the
* specified product description.
*
*
* @return The product description filter value. Specify this parameter to show only those reservations matching the
* specified product description.
*/
public final String productDescription() {
return productDescription;
}
/**
*
* The offering type filter value. Specify this parameter to show only the available offerings matching the
* specified offering type.
*
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*
*
* @return The offering type filter value. Specify this parameter to show only the available offerings matching the
* specified offering type.
*
* Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*/
public final String offeringType() {
return offeringType;
}
/**
*
* Specifies whether to show only those reservations that support Multi-AZ.
*
*
* @return Specifies whether to show only those reservations that support Multi-AZ.
*/
public final Boolean multiAZ() {
return multiAZ;
}
/**
*
* The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified
* lease ID.
*
*
*
* Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
*
*
*
* @return The lease identifier filter value. Specify this parameter to show only the reservation that matches the
* specified lease ID.
*
* Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
*
*/
public final String leaseId() {
return leaseId;
}
/**
* 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);
}
/**
*
* This parameter isn't currently supported.
*
*
* 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 This parameter isn't currently supported.
*/
public final List filters() {
return filters;
}
/**
*
* The maximum number of records to include in the response. If more than the MaxRecords
value is
* available, a pagination token called a marker is included in the response so you can retrieve the remaining
* results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @return The maximum number of records to include in the response. If more than the MaxRecords
value
* is available, a pagination token called a marker is included in the response so you can retrieve the
* remaining results.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional pagination token provided by a previous 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 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(reservedDBInstanceId());
hashCode = 31 * hashCode + Objects.hashCode(reservedDBInstancesOfferingId());
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceClass());
hashCode = 31 * hashCode + Objects.hashCode(duration());
hashCode = 31 * hashCode + Objects.hashCode(productDescription());
hashCode = 31 * hashCode + Objects.hashCode(offeringType());
hashCode = 31 * hashCode + Objects.hashCode(multiAZ());
hashCode = 31 * hashCode + Objects.hashCode(leaseId());
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 DescribeReservedDbInstancesRequest)) {
return false;
}
DescribeReservedDbInstancesRequest other = (DescribeReservedDbInstancesRequest) obj;
return Objects.equals(reservedDBInstanceId(), other.reservedDBInstanceId())
&& Objects.equals(reservedDBInstancesOfferingId(), other.reservedDBInstancesOfferingId())
&& Objects.equals(dbInstanceClass(), other.dbInstanceClass()) && Objects.equals(duration(), other.duration())
&& Objects.equals(productDescription(), other.productDescription())
&& Objects.equals(offeringType(), other.offeringType()) && Objects.equals(multiAZ(), other.multiAZ())
&& Objects.equals(leaseId(), other.leaseId()) && 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("DescribeReservedDbInstancesRequest").add("ReservedDBInstanceId", reservedDBInstanceId())
.add("ReservedDBInstancesOfferingId", reservedDBInstancesOfferingId()).add("DBInstanceClass", dbInstanceClass())
.add("Duration", duration()).add("ProductDescription", productDescription()).add("OfferingType", offeringType())
.add("MultiAZ", multiAZ()).add("LeaseId", leaseId()).add("Filters", hasFilters() ? filters() : null)
.add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReservedDBInstanceId":
return Optional.ofNullable(clazz.cast(reservedDBInstanceId()));
case "ReservedDBInstancesOfferingId":
return Optional.ofNullable(clazz.cast(reservedDBInstancesOfferingId()));
case "DBInstanceClass":
return Optional.ofNullable(clazz.cast(dbInstanceClass()));
case "Duration":
return Optional.ofNullable(clazz.cast(duration()));
case "ProductDescription":
return Optional.ofNullable(clazz.cast(productDescription()));
case "OfferingType":
return Optional.ofNullable(clazz.cast(offeringType()));
case "MultiAZ":
return Optional.ofNullable(clazz.cast(multiAZ()));
case "LeaseId":
return Optional.ofNullable(clazz.cast(leaseId()));
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