com.amazonaws.services.pi.model.DimensionKeyDescription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-pi Show documentation
The AWS Java SDK for AWS Performance Insights module holds the client classes that are used for communicating with AWS Performance Insights Service
The newest version!
/*
 * Copyright 2019-2024 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 com.amazonaws.services.pi.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * An object that includes the requested dimension key values and aggregated metric values within a dimension group.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DimensionKeyDescription implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * A map of name-value pairs for the dimensions in the group.
     * 
     */
    private java.util.Map dimensions;
    /**
     * 
     * The aggregated metric value for the dimensions, over the requested time range.
     * 
     */
    private Double total;
    /**
     * 
     * A map that contains the value for each additional metric.
     * 
     */
    private java.util.Map additionalMetrics;
    /**
     * 
     * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     * 
     */
    private java.util.List partitions;

    /**
     * 
     * A map of name-value pairs for the dimensions in the group.
     * 
     * 
     * @return A map of name-value pairs for the dimensions in the group.
     */

    public java.util.Map getDimensions() {
        return dimensions;
    }

    /**
     * 
     * 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.
     */

    public void setDimensions(java.util.Map dimensions) {
        this.dimensions = dimensions;
    }

    /**
     * 
     * 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.
     */

    public DimensionKeyDescription withDimensions(java.util.Map dimensions) {
        setDimensions(dimensions);
        return this;
    }

    /**
     * Add a single Dimensions entry
     *
     * @see DimensionKeyDescription#withDimensions
     * @returns a reference to this object so that method calls can be chained together.
     */

    public DimensionKeyDescription addDimensionsEntry(String key, String value) {
        if (null == this.dimensions) {
            this.dimensions = new java.util.HashMap();
        }
        if (this.dimensions.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.dimensions.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Dimensions.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DimensionKeyDescription clearDimensionsEntries() {
        this.dimensions = null;
        return this;
    }

    /**
     * 
     * The aggregated metric value for the dimensions, over the requested time range.
     * 
     * 
     * @param total
     *        The aggregated metric value for the dimensions, over the requested time range.
     */

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

    /**
     * 
     * The aggregated metric value for the dimensions, over the requested time range.
     * 
     * 
     * @return The aggregated metric value for the dimensions, over the requested time range.
     */

    public Double getTotal() {
        return this.total;
    }

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

    public DimensionKeyDescription withTotal(Double total) {
        setTotal(total);
        return this;
    }

    /**
     * 
     * A map that contains the value for each additional metric.
     * 
     * 
     * @return A map that contains the value for each additional metric.
     */

    public java.util.Map getAdditionalMetrics() {
        return additionalMetrics;
    }

    /**
     * 
     * A map that contains the value for each additional metric.
     * 
     * 
     * @param additionalMetrics
     *        A map that contains the value for each additional metric.
     */

    public void setAdditionalMetrics(java.util.Map additionalMetrics) {
        this.additionalMetrics = additionalMetrics;
    }

    /**
     * 
     * A map that contains the value for each additional metric.
     * 
     * 
     * @param additionalMetrics
     *        A map that contains the value for each additional metric.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DimensionKeyDescription withAdditionalMetrics(java.util.Map additionalMetrics) {
        setAdditionalMetrics(additionalMetrics);
        return this;
    }

    /**
     * Add a single AdditionalMetrics entry
     *
     * @see DimensionKeyDescription#withAdditionalMetrics
     * @returns a reference to this object so that method calls can be chained together.
     */

    public DimensionKeyDescription addAdditionalMetricsEntry(String key, Double value) {
        if (null == this.additionalMetrics) {
            this.additionalMetrics = new java.util.HashMap();
        }
        if (this.additionalMetrics.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.additionalMetrics.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into AdditionalMetrics.
     *
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DimensionKeyDescription clearAdditionalMetricsEntries() {
        this.additionalMetrics = null;
        return this;
    }

    /**
     * 
     * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     * 
     * 
     * @return If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     */

    public java.util.List getPartitions() {
        return partitions;
    }

    /**
     * 
     * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     * 
     * 
     * @param partitions
     *        If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     */

    public void setPartitions(java.util.Collection partitions) {
        if (partitions == null) {
            this.partitions = null;
            return;
        }

        this.partitions = new java.util.ArrayList(partitions);
    }

    /**
     * 
     * If PartitionBy was specified, PartitionKeys contains the dimensions that were.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setPartitions(java.util.Collection)} or {@link #withPartitions(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @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.
     */

    public DimensionKeyDescription withPartitions(Double... partitions) {
        if (this.partitions == null) {
            setPartitions(new java.util.ArrayList(partitions.length));
        }
        for (Double ele : partitions) {
            this.partitions.add(ele);
        }
        return this;
    }

    /**
     * 
     * 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.
     */

    public DimensionKeyDescription withPartitions(java.util.Collection partitions) {
        setPartitions(partitions);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getDimensions() != null)
            sb.append("Dimensions: ").append(getDimensions()).append(",");
        if (getTotal() != null)
            sb.append("Total: ").append(getTotal()).append(",");
        if (getAdditionalMetrics() != null)
            sb.append("AdditionalMetrics: ").append(getAdditionalMetrics()).append(",");
        if (getPartitions() != null)
            sb.append("Partitions: ").append(getPartitions());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof DimensionKeyDescription == false)
            return false;
        DimensionKeyDescription other = (DimensionKeyDescription) obj;
        if (other.getDimensions() == null ^ this.getDimensions() == null)
            return false;
        if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == false)
            return false;
        if (other.getTotal() == null ^ this.getTotal() == null)
            return false;
        if (other.getTotal() != null && other.getTotal().equals(this.getTotal()) == false)
            return false;
        if (other.getAdditionalMetrics() == null ^ this.getAdditionalMetrics() == null)
            return false;
        if (other.getAdditionalMetrics() != null && other.getAdditionalMetrics().equals(this.getAdditionalMetrics()) == false)
            return false;
        if (other.getPartitions() == null ^ this.getPartitions() == null)
            return false;
        if (other.getPartitions() != null && other.getPartitions().equals(this.getPartitions()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
        hashCode = prime * hashCode + ((getTotal() == null) ? 0 : getTotal().hashCode());
        hashCode = prime * hashCode + ((getAdditionalMetrics() == null) ? 0 : getAdditionalMetrics().hashCode());
        hashCode = prime * hashCode + ((getPartitions() == null) ? 0 : getPartitions().hashCode());
        return hashCode;
    }

    @Override
    public DimensionKeyDescription clone() {
        try {
            return (DimensionKeyDescription) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.pi.model.transform.DimensionKeyDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}