software.amazon.awssdk.services.rds.model.ReservedDBInstance Maven / Gradle / Ivy
/*
* 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.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;
/**
*
* This data type is used as a response element in the DescribeReservedDBInstances
and
* PurchaseReservedDBInstancesOffering
actions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ReservedDBInstance implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField RESERVED_DB_INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReservedDBInstanceId").getter(getter(ReservedDBInstance::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(ReservedDBInstance::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(ReservedDBInstance::dbInstanceClass))
.setter(setter(Builder::dbInstanceClass))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceClass").build()).build();
private static final SdkField START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTime").getter(getter(ReservedDBInstance::startTime)).setter(setter(Builder::startTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartTime").build()).build();
private static final SdkField DURATION_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("Duration").getter(getter(ReservedDBInstance::duration)).setter(setter(Builder::duration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Duration").build()).build();
private static final SdkField FIXED_PRICE_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("FixedPrice").getter(getter(ReservedDBInstance::fixedPrice)).setter(setter(Builder::fixedPrice))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FixedPrice").build()).build();
private static final SdkField USAGE_PRICE_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("UsagePrice").getter(getter(ReservedDBInstance::usagePrice)).setter(setter(Builder::usagePrice))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UsagePrice").build()).build();
private static final SdkField CURRENCY_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CurrencyCode").getter(getter(ReservedDBInstance::currencyCode)).setter(setter(Builder::currencyCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CurrencyCode").build()).build();
private static final SdkField DB_INSTANCE_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("DBInstanceCount").getter(getter(ReservedDBInstance::dbInstanceCount))
.setter(setter(Builder::dbInstanceCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceCount").build()).build();
private static final SdkField PRODUCT_DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProductDescription").getter(getter(ReservedDBInstance::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(ReservedDBInstance::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(ReservedDBInstance::multiAZ)).setter(setter(Builder::multiAZ))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MultiAZ").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(ReservedDBInstance::state)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField> RECURRING_CHARGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("RecurringCharges")
.getter(getter(ReservedDBInstance::recurringCharges))
.setter(setter(Builder::recurringCharges))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecurringCharges").build(),
ListTrait
.builder()
.memberLocationName("RecurringCharge")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RecurringCharge::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("RecurringCharge").build()).build()).build()).build();
private static final SdkField RESERVED_DB_INSTANCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReservedDBInstanceArn").getter(getter(ReservedDBInstance::reservedDBInstanceArn))
.setter(setter(Builder::reservedDBInstanceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedDBInstanceArn").build())
.build();
private static final SdkField LEASE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LeaseId").getter(getter(ReservedDBInstance::leaseId)).setter(setter(Builder::leaseId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LeaseId").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, START_TIME_FIELD, DURATION_FIELD,
FIXED_PRICE_FIELD, USAGE_PRICE_FIELD, CURRENCY_CODE_FIELD, DB_INSTANCE_COUNT_FIELD, PRODUCT_DESCRIPTION_FIELD,
OFFERING_TYPE_FIELD, MULTI_AZ_FIELD, STATE_FIELD, RECURRING_CHARGES_FIELD, RESERVED_DB_INSTANCE_ARN_FIELD,
LEASE_ID_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String reservedDBInstanceId;
private final String reservedDBInstancesOfferingId;
private final String dbInstanceClass;
private final Instant startTime;
private final Integer duration;
private final Double fixedPrice;
private final Double usagePrice;
private final String currencyCode;
private final Integer dbInstanceCount;
private final String productDescription;
private final String offeringType;
private final Boolean multiAZ;
private final String state;
private final List recurringCharges;
private final String reservedDBInstanceArn;
private final String leaseId;
private ReservedDBInstance(BuilderImpl builder) {
this.reservedDBInstanceId = builder.reservedDBInstanceId;
this.reservedDBInstancesOfferingId = builder.reservedDBInstancesOfferingId;
this.dbInstanceClass = builder.dbInstanceClass;
this.startTime = builder.startTime;
this.duration = builder.duration;
this.fixedPrice = builder.fixedPrice;
this.usagePrice = builder.usagePrice;
this.currencyCode = builder.currencyCode;
this.dbInstanceCount = builder.dbInstanceCount;
this.productDescription = builder.productDescription;
this.offeringType = builder.offeringType;
this.multiAZ = builder.multiAZ;
this.state = builder.state;
this.recurringCharges = builder.recurringCharges;
this.reservedDBInstanceArn = builder.reservedDBInstanceArn;
this.leaseId = builder.leaseId;
}
/**
*
* The unique identifier for the reservation.
*
*
* @return The unique identifier for the reservation.
*/
public final String reservedDBInstanceId() {
return reservedDBInstanceId;
}
/**
*
* The offering identifier.
*
*
* @return The offering identifier.
*/
public final String reservedDBInstancesOfferingId() {
return reservedDBInstancesOfferingId;
}
/**
*
* The DB instance class for the reserved DB instance.
*
*
* @return The DB instance class for the reserved DB instance.
*/
public final String dbInstanceClass() {
return dbInstanceClass;
}
/**
*
* The time the reservation started.
*
*
* @return The time the reservation started.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* The duration of the reservation in seconds.
*
*
* @return The duration of the reservation in seconds.
*/
public final Integer duration() {
return duration;
}
/**
*
* The fixed price charged for this reserved DB instance.
*
*
* @return The fixed price charged for this reserved DB instance.
*/
public final Double fixedPrice() {
return fixedPrice;
}
/**
*
* The hourly price charged for this reserved DB instance.
*
*
* @return The hourly price charged for this reserved DB instance.
*/
public final Double usagePrice() {
return usagePrice;
}
/**
*
* The currency code for the reserved DB instance.
*
*
* @return The currency code for the reserved DB instance.
*/
public final String currencyCode() {
return currencyCode;
}
/**
*
* The number of reserved DB instances.
*
*
* @return The number of reserved DB instances.
*/
public final Integer dbInstanceCount() {
return dbInstanceCount;
}
/**
*
* The description of the reserved DB instance.
*
*
* @return The description of the reserved DB instance.
*/
public final String productDescription() {
return productDescription;
}
/**
*
* The offering type of this reserved DB instance.
*
*
* @return The offering type of this reserved DB instance.
*/
public final String offeringType() {
return offeringType;
}
/**
*
* Indicates whether the reservation applies to Multi-AZ deployments.
*
*
* @return Indicates whether the reservation applies to Multi-AZ deployments.
*/
public final Boolean multiAZ() {
return multiAZ;
}
/**
*
* The state of the reserved DB instance.
*
*
* @return The state of the reserved DB instance.
*/
public final String state() {
return state;
}
/**
* For responses, this returns true if the service returned a value for the RecurringCharges 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 hasRecurringCharges() {
return recurringCharges != null && !(recurringCharges instanceof SdkAutoConstructList);
}
/**
*
* The recurring price charged to run this reserved DB instance.
*
*
* 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 #hasRecurringCharges} method.
*
*
* @return The recurring price charged to run this reserved DB instance.
*/
public final List recurringCharges() {
return recurringCharges;
}
/**
*
* The Amazon Resource Name (ARN) for the reserved DB instance.
*
*
* @return The Amazon Resource Name (ARN) for the reserved DB instance.
*/
public final String reservedDBInstanceArn() {
return reservedDBInstanceArn;
}
/**
*
* The unique identifier for the lease associated with the reserved DB instance.
*
*
*
* Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
*
*
*
* @return The unique identifier for the lease associated with the reserved DB instance.
*
* Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
*
*/
public final String leaseId() {
return leaseId;
}
@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 + Objects.hashCode(reservedDBInstanceId());
hashCode = 31 * hashCode + Objects.hashCode(reservedDBInstancesOfferingId());
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceClass());
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(duration());
hashCode = 31 * hashCode + Objects.hashCode(fixedPrice());
hashCode = 31 * hashCode + Objects.hashCode(usagePrice());
hashCode = 31 * hashCode + Objects.hashCode(currencyCode());
hashCode = 31 * hashCode + Objects.hashCode(dbInstanceCount());
hashCode = 31 * hashCode + Objects.hashCode(productDescription());
hashCode = 31 * hashCode + Objects.hashCode(offeringType());
hashCode = 31 * hashCode + Objects.hashCode(multiAZ());
hashCode = 31 * hashCode + Objects.hashCode(state());
hashCode = 31 * hashCode + Objects.hashCode(hasRecurringCharges() ? recurringCharges() : null);
hashCode = 31 * hashCode + Objects.hashCode(reservedDBInstanceArn());
hashCode = 31 * hashCode + Objects.hashCode(leaseId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ReservedDBInstance)) {
return false;
}
ReservedDBInstance other = (ReservedDBInstance) obj;
return Objects.equals(reservedDBInstanceId(), other.reservedDBInstanceId())
&& Objects.equals(reservedDBInstancesOfferingId(), other.reservedDBInstancesOfferingId())
&& Objects.equals(dbInstanceClass(), other.dbInstanceClass()) && Objects.equals(startTime(), other.startTime())
&& Objects.equals(duration(), other.duration()) && Objects.equals(fixedPrice(), other.fixedPrice())
&& Objects.equals(usagePrice(), other.usagePrice()) && Objects.equals(currencyCode(), other.currencyCode())
&& Objects.equals(dbInstanceCount(), other.dbInstanceCount())
&& Objects.equals(productDescription(), other.productDescription())
&& Objects.equals(offeringType(), other.offeringType()) && Objects.equals(multiAZ(), other.multiAZ())
&& Objects.equals(state(), other.state()) && hasRecurringCharges() == other.hasRecurringCharges()
&& Objects.equals(recurringCharges(), other.recurringCharges())
&& Objects.equals(reservedDBInstanceArn(), other.reservedDBInstanceArn())
&& Objects.equals(leaseId(), other.leaseId());
}
/**
* 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("ReservedDBInstance").add("ReservedDBInstanceId", reservedDBInstanceId())
.add("ReservedDBInstancesOfferingId", reservedDBInstancesOfferingId()).add("DBInstanceClass", dbInstanceClass())
.add("StartTime", startTime()).add("Duration", duration()).add("FixedPrice", fixedPrice())
.add("UsagePrice", usagePrice()).add("CurrencyCode", currencyCode()).add("DBInstanceCount", dbInstanceCount())
.add("ProductDescription", productDescription()).add("OfferingType", offeringType()).add("MultiAZ", multiAZ())
.add("State", state()).add("RecurringCharges", hasRecurringCharges() ? recurringCharges() : null)
.add("ReservedDBInstanceArn", reservedDBInstanceArn()).add("LeaseId", leaseId()).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 "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "Duration":
return Optional.ofNullable(clazz.cast(duration()));
case "FixedPrice":
return Optional.ofNullable(clazz.cast(fixedPrice()));
case "UsagePrice":
return Optional.ofNullable(clazz.cast(usagePrice()));
case "CurrencyCode":
return Optional.ofNullable(clazz.cast(currencyCode()));
case "DBInstanceCount":
return Optional.ofNullable(clazz.cast(dbInstanceCount()));
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 "State":
return Optional.ofNullable(clazz.cast(state()));
case "RecurringCharges":
return Optional.ofNullable(clazz.cast(recurringCharges()));
case "ReservedDBInstanceArn":
return Optional.ofNullable(clazz.cast(reservedDBInstanceArn()));
case "LeaseId":
return Optional.ofNullable(clazz.cast(leaseId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("ReservedDBInstanceId", RESERVED_DB_INSTANCE_ID_FIELD);
map.put("ReservedDBInstancesOfferingId", RESERVED_DB_INSTANCES_OFFERING_ID_FIELD);
map.put("DBInstanceClass", DB_INSTANCE_CLASS_FIELD);
map.put("StartTime", START_TIME_FIELD);
map.put("Duration", DURATION_FIELD);
map.put("FixedPrice", FIXED_PRICE_FIELD);
map.put("UsagePrice", USAGE_PRICE_FIELD);
map.put("CurrencyCode", CURRENCY_CODE_FIELD);
map.put("DBInstanceCount", DB_INSTANCE_COUNT_FIELD);
map.put("ProductDescription", PRODUCT_DESCRIPTION_FIELD);
map.put("OfferingType", OFFERING_TYPE_FIELD);
map.put("MultiAZ", MULTI_AZ_FIELD);
map.put("State", STATE_FIELD);
map.put("RecurringCharges", RECURRING_CHARGES_FIELD);
map.put("ReservedDBInstanceArn", RESERVED_DB_INSTANCE_ARN_FIELD);
map.put("LeaseId", LEASE_ID_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function