Skip to content

MessageCallback

  • Implements: com.aliyun.ros.cdk.vod.datasource.IMessageCallback

This class encapsulates and extends the ROS resource type DATASOURCE::VOD::MessageCallback.

Initializers

import com.aliyun.ros.cdk.vod.datasource.MessageCallback;
MessageCallback.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .appId(java.lang.String)
    .appId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
appId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property appId: The ID of the application.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

appIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property appId: The ID of the application.


refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.vod.datasource.MessageCallback;
MessageCallback.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAppId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AppId: The ID of the application.
attrAuthKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AuthKey: The cryptographic key.
attrAuthSwitch java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AuthSwitch: Indicates whether callback authentication is enabled.
attrCallbackType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CallbackType: The callback method.
attrCallbackUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CallbackUrl: The callback URL.
attrEventTypeList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EventTypeList: The type of the callback event.
attrMnsEndpoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MnsEndpoint: The public endpoint of MNS.
attrMnsQueueName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MnsQueueName: The name of the Message Service (MNS) queue.
props MessageCallbackProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAppIdRequired

public java.lang.Object getAttrAppId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AppId: The ID of the application.


attrAuthKeyRequired

public java.lang.Object getAttrAuthKey();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AuthKey: The cryptographic key.

This parameter is returned only for HTTP callbacks.


attrAuthSwitchRequired

public java.lang.Object getAttrAuthSwitch();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AuthSwitch: Indicates whether callback authentication is enabled.

This parameter is returned only for HTTP callbacks.


attrCallbackTypeRequired

public java.lang.Object getAttrCallbackType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CallbackType: The callback method.


attrCallbackUrlRequired

public java.lang.Object getAttrCallbackUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CallbackUrl: The callback URL.

This parameter is returned only for HTTP callbacks.


attrEventTypeListRequired

public java.lang.Object getAttrEventTypeList();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EventTypeList: The type of the callback event.


attrMnsEndpointRequired

public java.lang.Object getAttrMnsEndpoint();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MnsEndpoint: The public endpoint of MNS.

This parameter is returned only for MNS callbacks.


attrMnsQueueNameRequired

public java.lang.Object getAttrMnsQueueName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MnsQueueName: The name of the Message Service (MNS) queue.

This parameter is returned only for MNS callbacks.


propsRequired

public MessageCallbackProps getProps();