package google.cloud.iot.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Internet of things (IoT) service. Allows to manipulate device registry instances and the registration of devices (Things) to the cloud.
rpc CreateDevice (, )
device_manager.proto:76Creates a device in a device registry.
message
device_manager.proto:274Request for `CreateDevice`.
string parent = 1
The name of the device registry where this device should be created. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
optional device = 2
The device registration details. The field `name` must be empty. The server will generate that field from the device registry `id` provided and the `parent` field.
Creates a device registry that contains devices.
message
device_manager.proto:204Request for `CreateDeviceRegistry`.
string parent = 1
The project and cloud region where this device registry must be created. For example, `projects/example-project/locations/us-central1`.
optional device_registry = 2
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.
rpc DeleteDevice (, )
device_manager.proto:106Deletes a device.
message
device_manager.proto:314Request for `DeleteDevice`.
string name = 1
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}`.
Deletes a device registry configuration.
message
device_manager.proto:223Request for `DeleteDeviceRegistry`.
string name = 1
The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
rpc GetDevice (, )
device_manager.proto:84Gets details about a device.
message
device_manager.proto:287Request for `GetDevice`.
string name = 1
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}`.
optional field_mask = 2
The fields of the `Device` resource to be returned in the response. If the field mask is unset or empty, all fields are returned.
Gets a device registry configuration.
message
device_manager.proto:216Request for `GetDeviceRegistry`.
string name = 1
The name of the device registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
rpc GetIamPolicy (, )
device_manager.proto:177Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists the last few versions of the device configuration in descending order (i.e.: newest first).
message
device_manager.proto:382Request for `ListDeviceConfigVersions`.
string name = 1
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}`.
int32 num_versions = 2
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.
message
device_manager.proto:395Response for `ListDeviceConfigVersions`.
repeated device_configs = 1
The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one.
Lists device registries.
message
device_manager.proto:245Request for `ListDeviceRegistries`.
string parent = 1
The project and cloud region path. For example, `projects/example-project/locations/us-central1`.
int32 page_size = 2
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, but if there is a non-empty `page_token`, it indicates that more entries are available.
string page_token = 3
The value returned by the last `ListDeviceRegistriesResponse`; indicates that this is a continuation of a prior `ListDeviceRegistries` call, and that the system should return the next page of data.
message
device_manager.proto:263Response for `ListDeviceRegistries`.
repeated device_registries = 1
The registries that matched the query.
string next_page_token = 2
If not empty, indicates that there may be more registries that match the request; this value should be passed in a new `ListDeviceRegistriesRequest`.
Lists the last few versions of the device state in descending order (i.e.: newest first).
message
device_manager.proto:402Request for `ListDeviceStates`.
string name = 1
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}`.
int32 num_states = 2
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.
message
device_manager.proto:415Response for `ListDeviceStates`.
repeated device_states = 1
The last few device states. States are listed in descending order of server update time, starting from the most recent one.
rpc ListDevices (, )
device_manager.proto:116List devices in a device registry.
message
device_manager.proto:322Request for `ListDevices`.
string parent = 1
The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`.
repeated uint64 device_num_ids = 2
A list of device numerical ids. If empty, it will ignore this field. This field cannot hold more than 10,000 entries.
repeated string device_ids = 3
A list of device string identifiers. If empty, it will ignore this field. For example, `['device0', 'device12']`. This field cannot hold more than 10,000 entries.
optional field_mask = 4
The fields of the `Device` resource to be returned in the response. The fields `id`, and `num_id` are always returned by default, along with any other fields specified.
int32 page_size = 100
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, but if there is a non-empty `page_token`, it indicates that more entries are available.
string page_token = 101
The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call, and that the system should return the next page of data.
message
device_manager.proto:354Response for `ListDevices`.
repeated devices = 1
The devices that match the request.
string next_page_token = 2
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.
message
device_manager.proto:364Request for `ModifyCloudToDeviceConfig`.
string name = 1
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}`.
int64 version_to_update = 2
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.
bytes binary_data = 3
The configuration data for the device.
rpc SetIamPolicy (, )
device_manager.proto:163Sets the access control policy on the specified resource. Replaces any existing policy.
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.
rpc UpdateDevice (, )
device_manager.proto:94Updates a device.
message
device_manager.proto:299Request for `UpdateDevice`.
optional device = 2
The new values for the device registry. 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}`.
optional update_mask = 3
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`
Updates a device registry configuration.
message
device_manager.proto:230Request for `UpdateDeviceRegistry`.
optional device_registry = 1
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`.
optional update_mask = 2
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`.
message
resources.proto:31The device resource.
Used as response type in: DeviceManager.CreateDevice, DeviceManager.GetDevice, DeviceManager.UpdateDevice
Used as field type in: , ,
string id = 1
The user-defined device identifier. The device ID must be unique within a device registry.
string name = 2
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.
uint64 num_id = 3
[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.
repeated credentials = 12
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.
optional last_heartbeat_time = 7
[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.
optional last_event_time = 8
[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.
optional last_state_time = 20
[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.
optional last_config_ack_time = 14
[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.
optional last_config_send_time = 18
[Output only] The last time a cloud-to-device config version was sent to the device.
bool blocked = 19
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.
optional last_error_time = 10
[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'.
optional last_error_status = 11
[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.
optional config = 13
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.
optional state = 16
[Output only] The state most recently received from the device. If no state has been reported, this field is not present.
map<string, string> metadata = 17
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.
message
resources.proto:282The device configuration. Eventually delivered to devices.
Used as response type in: DeviceManager.ModifyCloudToDeviceConfig
Used as field type in: ,
int64 version = 1
[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.
optional cloud_update_time = 2
[Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
optional device_ack_time = 3
[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.
bytes binary_data = 4
The device configuration data.
message
resources.proto:249A server-stored device credential used for authentication.
Used in:
oneof credential
The credential data. Reserved for expansion in the future.
public_key = 2
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 expiration_time = 6
[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.
message
resources.proto:125A container for a group of devices.
Used as response type in: DeviceManager.CreateDeviceRegistry, DeviceManager.GetDeviceRegistry, DeviceManager.UpdateDeviceRegistry
Used as field type in: , ,
string id = 1
The identifier of this device registry. For example, `myRegistry`.
string name = 2
The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
repeated event_notification_configs = 10
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.
optional state_notification_config = 7
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.
optional mqtt_config = 4
The MQTT configuration for this device registry.
optional http_config = 9
The DeviceService (HTTP) configuration for this device registry.
repeated credentials = 8
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.
message
resources.proto:309The device state, as reported by the device.
Used in: ,
optional update_time = 1
[Output only] The time at which this state version was updated in Cloud IoT Core.
bytes binary_data = 2
The device state data.
message
resources.proto:187The configuration for forwarding telemetry events.
Used in:
string subfolder_matches = 2
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.
string pubsub_topic_name = 1
A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`.
message
resources.proto:180The configuration of the HTTP bridge for a device registry.
Used in:
HttpState http_enabled_state = 1
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:
HTTP_STATE_UNSPECIFIED = 0
No HTTP state specified. If not specified, DeviceService will be enabled by default.
HTTP_ENABLED = 1
Enables DeviceService (HTTP) service for the registry.
HTTP_DISABLED = 2
Disables DeviceService (HTTP) service for the registry.
message
resources.proto:173The configuration of MQTT for a device registry.
Used in:
MqttState mqtt_enabled_state = 1
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:
MQTT_STATE_UNSPECIFIED = 0
No MQTT state specified. If not specified, MQTT will be enabled by default.
MQTT_ENABLED = 1
Enables a MQTT connection.
MQTT_DISABLED = 2
Disables a MQTT connection.
message
resources.proto:237A public key certificate format and data.
Used in:
PublicKeyCertificateFormat format = 1
The certificate format.
string certificate = 2
The certificate data.
optional x509_details = 3
[Output only] The certificate details. Used only for X.509 certificates.
The supported formats for the public key.
Used in:
UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT = 0
The format has not been specified. This is an invalid default value and must not be used.
X509_CERTIFICATE_PEM = 1
An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
message
resources.proto:273A public key format and data.
Used in:
PublicKeyFormat format = 1
The format of the key.
string key = 2
The key data.
The supported formats for the public key.
Used in:
UNSPECIFIED_PUBLIC_KEY_FORMAT = 0
The format has not been specified. This is an invalid default value and must not be used.
RSA_PEM = 3
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)).
RSA_X509_PEM = 1
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-----`.
ES256_PEM = 2
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.
ES256_X509_PEM = 4
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-----`.
message
resources.proto:207A server-stored registry credential used to validate device credentials.
Used in:
oneof credential
The credential data. Reserved for expansion in the future.
public_key_certificate = 1
A public key certificate used to verify the device credentials.
message
resources.proto:200The configuration for notification of new states received from the device.
Used in:
string pubsub_topic_name = 1
A Cloud Pub/Sub topic name. For example, `projects/myProject/topics/deviceEvents`.
message
resources.proto:216Details of an X.509 certificate. For informational purposes only.
Used in:
string issuer = 1
The entity that signed the certificate.
string subject = 2
The entity the certificate and public key belong to.
optional start_time = 3
The time the certificate becomes valid.
optional expiry_time = 4
The time the certificate becomes invalid.
string signature_algorithm = 5
The algorithm used to sign the certificate.
string public_key_type = 6
The type of public key in the certificate.