ProductProps
Properties for defining a Product.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-iot-product
Initializer
import com.aliyun.ros.cdk.iot.ProductProps;
ProductProps.builder()
.nodeType(java.lang.Number)
.nodeType(IResolvable)
.productName(java.lang.String)
.productName(IResolvable)
// .aliyunCommodityCode(java.lang.String)
// .aliyunCommodityCode(IResolvable)
// .authType(java.lang.String)
// .authType(IResolvable)
// .categoryKey(java.lang.String)
// .categoryKey(IResolvable)
// .dataFormat(java.lang.Number)
// .dataFormat(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .id2(java.lang.Boolean)
// .id2(IResolvable)
// .iotInstanceId(java.lang.String)
// .iotInstanceId(IResolvable)
// .joinPermissionId(java.lang.String)
// .joinPermissionId(IResolvable)
// .netType(java.lang.String)
// .netType(IResolvable)
// .protocolType(java.lang.String)
// .protocolType(IResolvable)
// .publishAuto(java.lang.Boolean)
// .publishAuto(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
.build();
Properties
| Name | Type | Description |
|---|---|---|
nodeType |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property nodeType: The node type of the product. |
productName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property productName: The name of the product. |
aliyunCommodityCode |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property aliyunCommodityCode: The edition of the product that you want to create. |
authType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property authType: Authentication device to access the Internet of Things platform under the product. |
categoryKey |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property categoryKey: Identifier Product category. |
dataFormat |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property dataFormat: You must specify this parameter if the value of AliyunCommodityCode is iothub_senior. |
description |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property description: A description of the product. |
id2 |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property id2: Whether ID2 certification. |
iotInstanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property iotInstanceId: Public instance does not pass this parameter; |
joinPermissionId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property joinPermissionId: LoRaWAN network credential ID. |
netType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property netType: Networking mode. |
protocolType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property protocolType: The protocol that devices of this product use to connect to gateways. |
publishAuto |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property publishAuto: Whether to automatically model publication after the product is created. |
resourceGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property resourceGroupId: Resource group ID (group ID to view the resource in the resource management console), specify the product is classified as a resource group. |
nodeTypeRequired
public java.lang.Object getNodeType();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property nodeType: The node type of the product.
Values: 0: Device. A device cannot be mounted with sub-devices. It can connect to IoT Platform either directly or as a sub-device of a gateway. 1: Gateway. A gateway can be mounted with sub-devices. It can manage sub-devices, maintain the topological relationships with sub-devices, and synchronize the topological relationships to IoT Platform.
productNameRequired
public java.lang.Object getProductName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property productName: The name of the product.
A product name can be 4 to 30 characters in length and can contain Chinese characters, English letters, digits, and underscores (_). Note A product name must be unique in an account.
aliyunCommodityCodeOptional
public java.lang.Object getAliyunCommodityCode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aliyunCommodityCode: The edition of the product that you want to create.
There are two options: iothub_senior: Pro Edition. iothub: Basic Edition. If you do not input this parameter, the default value is used, which is iothub (Basic Edition).
authTypeOptional
public java.lang.Object getAuthType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authType: Authentication device to access the Internet of Things platform under the product.
Optional: secret: using a device key for device authentication. Details can be found MQTT-TCP connection communication. id2: Use things device authentication ID. x509: X.509 certificates using the device for device authentication. The use of X.509 certificates device side configuration instructions, see Using X.509 certificate authentication. If this parameter is passed, the default value is secret.
categoryKeyOptional
public java.lang.Object getCategoryKey();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property categoryKey: Identifier Product category.
If you pass this parameter, the product will be created using the object model specified category; not passed, the standard model is not used in any category. Call ListThingTemplates, view of things platform predefined category information from the returned results, get the value of CategoryKey.
dataFormatOptional
public java.lang.Object getDataFormat();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property dataFormat: You must specify this parameter if the value of AliyunCommodityCode is iothub_senior.
This parameter is only available and required when you create a Pro Edition product. Options: 0: Do not parse/Custom. 1: Alink JSON.
descriptionOptional
public java.lang.Object getDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: A description of the product.
The description can be a maximum of 100 characters in length.
id2Optional
public java.lang.Object getId2();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property id2: Whether ID2 certification.
Optional values: true: the opening of ID2 certification. false: do not open ID2 certification. Do not pass this parameter, the default is not opened. Explanation Only 2 East China (Shanghai) regional support ID2 authentication. If this parameter value is set to true, but passed AuthType parameter value is not id2, the system will AuthType parameter values prevail.
iotInstanceIdOptional
public java.lang.Object getIotInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property iotInstanceId: Public instance does not pass this parameter;
instance that you need to buy the incoming instance ID.
joinPermissionIdOptional
public java.lang.Object getJoinPermissionId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property joinPermissionId: LoRaWAN network credential ID.
When networking mode NetType chosen LORA, the necessary parameters. Please call QueryLoRaJoinPermissions query JoinPermissionId network credentials LoRaWAN under your account. If you do not LoRaWAN network credentials, visit the network management platform to create things together.
netTypeOptional
public java.lang.Object getNetType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property netType: Networking mode.
Set this parameter only if you are creating a product whose devices directly connect to IoT Platform. Options: WIFI CELLULAR ETHERNET OTHER The default value is WIFI.
protocolTypeOptional
public java.lang.Object getProtocolType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property protocolType: The protocol that devices of this product use to connect to gateways.
Set this parameter only if you are creating a product whose devices will be connected to gateways. Options: modbus: Modbus. opc-ua: OPC UA. customize: Customized protocol. ble: BLE. zigbee: ZigBee.
publishAutoOptional
public java.lang.Object getPublishAuto();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property publishAuto: Whether to automatically model publication after the product is created.
true: publishing. false: not released. This parameter is not passed, the default value true.
resourceGroupIdOptional
public java.lang.Object getResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Resource group ID (group ID to view the resource in the resource management console), specify the product is classified as a resource group.
If this parameter is passed, the product will be classified as a default resource group.