SubscribeRequest (AWS Java SDK for Amazon SNS 1.11.615 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sns.model.SubscribeRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SubscribeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Input for Subscribe action.

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`SubscribeRequest()` Default constructor for SubscribeRequest object.
`SubscribeRequest(String topicArn, String protocol, String endpoint)` Constructs a new SubscribeRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscribeRequest`	`addAttributesEntry(String key, String value)`
`SubscribeRequest`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`SubscribeRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` A map of attributes with their corresponding values.
`String`	`getEndpoint()` The endpoint that you want to receive notifications.
`String`	`getProtocol()` The protocol you want to use.
`Boolean`	`getReturnSubscriptionArn()` Sets whether the response from the `Subscribe` request includes the subscription ARN, even if the subscription is not yet confirmed.
`String`	`getTopicArn()` The ARN of the topic you want to subscribe to.
`int`	`hashCode()`
`Boolean`	`isReturnSubscriptionArn()` Sets whether the response from the `Subscribe` request includes the subscription ARN, even if the subscription is not yet confirmed.
`void`	`setAttributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`void`	`setEndpoint(String endpoint)` The endpoint that you want to receive notifications.
`void`	`setProtocol(String protocol)` The protocol you want to use.
`void`	`setReturnSubscriptionArn(Boolean returnSubscriptionArn)` Sets whether the response from the `Subscribe` request includes the subscription ARN, even if the subscription is not yet confirmed.
`void`	`setTopicArn(String topicArn)` The ARN of the topic you want to subscribe to.
`String`	`toString()` Returns a string representation of this object.
`SubscribeRequest`	`withAttributes(Map<String,String> attributes)` A map of attributes with their corresponding values.
`SubscribeRequest`	`withEndpoint(String endpoint)` The endpoint that you want to receive notifications.
`SubscribeRequest`	`withProtocol(String protocol)` The protocol you want to use.
`SubscribeRequest`	`withReturnSubscriptionArn(Boolean returnSubscriptionArn)` Sets whether the response from the `Subscribe` request includes the subscription ARN, even if the subscription is not yet confirmed.
`SubscribeRequest`	`withTopicArn(String topicArn)` The ARN of the topic you want to subscribe to.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 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.
    
    lambda – delivery of JSON-encoded message to an AWS Lambda function.
    endpoint - The endpoint that you want to receive notifications. Endpoints vary by protocol:
    
    For the http protocol, the endpoint is an URL beginning with "https://"
    
    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.
    
    For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
- 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.
    - lambda – delivery of JSON-encoded message to an AWS Lambda function.
    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.
    
    lambda – delivery of JSON-encoded message to an AWS Lambda function.
  - 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.
    - lambda – delivery of JSON-encoded message to an AWS Lambda function.
    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.
    
    lambda – delivery of JSON-encoded message to an AWS Lambda function.
  - 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.
    - lambda – delivery of JSON-encoded message to an AWS Lambda function.
    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.
    
    lambda – delivery of JSON-encoded message to an AWS Lambda function.
    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 "https://"
    - 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.
    - For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
    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 "https://"
    
    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.
    
    For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
  - 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 "https://"
    - 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.
    - For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
    Returns:
    The endpoint that you want to receive notifications. Endpoints vary by protocol:
    
    For the http protocol, the endpoint is an URL beginning with "https://"
    
    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.
    
    For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
  - 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 "https://"
    - 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.
    - For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
    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 "https://"
    
    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.
    
    For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
    - RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
    Returns:
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
    
    DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    
    FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
    
    RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
    - RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
    Parameters:
    attributes - A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
    
    DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    
    FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
    
    RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  - withAttributes
```
public SubscribeRequest withAttributes(Map<String,String> attributes)
```
    A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
    - DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    - FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
    - RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
    Parameters:
    attributes - A map of attributes with their corresponding values.
    
    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
    
    DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
    
    FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
    
    RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public SubscribeRequest addAttributesEntry(String key,
                                           String value)
```
  - clearAttributesEntries
```
public SubscribeRequest clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnSubscriptionArn
```
public void setReturnSubscriptionArn(Boolean returnSubscriptionArn)
```
    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
    
    Parameters:
    
    returnSubscriptionArn - Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
  - getReturnSubscriptionArn
```
public Boolean getReturnSubscriptionArn()
```
    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
    
    Returns:
    
    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
  - withReturnSubscriptionArn
```
public SubscribeRequest withReturnSubscriptionArn(Boolean returnSubscriptionArn)
```
    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
    
    Parameters:
    
    returnSubscriptionArn - Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReturnSubscriptionArn
```
public Boolean isReturnSubscriptionArn()
```
    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
    
    Returns:
    
    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.
    
    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.
    
    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.
    
    The default value is false.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SubscribeRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class SubscribeRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SubscribeRequest

SubscribeRequest

Method Detail

setTopicArn

getTopicArn

withTopicArn

setProtocol

getProtocol

withProtocol

setEndpoint

getEndpoint

withEndpoint

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setReturnSubscriptionArn

getReturnSubscriptionArn

withReturnSubscriptionArn

isReturnSubscriptionArn

toString

equals

hashCode

clone