DigitalTwinAdapterInboundEnvelope

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

Bases: object

Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.

Methods:

__init__(**kwargs)

Initializes a new DigitalTwinAdapterInboundEnvelope object with values from keyword arguments.

Attributes:

envelope_mapping

Gets the envelope_mapping of this DigitalTwinAdapterInboundEnvelope.

reference_endpoint

[Required] Gets the reference_endpoint of this DigitalTwinAdapterInboundEnvelope.

reference_payload

Gets the reference_payload of this DigitalTwinAdapterInboundEnvelope.

__init__(**kwargs)

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

Parameters
  • reference_endpoint (str) – The value to assign to the reference_endpoint property of this DigitalTwinAdapterInboundEnvelope.

  • reference_payload (oci.iot.models.DigitalTwinAdapterPayload) – The value to assign to the reference_payload property of this DigitalTwinAdapterInboundEnvelope.

  • envelope_mapping (oci.iot.models.DigitalTwinAdapterEnvelopeMapping) – The value to assign to the envelope_mapping property of this DigitalTwinAdapterInboundEnvelope.

property envelope_mapping

Gets the envelope_mapping of this DigitalTwinAdapterInboundEnvelope.

Returns

The envelope_mapping of this DigitalTwinAdapterInboundEnvelope.

Return type

oci.iot.models.DigitalTwinAdapterEnvelopeMapping

property reference_endpoint

[Required] Gets the reference_endpoint of this DigitalTwinAdapterInboundEnvelope. The device endpoint.

Returns

The reference_endpoint of this DigitalTwinAdapterInboundEnvelope.

Return type

str

property reference_payload

Gets the reference_payload of this DigitalTwinAdapterInboundEnvelope.

Returns

The reference_payload of this DigitalTwinAdapterInboundEnvelope.

Return type

oci.iot.models.DigitalTwinAdapterPayload