SubscriptionProps
Properties for defining a Subscription
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mns-subscription
Initializer
import com.aliyun.ros.cdk.mns.SubscriptionProps;
SubscriptionProps.builder()
.endpoint(java.lang.String)
.endpoint(IResolvable)
.subscriptionName(java.lang.String)
.subscriptionName(IResolvable)
.topicName(java.lang.String)
.topicName(IResolvable)
// .filterTag(java.lang.String)
// .filterTag(IResolvable)
// .notifyContentFormat(java.lang.String)
// .notifyContentFormat(IResolvable)
// .notifyStrategy(java.lang.String)
// .notifyStrategy(IResolvable)
.build();
Properties
Name | Type | Description |
---|---|---|
endpoint |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property endpoint: Terminal address of the message recipient for the created subscription. |
subscriptionName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property subscriptionName: Subscription name. |
topicName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property topicName: Topic name. |
filterTag |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property filterTag: Message filter tag in the created subscription (Only messages with consistent tags are pushed.) The value is a string of no more than 16 characters. The default value is no message filter. |
notifyContentFormat |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property notifyContentFormat: Format of the message content pushed to the endpoint. |
notifyStrategy |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property notifyStrategy: Retry policy that will be applied when an error occurs during message push to the endpoint. |
endpoint
Required
public java.lang.Object getEndpoint();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property endpoint: Terminal address of the message recipient for the created subscription.
Currently, four types of endpoints are supported:
- HttpEndpoint, which must be prefixed with "http://";
- QueueEndpoint, in the format of acs:mns:{REGION}:{AccountID}:queues/{QueueName};
- MailEndpoint, in the format of mail:directmail:{MailAddress};
- SmsEndpoint, in the format of sms:directsms:anonymous or sms:directsms:{Phone}.
subscriptionName
Required
public java.lang.Object getSubscriptionName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property subscriptionName: Subscription name.
topicName
Required
public java.lang.Object getTopicName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topicName: Topic name.
filterTag
Optional
public java.lang.Object getFilterTag();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property filterTag: Message filter tag in the created subscription (Only messages with consistent tags are pushed.) The value is a string of no more than 16 characters. The default value is no message filter.
notifyContentFormat
Optional
public java.lang.Object getNotifyContentFormat();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property notifyContentFormat: Format of the message content pushed to the endpoint.
XML, JSON, or SIMPLIFIED; default value: XML. For details about message formats, refer to Basic Concepts/NotifyContentFormat.
notifyStrategy
Optional
public java.lang.Object getNotifyStrategy();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property notifyStrategy: Retry policy that will be applied when an error occurs during message push to the endpoint.
BACKOFF_RETRY or EXPONENTIAL_DECAY_RETRY; default value: BACKOFF_RETRY. For details about retry policies, refer to Basic Concepts/NotifyStrategy.