iot.oracle.com/v1beta1¶
APIVersion: iot.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes iot.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| DigitalTwinAdapter | Namespaced | Sample | - |
| DigitalTwinInstance | Namespaced | Sample | - |
| DigitalTwinModel | Namespaced | Sample | - |
| DigitalTwinRelationship | Namespaced | Sample | - |
| IotDomain | Namespaced | Sample | - |
| IotDomainGroup | Namespaced | Sample | - |
DigitalTwinAdapter¶
DigitalTwinAdapter is the Schema for the digitaltwinadapters API.
Plural:digitaltwinadaptersScope:NamespacedAPIVersion:iot.oracle.com/v1beta1Sample: Sample (config/samples/iot_v1beta1_digitaltwinadapter.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DigitalTwinAdapterSpec defines the desired state of DigitalTwinAdapter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
digitalTwinModelId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. | string |
No | - | - |
digitalTwinModelSpecUri |
The URI of the digital twin model specification. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
inboundEnvelope |
DigitalTwinAdapterInboundEnvelope defines nested fields for DigitalTwinAdapter.InboundEnvelope. | object |
No | - | - |
inboundRoutes |
list of inbound routes | list[object] |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
Yes | - | - |
Spec.inboundEnvelope¶
Back to DigitalTwinAdapter spec
DigitalTwinAdapterInboundEnvelope defines nested fields for DigitalTwinAdapter.InboundEnvelope.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
envelopeMapping |
DigitalTwinAdapterInboundEnvelopeEnvelopeMapping defines nested fields for DigitalTwinAdapter.InboundEnvelope.EnvelopeMapping. | object |
No | - | - |
referenceEndpoint |
The device endpoint. | string |
Yes | - | - |
referencePayload |
DigitalTwinAdapterInboundEnvelopeReferencePayload defines nested fields for DigitalTwinAdapter.InboundEnvelope.ReferencePayload. | object |
No | - | - |
Spec.inboundEnvelope.envelopeMapping¶
Back to DigitalTwinAdapter spec
DigitalTwinAdapterInboundEnvelopeEnvelopeMapping defines nested fields for DigitalTwinAdapter.InboundEnvelope.EnvelopeMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
timeObserved |
JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using timeReceived as the timestamp. Example: For payload {"time": "<timestamp>","temp": 65,"hum": 55} 'timeObserved' can be mapped as JQ Expression (https://jqplay.org/) $.time. |
string |
No | - | - |
Spec.inboundEnvelope.referencePayload¶
Back to DigitalTwinAdapter spec
DigitalTwinAdapterInboundEnvelopeReferencePayload defines nested fields for DigitalTwinAdapter.InboundEnvelope.ReferencePayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
data |
JSON raw data. | map[string, object (preserves unknown fields)] |
No | - | - |
dataFormat |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Spec.inboundRoutes[]¶
Back to DigitalTwinAdapter spec
DigitalTwinAdapterInboundRoute defines nested fields for DigitalTwinAdapter.InboundRoute.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the payloadMapping. |
string |
Yes | - | - |
description |
Meaningful write up about the inbound route. | string |
No | - | - |
payloadMapping |
A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema. The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload. Example: Given payload: { "time": " |
map[string, string] |
No | - | - |
referencePayload |
DigitalTwinAdapterInboundRouteReferencePayload defines nested fields for DigitalTwinAdapter.InboundRoute.ReferencePayload. | object |
No | - | - |
Spec.inboundRoutes[].referencePayload¶
Back to DigitalTwinAdapter spec
DigitalTwinAdapterInboundRouteReferencePayload defines nested fields for DigitalTwinAdapter.InboundRoute.ReferencePayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
data |
JSON raw data. | map[string, object (preserves unknown fields)] |
No | - | - |
dataFormat |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Status¶
DigitalTwinAdapterStatus defines the observed state of DigitalTwinAdapter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
digitalTwinModelId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. | string |
No | - | - |
digitalTwinModelSpecUri |
The URI of the digital twin model specification. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
inboundEnvelope |
DigitalTwinAdapterInboundEnvelope defines nested fields for DigitalTwinAdapter.InboundEnvelope. | object |
No | - | - |
inboundRoutes |
list of routes | list[object] |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
No | - | - |
lifecycleState |
The current state of the digital twin adapter. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.inboundEnvelope¶
Back to DigitalTwinAdapter status
DigitalTwinAdapterInboundEnvelope defines nested fields for DigitalTwinAdapter.InboundEnvelope.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
envelopeMapping |
DigitalTwinAdapterInboundEnvelopeEnvelopeMapping defines nested fields for DigitalTwinAdapter.InboundEnvelope.EnvelopeMapping. | object |
No | - | - |
referenceEndpoint |
The device endpoint. | string |
Yes | - | - |
referencePayload |
DigitalTwinAdapterInboundEnvelopeReferencePayload defines nested fields for DigitalTwinAdapter.InboundEnvelope.ReferencePayload. | object |
No | - | - |
Status.inboundEnvelope.envelopeMapping¶
Back to DigitalTwinAdapter status
DigitalTwinAdapterInboundEnvelopeEnvelopeMapping defines nested fields for DigitalTwinAdapter.InboundEnvelope.EnvelopeMapping.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
timeObserved |
JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using timeReceived as the timestamp. Example: For payload {"time": "<timestamp>","temp": 65,"hum": 55} 'timeObserved' can be mapped as JQ Expression (https://jqplay.org/) $.time. |
string |
No | - | - |
Status.inboundEnvelope.referencePayload¶
Back to DigitalTwinAdapter status
DigitalTwinAdapterInboundEnvelopeReferencePayload defines nested fields for DigitalTwinAdapter.InboundEnvelope.ReferencePayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
data |
JSON raw data. | map[string, object (preserves unknown fields)] |
No | - | - |
dataFormat |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Status.inboundRoutes[]¶
Back to DigitalTwinAdapter status
DigitalTwinAdapterInboundRoute defines nested fields for DigitalTwinAdapter.InboundRoute.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
condition |
A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the payloadMapping. |
string |
Yes | - | - |
description |
Meaningful write up about the inbound route. | string |
No | - | - |
payloadMapping |
A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema. The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload. Example: Given payload: { "time": " |
map[string, string] |
No | - | - |
referencePayload |
DigitalTwinAdapterInboundRouteReferencePayload defines nested fields for DigitalTwinAdapter.InboundRoute.ReferencePayload. | object |
No | - | - |
Status.inboundRoutes[].referencePayload¶
Back to DigitalTwinAdapter status
DigitalTwinAdapterInboundRouteReferencePayload defines nested fields for DigitalTwinAdapter.InboundRoute.ReferencePayload.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
data |
JSON raw data. | map[string, object (preserves unknown fields)] |
No | - | - |
dataFormat |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
Status.status¶
Back to DigitalTwinAdapter status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to DigitalTwinAdapter status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to DigitalTwinAdapter status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to DigitalTwinAdapter status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
DigitalTwinInstance¶
DigitalTwinInstance is the Schema for the digitaltwininstances API.
Plural:digitaltwininstancesScope:NamespacedAPIVersion:iot.oracle.com/v1beta1Sample: Sample (config/samples/iot_v1beta1_digitaltwininstance.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DigitalTwinInstanceSpec defines the desired state of DigitalTwinInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
digitalTwinAdapterId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. | string |
No | - | - |
digitalTwinModelId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. | string |
No | - | - |
digitalTwinModelSpecUri |
The URI of the digital twin model specification. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
externalKey |
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. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
Yes | - | - |
Status¶
DigitalTwinInstanceStatus defines the observed state of DigitalTwinInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
authId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
digitalTwinAdapterId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. | string |
No | - | - |
digitalTwinModelId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. | string |
No | - | - |
digitalTwinModelSpecUri |
The URI of the digital twin model specification. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
externalKey |
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. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
No | - | - |
lifecycleState |
The current state of the digital twin instance. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.status¶
Back to DigitalTwinInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to DigitalTwinInstance status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to DigitalTwinInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to DigitalTwinInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
DigitalTwinModel¶
DigitalTwinModel is the Schema for the digitaltwinmodels API.
Plural:digitaltwinmodelsScope:NamespacedAPIVersion:iot.oracle.com/v1beta1Sample: Sample (config/samples/iot_v1beta1_digitaltwinmodel.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DigitalTwinModelSpec defines the desired state of DigitalTwinModel.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. If left blank, the description will be derived from the spec. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If left blank, the display name will be derived from the spec. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
Yes | - | - |
spec |
The specification of the digital twin model (DTDL). | map[string, object (preserves unknown fields)] |
Yes | - | - |
Status¶
DigitalTwinModelStatus defines the observed state of DigitalTwinModel.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. If left blank, the description will be derived from the spec. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If left blank, the display name will be derived from the spec. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
No | - | - |
lifecycleState |
The current state of the digital twin model. | string |
No | - | - |
specUri |
This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.status¶
Back to DigitalTwinModel status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to DigitalTwinModel status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to DigitalTwinModel status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to DigitalTwinModel status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
DigitalTwinRelationship¶
DigitalTwinRelationship is the Schema for the digitaltwinrelationships API.
Plural:digitaltwinrelationshipsScope:NamespacedAPIVersion:iot.oracle.com/v1beta1Sample: Sample (config/samples/iot_v1beta1_digitaltwinrelationship.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DigitalTwinRelationshipSpec defines the desired state of DigitalTwinRelationship.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
The value(s) of the relationship properties defined in the source digital twin model. | map[string, object (preserves unknown fields)] |
No | - | - |
contentPath |
Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
Yes | - | - |
sourceDigitalTwinInstanceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. | string |
Yes | - | - |
targetDigitalTwinInstanceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. | string |
Yes | - | - |
Status¶
DigitalTwinRelationshipStatus defines the observed state of DigitalTwinRelationship.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
content |
The value(s) of the relationship properties defined in the source digital twin model. | map[string, object (preserves unknown fields)] |
No | - | - |
contentPath |
Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
iotDomainId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. | string |
No | - | - |
lifecycleState |
The current state of the digital twin relationship. | string |
No | - | - |
sourceDigitalTwinInstanceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
targetDigitalTwinInstanceId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. | string |
No | - | - |
timeCreated |
The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.status¶
Back to DigitalTwinRelationship status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to DigitalTwinRelationship status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to DigitalTwinRelationship status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to DigitalTwinRelationship status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
IotDomain¶
IotDomain is the Schema for the iotdomains API.
Plural:iotdomainsScope:NamespacedAPIVersion:iot.oracle.com/v1beta1Sample: Sample (config/samples/iot_v1beta1_iotdomain.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
IotDomainSpec defines the desired state of IotDomain.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
iotDomainGroupId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. | string |
Yes | - | - |
Status¶
IotDomainStatus defines the observed state of IotDomain.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. | string |
No | - | - |
dataRetentionPeriodsInDays |
IotDomainDataRetentionPeriodsInDays defines nested fields for IotDomain.DataRetentionPeriodsInDays. | object |
No | - | - |
dbAllowListedIdentityGroupNames |
List of IAM groups of form described in here (https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197) that are allowed to directly connect to the data host. | list[string] |
No | - | - |
dbAllowedIdentityDomainHost |
Host name of identity domain that is used for authenticating connect to data host via ORDS. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
deviceHost |
Host name of an IoT domain, where IoT devices can connect to. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
iotDomainGroupId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. | string |
No | - | - |
lifecycleState |
The current state of the IoT domain. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
Status.dataRetentionPeriodsInDays¶
IotDomainDataRetentionPeriodsInDays defines nested fields for IotDomain.DataRetentionPeriodsInDays.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
historizedData |
Number of days for which any normalized data sent to IoT devices would be retained for. | integer |
No | - | - |
rawCommandData |
Number of days for which any raw command data sent to IoT devices would be retained for. | integer |
No | - | - |
rawData |
Number of days for which any raw data sent to IoT devices would be retained for. | integer |
No | - | - |
rejectedData |
Number of days for which any data sent to IoT devices would be retained for. | integer |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
IotDomainGroup¶
IotDomainGroup is the Schema for the iotdomaingroups API.
Plural:iotdomaingroupsScope:NamespacedAPIVersion:iot.oracle.com/v1beta1Sample: Sample (config/samples/iot_v1beta1_iotdomaingroup.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
IotDomainGroupSpec defines the desired state of IotDomainGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
type |
Type of the domain group. LIGHTWEIGHT uses fewer resources and has a higher Recovery Time Objective (RTO), making it suitable for development and testing. STANDARD is recommended for production. | string |
No | - | - |
Status¶
IotDomainGroupStatus defines the observed state of IotDomainGroup.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. | string |
No | - | - |
dataHost |
The host name of the database corresponding to the IoT Domain group. | string |
No | - | - |
dbAllowListedVcnIds |
This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host. | list[string] |
No | - | - |
dbConnectionString |
The connection string used to connect to the data host associated with the IoT domain group. | string |
No | - | - |
dbTokenScope |
The token scope used to connect to the data host associated with the IoT domain group. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A short description of the resource. | string |
No | - | - |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. | string |
No | - | - |
lifecycleState |
The current state of an IoT Domain Group. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
type |
Type of the domain group. LIGHTWEIGHT uses fewer resources and has a higher Recovery Time Objective (RTO), making it suitable for development and testing. STANDARD is recommended for production. | string |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |