Get desktop application:
View/edit binary Protocol Buffers messages
Internet of Things (IoT) service. Securely connect and manage IoT devices.
Creates a device registry that contains devices.
Request for `CreateDeviceRegistry`.
Required. The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`.
Required. The device registry. The field `name` must be empty. The server will generate that field from the device registry `id` provided and the `parent` field.
Gets a device registry configuration.
Request for `GetDeviceRegistry`.
Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Updates a device registry configuration.
Request for `UpdateDeviceRegistry`.
Required. The new values for the device registry. The `id` field must be empty, and the `name` field must indicate the path of the resource. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required. Only updates the `device_registry` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `event_notification_config`, `http_config`, `mqtt_config`, and `state_notification_config`.
Deletes a device registry configuration.
Request for `DeleteDeviceRegistry`.
Required. The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Lists device registries.
Request for `ListDeviceRegistries`.
Required. The project and cloud region path. For example, `projects/example-project/locations/us-central1`.
The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries` call and the system should return the next page of data.
Response for `ListDeviceRegistries`.
The registries that matched the query.
If not empty, indicates that there may be more registries that match the request; this value should be passed in a new `ListDeviceRegistriesRequest`.
Creates a device in a device registry.
Request for `CreateDevice`.
Required. The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required. The device registration details. The field `name` must be empty. The server generates `name` from the device registry `id` and the `parent` field.
Gets details about a device.
Request for `GetDevice`.
Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned.
Updates a device.
Request for `UpdateDevice`.
Required. The new values for the device. The `id` and `num_id` fields must be empty, and the field `name` must specify the name path. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0`or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
Required. Only updates the `device` fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: `credentials`, `blocked`, and `metadata`
Deletes a device.
Request for `DeleteDevice`.
Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
List devices in a device registry.
Request for `ListDevices`.
Required. The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000
The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified.
Options related to gateways.
The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data.
Response for `ListDevices`.
The devices that match the request.
If not empty, indicates that there may be more devices that match the request; this value should be passed in a new `ListDevicesRequest`.
Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.
Request for `ModifyCloudToDeviceConfig`.
Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.
Required. The configuration data for the device.
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
Request for `ListDeviceConfigVersions`.
Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available.
Response for `ListDeviceConfigVersions`.
The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one.
Lists the last few versions of the device state in descending order (i.e.: newest first).
Request for `ListDeviceStates`.
Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
Response for `ListDeviceStates`.
The last few device states. States are listed in descending order of server update time, starting from the most recent one.
Sets the access control policy on the specified resource. Replaces any existing policy.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.
Request for `SendCommandToDevice`.
Required. The name of the device. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
Required. The command data to send to the device.
Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters.
Response for `SendCommandToDevice`.
(message has no fields)
Associates the device with the gateway.
Request for `BindDeviceToGateway`.
Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier.
Required. The device to associate with the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier.
Response for `BindDeviceToGateway`.
(message has no fields)
Deletes the association between the device and the gateway.
Request for `UnbindDeviceFromGateway`.
Required. The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
Required. The value of `gateway_id` can be either the device numeric ID or the user-defined device identifier.
Required. The device to disassociate from the specified gateway. The value of `device_id` can be either the device numeric ID or the user-defined device identifier.
Response for `UnbindDeviceFromGateway`.
(message has no fields)
The device resource.
Used as response type in: DeviceManager.CreateDevice, DeviceManager.GetDevice, DeviceManager.UpdateDevice
Used as field type in:
, ,The user-defined device identifier. The device ID must be unique within a device registry.
The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID.
[Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.
The credentials used to authenticate this device. To allow credential rotation without interruption, multiple device credentials can be bound to this device. No more than 3 credentials can be bound to a single device at a time. When new credentials are added to a device, they are verified against the registry credentials. For details, see the description of the `DeviceRegistry.credentials` field.
[Output only] The last time an MQTT `PINGREQ` was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send `PINGREQ` messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
[Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
[Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
[Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.
[Output only] The last time a cloud-to-device config version was sent to the device.
If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance.
[Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.
[Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and version value of `1`. To update this field after creation, use the `DeviceManager.ModifyCloudToDeviceConfig` method.
[Output only] The state most recently received from the device. If no state has been reported, this field is not present.
**Beta Feature** The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression [a-zA-Z][a-zA-Z0-9-_.+~%]+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500.
Gateway-related configuration and state.
The device configuration. Eventually delivered to devices.
Used as response type in: DeviceManager.ModifyCloudToDeviceConfig
Used as field type in:
,[Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the `CreateDevice` request if a `config` is specified; the response of `CreateDevice` will always have a value of 1.
[Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
[Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
The device configuration data.
A server-stored device credential used for authentication.
Used in:
The credential data. Reserved for expansion in the future.
A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
[Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
A container for a group of devices.
Used as response type in: DeviceManager.CreateDeviceRegistry, DeviceManager.GetDeviceRegistry, DeviceManager.UpdateDeviceRegistry
Used as field type in:
, ,The identifier of this device registry. For example, `myRegistry`.
The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
The MQTT configuration for this device registry.
The DeviceService (HTTP) configuration for this device registry.
**Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
The device state, as reported by the device.
Used in:
,[Output only] The time at which this state version was updated in Cloud IoT Core.
The device state data.
The configuration for forwarding telemetry events.
Used in:
If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`.
The gateway authorization/authentication method. This setting determines how Cloud IoT Core authorizes/authenticate devices to access the gateway.
Used in:
No authentication/authorization method specified. No devices are allowed to access the gateway.
The device is authenticated through the gateway association only. Device credentials are ignored even if provided.
The device is authenticated through its own credentials. Gateway association is not checked.
The device is authenticated through both device credentials and gateway association. The device must be bound to the gateway and must provide its own credentials.
Gateway-related configuration and state.
Used in:
Indicates whether the device is a gateway.
Indicates how to authorize and/or authenticate devices to access the gateway.
[Output only] The ID of the gateway the device accessed most recently.
[Output only] The most recent time at which the device accessed the gateway specified in `last_accessed_gateway`.
Options for limiting the list based on gateway type and associations.
Used in:
If not set, all devices and gateways are returned. If set, the list is filtered based on gateway type and associations.
If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned.
If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound.
Gateway type.
Used in:
,If unspecified, the device is considered a non-gateway device.
The device is a gateway.
The device is not a gateway.
The configuration of the HTTP bridge for a device registry.
Used in:
If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.
Indicates whether DeviceService (HTTP) is enabled or disabled for the registry. See the field description for details.
Used in:
No HTTP state specified. If not specified, DeviceService will be enabled by default.
Enables DeviceService (HTTP) service for the registry.
Disables DeviceService (HTTP) service for the registry.
**Beta Feature** The logging verbosity for device activity. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging.
Used in:
,No logging specified. If not specified, logging will be disabled.
Disables logging.
Error events will be logged.
Informational events will be logged, such as connections and disconnections.
All events will be logged.
The configuration of MQTT for a device registry.
Used in:
If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
Indicates whether an MQTT connection is enabled or disabled. See the field description for details.
Used in:
No MQTT state specified. If not specified, MQTT will be enabled by default.
Enables a MQTT connection.
Disables a MQTT connection.
A public key certificate format and data.
Used in:
The certificate format.
The certificate data.
[Output only] The certificate details. Used only for X.509 certificates.
The supported formats for the public key.
Used in:
The format has not been specified. This is an invalid default value and must not be used.
An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
A public key format and data.
Used in:
The format of the key.
The key data.
The supported formats for the public key.
Used in:
The format has not been specified. This is an invalid default value and must not be used.
An RSA public key encoded in base64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be used to verify `RS256` signatures in JWT tokens ([RFC7518]( https://www.ietf.org/rfc/rfc7518.txt)).
As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280]( https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in base64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256` algorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is defined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.
As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280]( https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
A server-stored registry credential used to validate device credentials.
Used in:
The credential data. Reserved for expansion in the future.
A public key certificate used to verify the device credentials.
The configuration for notification of new states received from the device.
Used in:
A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`.
Details of an X.509 certificate. For informational purposes only.
Used in:
The entity that signed the certificate.
The entity the certificate and public key belong to.
The time the certificate becomes valid.
The time the certificate becomes invalid.
The algorithm used to sign the certificate.
The type of public key in the certificate.