Skip to content

ProductTopicProps

Properties for defining a ProductTopic.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-iot-producttopic

Initializer

import com.aliyun.ros.cdk.iot.ProductTopicProps;
ProductTopicProps.builder()
    .operation(java.lang.String)
    .operation(IResolvable)
    .productKey(java.lang.String)
    .productKey(IResolvable)
    .topicShortName(java.lang.String)
    .topicShortName(IResolvable)
//  .desc(java.lang.String)
//  .desc(IResolvable)
//  .iotInstanceId(java.lang.String)
//  .iotInstanceId(IResolvable)
    .build();

Properties

Name Type Description
operation java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property operation: Operation permissions of devices on the topic category.
productKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property productKey: The unique identifier of the product for which you want to create a topic category.
topicShortName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topicShortName: The custom category hierarchy in the topic category.
desc java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property desc: The description of the topic category.
iotInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property iotInstanceId: Instance ID you purchased.

operationRequired

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

Property operation: Operation permissions of devices on the topic category.

Value options: SUB: Subscribe. Devices can subscribe to the topics of this category. PUB: Publish. Devices can publish messages using the topics of this category. ALL: Subscribe and publish. Devices can subscribe to and publish messages to the topics of this category.


productKeyRequired

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

Property productKey: The unique identifier of the product for which you want to create a topic category.


topicShortNameRequired

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

Property topicShortName: The custom category hierarchy in the topic category.

By default, a topic category contains two system defined category hierarchies: productKey and ${deviceName}. Forward slashes (/) are used to delimit the topic hierarchies. The format of a topic category is productKey/${deviceName}/topicShortName. Note The name of each category hierarchy can contain English letters, digits, and underscores (_), and cannot be empty.


descOptional

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

Property desc: The description of the topic category.

You can enter a description with up to 100 characters.


iotInstanceIdOptional

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

Property iotInstanceId: Instance ID you purchased.

Public instances do not need pass this property.