MessageCallbackProps
Properties for defining a MessageCallback
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vod-messagecallback
Initializer
import com.aliyun.ros.cdk.vod.MessageCallbackProps;
MessageCallbackProps.builder()
.callbackType(java.lang.String)
.callbackType(IResolvable)
// .appId(java.lang.String)
// .appId(IResolvable)
// .authKey(java.lang.String)
// .authKey(IResolvable)
// .authSwitch(java.lang.String)
// .authSwitch(IResolvable)
// .callbackUrl(java.lang.String)
// .callbackUrl(IResolvable)
// .eventTypeList(java.lang.String)
// .eventTypeList(IResolvable)
// .mnsEndpoint(java.lang.String)
// .mnsEndpoint(IResolvable)
// .mnsQueueName(java.lang.String)
// .mnsQueueName(IResolvable)
.build();
Properties
Name | Type | Description |
---|---|---|
callbackType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property callbackType: Callback method. |
appId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property appId: App ID. |
authKey |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers. |
authSwitch |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP. |
callbackUrl |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property callbackUrl: Callback address. |
eventTypeList |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property eventTypeList: Callback event type. |
mnsEndpoint |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint. |
mnsQueueName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console. |
callbackType
Required
public java.lang.Object getCallbackType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property callbackType: Callback method.
appId
Optional
public java.lang.Object getAppId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property appId: App ID.
If it is not passed, it is the ID of the default application of the system, with a fixed value: app-1000000.
authKey
Optional
public java.lang.Object getAuthKey();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authKey: Authentication Key, up to 32 characters, must contain both uppercase and lowercase letters and numbers.
This parameter can be set when the callback method is HTTP.
authSwitch
Optional
public java.lang.Object getAuthSwitch();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authSwitch: The authentication switch of the HTTP callback, this parameter is valid when the callback method is set to HTTP.
callbackUrl
Optional
public java.lang.Object getCallbackUrl();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property callbackUrl: Callback address.
When the callback method is HTTP, this parameter needs to be set. The length of the callback address URL cannot exceed 256 bytes, and setting multiple callback addresses is not supported.
eventTypeList
Optional
public java.lang.Object getEventTypeList();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property eventTypeList: Callback event type.
When the value is empty, all message notifications are turned off, and when the value is ALL, all message notifications are turned on. You can also specify to enable certain message notifications, and use a comma (,) to separate multiple event types.
mnsEndpoint
Optional
public java.lang.Object getMnsEndpoint();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property mnsEndpoint: This parameter needs to be set when the callback method is MNS for the message queue public network endpoint.
You can log in to the message service console and click the Get Endpoint button in the upper right corner to get it.
mnsQueueName
Optional
public java.lang.Object getMnsQueueName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property mnsQueueName: The name of the message queue, which can be viewed in the queue list by logging in to the message service console.
When the callback method is MNS, this parameter needs to be set.