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.

CreateDeviceRequest

Request for CreateDevice.

Required. The device registration details. The field name must be empty. The server generates name from the device registry id and the parent field.

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.

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 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 cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.

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 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.

[Output only] The state most recently received from the device. If no state has been reported, this field is not present.

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.

DeviceConfig

The device configuration. Eventually delivered to devices.

[Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.

The device configuration data.

DeviceCredential

A server-stored device credential used for authentication.

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.

DeviceRegistry

A container for a group of devices.

The resource path name. For example, projects/example- project/locations/us-central1/registries/my-registry.

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 DeviceService (HTTP) configuration for this device registry.

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.

DeviceState

The device state, as reported by the device.

The device state data.

Empty

API documentation for iot_v1.types.Empty class.

EventNotificationConfig

The configuration for forwarding telemetry events.

A Cloud Pub/Sub topic name. For example, projects/myProject/topics/deviceEvents.

Expr

API documentation for iot_v1.types.Expr class.

FieldMask

API documentation for iot_v1.types.FieldMask class.

GatewayConfig

Gateway-related configuration and state.

Indicates how to authorize and/or authenticate devices to access the gateway.

[Output only] The most recent time at which the device accessed the gateway specified in last_accessed_gateway.

GatewayListOptions

Options for limiting the list 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, 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.

GetDeviceRegistryRequest

Request for GetDeviceRegistry.

GetDeviceRequest

Request for GetDevice.

The fields of the Device resource to be returned in the response. If the field mask is unset or empty, all fields are returned.

GetIamPolicyRequest

API documentation for iot_v1.types.GetIamPolicyRequest class.

GetPolicyOptions

API documentation for iot_v1.types.GetPolicyOptions class.

HttpConfig

The configuration of the HTTP bridge for a device registry.

ListDeviceConfigVersionsRequest

Request for ListDeviceConfigVersions.

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.

ListDeviceConfigVersionsResponse

Response for ListDeviceConfigVersions.

ListDeviceRegistriesRequest

Request for ListDeviceRegistries.

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.

ListDeviceRegistriesResponse

Response for ListDeviceRegistries.

If not empty, indicates that there may be more registries that match the request; this value should be passed in a new ListDeviceRegistriesRequest.

ListDeviceStatesRequest

Request for ListDeviceStates.

The number of states to list. States are listed in descending order of update time. The maximum number of states retained is

If this value is zero, it will return all the states available.

ListDeviceStatesResponse

Response for ListDeviceStates.

ListDevicesRequest

Request for ListDevices.

A list of device numeric IDs. 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.

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.

ListDevicesResponse

Response for ListDevices.

If not empty, indicates that there may be more devices that match the request; this value should be passed in a new ListDevicesRequest.

ModifyCloudToDeviceConfigRequest

Request for ModifyCloudToDeviceConfig.

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.

MqttConfig

The configuration of MQTT for a device registry.

Policy

API documentation for iot_v1.types.Policy class.

PolicyDelta

API documentation for iot_v1.types.PolicyDelta class.

PublicKeyCertificate

A public key certificate format and data.

The certificate data.

PublicKeyCredential

A public key format and data.

The key data.

RegistryCredential

A server-stored registry credential used to validate device credentials.

A public key certificate used to verify the device credentials.

SendCommandToDeviceRequest

Request for SendCommandToDevice.

Required. The command data to send to the device.

SendCommandToDeviceResponse

Response for SendCommandToDevice.

SetIamPolicyRequest

API documentation for iot_v1.types.SetIamPolicyRequest class.

StateNotificationConfig

The configuration for notification of new states received from the device.

Status

API documentation for iot_v1.types.Status class.

TestIamPermissionsRequest

API documentation for iot_v1.types.TestIamPermissionsRequest class.

TestIamPermissionsResponse

API documentation for iot_v1.types.TestIamPermissionsResponse class.

Timestamp

API documentation for iot_v1.types.Timestamp class.

UnbindDeviceFromGatewayRequest

Request for UnbindDeviceFromGateway.

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

UnbindDeviceFromGatewayResponse

Response for UnbindDeviceFromGateway.

UpdateDeviceRegistryRequest

Request for UpdateDeviceRegistry.

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.

UpdateDeviceRequest

Request for UpdateDevice.

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

X509CertificateDetails

Details of an X.509 certificate. For informational purposes only.

The entity the certificate and public key belong to.

The time the certificate becomes invalid.

The type of public key in the certificate.