/*
 * Copyright 2010-2019 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;

/**
 * Send message request.
 */
public class SendUsersMessageRequest implements Serializable {
    /**
     * A map of custom attribute-value pairs. Amazon Pinpoint adds these
     * attributes to the data.pinpoint object in the body of the push
     * notification payload. Amazon Pinpoint also provides these attributes in
     * the events that it generates for users-messages deliveries.
     */
    private java.util.Map<String, String> context;

    /**
     * Message definitions for the default message and any messages that are
     * tailored for specific channels.
     */
    private DirectMessageConfiguration messageConfiguration;

    /**
     * A unique ID that you can use to trace a message. This ID is visible to
     * recipients.
     */
    private String traceId;

    /**
     * A map that associates user IDs with EndpointSendConfiguration objects.
     * Within an EndpointSendConfiguration object, you can tailor the message
     * for a user by specifying message overrides or substitutions.
     */
    private java.util.Map<String, EndpointSendConfiguration> users;

    /**
     * A map of custom attribute-value pairs. Amazon Pinpoint adds these
     * attributes to the data.pinpoint object in the body of the push
     * notification payload. Amazon Pinpoint also provides these attributes in
     * the events that it generates for users-messages deliveries.
     *
     * @return A map of custom attribute-value pairs. Amazon Pinpoint adds these
     *         attributes to the data.pinpoint object in the body of the push
     *         notification payload. Amazon Pinpoint also provides these
     *         attributes in the events that it generates for users-messages
     *         deliveries.
     */
    public java.util.Map<String, String> getContext() {
        return context;
    }

    /**
     * A map of custom attribute-value pairs. Amazon Pinpoint adds these
     * attributes to the data.pinpoint object in the body of the push
     * notification payload. Amazon Pinpoint also provides these attributes in
     * the events that it generates for users-messages deliveries.
     *
     * @param context A map of custom attribute-value pairs. Amazon Pinpoint
     *            adds these attributes to the data.pinpoint object in the body
     *            of the push notification payload. Amazon Pinpoint also
     *            provides these attributes in the events that it generates for
     *            users-messages deliveries.
     */
    public void setContext(java.util.Map<String, String> context) {
        this.context = context;
    }

    /**
     * A map of custom attribute-value pairs. Amazon Pinpoint adds these
     * attributes to the data.pinpoint object in the body of the push
     * notification payload. Amazon Pinpoint also provides these attributes in
     * the events that it generates for users-messages deliveries.
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param context A map of custom attribute-value pairs. Amazon Pinpoint
     *            adds these attributes to the data.pinpoint object in the body
     *            of the push notification payload. Amazon Pinpoint also
     *            provides these attributes in the events that it generates for
     *            users-messages deliveries.
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public SendUsersMessageRequest withContext(java.util.Map<String, String> context) {
        this.context = context;
        return this;
    }

    /**
     * A map of custom attribute-value pairs. Amazon Pinpoint adds these
     * attributes to the data.pinpoint object in the body of the push
     * notification payload. Amazon Pinpoint also provides these attributes in
     * the events that it generates for users-messages deliveries.
     * <p>
     * The method adds a new key-value pair into Context parameter, and returns
     * a reference to this object so that method calls can be chained together.
     *
     * @param key The key of the entry to be added into Context.
     * @param value The corresponding value of the entry to be added into
     *            Context.
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public SendUsersMessageRequest addContextEntry(String key, String value) {
        if (null == this.context) {
            this.context = new java.util.HashMap<String, String>();
        }
        if (this.context.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString()
                    + ") are provided.");
        this.context.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Context.
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     */
    public SendUsersMessageRequest clearContextEntries() {
        this.context = null;
        return this;
    }

    /**
     * Message definitions for the default message and any messages that are
     * tailored for specific channels.
     *
     * @return Message definitions for the default message and any messages that
     *         are tailored for specific channels.
     */
    public DirectMessageConfiguration getMessageConfiguration() {
        return messageConfiguration;
    }

    /**
     * Message definitions for the default message and any messages that are
     * tailored for specific channels.
     *
     * @param messageConfiguration Message definitions for the default message
     *            and any messages that are tailored for specific channels.
     */
    public void setMessageConfiguration(DirectMessageConfiguration messageConfiguration) {
        this.messageConfiguration = messageConfiguration;
    }

    /**
     * Message definitions for the default message and any messages that are
     * tailored for specific channels.
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param messageConfiguration Message definitions for the default message
     *            and any messages that are tailored for specific channels.
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public SendUsersMessageRequest withMessageConfiguration(
            DirectMessageConfiguration messageConfiguration) {
        this.messageConfiguration = messageConfiguration;
        return this;
    }

    /**
     * A unique ID that you can use to trace a message. This ID is visible to
     * recipients.
     *
     * @return A unique ID that you can use to trace a message. This ID is
     *         visible to recipients.
     */
    public String getTraceId() {
        return traceId;
    }

    /**
     * A unique ID that you can use to trace a message. This ID is visible to
     * recipients.
     *
     * @param traceId A unique ID that you can use to trace a message. This ID
     *            is visible to recipients.
     */
    public void setTraceId(String traceId) {
        this.traceId = traceId;
    }

    /**
     * A unique ID that you can use to trace a message. This ID is visible to
     * recipients.
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param traceId A unique ID that you can use to trace a message. This ID
     *            is visible to recipients.
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public SendUsersMessageRequest withTraceId(String traceId) {
        this.traceId = traceId;
        return this;
    }

    /**
     * A map that associates user IDs with EndpointSendConfiguration objects.
     * Within an EndpointSendConfiguration object, you can tailor the message
     * for a user by specifying message overrides or substitutions.
     *
     * @return A map that associates user IDs with EndpointSendConfiguration
     *         objects. Within an EndpointSendConfiguration object, you can
     *         tailor the message for a user by specifying message overrides or
     *         substitutions.
     */
    public java.util.Map<String, EndpointSendConfiguration> getUsers() {
        return users;
    }

    /**
     * A map that associates user IDs with EndpointSendConfiguration objects.
     * Within an EndpointSendConfiguration object, you can tailor the message
     * for a user by specifying message overrides or substitutions.
     *
     * @param users A map that associates user IDs with
     *            EndpointSendConfiguration objects. Within an
     *            EndpointSendConfiguration object, you can tailor the message
     *            for a user by specifying message overrides or substitutions.
     */
    public void setUsers(java.util.Map<String, EndpointSendConfiguration> users) {
        this.users = users;
    }

    /**
     * A map that associates user IDs with EndpointSendConfiguration objects.
     * Within an EndpointSendConfiguration object, you can tailor the message
     * for a user by specifying message overrides or substitutions.
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param users A map that associates user IDs with
     *            EndpointSendConfiguration objects. Within an
     *            EndpointSendConfiguration object, you can tailor the message
     *            for a user by specifying message overrides or substitutions.
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public SendUsersMessageRequest withUsers(java.util.Map<String, EndpointSendConfiguration> users) {
        this.users = users;
        return this;
    }

    /**
     * A map that associates user IDs with EndpointSendConfiguration objects.
     * Within an EndpointSendConfiguration object, you can tailor the message
     * for a user by specifying message overrides or substitutions.
     * <p>
     * The method adds a new key-value pair into Users parameter, and returns a
     * reference to this object so that method calls can be chained together.
     *
     * @param key The key of the entry to be added into Users.
     * @param value The corresponding value of the entry to be added into Users.
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public SendUsersMessageRequest addUsersEntry(String key, EndpointSendConfiguration value) {
        if (null == this.users) {
            this.users = new java.util.HashMap<String, EndpointSendConfiguration>();
        }
        if (this.users.containsKey(key))
            throw new IllegalArgumentException("Duplicated keys (" + key.toString()
                    + ") are provided.");
        this.users.put(key, value);
        return this;
    }

    /**
     * Removes all the entries added into Users.
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     */
    public SendUsersMessageRequest clearUsersEntries() {
        this.users = null;
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getContext() != null)
            sb.append("Context: " + getContext() + ",");
        if (getMessageConfiguration() != null)
            sb.append("MessageConfiguration: " + getMessageConfiguration() + ",");
        if (getTraceId() != null)
            sb.append("TraceId: " + getTraceId() + ",");
        if (getUsers() != null)
            sb.append("Users: " + getUsers());
        sb.append("}");
        return sb.toString();
    }

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

        hashCode = prime * hashCode + ((getContext() == null) ? 0 : getContext().hashCode());
        hashCode = prime * hashCode
                + ((getMessageConfiguration() == null) ? 0 : getMessageConfiguration().hashCode());
        hashCode = prime * hashCode + ((getTraceId() == null) ? 0 : getTraceId().hashCode());
        hashCode = prime * hashCode + ((getUsers() == null) ? 0 : getUsers().hashCode());
        return hashCode;
    }

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

        if (obj instanceof SendUsersMessageRequest == false)
            return false;
        SendUsersMessageRequest other = (SendUsersMessageRequest) obj;

        if (other.getContext() == null ^ this.getContext() == null)
            return false;
        if (other.getContext() != null && other.getContext().equals(this.getContext()) == false)
            return false;
        if (other.getMessageConfiguration() == null ^ this.getMessageConfiguration() == null)
            return false;
        if (other.getMessageConfiguration() != null
                && other.getMessageConfiguration().equals(this.getMessageConfiguration()) == false)
            return false;
        if (other.getTraceId() == null ^ this.getTraceId() == null)
            return false;
        if (other.getTraceId() != null && other.getTraceId().equals(this.getTraceId()) == false)
            return false;
        if (other.getUsers() == null ^ this.getUsers() == null)
            return false;
        if (other.getUsers() != null && other.getUsers().equals(this.getUsers()) == false)
            return false;
        return true;
    }
}