GatewayInfo

Used for PublishEventRequest, SetDeviceStateRequest and GetDeviceConfigRequest if sent through a gateway. Specify either delegatedDeviceId or gatewayId but not both. Note: the resource path and authorization token can correspond to either the device or the gateway.

The following cases illustrate the use of this field:

  1. The request is for a device and is not sent through a gateway. The resource path and authorization token belong to the device. gatewayInfo should NOT be set.

  2. The request is for the gateway itself, not for a delegated device. The resource path and authorization token belong to the gateway. gatewayInfo should NOT be set.

  3. The request has the gateway's resource path and authorization token, but the gateway makes the request on behalf of a device. gatewayInfo.delegated_device_id MUST be set to the ID of the delegated device.

  4. The request has the device's resource path and authorization token and is sent through a gateway. gatewayInfo.gateway_id MUST be set to ID of the gateway.

JSON representation
{

  // Union field gateway_or_device can be only one of the following:
  "delegatedDeviceId": string,
  "gatewayId": string
  // End of list of possible types for union field gateway_or_device.
}
Fields
Union field gateway_or_device. Either delegated_device_id or gateway_id is set but not both. gateway_or_device can be only one of the following:
delegatedDeviceId

string

The ID of the delegated device. Set only if the resource name in the request corresponds to the gateway.

gatewayId

string

The ID of the gateway. Set only if the resource name in the request corresponds to the delegated device.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud IoT Core Documentation