Topic
This class encapsulates and extends the ROS resource type ALIYUN::DATAHUB::Topic
, which is used to create a topic.
Initializers
import com.aliyun.ros.cdk.datahub.Topic;
Topic.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.comment(java.lang.String)
.comment(IResolvable)
.projectName(java.lang.String)
.projectName(IResolvable)
.recordType(java.lang.String)
.recordType(IResolvable)
.topicName(java.lang.String)
.topicName(IResolvable)
// .lifecycle(java.lang.Number)
// .lifecycle(IResolvable)
// .recordSchema(java.lang.String)
// .recordSchema(IResolvable)
// .shardCount(java.lang.Number)
// .shardCount(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. |
comment |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property comment: The comment of topic. |
projectName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property projectName: The name of the project. |
recordType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property recordType: Record type. |
topicName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property topicName: The name of the topic. |
lifecycle |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property lifecycle: Data storage life cycle. |
recordSchema |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property recordSchema: When creating a TUPLE type topic, you need to specify the schema, but the BLOB type does not pass this parameter. |
shardCount |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property shardCount: Initial shard number. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
comment
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property comment: The comment of topic.
projectName
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property projectName: The name of the project.
Length [3, 32]. Beginning with characters, only characters, numbers and _ are allowed.
recordType
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property recordType: Record type.
TUPLE: structured data, BLOB: unstructured data.
topicName
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topicName: The name of the topic.
Length [3, 64]. Beginning with characters, only characters, numbers and _ are allowed.
lifecycle
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property lifecycle: Data storage life cycle.
recordSchema
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property recordSchema: When creating a TUPLE type topic, you need to specify the schema, but the BLOB type does not pass this parameter.
shardCount
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property shardCount: Initial shard number.
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. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.datahub.Topic;
Topic.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
Name | Type | Description |
---|---|---|
node |
com.aliyun.ros.cdk.core.ConstructNode |
The construct tree node associated with this construct. |
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. |
attrProjectName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute ProjectName: Project name. |
attrTopicName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute TopicName: Topic name. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
stack
Required
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resource
Optional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrProjectName
Required
public IResolvable getAttrProjectName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute ProjectName: Project name.
attrTopicName
Required
public IResolvable getAttrTopicName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute TopicName: Topic name.