com.amazonaws.services.quicksight.model.NumericalMeasureField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-quicksight Show documentation
The AWS Java SDK for Amazon QuickSight module holds the client classes that are used for communicating with Amazon QuickSight 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.quicksight.model;

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

/**
 * 
 * The measure type field with numerical type columns.
 * 
 * 
 * @see AWS
 *      API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class NumericalMeasureField implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The custom field ID.
     * 
     */
    private String fieldId;
    /**
     * 
     * The column that is used in the NumericalMeasureField.
     * 
     */
    private ColumnIdentifier column;
    /**
     * 
     * The aggregation function of the measure field.
     * 
     */
    private NumericalAggregationFunction aggregationFunction;
    /**
     * 
     * The format configuration of the field.
     * 
     */
    private NumberFormatConfiguration formatConfiguration;

    /**
     * 
     * The custom field ID.
     * 
     * 
     * @param fieldId
     *        The custom field ID.
     */

    public void setFieldId(String fieldId) {
        this.fieldId = fieldId;
    }

    /**
     * 
     * The custom field ID.
     * 
     * 
     * @return The custom field ID.
     */

    public String getFieldId() {
        return this.fieldId;
    }

    /**
     * 
     * The custom field ID.
     * 
     * 
     * @param fieldId
     *        The custom field ID.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public NumericalMeasureField withFieldId(String fieldId) {
        setFieldId(fieldId);
        return this;
    }

    /**
     * 
     * The column that is used in the NumericalMeasureField.
     * 
     * 
     * @param column
     *        The column that is used in the NumericalMeasureField.
     */

    public void setColumn(ColumnIdentifier column) {
        this.column = column;
    }

    /**
     * 
     * The column that is used in the NumericalMeasureField.
     * 
     * 
     * @return The column that is used in the NumericalMeasureField.
     */

    public ColumnIdentifier getColumn() {
        return this.column;
    }

    /**
     * 
     * The column that is used in the NumericalMeasureField.
     * 
     * 
     * @param column
     *        The column that is used in the NumericalMeasureField.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public NumericalMeasureField withColumn(ColumnIdentifier column) {
        setColumn(column);
        return this;
    }

    /**
     * 
     * The aggregation function of the measure field.
     * 
     * 
     * @param aggregationFunction
     *        The aggregation function of the measure field.
     */

    public void setAggregationFunction(NumericalAggregationFunction aggregationFunction) {
        this.aggregationFunction = aggregationFunction;
    }

    /**
     * 
     * The aggregation function of the measure field.
     * 
     * 
     * @return The aggregation function of the measure field.
     */

    public NumericalAggregationFunction getAggregationFunction() {
        return this.aggregationFunction;
    }

    /**
     * 
     * The aggregation function of the measure field.
     * 
     * 
     * @param aggregationFunction
     *        The aggregation function of the measure field.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public NumericalMeasureField withAggregationFunction(NumericalAggregationFunction aggregationFunction) {
        setAggregationFunction(aggregationFunction);
        return this;
    }

    /**
     * 
     * The format configuration of the field.
     * 
     * 
     * @param formatConfiguration
     *        The format configuration of the field.
     */

    public void setFormatConfiguration(NumberFormatConfiguration formatConfiguration) {
        this.formatConfiguration = formatConfiguration;
    }

    /**
     * 
     * The format configuration of the field.
     * 
     * 
     * @return The format configuration of the field.
     */

    public NumberFormatConfiguration getFormatConfiguration() {
        return this.formatConfiguration;
    }

    /**
     * 
     * The format configuration of the field.
     * 
     * 
     * @param formatConfiguration
     *        The format configuration of the field.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public NumericalMeasureField withFormatConfiguration(NumberFormatConfiguration formatConfiguration) {
        setFormatConfiguration(formatConfiguration);
        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 (getFieldId() != null)
            sb.append("FieldId: ").append(getFieldId()).append(",");
        if (getColumn() != null)
            sb.append("Column: ").append(getColumn()).append(",");
        if (getAggregationFunction() != null)
            sb.append("AggregationFunction: ").append(getAggregationFunction()).append(",");
        if (getFormatConfiguration() != null)
            sb.append("FormatConfiguration: ").append(getFormatConfiguration());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof NumericalMeasureField == false)
            return false;
        NumericalMeasureField other = (NumericalMeasureField) obj;
        if (other.getFieldId() == null ^ this.getFieldId() == null)
            return false;
        if (other.getFieldId() != null && other.getFieldId().equals(this.getFieldId()) == false)
            return false;
        if (other.getColumn() == null ^ this.getColumn() == null)
            return false;
        if (other.getColumn() != null && other.getColumn().equals(this.getColumn()) == false)
            return false;
        if (other.getAggregationFunction() == null ^ this.getAggregationFunction() == null)
            return false;
        if (other.getAggregationFunction() != null && other.getAggregationFunction().equals(this.getAggregationFunction()) == false)
            return false;
        if (other.getFormatConfiguration() == null ^ this.getFormatConfiguration() == null)
            return false;
        if (other.getFormatConfiguration() != null && other.getFormatConfiguration().equals(this.getFormatConfiguration()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getFieldId() == null) ? 0 : getFieldId().hashCode());
        hashCode = prime * hashCode + ((getColumn() == null) ? 0 : getColumn().hashCode());
        hashCode = prime * hashCode + ((getAggregationFunction() == null) ? 0 : getAggregationFunction().hashCode());
        hashCode = prime * hashCode + ((getFormatConfiguration() == null) ? 0 : getFormatConfiguration().hashCode());
        return hashCode;
    }

    @Override
    public NumericalMeasureField clone() {
        try {
            return (NumericalMeasureField) 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.quicksight.model.transform.NumericalMeasureFieldMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}