Google Cloud IoT Core is being retired on August 16, 2023. Contact your Google Cloud account team for more information.

Package google.cloud.iot.v1

Index

DeviceManager

Internet of Things (IoT) service. Securely connect and manage IoT devices.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Creates a device in a device registry.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateDeviceRegistry

rpc CreateDeviceRegistry(CreateDeviceRegistryRequest) returns (DeviceRegistry)

Creates a device registry that contains devices.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Deletes a device.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
DeleteDeviceRegistry

rpc DeleteDeviceRegistry(DeleteDeviceRegistryRequest) returns (Empty)

Deletes a device registry configuration.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Gets details about a device.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetDeviceRegistry

rpc GetDeviceRegistry(GetDeviceRegistryRequest) returns (DeviceRegistry)

Gets a device registry configuration.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListDeviceConfigVersions

rpc ListDeviceConfigVersions(ListDeviceConfigVersionsRequest) returns (ListDeviceConfigVersionsResponse)

Lists the last few versions of the device configuration in descending order (i.e.: newest first).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListDeviceRegistries

rpc ListDeviceRegistries(ListDeviceRegistriesRequest) returns (ListDeviceRegistriesResponse)

Lists device registries.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListDeviceStates

rpc ListDeviceStates(ListDeviceStatesRequest) returns (ListDeviceStatesResponse)

Lists the last few versions of the device state in descending order (i.e.: newest first).

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

List devices in a device registry.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ModifyCloudToDeviceConfig

rpc ModifyCloudToDeviceConfig(ModifyCloudToDeviceConfigRequest) returns (DeviceConfig)

Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
SendCommandToDevice

rpc SendCommandToDevice(SendCommandToDeviceRequest) returns (SendCommandToDeviceResponse)

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.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Sets the access control policy on the specified resource. Replaces any existing policy.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

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.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateDevice

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Updates a device.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
UpdateDeviceRegistry

rpc UpdateDeviceRegistry(UpdateDeviceRegistryRequest) returns (DeviceRegistry)

Updates a device registry configuration.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudiot
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateDeviceRegistryRequest

Request for CreateDeviceRegistry.

Fields
parent

string

The project and cloud region where this device registry must be created. For example, projects/example-project/locations/us-central1.

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudiot.registries.create
device_registry

DeviceRegistry

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.

Fields
parent

string

The name of the device registry where this device should be created. For example, projects/example-project/locations/us-central1/registries/my-registry.

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudiot.devices.create
device

Device

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

DeleteDeviceRegistryRequest

Request for DeleteDeviceRegistry.

Fields
name

string

The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.registries.delete

DeleteDeviceRequest

Request for DeleteDevice.

Fields
name

string

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

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.devices.delete

Device

The device resource.

Fields
id

string

The user-defined device identifier. The device ID must be unique within a device registry.

name

string

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.

num_id

uint64

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

credentials[]

DeviceCredential

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.

last_heartbeat_time

Timestamp

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

last_event_time

Timestamp

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

last_state_time

Timestamp

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

last_config_ack_time

Timestamp

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

last_config_send_time

Timestamp

[Output only] The last time a cloud-to-device config version was sent to the device.

blocked

bool

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.

last_error_time

Timestamp

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

last_error_status

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.

config

DeviceConfig

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.

state

DeviceState

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

log_level

LogLevel

Beta Feature

The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
metadata

map<string, string>

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.

Fields
version

int64

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

cloud_update_time

Timestamp

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

device_ack_time

Timestamp

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

binary_data

bytes

The device configuration data.

DeviceCredential

A server-stored device credential used for authentication.

Fields
expiration_time

Timestamp

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

public_key

PublicKeyCredential

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.

Fields
id

string

The identifier of this device registry. For example, myRegistry.

name

string

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

event_notification_configs[]

EventNotificationConfig

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.

state_notification_config

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.

mqtt_config

MqttConfig

The MQTT configuration for this device registry.

http_config

HttpConfig

The DeviceService (HTTP) configuration for this device registry.

log_level

LogLevel

Beta Feature

The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
credentials[]

RegistryCredential

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.

Fields
update_time

Timestamp

[Output only] The time at which this state version was updated in Cloud IoT Core.

binary_data

bytes

The device state data.

EventNotificationConfig

The configuration for forwarding telemetry events.

Fields
subfolder_matches

string

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.

pubsub_topic_name

string

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

GetDeviceRegistryRequest

Request for GetDeviceRegistry.

Fields
name

string

The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.registries.get

GetDeviceRequest

Request for GetDevice.

Fields
name

string

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

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.devices.get
field_mask

FieldMask

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

HttpConfig

The configuration of the HTTP bridge for a device registry.

Fields
http_enabled_state

HttpState

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.

ListDeviceConfigVersionsRequest

Request for ListDeviceConfigVersions.

Fields
name

string

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

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.devices.get
num_versions

int32

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.

Fields
device_configs[]

DeviceConfig

The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one.

ListDeviceRegistriesRequest

Request for ListDeviceRegistries.

Fields
parent

string

The project and cloud region path. For example, projects/example-project/locations/us-central1.

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudiot.registries.list
page_size

int32

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.

page_token

string

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.

ListDeviceRegistriesResponse

Response for ListDeviceRegistries.

Fields
device_registries[]

DeviceRegistry

The registries that matched the query.

next_page_token

string

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.

Fields
name

string

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

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.devices.get
num_states

int32

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.

ListDeviceStatesResponse

Response for ListDeviceStates.

Fields
device_states[]

DeviceState

The last few device states. States are listed in descending order of server update time, starting from the most recent one.

ListDevicesRequest

Request for ListDevices.

Fields
parent

string

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

Authorization requires the following Google IAM permission on the specified resource parent:

  • cloudiot.devices.list
device_num_ids[]

uint64

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

device_ids[]

string

A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000

field_mask

FieldMask

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.

page_size

int32

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.

page_token

string

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.

ListDevicesResponse

Response for ListDevices.

Fields
devices[]

Device

The devices that match the request.

next_page_token

string

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

LogLevel

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.

Enums
LOG_LEVEL_UNSPECIFIED No logging specified. If not specified, logging will be disabled.
NONE Disables logging.
ERROR Error events will be logged.
INFO Informational events will be logged, such as connections and disconnections.
DEBUG All events will be logged.

ModifyCloudToDeviceConfigRequest

Request for ModifyCloudToDeviceConfig.

Fields
name

string

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

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.devices.updateConfig
version_to_update

int64

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.

binary_data

bytes

The configuration data for the device.

MqttConfig

The configuration of MQTT for a device registry.

Fields
mqtt_enabled_state

MqttState

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.

PublicKeyCertificate

A public key certificate format and data.

Fields
format

PublicKeyCertificateFormat

The certificate format.

certificate

string

The certificate data.

x509_details

X509CertificateDetails

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

PublicKeyCredential

A public key format and data.

Fields
format

PublicKeyFormat

The format of the key.

key

string

The key data.

PublicKeyFormat

The supported formats for the public key.

Enums
UNSPECIFIED_PUBLIC_KEY_FORMAT The format has not been specified. This is an invalid default value and must not be used.
RSA_PEM 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 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

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). This curve is defined in OpenSSL as the prime256v1 curve.
ES256_X509_PEM 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-----.

RegistryCredential

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

Fields
public_key_certificate

PublicKeyCertificate

A public key certificate used to verify the device credentials.

SendCommandToDeviceRequest

Request for SendCommandToDevice.

Fields
name

string

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

Authorization requires the following Google IAM permission on the specified resource name:

  • cloudiot.devices.sendCommand
binary_data

bytes

The command data to send to the device.

subfolder

string

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.

SendCommandToDeviceResponse

Response for SendCommandToDevice.

StateNotificationConfig

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

Fields
pubsub_topic_name

string

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

UpdateDeviceRegistryRequest

Request for UpdateDeviceRegistry.

Fields
device_registry

DeviceRegistry

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.

Authorization requires the following Google IAM permission on the specified resource deviceRegistry:

  • cloudiot.registries.update
update_mask

FieldMask

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.

Fields
device

Device

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/device0or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

Authorization requires the following Google IAM permission on the specified resource device:

  • cloudiot.devices.update
update_mask

FieldMask

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.

Fields
issuer

string

The entity that signed the certificate.

subject

string

The entity the certificate and public key belong to.

start_time

Timestamp

The time the certificate becomes valid.

expiry_time

Timestamp

The time the certificate becomes invalid.

signature_algorithm

string

The algorithm used to sign the certificate.

public_key_type

string

The type of public key in the certificate.