software.amazon.awssdk.services.pi.model.DimensionKeyDescription 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.pi.model;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * An array of descriptions and aggregated values for each dimension within a dimension group.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class DimensionKeyDescription implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField> DIMENSIONS_FIELD = SdkField
            .> builder(MarshallingType.MAP)
            .getter(getter(DimensionKeyDescription::dimensions))
            .setter(setter(Builder::dimensions))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build(),
                    MapTrait.builder()
                            .keyLocationName("key")
                            .valueLocationName("value")
                            .valueFieldInfo(
                                    SdkField. builder(MarshallingType.STRING)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("value").build()).build()).build()).build();

    private static final SdkField TOTAL_FIELD = SdkField. builder(MarshallingType.DOUBLE)
            .getter(getter(DimensionKeyDescription::total)).setter(setter(Builder::total))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Total").build()).build();

    private static final SdkField> PARTITIONS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .getter(getter(DimensionKeyDescription::partitions))
            .setter(setter(Builder::partitions))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Partitions").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.DOUBLE)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DIMENSIONS_FIELD, TOTAL_FIELD,
            PARTITIONS_FIELD));

    private static final long serialVersionUID = 1L;

    private final Map dimensions;

    private final Double total;

    private final List partitions;

    private DimensionKeyDescription(BuilderImpl builder) {
        this.dimensions = builder.dimensions;
        this.total = builder.total;
        this.partitions = builder.partitions;
    }

    /**
     * Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did
     * not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
     */
    public boolean hasDimensions() {
        return dimensions != null && !(dimensions instanceof SdkAutoConstructMap);
    }

    /**
     * 
     * A map of name-value pairs for the dimensions in the group.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasDimensions()} to see if a value was sent in this field.
     * 
     * 
     * @return A map of name-value pairs for the dimensions in the group.
     */
    public Map dimensions() {
        return dimensions;
    }

    /**
     * 
     * The aggregated metric value for the dimension(s), over the requested time range.
     * 
     * 
     * @return The aggregated metric value for the dimension(s), over the requested time range.
     */
    public Double total() {
        return total;
    }

    /**
     * Returns true if the Partitions property was specified by the sender (it may be empty), or false if the sender did
     * not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
     */
    public boolean hasPartitions() {
        return partitions != null && !(partitions instanceof SdkAutoConstructList);
    }

    /**
     * 
     * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     * 
     * 
     * Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
     * 
     * 
     * You can use {@link #hasPartitions()} to see if a value was sent in this field.
     * 
     * 
     * @return If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     */
    public List partitions() {
        return partitions;
    }

    @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(dimensions());
        hashCode = 31 * hashCode + Objects.hashCode(total());
        hashCode = 31 * hashCode + Objects.hashCode(partitions());
        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 DimensionKeyDescription)) {
            return false;
        }
        DimensionKeyDescription other = (DimensionKeyDescription) obj;
        return Objects.equals(dimensions(), other.dimensions()) && Objects.equals(total(), other.total())
                && Objects.equals(partitions(), other.partitions());
    }

    /**
     * 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("DimensionKeyDescription").add("Dimensions", dimensions()).add("Total", total())
                .add("Partitions", partitions()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Dimensions":
            return Optional.ofNullable(clazz.cast(dimensions()));
        case "Total":
            return Optional.ofNullable(clazz.cast(total()));
        case "Partitions":
            return Optional.ofNullable(clazz.cast(partitions()));
        default:
            return Optional.empty();
        }
    }

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * A map of name-value pairs for the dimensions in the group.
         * 
         * 
         * @param dimensions
         *        A map of name-value pairs for the dimensions in the group.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder dimensions(Map dimensions);

        /**
         * 
         * The aggregated metric value for the dimension(s), over the requested time range.
         * 
         * 
         * @param total
         *        The aggregated metric value for the dimension(s), over the requested time range.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder total(Double total);

        /**
         * 
         * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
         * 
         * 
         * @param partitions
         *        If PartitionBy was specified, PartitionKeys contains the dimensions that
         *        were.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder partitions(Collection partitions);

        /**
         * 
         * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
         * 
         * 
         * @param partitions
         *        If PartitionBy was specified, PartitionKeys contains the dimensions that
         *        were.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder partitions(Double... partitions);
    }

    static final class BuilderImpl implements Builder {
        private Map dimensions = DefaultSdkAutoConstructMap.getInstance();

        private Double total;

        private List partitions = DefaultSdkAutoConstructList.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(DimensionKeyDescription model) {
            dimensions(model.dimensions);
            total(model.total);
            partitions(model.partitions);
        }

        public final Map getDimensions() {
            return dimensions;
        }

        @Override
        public final Builder dimensions(Map dimensions) {
            this.dimensions = DimensionMapCopier.copy(dimensions);
            return this;
        }

        public final void setDimensions(Map dimensions) {
            this.dimensions = DimensionMapCopier.copy(dimensions);
        }

        public final Double getTotal() {
            return total;
        }

        @Override
        public final Builder total(Double total) {
            this.total = total;
            return this;
        }

        public final void setTotal(Double total) {
            this.total = total;
        }

        public final Collection getPartitions() {
            return partitions;
        }

        @Override
        public final Builder partitions(Collection partitions) {
            this.partitions = MetricValuesListCopier.copy(partitions);
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder partitions(Double... partitions) {
            partitions(Arrays.asList(partitions));
            return this;
        }

        public final void setPartitions(Collection partitions) {
            this.partitions = MetricValuesListCopier.copy(partitions);
        }

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

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