DigitalTwinAdapterEnvelopeMapping

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

Bases: object

Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.

Methods:

__init__(**kwargs)

Initializes a new DigitalTwinAdapterEnvelopeMapping object with values from keyword arguments.

Attributes:

content_root

Gets the content_root of this DigitalTwinAdapterEnvelopeMapping.

target

Gets the target of this DigitalTwinAdapterEnvelopeMapping.

time_observed

Gets the time_observed of this DigitalTwinAdapterEnvelopeMapping.

__init__(**kwargs)

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

Parameters
  • time_observed (str) – The value to assign to the time_observed property of this DigitalTwinAdapterEnvelopeMapping.

  • target (str) – The value to assign to the target property of this DigitalTwinAdapterEnvelopeMapping.

  • content_root (str) – The value to assign to the content_root property of this DigitalTwinAdapterEnvelopeMapping.

property content_root

Gets the content_root of this DigitalTwinAdapterEnvelopeMapping. JSON Path string to override the context root before delegating to the adapter of the target digital twin instance.

Returns

The content_root of this DigitalTwinAdapterEnvelopeMapping.

Return type

str

property target

Gets the target of this DigitalTwinAdapterEnvelopeMapping. Optional. JQ expression to map the target resource, which is externalKey of digital twin instance, the incoming data belongs to.

Returns

The target of this DigitalTwinAdapterEnvelopeMapping.

Return type

str

property time_observed

Gets the time_observed of this DigitalTwinAdapterEnvelopeMapping. 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 $.time.

Returns

The time_observed of this DigitalTwinAdapterEnvelopeMapping.

Return type

str