software.amazon.awssdk.services.opensearch.model.ReservedInstanceOffering 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.opensearch.model;
import java.io.Serializable;
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 an OpenSearch Reserved Instance offering.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ReservedInstanceOffering implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField RESERVED_INSTANCE_OFFERING_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReservedInstanceOfferingId")
.getter(getter(ReservedInstanceOffering::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(ReservedInstanceOffering::instanceTypeAsString))
.setter(setter(Builder::instanceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceType").build()).build();
private static final SdkField DURATION_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("Duration").getter(getter(ReservedInstanceOffering::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(ReservedInstanceOffering::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(ReservedInstanceOffering::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(ReservedInstanceOffering::currencyCode))
.setter(setter(Builder::currencyCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CurrencyCode").build()).build();
private static final SdkField PAYMENT_OPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PaymentOption").getter(getter(ReservedInstanceOffering::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(ReservedInstanceOffering::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(
RESERVED_INSTANCE_OFFERING_ID_FIELD, INSTANCE_TYPE_FIELD, DURATION_FIELD, FIXED_PRICE_FIELD, USAGE_PRICE_FIELD,
CURRENCY_CODE_FIELD, PAYMENT_OPTION_FIELD, RECURRING_CHARGES_FIELD));
private static final long serialVersionUID = 1L;
private final String reservedInstanceOfferingId;
private final String instanceType;
private final Integer duration;
private final Double fixedPrice;
private final Double usagePrice;
private final String currencyCode;
private final String paymentOption;
private final List recurringCharges;
private ReservedInstanceOffering(BuilderImpl builder) {
this.reservedInstanceOfferingId = builder.reservedInstanceOfferingId;
this.instanceType = builder.instanceType;
this.duration = builder.duration;
this.fixedPrice = builder.fixedPrice;
this.usagePrice = builder.usagePrice;
this.currencyCode = builder.currencyCode;
this.paymentOption = builder.paymentOption;
this.recurringCharges = builder.recurringCharges;
}
/**
*
* The unique identifier of the Reserved Instance offering.
*
*
* @return The unique identifier of the Reserved Instance offering.
*/
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 duration, in seconds, for which the offering will reserve the OpenSearch instance.
*
*
* @return The duration, in seconds, for which the offering will reserve the OpenSearch instance.
*/
public final Integer duration() {
return duration;
}
/**
*
* The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
*
*
* @return The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
*/
public final Double fixedPrice() {
return fixedPrice;
}
/**
*
* The hourly rate at which you're charged for the domain using this Reserved Instance.
*
*
* @return The hourly rate at which you're charged for the domain using this Reserved Instance.
*/
public final Double usagePrice() {
return usagePrice;
}
/**
*
* The currency code for the Reserved Instance offering.
*
*
* @return The currency code for the Reserved Instance offering.
*/
public final String currencyCode() {
return currencyCode;
}
/**
*
* Payment option for the Reserved 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 Payment option for the Reserved Instance offering
* @see ReservedInstancePaymentOption
*/
public final ReservedInstancePaymentOption paymentOption() {
return ReservedInstancePaymentOption.fromValue(paymentOption);
}
/**
*
* Payment option for the Reserved 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 Payment option for the Reserved 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 recurring charge to your account, regardless of whether you creates any domains using the 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 recurring charge to your account, regardless of whether you creates any domains using the 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 serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(reservedInstanceOfferingId());
hashCode = 31 * hashCode + Objects.hashCode(instanceTypeAsString());
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(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 ReservedInstanceOffering)) {
return false;
}
ReservedInstanceOffering other = (ReservedInstanceOffering) obj;
return Objects.equals(reservedInstanceOfferingId(), other.reservedInstanceOfferingId())
&& Objects.equals(instanceTypeAsString(), other.instanceTypeAsString())
&& Objects.equals(duration(), other.duration()) && Objects.equals(fixedPrice(), other.fixedPrice())
&& Objects.equals(usagePrice(), other.usagePrice()) && Objects.equals(currencyCode(), other.currencyCode())
&& 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("ReservedInstanceOffering").add("ReservedInstanceOfferingId", reservedInstanceOfferingId())
.add("InstanceType", instanceTypeAsString()).add("Duration", duration()).add("FixedPrice", fixedPrice())
.add("UsagePrice", usagePrice()).add("CurrencyCode", currencyCode())
.add("PaymentOption", paymentOptionAsString())
.add("RecurringCharges", hasRecurringCharges() ? recurringCharges() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReservedInstanceOfferingId":
return Optional.ofNullable(clazz.cast(reservedInstanceOfferingId()));
case "InstanceType":
return Optional.ofNullable(clazz.cast(instanceTypeAsString()));
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 "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 getter(Function g) {
return obj -> g.apply((ReservedInstanceOffering) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier of the Reserved Instance offering.
*
*
* @param reservedInstanceOfferingId
* The unique identifier of the Reserved Instance offering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reservedInstanceOfferingId(String reservedInstanceOfferingId);
/**
*
* The OpenSearch instance type offered by the Reserved Instance offering.
*
*
* @param instanceType
* The OpenSearch instance type offered by the Reserved Instance offering.
* @see OpenSearchPartitionInstanceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see OpenSearchPartitionInstanceType
*/
Builder instanceType(String instanceType);
/**
*
* The OpenSearch instance type offered by the Reserved Instance offering.
*
*
* @param instanceType
* The OpenSearch instance type offered by the Reserved Instance offering.
* @see OpenSearchPartitionInstanceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see OpenSearchPartitionInstanceType
*/
Builder instanceType(OpenSearchPartitionInstanceType instanceType);
/**
*
* The duration, in seconds, for which the offering will reserve the OpenSearch instance.
*
*
* @param duration
* The duration, in seconds, for which the offering will reserve the OpenSearch instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder duration(Integer duration);
/**
*
* The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
*
*
* @param fixedPrice
* The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fixedPrice(Double fixedPrice);
/**
*
* The hourly rate at which you're charged for the domain using this Reserved Instance.
*
*
* @param usagePrice
* The hourly rate at which you're charged for the domain using this Reserved Instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder usagePrice(Double usagePrice);
/**
*
* The currency code for the Reserved Instance offering.
*
*
* @param currencyCode
* The currency code for the Reserved Instance offering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder currencyCode(String currencyCode);
/**
*
* Payment option for the Reserved Instance offering
*
*
* @param paymentOption
* Payment option for the Reserved Instance offering
* @see ReservedInstancePaymentOption
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReservedInstancePaymentOption
*/
Builder paymentOption(String paymentOption);
/**
*
* Payment option for the Reserved Instance offering
*
*
* @param paymentOption
* Payment option for the Reserved Instance offering
* @see ReservedInstancePaymentOption
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReservedInstancePaymentOption
*/
Builder paymentOption(ReservedInstancePaymentOption paymentOption);
/**
*
* The recurring charge to your account, regardless of whether you creates any domains using the offering.
*
*
* @param recurringCharges
* The recurring charge to your account, regardless of whether you creates any domains using the
* offering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recurringCharges(Collection recurringCharges);
/**
*
* The recurring charge to your account, regardless of whether you creates any domains using the offering.
*
*
* @param recurringCharges
* The recurring charge to your account, regardless of whether you creates any domains using the
* offering.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recurringCharges(RecurringCharge... recurringCharges);
/**
*
* The recurring charge to your account, regardless of whether you creates any domains using the offering.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.opensearch.model.RecurringCharge.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.opensearch.model.RecurringCharge#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.opensearch.model.RecurringCharge.Builder#build()} is called
* immediately and its result is passed to {@link #recurringCharges(List)}.
*
* @param recurringCharges
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.opensearch.model.RecurringCharge.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #recurringCharges(java.util.Collection)
*/
Builder recurringCharges(Consumer... recurringCharges);
}
static final class BuilderImpl implements Builder {
private String reservedInstanceOfferingId;
private String instanceType;
private Integer duration;
private Double fixedPrice;
private Double usagePrice;
private String currencyCode;
private String paymentOption;
private List recurringCharges = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ReservedInstanceOffering model) {
reservedInstanceOfferingId(model.reservedInstanceOfferingId);
instanceType(model.instanceType);
duration(model.duration);
fixedPrice(model.fixedPrice);
usagePrice(model.usagePrice);
currencyCode(model.currencyCode);
paymentOption(model.paymentOption);
recurringCharges(model.recurringCharges);
}
public final String getReservedInstanceOfferingId() {
return reservedInstanceOfferingId;
}
public final void setReservedInstanceOfferingId(String reservedInstanceOfferingId) {
this.reservedInstanceOfferingId = reservedInstanceOfferingId;
}
@Override
public final Builder reservedInstanceOfferingId(String reservedInstanceOfferingId) {
this.reservedInstanceOfferingId = reservedInstanceOfferingId;
return this;
}
public final String getInstanceType() {
return instanceType;
}
public final void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
@Override
public final Builder instanceType(String instanceType) {
this.instanceType = instanceType;
return this;
}
@Override
public final Builder instanceType(OpenSearchPartitionInstanceType instanceType) {
this.instanceType(instanceType == null ? null : instanceType.toString());
return this;
}
public final Integer getDuration() {
return duration;
}
public final void setDuration(Integer duration) {
this.duration = duration;
}
@Override
public final Builder duration(Integer duration) {
this.duration = duration;
return this;
}
public final Double getFixedPrice() {
return fixedPrice;
}
public final void setFixedPrice(Double fixedPrice) {
this.fixedPrice = fixedPrice;
}
@Override
public final Builder fixedPrice(Double fixedPrice) {
this.fixedPrice = fixedPrice;
return this;
}
public final Double getUsagePrice() {
return usagePrice;
}
public final void setUsagePrice(Double usagePrice) {
this.usagePrice = usagePrice;
}
@Override
public final Builder usagePrice(Double usagePrice) {
this.usagePrice = usagePrice;
return this;
}
public final String getCurrencyCode() {
return currencyCode;
}
public final void setCurrencyCode(String currencyCode) {
this.currencyCode = currencyCode;
}
@Override
public final Builder currencyCode(String currencyCode) {
this.currencyCode = currencyCode;
return this;
}
public final String getPaymentOption() {
return paymentOption;
}
public final void setPaymentOption(String paymentOption) {
this.paymentOption = paymentOption;
}
@Override
public final Builder paymentOption(String paymentOption) {
this.paymentOption = paymentOption;
return this;
}
@Override
public final Builder paymentOption(ReservedInstancePaymentOption paymentOption) {
this.paymentOption(paymentOption == null ? null : paymentOption.toString());
return this;
}
public final List getRecurringCharges() {
List result = RecurringChargeListCopier.copyToBuilder(this.recurringCharges);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRecurringCharges(Collection recurringCharges) {
this.recurringCharges = RecurringChargeListCopier.copyFromBuilder(recurringCharges);
}
@Override
public final Builder recurringCharges(Collection recurringCharges) {
this.recurringCharges = RecurringChargeListCopier.copy(recurringCharges);
return this;
}
@Override
@SafeVarargs
public final Builder recurringCharges(RecurringCharge... recurringCharges) {
recurringCharges(Arrays.asList(recurringCharges));
return this;
}
@Override
@SafeVarargs
public final Builder recurringCharges(Consumer... recurringCharges) {
recurringCharges(Stream.of(recurringCharges).map(c -> RecurringCharge.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ReservedInstanceOffering build() {
return new ReservedInstanceOffering(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}