CreateDigitalTwinInstanceDetails

class oci.iot.models.CreateDigitalTwinInstanceDetails(**kwargs)

Bases: object

The information about new digital twin instance to be created.

Attributes:

CONNECTIVITY_TYPE_DIRECT

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails.

CONNECTIVITY_TYPE_GATEWAY

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails.

CONNECTIVITY_TYPE_INDIRECT

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails.

CONNECTIVITY_TYPE_NONE

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails.

auth_id

Gets the auth_id of this CreateDigitalTwinInstanceDetails.

connectivity_type

Gets the connectivity_type of this CreateDigitalTwinInstanceDetails.

defined_tags

Gets the defined_tags of this CreateDigitalTwinInstanceDetails.

description

Gets the description of this CreateDigitalTwinInstanceDetails.

digital_twin_adapter_id

Gets the digital_twin_adapter_id of this CreateDigitalTwinInstanceDetails.

digital_twin_model_id

Gets the digital_twin_model_id of this CreateDigitalTwinInstanceDetails.

digital_twin_model_spec_uri

Gets the digital_twin_model_spec_uri of this CreateDigitalTwinInstanceDetails.

display_name

Gets the display_name of this CreateDigitalTwinInstanceDetails.

external_key

Gets the external_key of this CreateDigitalTwinInstanceDetails.

freeform_tags

Gets the freeform_tags of this CreateDigitalTwinInstanceDetails.

gateways

Gets the gateways of this CreateDigitalTwinInstanceDetails.

iot_domain_id

[Required] Gets the iot_domain_id of this CreateDigitalTwinInstanceDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateDigitalTwinInstanceDetails object with values from keyword arguments.

CONNECTIVITY_TYPE_DIRECT = 'DIRECT'

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails. This constant has a value of “DIRECT”

CONNECTIVITY_TYPE_GATEWAY = 'GATEWAY'

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails. This constant has a value of “GATEWAY”

CONNECTIVITY_TYPE_INDIRECT = 'INDIRECT'

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails. This constant has a value of “INDIRECT”

CONNECTIVITY_TYPE_NONE = 'NONE'

A constant which can be used with the connectivity_type property of a CreateDigitalTwinInstanceDetails. This constant has a value of “NONE”

__init__(**kwargs)

Initializes a new CreateDigitalTwinInstanceDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • iot_domain_id (str) – The value to assign to the iot_domain_id property of this CreateDigitalTwinInstanceDetails.

  • connectivity_type (str) – The value to assign to the connectivity_type property of this CreateDigitalTwinInstanceDetails. Allowed values for this property are: “DIRECT”, “INDIRECT”, “GATEWAY”, “NONE”

  • auth_id (str) – The value to assign to the auth_id property of this CreateDigitalTwinInstanceDetails.

  • external_key (str) – The value to assign to the external_key property of this CreateDigitalTwinInstanceDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateDigitalTwinInstanceDetails.

  • description (str) – The value to assign to the description property of this CreateDigitalTwinInstanceDetails.

  • digital_twin_adapter_id (str) – The value to assign to the digital_twin_adapter_id property of this CreateDigitalTwinInstanceDetails.

  • digital_twin_model_id (str) – The value to assign to the digital_twin_model_id property of this CreateDigitalTwinInstanceDetails.

  • digital_twin_model_spec_uri (str) – The value to assign to the digital_twin_model_spec_uri property of this CreateDigitalTwinInstanceDetails.

  • gateways (list[str]) – The value to assign to the gateways property of this CreateDigitalTwinInstanceDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDigitalTwinInstanceDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDigitalTwinInstanceDetails.

property auth_id

Gets the auth_id of this CreateDigitalTwinInstanceDetails. The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.

Returns

The auth_id of this CreateDigitalTwinInstanceDetails.

Return type

str

property connectivity_type

Gets the connectivity_type of this CreateDigitalTwinInstanceDetails. Connectivity type of the digital twin instance.

Allowed values for this property are: “DIRECT”, “INDIRECT”, “GATEWAY”, “NONE”

Returns

The connectivity_type of this CreateDigitalTwinInstanceDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateDigitalTwinInstanceDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateDigitalTwinInstanceDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateDigitalTwinInstanceDetails. A short description of the resource.

Returns

The description of this CreateDigitalTwinInstanceDetails.

Return type

str

property digital_twin_adapter_id

Gets the digital_twin_adapter_id of this CreateDigitalTwinInstanceDetails. The OCID of the digital twin adapter.

Returns

The digital_twin_adapter_id of this CreateDigitalTwinInstanceDetails.

Return type

str

property digital_twin_model_id

Gets the digital_twin_model_id of this CreateDigitalTwinInstanceDetails. The OCID of the digital twin model.

Returns

The digital_twin_model_id of this CreateDigitalTwinInstanceDetails.

Return type

str

property digital_twin_model_spec_uri

Gets the digital_twin_model_spec_uri of this CreateDigitalTwinInstanceDetails. The URI of the digital twin model specification.

Returns

The digital_twin_model_spec_uri of this CreateDigitalTwinInstanceDetails.

Return type

str

property display_name

Gets the display_name of this CreateDigitalTwinInstanceDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this CreateDigitalTwinInstanceDetails.

Return type

str

property external_key

Gets the external_key of this CreateDigitalTwinInstanceDetails. A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.

Returns

The external_key of this CreateDigitalTwinInstanceDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDigitalTwinInstanceDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateDigitalTwinInstanceDetails.

Return type

dict(str, str)

property gateways

Gets the gateways of this CreateDigitalTwinInstanceDetails. An array of unique ids (OCIDs) of the IoT digital twin instances with connectivityType equals to GATEWAY.

Returns

The gateways of this CreateDigitalTwinInstanceDetails.

Return type

list[str]

property iot_domain_id

[Required] Gets the iot_domain_id of this CreateDigitalTwinInstanceDetails. The OCID of the IoT domain.

Returns

The iot_domain_id of this CreateDigitalTwinInstanceDetails.

Return type

str