- Resource: DeviceRegistry
- EventNotificationConfig
- StateNotificationConfig
- MqttConfig
- MqttState
- HttpConfig
- HttpState
- RegistryCredential
- PublicKeyCertificate
- PublicKeyCertificateFormat
- X509CertificateDetails
- Methods
Resource: DeviceRegistry
A container for a group of devices.
JSON representation | |
---|---|
{ "id": string, "name": string, "eventNotificationConfigs": [ { object( |
Fields | |
---|---|
id |
The identifier of this device registry. For example, |
name |
The resource path name. For example, |
eventNotificationConfigs[] |
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. |
stateNotificationConfig |
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. |
mqttConfig |
The MQTT configuration for this device registry. |
httpConfig |
The DeviceService (HTTP) configuration for this device registry. |
logLevel |
The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level. |
credentials[] |
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 when you create or update a device. 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. |
EventNotificationConfig
The configuration for forwarding telemetry events.
JSON representation | |
---|---|
{ "subfolderMatches": string, "pubsubTopicName": string } |
Fields | |
---|---|
subfolderMatches |
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. |
pubsubTopicName |
A Cloud Pub/Sub topic name. For example, |
StateNotificationConfig
The configuration for notification of new states received from the device.
JSON representation | |
---|---|
{ "pubsubTopicName": string } |
Fields | |
---|---|
pubsubTopicName |
A Cloud Pub/Sub topic name. For example, |
MqttConfig
The configuration of MQTT for a device registry.
JSON representation | |
---|---|
{
"mqttEnabledState": enum( |
Fields | |
---|---|
mqttEnabledState |
If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail. |
MqttState
Indicates whether an MQTT connection is enabled or disabled. See the field description for details.
Enums | |
---|---|
MQTT_STATE_UNSPECIFIED |
No MQTT state specified. If not specified, MQTT will be enabled by default. |
MQTT_ENABLED |
Enables a MQTT connection. |
MQTT_DISABLED |
Disables a MQTT connection. |
HttpConfig
The configuration of the HTTP bridge for a device registry.
JSON representation | |
---|---|
{
"httpEnabledState": enum( |
Fields | |
---|---|
httpEnabledState |
If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry. |
HttpState
Indicates whether DeviceService (HTTP) is enabled or disabled for the registry. See the field description for details.
Enums | |
---|---|
HTTP_STATE_UNSPECIFIED |
No HTTP state specified. If not specified, DeviceService will be enabled by default. |
HTTP_ENABLED |
Enables DeviceService (HTTP) service for the registry. |
HTTP_DISABLED |
Disables DeviceService (HTTP) service for the registry. |
RegistryCredential
A server-stored registry credential used to validate device credentials.
JSON representation | |
---|---|
{
"publicKeyCertificate": {
object( |
Fields | |
---|---|
publicKeyCertificate |
A public key certificate used to verify the device credentials. |
PublicKeyCertificate
A public key certificate format and data.
JSON representation | |
---|---|
{ "format": enum( |
Fields | |
---|---|
format |
The certificate format. |
certificate |
The certificate data. |
x509Details |
[Output only] The certificate details. Used only for X.509 certificates. |
PublicKeyCertificateFormat
The supported formats for the public key.
Enums | |
---|---|
UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT |
The format has not been specified. This is an invalid default value and must not be used. |
X509_CERTIFICATE_PEM |
An X.509v3 certificate (RFC5280), encoded in base64, and wrapped by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- . |
X509CertificateDetails
Details of an X.509 certificate. For informational purposes only.
JSON representation | |
---|---|
{ "issuer": string, "subject": string, "startTime": string, "expiryTime": string, "signatureAlgorithm": string, "publicKeyType": string } |
Fields | |
---|---|
issuer |
The entity that signed the certificate. |
subject |
The entity the certificate and public key belong to. |
startTime |
The time the certificate becomes valid. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
expiryTime |
The time the certificate becomes invalid. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
signatureAlgorithm |
The algorithm used to sign the certificate. |
publicKeyType |
The type of public key in the certificate. |
Methods |
|
---|---|
|
Associates the device with the gateway. |
|
Creates a device registry that contains devices. |
|
Deletes a device registry configuration. |
|
Gets a device registry configuration. |
|
Gets the access control policy for a resource. |
|
Lists device registries. |
|
Updates a device registry configuration. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |
|
Deletes the association between the device and the gateway. |