software.amazon.awssdk.services.ec2.model.GetHostReservationPurchasePreviewResponse Maven / Gradle / Ivy
Show all versions of ec2 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.ec2.model;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetHostReservationPurchasePreviewResponse extends Ec2Response implements
ToCopyableBuilder {
private static final SdkField CURRENCY_CODE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CurrencyCode")
.getter(getter(GetHostReservationPurchasePreviewResponse::currencyCodeAsString))
.setter(setter(Builder::currencyCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CurrencyCode")
.unmarshallLocationName("currencyCode").build()).build();
private static final SdkField> PURCHASE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Purchase")
.getter(getter(GetHostReservationPurchasePreviewResponse::purchase))
.setter(setter(Builder::purchase))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Purchase")
.unmarshallLocationName("purchase").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Purchase::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField TOTAL_HOURLY_PRICE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TotalHourlyPrice")
.getter(getter(GetHostReservationPurchasePreviewResponse::totalHourlyPrice))
.setter(setter(Builder::totalHourlyPrice))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TotalHourlyPrice")
.unmarshallLocationName("totalHourlyPrice").build()).build();
private static final SdkField TOTAL_UPFRONT_PRICE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TotalUpfrontPrice")
.getter(getter(GetHostReservationPurchasePreviewResponse::totalUpfrontPrice))
.setter(setter(Builder::totalUpfrontPrice))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TotalUpfrontPrice")
.unmarshallLocationName("totalUpfrontPrice").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CURRENCY_CODE_FIELD,
PURCHASE_FIELD, TOTAL_HOURLY_PRICE_FIELD, TOTAL_UPFRONT_PRICE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("CurrencyCode", CURRENCY_CODE_FIELD);
put("Purchase", PURCHASE_FIELD);
put("TotalHourlyPrice", TOTAL_HOURLY_PRICE_FIELD);
put("TotalUpfrontPrice", TOTAL_UPFRONT_PRICE_FIELD);
}
});
private final String currencyCode;
private final List purchase;
private final String totalHourlyPrice;
private final String totalUpfrontPrice;
private GetHostReservationPurchasePreviewResponse(BuilderImpl builder) {
super(builder);
this.currencyCode = builder.currencyCode;
this.purchase = builder.purchase;
this.totalHourlyPrice = builder.totalHourlyPrice;
this.totalUpfrontPrice = builder.totalUpfrontPrice;
}
/**
*
* The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified.
* At this time, the only supported currency is USD.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #currencyCode} will
* return {@link CurrencyCodeValues#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #currencyCodeAsString}.
*
*
* @return The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are
* specified. At this time, the only supported currency is USD.
* @see CurrencyCodeValues
*/
public final CurrencyCodeValues currencyCode() {
return CurrencyCodeValues.fromValue(currencyCode);
}
/**
*
* The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified.
* At this time, the only supported currency is USD.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #currencyCode} will
* return {@link CurrencyCodeValues#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #currencyCodeAsString}.
*
*
* @return The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are
* specified. At this time, the only supported currency is USD.
* @see CurrencyCodeValues
*/
public final String currencyCodeAsString() {
return currencyCode;
}
/**
* For responses, this returns true if the service returned a value for the Purchase 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 hasPurchase() {
return purchase != null && !(purchase instanceof SdkAutoConstructList);
}
/**
*
* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
*
*
* 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 #hasPurchase} method.
*
*
* @return The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
*/
public final List purchase() {
return purchase;
}
/**
*
* The potential total hourly price of the reservation per hour.
*
*
* @return The potential total hourly price of the reservation per hour.
*/
public final String totalHourlyPrice() {
return totalHourlyPrice;
}
/**
*
* The potential total upfront price. This is billed immediately.
*
*
* @return The potential total upfront price. This is billed immediately.
*/
public final String totalUpfrontPrice() {
return totalUpfrontPrice;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(currencyCodeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasPurchase() ? purchase() : null);
hashCode = 31 * hashCode + Objects.hashCode(totalHourlyPrice());
hashCode = 31 * hashCode + Objects.hashCode(totalUpfrontPrice());
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 GetHostReservationPurchasePreviewResponse)) {
return false;
}
GetHostReservationPurchasePreviewResponse other = (GetHostReservationPurchasePreviewResponse) obj;
return Objects.equals(currencyCodeAsString(), other.currencyCodeAsString()) && hasPurchase() == other.hasPurchase()
&& Objects.equals(purchase(), other.purchase()) && Objects.equals(totalHourlyPrice(), other.totalHourlyPrice())
&& Objects.equals(totalUpfrontPrice(), other.totalUpfrontPrice());
}
/**
* 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("GetHostReservationPurchasePreviewResponse").add("CurrencyCode", currencyCodeAsString())
.add("Purchase", hasPurchase() ? purchase() : null).add("TotalHourlyPrice", totalHourlyPrice())
.add("TotalUpfrontPrice", totalUpfrontPrice()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CurrencyCode":
return Optional.ofNullable(clazz.cast(currencyCodeAsString()));
case "Purchase":
return Optional.ofNullable(clazz.cast(purchase()));
case "TotalHourlyPrice":
return Optional.ofNullable(clazz.cast(totalHourlyPrice()));
case "TotalUpfrontPrice":
return Optional.ofNullable(clazz.cast(totalUpfrontPrice()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((GetHostReservationPurchasePreviewResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Response.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are
* specified. At this time, the only supported currency is USD.
*
*
* @param currencyCode
* The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are
* specified. At this time, the only supported currency is USD.
* @see CurrencyCodeValues
* @return Returns a reference to this object so that method calls can be chained together.
* @see CurrencyCodeValues
*/
Builder currencyCode(String currencyCode);
/**
*
* The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are
* specified. At this time, the only supported currency is USD.
*
*
* @param currencyCode
* The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are
* specified. At this time, the only supported currency is USD.
* @see CurrencyCodeValues
* @return Returns a reference to this object so that method calls can be chained together.
* @see CurrencyCodeValues
*/
Builder currencyCode(CurrencyCodeValues currencyCode);
/**
*
* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
*
*
* @param purchase
* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder purchase(Collection purchase);
/**
*
* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
*
*
* @param purchase
* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder purchase(Purchase... purchase);
/**
*
* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.Purchase.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.ec2.model.Purchase#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ec2.model.Purchase.Builder#build()} is called immediately and its
* result is passed to {@link #purchase(List)}.
*
* @param purchase
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ec2.model.Purchase.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #purchase(java.util.Collection)
*/
Builder purchase(Consumer... purchase);
/**
*
* The potential total hourly price of the reservation per hour.
*
*
* @param totalHourlyPrice
* The potential total hourly price of the reservation per hour.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder totalHourlyPrice(String totalHourlyPrice);
/**
*
* The potential total upfront price. This is billed immediately.
*
*
* @param totalUpfrontPrice
* The potential total upfront price. This is billed immediately.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder totalUpfrontPrice(String totalUpfrontPrice);
}
static final class BuilderImpl extends Ec2Response.BuilderImpl implements Builder {
private String currencyCode;
private List purchase = DefaultSdkAutoConstructList.getInstance();
private String totalHourlyPrice;
private String totalUpfrontPrice;
private BuilderImpl() {
}
private BuilderImpl(GetHostReservationPurchasePreviewResponse model) {
super(model);
currencyCode(model.currencyCode);
purchase(model.purchase);
totalHourlyPrice(model.totalHourlyPrice);
totalUpfrontPrice(model.totalUpfrontPrice);
}
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;
}
@Override
public final Builder currencyCode(CurrencyCodeValues currencyCode) {
this.currencyCode(currencyCode == null ? null : currencyCode.toString());
return this;
}
public final List getPurchase() {
List result = PurchaseSetCopier.copyToBuilder(this.purchase);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPurchase(Collection purchase) {
this.purchase = PurchaseSetCopier.copyFromBuilder(purchase);
}
@Override
public final Builder purchase(Collection purchase) {
this.purchase = PurchaseSetCopier.copy(purchase);
return this;
}
@Override
@SafeVarargs
public final Builder purchase(Purchase... purchase) {
purchase(Arrays.asList(purchase));
return this;
}
@Override
@SafeVarargs
public final Builder purchase(Consumer... purchase) {
purchase(Stream.of(purchase).map(c -> Purchase.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getTotalHourlyPrice() {
return totalHourlyPrice;
}
public final void setTotalHourlyPrice(String totalHourlyPrice) {
this.totalHourlyPrice = totalHourlyPrice;
}
@Override
public final Builder totalHourlyPrice(String totalHourlyPrice) {
this.totalHourlyPrice = totalHourlyPrice;
return this;
}
public final String getTotalUpfrontPrice() {
return totalUpfrontPrice;
}
public final void setTotalUpfrontPrice(String totalUpfrontPrice) {
this.totalUpfrontPrice = totalUpfrontPrice;
}
@Override
public final Builder totalUpfrontPrice(String totalUpfrontPrice) {
this.totalUpfrontPrice = totalUpfrontPrice;
return this;
}
@Override
public GetHostReservationPurchasePreviewResponse build() {
return new GetHostReservationPurchasePreviewResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}