software.amazon.awssdk.services.budgets.model.Spend Maven / Gradle / Ivy

Go to download
/*
 * 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.budgets.model;

import java.io.Serializable;
import java.math.BigDecimal;
import java.util.Arrays;
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.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;

/**
 * 
 * The amount of cost or usage that is measured for a budget.
 * 
 * 
 * For example, a Spend for 3 GB of S3 usage would have the following parameters:
 * 
 * 
 * 
 * 
 * An Amount of 3
 * 
 * 
 * 
 * 
 * A unit of GB
 * 
 * 
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class Spend implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField AMOUNT_FIELD = SdkField. builder(MarshallingType.BIG_DECIMAL)
            .getter(getter(Spend::amount)).setter(setter(Builder::amount))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Amount").build()).build();

    private static final SdkField UNIT_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(Spend::unit)).setter(setter(Builder::unit))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Unit").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AMOUNT_FIELD, UNIT_FIELD));

    private static final long serialVersionUID = 1L;

    private final BigDecimal amount;

    private final String unit;

    private Spend(BuilderImpl builder) {
        this.amount = builder.amount;
        this.unit = builder.unit;
    }

    /**
     * 
     * The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
     * 
     * 
     * @return The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
     */
    public BigDecimal amount() {
        return amount;
    }

    /**
     * 
     * The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars
     * or GB.
     * 
     * 
     * @return The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as
     *         dollars or GB.
     */
    public String unit() {
        return unit;
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + Objects.hashCode(amount());
        hashCode = 31 * hashCode + Objects.hashCode(unit());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        return equalsBySdkFields(obj);
    }

    @Override
    public boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof Spend)) {
            return false;
        }
        Spend other = (Spend) obj;
        return Objects.equals(amount(), other.amount()) && Objects.equals(unit(), other.unit());
    }

    /**
     * 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 String toString() {
        return ToString.builder("Spend").add("Amount", amount()).add("Unit", unit()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Amount":
            return Optional.ofNullable(clazz.cast(amount()));
        case "Unit":
            return Optional.ofNullable(clazz.cast(unit()));
        default:
            return Optional.empty();
        }
    }

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

    private static  Function getter(Function g) {
        return obj -> g.apply((Spend) obj);
    }

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
         * 
         * 
         * @param amount
         *        The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder amount(BigDecimal amount);

        /**
         * 
         * The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as
         * dollars or GB.
         * 
         * 
         * @param unit
         *        The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such
         *        as dollars or GB.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder unit(String unit);
    }

    static final class BuilderImpl implements Builder {
        private BigDecimal amount;

        private String unit;

        private BuilderImpl() {
        }

        private BuilderImpl(Spend model) {
            amount(model.amount);
            unit(model.unit);
        }

        public final BigDecimal getAmount() {
            return amount;
        }

        @Override
        public final Builder amount(BigDecimal amount) {
            this.amount = amount;
            return this;
        }

        public final void setAmount(BigDecimal amount) {
            this.amount = amount;
        }

        public final String getUnit() {
            return unit;
        }

        @Override
        public final Builder unit(String unit) {
            this.unit = unit;
            return this;
        }

        public final void setUnit(String unit) {
            this.unit = unit;
        }

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

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