software.amazon.awssdk.services.ec2.model.PriceScheduleSpecification Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ec2 Show documentation
The AWS Java SDK for Amazon EC2 module holds the client classes that are used for communicating with Amazon EC2 Service
The newest version!
/*
 * 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.io.Serializable;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Describes the price for a Reserved Instance.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class PriceScheduleSpecification implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField TERM_FIELD = SdkField
            . builder(MarshallingType.LONG)
            .memberName("Term")
            .getter(getter(PriceScheduleSpecification::term))
            .setter(setter(Builder::term))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Term")
                    .unmarshallLocationName("term").build()).build();

    private static final SdkField PRICE_FIELD = SdkField
            . builder(MarshallingType.DOUBLE)
            .memberName("Price")
            .getter(getter(PriceScheduleSpecification::price))
            .setter(setter(Builder::price))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Price")
                    .unmarshallLocationName("price").build()).build();

    private static final SdkField CURRENCY_CODE_FIELD = SdkField
            . builder(MarshallingType.STRING)
            .memberName("CurrencyCode")
            .getter(getter(PriceScheduleSpecification::currencyCodeAsString))
            .setter(setter(Builder::currencyCode))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CurrencyCode")
                    .unmarshallLocationName("currencyCode").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TERM_FIELD, PRICE_FIELD,
            CURRENCY_CODE_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = Collections
            .unmodifiableMap(new HashMap>() {
                {
                    put("Term", TERM_FIELD);
                    put("Price", PRICE_FIELD);
                    put("CurrencyCode", CURRENCY_CODE_FIELD);
                }
            });

    private static final long serialVersionUID = 1L;

    private final Long term;

    private final Double price;

    private final String currencyCode;

    private PriceScheduleSpecification(BuilderImpl builder) {
        this.term = builder.term;
        this.price = builder.price;
        this.currencyCode = builder.currencyCode;
    }

    /**
     * 
     * The number of months remaining in the reservation. For example, 2 is the second to the last month before the
     * capacity reservation expires.
     * 
     * 
     * @return The number of months remaining in the reservation. For example, 2 is the second to the last month before
     *         the capacity reservation expires.
     */
    public final Long term() {
        return term;
    }

    /**
     * 
     * The fixed price for the term.
     * 
     * 
     * @return The fixed price for the term.
     */
    public final Double price() {
        return price;
    }

    /**
     * 
     * The currency for transacting the Reserved Instance resale. 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 for transacting the Reserved Instance resale. At this time, the only supported currency is
     *         USD.
     * @see CurrencyCodeValues
     */
    public final CurrencyCodeValues currencyCode() {
        return CurrencyCodeValues.fromValue(currencyCode);
    }

    /**
     * 
     * The currency for transacting the Reserved Instance resale. 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 for transacting the Reserved Instance resale. At this time, the only supported currency is
     *         USD.
     * @see CurrencyCodeValues
     */
    public final String currencyCodeAsString() {
        return currencyCode;
    }

    @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(term());
        hashCode = 31 * hashCode + Objects.hashCode(price());
        hashCode = 31 * hashCode + Objects.hashCode(currencyCodeAsString());
        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 PriceScheduleSpecification)) {
            return false;
        }
        PriceScheduleSpecification other = (PriceScheduleSpecification) obj;
        return Objects.equals(term(), other.term()) && Objects.equals(price(), other.price())
                && Objects.equals(currencyCodeAsString(), other.currencyCodeAsString());
    }

    /**
     * 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("PriceScheduleSpecification").add("Term", term()).add("Price", price())
                .add("CurrencyCode", currencyCodeAsString()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Term":
            return Optional.ofNullable(clazz.cast(term()));
        case "Price":
            return Optional.ofNullable(clazz.cast(price()));
        case "CurrencyCode":
            return Optional.ofNullable(clazz.cast(currencyCodeAsString()));
        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((PriceScheduleSpecification) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The number of months remaining in the reservation. For example, 2 is the second to the last month before the
         * capacity reservation expires.
         * 
         * 
         * @param term
         *        The number of months remaining in the reservation. For example, 2 is the second to the last month
         *        before the capacity reservation expires.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder term(Long term);

        /**
         * 
         * The fixed price for the term.
         * 
         * 
         * @param price
         *        The fixed price for the term.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder price(Double price);

        /**
         * 
         * The currency for transacting the Reserved Instance resale. At this time, the only supported currency is
         * USD.
         * 
         * 
         * @param currencyCode
         *        The currency for transacting the Reserved Instance resale. 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 for transacting the Reserved Instance resale. At this time, the only supported currency is
         * USD.
         * 
         * 
         * @param currencyCode
         *        The currency for transacting the Reserved Instance resale. 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);
    }

    static final class BuilderImpl implements Builder {
        private Long term;

        private Double price;

        private String currencyCode;

        private BuilderImpl() {
        }

        private BuilderImpl(PriceScheduleSpecification model) {
            term(model.term);
            price(model.price);
            currencyCode(model.currencyCode);
        }

        public final Long getTerm() {
            return term;
        }

        public final void setTerm(Long term) {
            this.term = term;
        }

        @Override
        public final Builder term(Long term) {
            this.term = term;
            return this;
        }

        public final Double getPrice() {
            return price;
        }

        public final void setPrice(Double price) {
            this.price = price;
        }

        @Override
        public final Builder price(Double price) {
            this.price = price;
            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;
        }

        @Override
        public final Builder currencyCode(CurrencyCodeValues currencyCode) {
            this.currencyCode(currencyCode == null ? null : currencyCode.toString());
            return this;
        }

        @Override
        public PriceScheduleSpecification build() {
            return new PriceScheduleSpecification(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}