/*
 * 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>
 * Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey
 * activity, and provides information about that query.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/JourneyExecutionActivityMetricsResponse"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class JourneyExecutionActivityMetricsResponse implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The type of activity that the metric applies to. Possible values are:
     * </p>
     * <ul>
     * <li>
     * <p>
     * CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two
     * paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     * participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down
     * one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants
     * down one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date
     * and time before moving participants to the next activity in a journey.
     * </p>
     * </li>
     * </ul>
     */
    private String activityType;
    /**
     * <p>
     * The unique identifier for the application that the metric applies to.
     * </p>
     */
    private String applicationId;
    /**
     * <p>
     * The unique identifier for the activity that the metric applies to.
     * </p>
     */
    private String journeyActivityId;
    /**
     * <p>
     * The unique identifier for the journey that the metric applies to.
     * </p>
     */
    private String journeyId;
    /**
     * <p>
     * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity
     * and updated the data for the metric.
     * </p>
     */
    private String lastEvaluatedTime;
    /**
     * <p>
     * A JSON object that contains the results of the query. The results vary depending on the type of activity
     * (ActivityType). For information about the structure and contents of the results, see the <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint
     * Developer Guide</a>.
     * </p>
     */
    private java.util.Map<String, String> metrics;

    /**
     * <p>
     * The type of activity that the metric applies to. Possible values are:
     * </p>
     * <ul>
     * <li>
     * <p>
     * CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two
     * paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     * participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down
     * one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants
     * down one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date
     * and time before moving participants to the next activity in a journey.
     * </p>
     * </li>
     * </ul>
     * 
     * @param activityType
     *        The type of activity that the metric applies to. Possible values are:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of
     *        two paths in a journey.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     *        participants.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants
     *        down one of as many as five paths in a journey.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of
     *        participants down one of as many as five paths in a journey.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a
     *        specific date and time before moving participants to the next activity in a journey.
     *        </p>
     *        </li>
     */

    public void setActivityType(String activityType) {
        this.activityType = activityType;
    }

    /**
     * <p>
     * The type of activity that the metric applies to. Possible values are:
     * </p>
     * <ul>
     * <li>
     * <p>
     * CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two
     * paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     * participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down
     * one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants
     * down one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date
     * and time before moving participants to the next activity in a journey.
     * </p>
     * </li>
     * </ul>
     * 
     * @return The type of activity that the metric applies to. Possible values are:</p>
     *         <ul>
     *         <li>
     *         <p>
     *         CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of
     *         two paths in a journey.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     *         participants.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants
     *         down one of as many as five paths in a journey.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of
     *         participants down one of as many as five paths in a journey.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a
     *         specific date and time before moving participants to the next activity in a journey.
     *         </p>
     *         </li>
     */

    public String getActivityType() {
        return this.activityType;
    }

    /**
     * <p>
     * The type of activity that the metric applies to. Possible values are:
     * </p>
     * <ul>
     * <li>
     * <p>
     * CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two
     * paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     * participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     * </p>
     * </li>
     * <li>
     * <p>
     * MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down
     * one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants
     * down one of as many as five paths in a journey.
     * </p>
     * </li>
     * <li>
     * <p>
     * WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date
     * and time before moving participants to the next activity in a journey.
     * </p>
     * </li>
     * </ul>
     * 
     * @param activityType
     *        The type of activity that the metric applies to. Possible values are:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of
     *        two paths in a journey.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of
     *        participants.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        MESSAGE – For an email activity, which is an activity that sends an email message to participants.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants
     *        down one of as many as five paths in a journey.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of
     *        participants down one of as many as five paths in a journey.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a
     *        specific date and time before moving participants to the next activity in a journey.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public JourneyExecutionActivityMetricsResponse withActivityType(String activityType) {
        setActivityType(activityType);
        return this;
    }

    /**
     * <p>
     * The unique identifier for the application that the metric applies to.
     * </p>
     * 
     * @param applicationId
     *        The unique identifier for the application that the metric applies to.
     */

    public void setApplicationId(String applicationId) {
        this.applicationId = applicationId;
    }

    /**
     * <p>
     * The unique identifier for the application that the metric applies to.
     * </p>
     * 
     * @return The unique identifier for the application that the metric applies to.
     */

    public String getApplicationId() {
        return this.applicationId;
    }

    /**
     * <p>
     * The unique identifier for the application that the metric applies to.
     * </p>
     * 
     * @param applicationId
     *        The unique identifier for the application that the metric applies to.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public JourneyExecutionActivityMetricsResponse withApplicationId(String applicationId) {
        setApplicationId(applicationId);
        return this;
    }

    /**
     * <p>
     * The unique identifier for the activity that the metric applies to.
     * </p>
     * 
     * @param journeyActivityId
     *        The unique identifier for the activity that the metric applies to.
     */

    public void setJourneyActivityId(String journeyActivityId) {
        this.journeyActivityId = journeyActivityId;
    }

    /**
     * <p>
     * The unique identifier for the activity that the metric applies to.
     * </p>
     * 
     * @return The unique identifier for the activity that the metric applies to.
     */

    public String getJourneyActivityId() {
        return this.journeyActivityId;
    }

    /**
     * <p>
     * The unique identifier for the activity that the metric applies to.
     * </p>
     * 
     * @param journeyActivityId
     *        The unique identifier for the activity that the metric applies to.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public JourneyExecutionActivityMetricsResponse withJourneyActivityId(String journeyActivityId) {
        setJourneyActivityId(journeyActivityId);
        return this;
    }

    /**
     * <p>
     * The unique identifier for the journey that the metric applies to.
     * </p>
     * 
     * @param journeyId
     *        The unique identifier for the journey that the metric applies to.
     */

    public void setJourneyId(String journeyId) {
        this.journeyId = journeyId;
    }

    /**
     * <p>
     * The unique identifier for the journey that the metric applies to.
     * </p>
     * 
     * @return The unique identifier for the journey that the metric applies to.
     */

    public String getJourneyId() {
        return this.journeyId;
    }

    /**
     * <p>
     * The unique identifier for the journey that the metric applies to.
     * </p>
     * 
     * @param journeyId
     *        The unique identifier for the journey that the metric applies to.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public JourneyExecutionActivityMetricsResponse withJourneyId(String journeyId) {
        setJourneyId(journeyId);
        return this;
    }

    /**
     * <p>
     * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity
     * and updated the data for the metric.
     * </p>
     * 
     * @param lastEvaluatedTime
     *        The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the
     *        activity and updated the data for the metric.
     */

    public void setLastEvaluatedTime(String lastEvaluatedTime) {
        this.lastEvaluatedTime = lastEvaluatedTime;
    }

    /**
     * <p>
     * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity
     * and updated the data for the metric.
     * </p>
     * 
     * @return The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the
     *         activity and updated the data for the metric.
     */

    public String getLastEvaluatedTime() {
        return this.lastEvaluatedTime;
    }

    /**
     * <p>
     * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity
     * and updated the data for the metric.
     * </p>
     * 
     * @param lastEvaluatedTime
     *        The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the
     *        activity and updated the data for the metric.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public JourneyExecutionActivityMetricsResponse withLastEvaluatedTime(String lastEvaluatedTime) {
        setLastEvaluatedTime(lastEvaluatedTime);
        return this;
    }

    /**
     * <p>
     * A JSON object that contains the results of the query. The results vary depending on the type of activity
     * (ActivityType). For information about the structure and contents of the results, see the <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint
     * Developer Guide</a>.
     * </p>
     * 
     * @return A JSON object that contains the results of the query. The results vary depending on the type of activity
     *         (ActivityType). For information about the structure and contents of the results, see the <a
     *         href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
     *         Pinpoint Developer Guide</a>.
     */

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

    /**
     * <p>
     * A JSON object that contains the results of the query. The results vary depending on the type of activity
     * (ActivityType). For information about the structure and contents of the results, see the <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint
     * Developer Guide</a>.
     * </p>
     * 
     * @param metrics
     *        A JSON object that contains the results of the query. The results vary depending on the type of activity
     *        (ActivityType). For information about the structure and contents of the results, see the <a
     *        href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
     *        Pinpoint Developer Guide</a>.
     */

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

    /**
     * <p>
     * A JSON object that contains the results of the query. The results vary depending on the type of activity
     * (ActivityType). For information about the structure and contents of the results, see the <a
     * href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint
     * Developer Guide</a>.
     * </p>
     * 
     * @param metrics
     *        A JSON object that contains the results of the query. The results vary depending on the type of activity
     *        (ActivityType). For information about the structure and contents of the results, see the <a
     *        href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon
     *        Pinpoint Developer Guide</a>.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

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

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

    public JourneyExecutionActivityMetricsResponse addMetricsEntry(String key, String value) {
        if (null == this.metrics) {
            this.metrics = new java.util.HashMap<String, String>();
        }
        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 JourneyExecutionActivityMetricsResponse 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 (getActivityType() != null)
            sb.append("ActivityType: ").append(getActivityType()).append(",");
        if (getApplicationId() != null)
            sb.append("ApplicationId: ").append(getApplicationId()).append(",");
        if (getJourneyActivityId() != null)
            sb.append("JourneyActivityId: ").append(getJourneyActivityId()).append(",");
        if (getJourneyId() != null)
            sb.append("JourneyId: ").append(getJourneyId()).append(",");
        if (getLastEvaluatedTime() != null)
            sb.append("LastEvaluatedTime: ").append(getLastEvaluatedTime()).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 JourneyExecutionActivityMetricsResponse == false)
            return false;
        JourneyExecutionActivityMetricsResponse other = (JourneyExecutionActivityMetricsResponse) obj;
        if (other.getActivityType() == null ^ this.getActivityType() == null)
            return false;
        if (other.getActivityType() != null && other.getActivityType().equals(this.getActivityType()) == false)
            return false;
        if (other.getApplicationId() == null ^ this.getApplicationId() == null)
            return false;
        if (other.getApplicationId() != null && other.getApplicationId().equals(this.getApplicationId()) == false)
            return false;
        if (other.getJourneyActivityId() == null ^ this.getJourneyActivityId() == null)
            return false;
        if (other.getJourneyActivityId() != null && other.getJourneyActivityId().equals(this.getJourneyActivityId()) == false)
            return false;
        if (other.getJourneyId() == null ^ this.getJourneyId() == null)
            return false;
        if (other.getJourneyId() != null && other.getJourneyId().equals(this.getJourneyId()) == false)
            return false;
        if (other.getLastEvaluatedTime() == null ^ this.getLastEvaluatedTime() == null)
            return false;
        if (other.getLastEvaluatedTime() != null && other.getLastEvaluatedTime().equals(this.getLastEvaluatedTime()) == 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 + ((getActivityType() == null) ? 0 : getActivityType().hashCode());
        hashCode = prime * hashCode + ((getApplicationId() == null) ? 0 : getApplicationId().hashCode());
        hashCode = prime * hashCode + ((getJourneyActivityId() == null) ? 0 : getJourneyActivityId().hashCode());
        hashCode = prime * hashCode + ((getJourneyId() == null) ? 0 : getJourneyId().hashCode());
        hashCode = prime * hashCode + ((getLastEvaluatedTime() == null) ? 0 : getLastEvaluatedTime().hashCode());
        hashCode = prime * hashCode + ((getMetrics() == null) ? 0 : getMetrics().hashCode());
        return hashCode;
    }

    @Override
    public JourneyExecutionActivityMetricsResponse clone() {
        try {
            return (JourneyExecutionActivityMetricsResponse) 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.JourneyExecutionActivityMetricsResponseMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}
