software.amazon.awssdk.services.opensearch.model.ReservedInstance Maven / Gradle / Ivy
Show all versions of opensearch 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.opensearch.model;
import java.beans.Transient;
import java.io.Serializable;
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.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;
/**
*
* Details of a reserved OpenSearch instance.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ReservedInstance implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField RESERVATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReservationName").getter(getter(ReservedInstance::reservationName))
.setter(setter(Builder::reservationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservationName").build()).build();
private static final SdkField RESERVED_INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReservedInstanceId").getter(getter(ReservedInstance::reservedInstanceId))
.setter(setter(Builder::reservedInstanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedInstanceId").build())
.build();
private static final SdkField BILLING_SUBSCRIPTION_ID_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("BillingSubscriptionId").getter(getter(ReservedInstance::billingSubscriptionId))
.setter(setter(Builder::billingSubscriptionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BillingSubscriptionId").build())
.build();
private static final SdkField RESERVED_INSTANCE_OFFERING_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReservedInstanceOfferingId")
.getter(getter(ReservedInstance::reservedInstanceOfferingId))
.setter(setter(Builder::reservedInstanceOfferingId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedInstanceOfferingId").build())
.build();
private static final SdkField INSTANCE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceType").getter(getter(ReservedInstance::instanceTypeAsString))
.setter(setter(Builder::instanceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceType").build()).build();
private static final SdkField START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTime").getter(getter(ReservedInstance::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(ReservedInstance::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(ReservedInstance::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(ReservedInstance::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(ReservedInstance::currencyCode)).setter(setter(Builder::currencyCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CurrencyCode").build()).build();
private static final SdkField INSTANCE_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("InstanceCount").getter(getter(ReservedInstance::instanceCount)).setter(setter(Builder::instanceCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceCount").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(ReservedInstance::state)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField PAYMENT_OPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PaymentOption").getter(getter(ReservedInstance::paymentOptionAsString))
.setter(setter(Builder::paymentOption))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PaymentOption").build()).build();
private static final SdkField> RECURRING_CHARGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("RecurringCharges")
.getter(getter(ReservedInstance::recurringCharges))
.setter(setter(Builder::recurringCharges))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RecurringCharges").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RecurringCharge::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESERVATION_NAME_FIELD,
RESERVED_INSTANCE_ID_FIELD, BILLING_SUBSCRIPTION_ID_FIELD, RESERVED_INSTANCE_OFFERING_ID_FIELD, INSTANCE_TYPE_FIELD,
START_TIME_FIELD, DURATION_FIELD, FIXED_PRICE_FIELD, USAGE_PRICE_FIELD, CURRENCY_CODE_FIELD, INSTANCE_COUNT_FIELD,
STATE_FIELD, PAYMENT_OPTION_FIELD, RECURRING_CHARGES_FIELD));
private static final long serialVersionUID = 1L;
private final String reservationName;
private final String reservedInstanceId;
private final Long billingSubscriptionId;
private final String reservedInstanceOfferingId;
private final String instanceType;
private final Instant startTime;
private final Integer duration;
private final Double fixedPrice;
private final Double usagePrice;
private final String currencyCode;
private final Integer instanceCount;
private final String state;
private final String paymentOption;
private final List recurringCharges;
private ReservedInstance(BuilderImpl builder) {
this.reservationName = builder.reservationName;
this.reservedInstanceId = builder.reservedInstanceId;
this.billingSubscriptionId = builder.billingSubscriptionId;
this.reservedInstanceOfferingId = builder.reservedInstanceOfferingId;
this.instanceType = builder.instanceType;
this.startTime = builder.startTime;
this.duration = builder.duration;
this.fixedPrice = builder.fixedPrice;
this.usagePrice = builder.usagePrice;
this.currencyCode = builder.currencyCode;
this.instanceCount = builder.instanceCount;
this.state = builder.state;
this.paymentOption = builder.paymentOption;
this.recurringCharges = builder.recurringCharges;
}
/**
*
* The customer-specified identifier to track this reservation.
*
*
* @return The customer-specified identifier to track this reservation.
*/
public final String reservationName() {
return reservationName;
}
/**
*
* The unique identifier for the reservation.
*
*
* @return The unique identifier for the reservation.
*/
public final String reservedInstanceId() {
return reservedInstanceId;
}
/**
* Returns the value of the BillingSubscriptionId property for this object.
*
* @return The value of the BillingSubscriptionId property for this object.
*/
public final Long billingSubscriptionId() {
return billingSubscriptionId;
}
/**
*
* The offering identifier.
*
*
* @return The offering identifier.
*/
public final String reservedInstanceOfferingId() {
return reservedInstanceOfferingId;
}
/**
*
* The OpenSearch instance type offered by the reserved instance offering.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #instanceType} will
* return {@link OpenSearchPartitionInstanceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #instanceTypeAsString}.
*
*
* @return The OpenSearch instance type offered by the reserved instance offering.
* @see OpenSearchPartitionInstanceType
*/
public final OpenSearchPartitionInstanceType instanceType() {
return OpenSearchPartitionInstanceType.fromValue(instanceType);
}
/**
*
* The OpenSearch instance type offered by the reserved instance offering.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #instanceType} will
* return {@link OpenSearchPartitionInstanceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #instanceTypeAsString}.
*
*
* @return The OpenSearch instance type offered by the reserved instance offering.
* @see OpenSearchPartitionInstanceType
*/
public final String instanceTypeAsString() {
return instanceType;
}
/**
*
* The time the reservation started.
*
*
* @return The time the reservation started.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* The duration, in seconds, for which the OpenSearch instance is reserved.
*
*
* @return The duration, in seconds, for which the OpenSearch instance is reserved.
*/
public final Integer duration() {
return duration;
}
/**
*
* The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
*
*
* @return The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
*/
public final Double fixedPrice() {
return fixedPrice;
}
/**
*
* The rate you are charged for each hour for the domain that is using this reserved instance.
*
*
* @return The rate you are charged for each hour for the domain that is using this reserved instance.
*/
public final Double usagePrice() {
return usagePrice;
}
/**
*
* The currency code for the reserved OpenSearch instance offering.
*
*
* @return The currency code for the reserved OpenSearch instance offering.
*/
public final String currencyCode() {
return currencyCode;
}
/**
*
* The number of OpenSearch instances that have been reserved.
*
*
* @return The number of OpenSearch instances that have been reserved.
*/
public final Integer instanceCount() {
return instanceCount;
}
/**
*
* The state of the reserved OpenSearch instance.
*
*
* @return The state of the reserved OpenSearch instance.
*/
public final String state() {
return state;
}
/**
*
* The payment option as defined in the reserved OpenSearch instance offering.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #paymentOption}
* will return {@link ReservedInstancePaymentOption#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #paymentOptionAsString}.
*
*
* @return The payment option as defined in the reserved OpenSearch instance offering.
* @see ReservedInstancePaymentOption
*/
public final ReservedInstancePaymentOption paymentOption() {
return ReservedInstancePaymentOption.fromValue(paymentOption);
}
/**
*
* The payment option as defined in the reserved OpenSearch instance offering.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #paymentOption}
* will return {@link ReservedInstancePaymentOption#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #paymentOptionAsString}.
*
*
* @return The payment option as defined in the reserved OpenSearch instance offering.
* @see ReservedInstancePaymentOption
*/
public final String paymentOptionAsString() {
return paymentOption;
}
/**
* 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 charge to your account regardless of whether you are creating any domains using the instance offering.
*
*
* 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 charge to your account regardless of whether you are creating any domains using the instance
* offering.
*/
public final List recurringCharges() {
return recurringCharges;
}
@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(reservationName());
hashCode = 31 * hashCode + Objects.hashCode(reservedInstanceId());
hashCode = 31 * hashCode + Objects.hashCode(billingSubscriptionId());
hashCode = 31 * hashCode + Objects.hashCode(reservedInstanceOfferingId());
hashCode = 31 * hashCode + Objects.hashCode(instanceTypeAsString());
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(instanceCount());
hashCode = 31 * hashCode + Objects.hashCode(state());
hashCode = 31 * hashCode + Objects.hashCode(paymentOptionAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasRecurringCharges() ? recurringCharges() : null);
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 ReservedInstance)) {
return false;
}
ReservedInstance other = (ReservedInstance) obj;
return Objects.equals(reservationName(), other.reservationName())
&& Objects.equals(reservedInstanceId(), other.reservedInstanceId())
&& Objects.equals(billingSubscriptionId(), other.billingSubscriptionId())
&& Objects.equals(reservedInstanceOfferingId(), other.reservedInstanceOfferingId())
&& Objects.equals(instanceTypeAsString(), other.instanceTypeAsString())
&& 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(instanceCount(), other.instanceCount())
&& Objects.equals(state(), other.state())
&& Objects.equals(paymentOptionAsString(), other.paymentOptionAsString())
&& hasRecurringCharges() == other.hasRecurringCharges()
&& Objects.equals(recurringCharges(), other.recurringCharges());
}
/**
* 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("ReservedInstance").add("ReservationName", reservationName())
.add("ReservedInstanceId", reservedInstanceId()).add("BillingSubscriptionId", billingSubscriptionId())
.add("ReservedInstanceOfferingId", reservedInstanceOfferingId()).add("InstanceType", instanceTypeAsString())
.add("StartTime", startTime()).add("Duration", duration()).add("FixedPrice", fixedPrice())
.add("UsagePrice", usagePrice()).add("CurrencyCode", currencyCode()).add("InstanceCount", instanceCount())
.add("State", state()).add("PaymentOption", paymentOptionAsString())
.add("RecurringCharges", hasRecurringCharges() ? recurringCharges() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReservationName":
return Optional.ofNullable(clazz.cast(reservationName()));
case "ReservedInstanceId":
return Optional.ofNullable(clazz.cast(reservedInstanceId()));
case "BillingSubscriptionId":
return Optional.ofNullable(clazz.cast(billingSubscriptionId()));
case "ReservedInstanceOfferingId":
return Optional.ofNullable(clazz.cast(reservedInstanceOfferingId()));
case "InstanceType":
return Optional.ofNullable(clazz.cast(instanceTypeAsString()));
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 "InstanceCount":
return Optional.ofNullable(clazz.cast(instanceCount()));
case "State":
return Optional.ofNullable(clazz.cast(state()));
case "PaymentOption":
return Optional.ofNullable(clazz.cast(paymentOptionAsString()));
case "RecurringCharges":
return Optional.ofNullable(clazz.cast(recurringCharges()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function