com.amazonaws.services.sns.model.SubscribeRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010-2011 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.sns.model;
import com.amazonaws.AmazonWebServiceRequest;

/**
 * Container for the parameters to the {@link com.amazonaws.services.sns.AmazonSNS#subscribe(SubscribeRequest) Subscribe operation}.
 * 
 * The Subscribe action prepares to subscribe an endpoint by sending the
 * endpoint a confirmation message. To actually create a subscription,
 * the endpoint owner must call the ConfirmSubscription action with the
 * token from the confirmation message. Confirmation tokens are valid for
 * twenty-four hours.
 * 
 *
 * @see com.amazonaws.services.sns.AmazonSNS#subscribe(SubscribeRequest)
 */
public class SubscribeRequest extends AmazonWebServiceRequest {

    /**
     * The ARN of topic you want to subscribe to.
     */
    private String topicArn;

    /**
     * The protocol you want to use. Supported protocols include: 
     * http -- delivery of JSON-encoded message via HTTP POST
     * https -- delivery of JSON-encoded message via HTTPS POST
     * email -- delivery of message via SMTP
 email-json --
     * delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     * JSON-encoded message to an Amazon SQS queue
 
     */
    private String protocol;

    /**
     * The endpoint that you want to receive notifications. Endpoints vary by
     * protocol:  For the http protocol, the endpoint is an URL
     * beginning with "http://"
 For the https protocol, the endpoint
     * is a URL beginning with "https://"
 For the email protocol,
     * the endpoint is an e-mail address
 For the email-json
     * protocol, the endpoint is an e-mail address
 For the sqs
     * protocol, the endpoint is the ARN of an Amazon SQS queue
 
     */
    private String endpoint;

    /**
     * Default constructor for a new SubscribeRequest object.  Callers should use the
     * setter or fluent setter (with...) methods to initialize this object after creating it.
     */
    public SubscribeRequest() {}
    
    /**
     * Constructs a new SubscribeRequest object.
     * Callers should use the setter or fluent setter (with...) methods to
     * initialize any additional object members.
     * 
     * @param topicArn The ARN of topic you want to subscribe to.
     * @param protocol The protocol you want to use. Supported protocols
     * include:  http -- delivery of JSON-encoded message via HTTP
     * POST
 https -- delivery of JSON-encoded message via HTTPS
     * POST
 email -- delivery of message via SMTP
     * email-json -- delivery of JSON-encoded message via SMTP
     * sqs -- delivery of JSON-encoded message to an Amazon SQS
     * queue
 
     * @param endpoint The endpoint that you want to receive notifications.
     * Endpoints vary by protocol:  For the http protocol, the
     * endpoint is an URL beginning with "http://"
 For the https
     * protocol, the endpoint is a URL beginning with "https://"
 For
     * the email protocol, the endpoint is an e-mail address
 For the
     * email-json protocol, the endpoint is an e-mail address
 For
     * the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
     * 
     */
    public SubscribeRequest(String topicArn, String protocol, String endpoint) {
        this.topicArn = topicArn;
        this.protocol = protocol;
        this.endpoint = endpoint;
    }
    
    /**
     * The ARN of topic you want to subscribe to.
     *
     * @return The ARN of topic you want to subscribe to.
     */
    public String getTopicArn() {
        return topicArn;
    }
    
    /**
     * The ARN of topic you want to subscribe to.
     *
     * @param topicArn The ARN of topic you want to subscribe to.
     */
    public void setTopicArn(String topicArn) {
        this.topicArn = topicArn;
    }
    
    /**
     * The ARN of topic you want to subscribe to.
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param topicArn The ARN of topic you want to subscribe to.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together. 
     */
    public SubscribeRequest withTopicArn(String topicArn) {
        this.topicArn = topicArn;
        return this;
    }
    
    
    /**
     * The protocol you want to use. Supported protocols include: 

     * http -- delivery of JSON-encoded message via HTTP POST
     * https -- delivery of JSON-encoded message via HTTPS POST
     * email -- delivery of message via SMTP
 email-json --
     * delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     * JSON-encoded message to an Amazon SQS queue
 
     *
     * @return The protocol you want to use. Supported protocols include: 
     *         http -- delivery of JSON-encoded message via HTTP POST
     *         https -- delivery of JSON-encoded message via HTTPS POST
     *         email -- delivery of message via SMTP
 email-json --
     *         delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     *         JSON-encoded message to an Amazon SQS queue
 
     */
    public String getProtocol() {
        return protocol;
    }
    
    /**
     * The protocol you want to use. Supported protocols include: 
     * http -- delivery of JSON-encoded message via HTTP POST
     * https -- delivery of JSON-encoded message via HTTPS POST
     * email -- delivery of message via SMTP
 email-json --
     * delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     * JSON-encoded message to an Amazon SQS queue
 
     *
     * @param protocol The protocol you want to use. Supported protocols include: 
     *         http -- delivery of JSON-encoded message via HTTP POST
     *         https -- delivery of JSON-encoded message via HTTPS POST
     *         email -- delivery of message via SMTP
 email-json --
     *         delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     *         JSON-encoded message to an Amazon SQS queue
 
     */
    public void setProtocol(String protocol) {
        this.protocol = protocol;
    }
    
    /**
     * The protocol you want to use. Supported protocols include: 
     * http -- delivery of JSON-encoded message via HTTP POST
     * https -- delivery of JSON-encoded message via HTTPS POST
     * email -- delivery of message via SMTP
 email-json --
     * delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     * JSON-encoded message to an Amazon SQS queue
 
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param protocol The protocol you want to use. Supported protocols include: 

     *         http -- delivery of JSON-encoded message via HTTP POST
     *         https -- delivery of JSON-encoded message via HTTPS POST
     *         email -- delivery of message via SMTP
 email-json --
     *         delivery of JSON-encoded message via SMTP
 sqs -- delivery of
     *         JSON-encoded message to an Amazon SQS queue
 
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together. 
     */
    public SubscribeRequest withProtocol(String protocol) {
        this.protocol = protocol;
        return this;
    }
    
    
    /**
     * The endpoint that you want to receive notifications. Endpoints vary by
     * protocol:  For the http protocol, the endpoint is an URL
     * beginning with "http://"
 For the https protocol, the endpoint
     * is a URL beginning with "https://"
 For the email protocol,
     * the endpoint is an e-mail address
 For the email-json
     * protocol, the endpoint is an e-mail address
 For the sqs
     * protocol, the endpoint is the ARN of an Amazon SQS queue
 
     *
     * @return The endpoint that you want to receive notifications. Endpoints vary by
     *         protocol:  For the http protocol, the endpoint is an URL
     *         beginning with "http://"
 For the https protocol, the endpoint
     *         is a URL beginning with "https://"
 For the email protocol,
     *         the endpoint is an e-mail address
 For the email-json
     *         protocol, the endpoint is an e-mail address
 For the sqs
     *         protocol, the endpoint is the ARN of an Amazon SQS queue
 
     */
    public String getEndpoint() {
        return endpoint;
    }
    
    /**
     * The endpoint that you want to receive notifications. Endpoints vary by
     * protocol:  For the http protocol, the endpoint is an URL
     * beginning with "http://"
 For the https protocol, the endpoint
     * is a URL beginning with "https://"
 For the email protocol,
     * the endpoint is an e-mail address
 For the email-json
     * protocol, the endpoint is an e-mail address
 For the sqs
     * protocol, the endpoint is the ARN of an Amazon SQS queue
 
     *
     * @param endpoint The endpoint that you want to receive notifications. Endpoints vary by
     *         protocol:  For the http protocol, the endpoint is an URL
     *         beginning with "http://"
 For the https protocol, the endpoint
     *         is a URL beginning with "https://"
 For the email protocol,
     *         the endpoint is an e-mail address
 For the email-json
     *         protocol, the endpoint is an e-mail address
 For the sqs
     *         protocol, the endpoint is the ARN of an Amazon SQS queue
 
     */
    public void setEndpoint(String endpoint) {
        this.endpoint = endpoint;
    }
    
    /**
     * The endpoint that you want to receive notifications. Endpoints vary by
     * protocol:  For the http protocol, the endpoint is an URL
     * beginning with "http://"
 For the https protocol, the endpoint
     * is a URL beginning with "https://"
 For the email protocol,
     * the endpoint is an e-mail address
 For the email-json
     * protocol, the endpoint is an e-mail address
 For the sqs
     * protocol, the endpoint is the ARN of an Amazon SQS queue
 
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param endpoint The endpoint that you want to receive notifications. Endpoints vary by
     *         protocol: 
 For the http protocol, the endpoint is an URL
     *         beginning with "http://"
 For the https protocol, the endpoint
     *         is a URL beginning with "https://"
 For the email protocol,
     *         the endpoint is an e-mail address
 For the email-json
     *         protocol, the endpoint is an e-mail address
 For the sqs
     *         protocol, the endpoint is the ARN of an Amazon SQS queue
 
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together. 
     */
    public SubscribeRequest withEndpoint(String endpoint) {
        this.endpoint = endpoint;
        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("{");
        sb.append("TopicArn: " + topicArn + ", ");
        sb.append("Protocol: " + protocol + ", ");
        sb.append("Endpoint: " + endpoint + ", ");
        sb.append("}");
        return sb.toString();
    }
    
}