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)
// .dlqPolicy(IResolvable)
// .dlqPolicy(DlqPolicyProperty)
// .filterTag(java.lang.String)
// .filterTag(IResolvable)
// .notifyContentFormat(java.lang.String)
// .notifyContentFormat(IResolvable)
// .notifyStrategy(java.lang.String)
// .notifyStrategy(IResolvable)
// .pushType(java.lang.String)
// .pushType(IResolvable)
.build();
Properties
| Name | Type | Description |
|---|---|---|
endpoint | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property endpoint: The message delivery endpoint. |
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. |
dlqPolicy | com.aliyun.ros.cdk.core.IResolvable OR DlqPolicyProperty | Property dlqPolicy: Dead-letter queue policy. |
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. |
pushType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property pushType: Push type of the created subscription. |
endpointRequired
public java.lang.Object getEndpoint();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property endpoint: The message delivery endpoint.
The format varies based on the PushType value:
- If
PushTypeishttp: An HTTP/HTTPS callback URL, such ashttp:\/\/example.com\/callbackorhttps:\/\/example.com\/callback. - If
PushTypeisqueue: The ARN of the destination queue, in the formatacs:mns:{RegionId}:{account ID}:queues\/{QueueName}. - If
PushTypeisdm: The endpoint for email push, in the fixed formatsmq-ep:dm:{account ID}:__dynamic. Replace{account ID}with your account ID. - If
PushTypeisdysms: The endpoint for SMS push, in the formatsmq-ep:dysms:{account ID}:{MobileNumber}. - If
PushTypeiskafka: The Kafka push endpoint. - If
PushTypeisfc: The endpoint for Function Compute, in the formatacs:fc:{RegionId}:{account ID}:services\/{ServiceName}\/functions\/{FunctionName}. - If
PushTypeiseventbus: The endpoint for EventBridge, in the formatacs:eventbridge:{RegionId}:{account ID}:eventbus\/{EventBusName}.
subscriptionNameRequired
public java.lang.Object getSubscriptionName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property subscriptionName: Subscription name.
topicNameRequired
public java.lang.Object getTopicName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topicName: Topic name.
dlqPolicyOptional
public java.lang.Object getDlqPolicy();
- Type: com.aliyun.ros.cdk.core.IResolvable OR DlqPolicyProperty
Property dlqPolicy: Dead-letter queue policy.
filterTagOptional
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.
notifyContentFormatOptional
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.
notifyStrategyOptional
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.
pushTypeOptional
public java.lang.Object getPushType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property pushType: Push type of the created subscription.