/*
 * Copyright 2018-2023 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.pinpoint.model;

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

/**
 * <p>
 * Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is
 * performed.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/EventDimensions" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EventDimensions implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as
     * selection criteria when you create an event filter.
     * </p>
     */
    private java.util.Map<String, AttributeDimension> attributes;
    /**
     * <p>
     * The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a
     * standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom
     * event that's specific to your application. For information about standard events, see <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint
     * Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     * </p>
     */
    private SetDimension eventType;
    /**
     * <p>
     * One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     * selection criteria when you create an event filter.
     * </p>
     */
    private java.util.Map<String, MetricDimension> metrics;

    /**
     * <p>
     * One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as
     * selection criteria when you create an event filter.
     * </p>
     * 
     * @return One or more custom attributes that your application reports to Amazon Pinpoint. You can use these
     *         attributes as selection criteria when you create an event filter.
     */

    public java.util.Map<String, AttributeDimension> getAttributes() {
        return attributes;
    }

    /**
     * <p>
     * One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as
     * selection criteria when you create an event filter.
     * </p>
     * 
     * @param attributes
     *        One or more custom attributes that your application reports to Amazon Pinpoint. You can use these
     *        attributes as selection criteria when you create an event filter.
     */

    public void setAttributes(java.util.Map<String, AttributeDimension> attributes) {
        this.attributes = attributes;
    }

    /**
     * <p>
     * One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as
     * selection criteria when you create an event filter.
     * </p>
     * 
     * @param attributes
     *        One or more custom attributes that your application reports to Amazon Pinpoint. You can use these
     *        attributes as selection criteria when you create an event filter.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public EventDimensions withAttributes(java.util.Map<String, AttributeDimension> attributes) {
        setAttributes(attributes);
        return this;
    }

    /**
     * Add a single Attributes entry
     *
     * @see EventDimensions#withAttributes
     * @returns a reference to this object so that method calls can be chained together.
     */

    public EventDimensions addAttributesEntry(String key, AttributeDimension value) {
        if (null == this.attributes) {
            this.attributes = new java.util.HashMap<String, AttributeDimension>();
        }
        if (this.attributes.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.attributes.put(key, value);
        return this;
    }

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

    public EventDimensions clearAttributesEntries() {
        this.attributes = null;
        return this;
    }

    /**
     * <p>
     * The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a
     * standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom
     * event that's specific to your application. For information about standard events, see <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint
     * Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     * </p>
     * 
     * @param eventType
     *        The name of the event that causes the campaign to be sent or the journey activity to be performed. This
     *        can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can
     *        also be a custom event that's specific to your application. For information about standard events, see <a
     *        href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon
     *        Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     */

    public void setEventType(SetDimension eventType) {
        this.eventType = eventType;
    }

    /**
     * <p>
     * The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a
     * standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom
     * event that's specific to your application. For information about standard events, see <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint
     * Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     * </p>
     * 
     * @return The name of the event that causes the campaign to be sent or the journey activity to be performed. This
     *         can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can
     *         also be a custom event that's specific to your application. For information about standard events, see <a
     *         href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon
     *         Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     */

    public SetDimension getEventType() {
        return this.eventType;
    }

    /**
     * <p>
     * The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a
     * standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom
     * event that's specific to your application. For information about standard events, see <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon Pinpoint
     * Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     * </p>
     * 
     * @param eventType
     *        The name of the event that causes the campaign to be sent or the journey activity to be performed. This
     *        can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can
     *        also be a custom event that's specific to your application. For information about standard events, see <a
     *        href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html">Streaming Amazon
     *        Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public EventDimensions withEventType(SetDimension eventType) {
        setEventType(eventType);
        return this;
    }

    /**
     * <p>
     * One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     * selection criteria when you create an event filter.
     * </p>
     * 
     * @return One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     *         selection criteria when you create an event filter.
     */

    public java.util.Map<String, MetricDimension> getMetrics() {
        return metrics;
    }

    /**
     * <p>
     * One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     * selection criteria when you create an event filter.
     * </p>
     * 
     * @param metrics
     *        One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     *        selection criteria when you create an event filter.
     */

    public void setMetrics(java.util.Map<String, MetricDimension> metrics) {
        this.metrics = metrics;
    }

    /**
     * <p>
     * One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     * selection criteria when you create an event filter.
     * </p>
     * 
     * @param metrics
     *        One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as
     *        selection criteria when you create an event filter.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public EventDimensions withMetrics(java.util.Map<String, MetricDimension> metrics) {
        setMetrics(metrics);
        return this;
    }

    /**
     * Add a single Metrics entry
     *
     * @see EventDimensions#withMetrics
     * @returns a reference to this object so that method calls can be chained together.
     */

    public EventDimensions addMetricsEntry(String key, MetricDimension value) {
        if (null == this.metrics) {
            this.metrics = new java.util.HashMap<String, MetricDimension>();
        }
        if (this.metrics.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
        this.metrics.put(key, value);
        return this;
    }

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

    public EventDimensions clearMetricsEntries() {
        this.metrics = null;
        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 (getAttributes() != null)
            sb.append("Attributes: ").append(getAttributes()).append(",");
        if (getEventType() != null)
            sb.append("EventType: ").append(getEventType()).append(",");
        if (getMetrics() != null)
            sb.append("Metrics: ").append(getMetrics());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof EventDimensions == false)
            return false;
        EventDimensions other = (EventDimensions) obj;
        if (other.getAttributes() == null ^ this.getAttributes() == null)
            return false;
        if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
            return false;
        if (other.getEventType() == null ^ this.getEventType() == null)
            return false;
        if (other.getEventType() != null && other.getEventType().equals(this.getEventType()) == false)
            return false;
        if (other.getMetrics() == null ^ this.getMetrics() == null)
            return false;
        if (other.getMetrics() != null && other.getMetrics().equals(this.getMetrics()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
        hashCode = prime * hashCode + ((getEventType() == null) ? 0 : getEventType().hashCode());
        hashCode = prime * hashCode + ((getMetrics() == null) ? 0 : getMetrics().hashCode());
        return hashCode;
    }

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