/*
 * 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 status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send
 * push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GCMChannelRequest" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GCMChannelRequest implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to
     * communicate with Google services.
     * </p>
     */
    private String apiKey;
    /**
     * <p>
     * The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     * </p>
     */
    private String defaultAuthenticationMethod;
    /**
     * <p>
     * Specifies whether to enable the GCM channel for the application.
     * </p>
     */
    private Boolean enabled;
    /**
     * <p>
     * The contents of the JSON file provided by Google during registration in order to generate an access token for
     * authentication. For more information see <a
     * href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP v1</a>.
     * </p>
     */
    private String serviceJson;

    /**
     * <p>
     * The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to
     * communicate with Google services.
     * </p>
     * 
     * @param apiKey
     *        The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google
     *        to communicate with Google services.
     */

    public void setApiKey(String apiKey) {
        this.apiKey = apiKey;
    }

    /**
     * <p>
     * The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to
     * communicate with Google services.
     * </p>
     * 
     * @return The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from
     *         Google to communicate with Google services.
     */

    public String getApiKey() {
        return this.apiKey;
    }

    /**
     * <p>
     * The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google to
     * communicate with Google services.
     * </p>
     * 
     * @param apiKey
     *        The Web API Key, also referred to as an <i>API_KEY</i> or <i>server key</i>, that you received from Google
     *        to communicate with Google services.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GCMChannelRequest withApiKey(String apiKey) {
        setApiKey(apiKey);
        return this;
    }

    /**
     * <p>
     * The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     * </p>
     * 
     * @param defaultAuthenticationMethod
     *        The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     */

    public void setDefaultAuthenticationMethod(String defaultAuthenticationMethod) {
        this.defaultAuthenticationMethod = defaultAuthenticationMethod;
    }

    /**
     * <p>
     * The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     * </p>
     * 
     * @return The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     */

    public String getDefaultAuthenticationMethod() {
        return this.defaultAuthenticationMethod;
    }

    /**
     * <p>
     * The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     * </p>
     * 
     * @param defaultAuthenticationMethod
     *        The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GCMChannelRequest withDefaultAuthenticationMethod(String defaultAuthenticationMethod) {
        setDefaultAuthenticationMethod(defaultAuthenticationMethod);
        return this;
    }

    /**
     * <p>
     * Specifies whether to enable the GCM channel for the application.
     * </p>
     * 
     * @param enabled
     *        Specifies whether to enable the GCM channel for the application.
     */

    public void setEnabled(Boolean enabled) {
        this.enabled = enabled;
    }

    /**
     * <p>
     * Specifies whether to enable the GCM channel for the application.
     * </p>
     * 
     * @return Specifies whether to enable the GCM channel for the application.
     */

    public Boolean getEnabled() {
        return this.enabled;
    }

    /**
     * <p>
     * Specifies whether to enable the GCM channel for the application.
     * </p>
     * 
     * @param enabled
     *        Specifies whether to enable the GCM channel for the application.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GCMChannelRequest withEnabled(Boolean enabled) {
        setEnabled(enabled);
        return this;
    }

    /**
     * <p>
     * Specifies whether to enable the GCM channel for the application.
     * </p>
     * 
     * @return Specifies whether to enable the GCM channel for the application.
     */

    public Boolean isEnabled() {
        return this.enabled;
    }

    /**
     * <p>
     * The contents of the JSON file provided by Google during registration in order to generate an access token for
     * authentication. For more information see <a
     * href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP v1</a>.
     * </p>
     * 
     * @param serviceJson
     *        The contents of the JSON file provided by Google during registration in order to generate an access token
     *        for authentication. For more information see <a
     *        href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP
     *        v1</a>.
     */

    public void setServiceJson(String serviceJson) {
        this.serviceJson = serviceJson;
    }

    /**
     * <p>
     * The contents of the JSON file provided by Google during registration in order to generate an access token for
     * authentication. For more information see <a
     * href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP v1</a>.
     * </p>
     * 
     * @return The contents of the JSON file provided by Google during registration in order to generate an access token
     *         for authentication. For more information see <a
     *         href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP
     *         v1</a>.
     */

    public String getServiceJson() {
        return this.serviceJson;
    }

    /**
     * <p>
     * The contents of the JSON file provided by Google during registration in order to generate an access token for
     * authentication. For more information see <a
     * href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP v1</a>.
     * </p>
     * 
     * @param serviceJson
     *        The contents of the JSON file provided by Google during registration in order to generate an access token
     *        for authentication. For more information see <a
     *        href="https://firebase.google.com/docs/cloud-messaging/migrate-v1">Migrate from legacy FCM APIs to HTTP
     *        v1</a>.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GCMChannelRequest withServiceJson(String serviceJson) {
        setServiceJson(serviceJson);
        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 (getApiKey() != null)
            sb.append("ApiKey: ").append(getApiKey()).append(",");
        if (getDefaultAuthenticationMethod() != null)
            sb.append("DefaultAuthenticationMethod: ").append(getDefaultAuthenticationMethod()).append(",");
        if (getEnabled() != null)
            sb.append("Enabled: ").append(getEnabled()).append(",");
        if (getServiceJson() != null)
            sb.append("ServiceJson: ").append(getServiceJson());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof GCMChannelRequest == false)
            return false;
        GCMChannelRequest other = (GCMChannelRequest) obj;
        if (other.getApiKey() == null ^ this.getApiKey() == null)
            return false;
        if (other.getApiKey() != null && other.getApiKey().equals(this.getApiKey()) == false)
            return false;
        if (other.getDefaultAuthenticationMethod() == null ^ this.getDefaultAuthenticationMethod() == null)
            return false;
        if (other.getDefaultAuthenticationMethod() != null && other.getDefaultAuthenticationMethod().equals(this.getDefaultAuthenticationMethod()) == false)
            return false;
        if (other.getEnabled() == null ^ this.getEnabled() == null)
            return false;
        if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
            return false;
        if (other.getServiceJson() == null ^ this.getServiceJson() == null)
            return false;
        if (other.getServiceJson() != null && other.getServiceJson().equals(this.getServiceJson()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getApiKey() == null) ? 0 : getApiKey().hashCode());
        hashCode = prime * hashCode + ((getDefaultAuthenticationMethod() == null) ? 0 : getDefaultAuthenticationMethod().hashCode());
        hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
        hashCode = prime * hashCode + ((getServiceJson() == null) ? 0 : getServiceJson().hashCode());
        return hashCode;
    }

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