Class SubscribeRequest

    • Constructor Detail

      • SubscribeRequest

        public SubscribeRequest()
        Default constructor for SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
      • SubscribeRequest

        public SubscribeRequest​(String topicArn,
                                String protocol,
                                String endpoint)
        Constructs a new SubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
        Parameters:
        topicArn - The ARN of the topic you want to subscribe to.
        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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
        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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
    • Method Detail

      • setTopicArn

        public void setTopicArn​(String topicArn)

        The ARN of the topic you want to subscribe to.

        Parameters:
        topicArn - The ARN of the topic you want to subscribe to.
      • getTopicArn

        public String getTopicArn()

        The ARN of the topic you want to subscribe to.

        Returns:
        The ARN of the topic you want to subscribe to.
      • withTopicArn

        public SubscribeRequest withTopicArn​(String topicArn)

        The ARN of the topic you want to subscribe to.

        Parameters:
        topicArn - The ARN of the topic you want to subscribe to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setProtocol

        public void setProtocol​(String 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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
        Parameters:
        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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
      • getProtocol

        public String getProtocol()

        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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
        Returns:
        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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
      • withProtocol

        public SubscribeRequest withProtocol​(String 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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
        Parameters:
        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
        • sms -- delivery of message via SMS
        • sqs -- delivery of JSON-encoded message to an Amazon SQS queue
        • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setEndpoint

        public void setEndpoint​(String 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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
        Parameters:
        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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
      • getEndpoint

        public String getEndpoint()

        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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
        Returns:
        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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
      • withEndpoint

        public SubscribeRequest withEndpoint​(String 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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
        Parameters:
        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 email address
        • For the email-json protocol, the endpoint is an email address
        • For the sms protocol, the endpoint is a phone number of an SMS-enabled device
        • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
        • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object