Package types (2.2.1) Stay organized with collections Save and categorize content based on your preferences.
API documentation foriot_v1.types package.
Classes
BindDeviceToGatewayRequest
Request forBindDeviceToGateway... attribute:: parent
Required. The name of the registry. For example,projects/example-project/locations/us-central1/registries/my-registry.
:type: str
BindDeviceToGatewayResponse
Response forBindDeviceToGateway.
CreateDeviceRegistryRequest
Request forCreateDeviceRegistry... attribute:: parent
Required. The project and cloud region where this device registry must be created. For example,projects/example-project/locations/us-central1.
:type: str
CreateDeviceRequest
Request forCreateDevice... attribute:: parent
Required. The name of the device registry where this device should be created. For example,projects/example-project/locations/us-central1/registries/my-registry.
:type: str
DeleteDeviceRegistryRequest
Request forDeleteDeviceRegistry... attribute:: name
Required. The name of the device registry. For example,projects/example-project/locations/us-central1/registries/my-registry.
:type: str
DeleteDeviceRequest
Request forDeleteDevice... attribute:: name
Required. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0 orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
:type: str
Device
The device resource... attribute:: id
The user-defined device identifier. The device ID must be unique within a device registry.
:type: str
DeviceConfig
The device configuration. Eventually delivered to devices... attribute:: version
[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 theCreateDevice request if aconfig is specified; the response ofCreateDevice will always have a value of 1.
:type: int
DeviceCredential
A server-stored device credential used for authentication... attribute:: public_key
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... attribute:: id
The identifier of this device registry. For example,myRegistry.
:type: str
DeviceState
The device state, as reported by the device... attribute:: update_time
[Output only] The time at which this state version was updated in Cloud IoT Core.
:type: google.protobuf.timestamp_pb2.Timestamp
EventNotificationConfig
The configuration for forwarding telemetry events... attribute:: subfolder_matches
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.
:type: str
GatewayAuthMethod
The gateway authorization/authentication method. This settingdetermines how Cloud IoT Core authorizes/authenticate devices toaccess the gateway.
GatewayConfig
Gateway-related configuration and state... attribute:: gateway_type
Indicates whether the device is a gateway.
GatewayListOptions
Options for limiting the list based on gateway type andassociations.
GatewayType
Gateway type.
GetDeviceRegistryRequest
Request forGetDeviceRegistry... attribute:: name
Required. The name of the device registry. For example,projects/example-project/locations/us-central1/registries/my-registry.
:type: str
GetDeviceRequest
Request forGetDevice... attribute:: name
Required. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0 orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
:type: str
HttpConfig
The configuration of the HTTP bridge for a device registry... attribute:: http_enabled_state
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 disabledfor the registry. See the field description for details.
ListDeviceConfigVersionsRequest
Request forListDeviceConfigVersions... attribute:: name
Required. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0 orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
:type: str
ListDeviceConfigVersionsResponse
Response forListDeviceConfigVersions... attribute:: device_configs
The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one.
:type: Sequence[google.cloud.iot_v1.types.DeviceConfig]
ListDeviceRegistriesRequest
Request forListDeviceRegistries... attribute:: parent
Required. The project and cloud region path. For example,projects/example-project/locations/us-central1.
:type: str
ListDeviceRegistriesResponse
Response forListDeviceRegistries... attribute:: device_registries
The registries that matched the query.
:type: Sequence[google.cloud.iot_v1.types.DeviceRegistry]
ListDeviceStatesRequest
Request forListDeviceStates... attribute:: name
Required. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0 orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
:type: str
ListDeviceStatesResponse
Response forListDeviceStates... attribute:: device_states
The last few device states. States are listed in descending order of server update time, starting from the most recent one.
:type: Sequence[google.cloud.iot_v1.types.DeviceState]
ListDevicesRequest
Request forListDevices... attribute:: parent
Required. The device registry path. Required. For example,projects/my-project/locations/us-central1/registries/my-registry.
:type: str
ListDevicesResponse
Response forListDevices... attribute:: devices
The devices that match the request.
:type: Sequence[google.cloud.iot_v1.types.Device]
LogLevel
Beta Feature
The logging verbosity for device activity. Specifies which eventsshould be written to logs. For example, if the LogLevel is ERROR,only events that terminate in errors will be logged. LogLevel isinclusive; enabling INFO logging will also enable ERROR logging.
ModifyCloudToDeviceConfigRequest
Request forModifyCloudToDeviceConfig... attribute:: name
Required. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0 orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
:type: str
MqttConfig
The configuration of MQTT for a device registry... attribute:: mqtt_enabled_state
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.
PublicKeyCertificate
A public key certificate format and data... attribute:: format
The certificate format.
PublicKeyCertificateFormat
The supported formats for the public key.
PublicKeyCredential
A public key format and data... attribute:: format
The format of the key.
PublicKeyFormat
The supported formats for the public key.
RegistryCredential
A server-stored registry credential used to validate devicecredentials.
SendCommandToDeviceRequest
Request forSendCommandToDevice... attribute:: name
Required. The name of the device. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0 orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
:type: str
SendCommandToDeviceResponse
Response forSendCommandToDevice.
StateNotificationConfig
The configuration for notification of new states receivedfrom the device.
UnbindDeviceFromGatewayRequest
Request forUnbindDeviceFromGateway... attribute:: parent
Required. The name of the registry. For example,projects/example-project/locations/us-central1/registries/my-registry.
:type: str
UnbindDeviceFromGatewayResponse
Response forUnbindDeviceFromGateway.
UpdateDeviceRegistryRequest
Request forUpdateDeviceRegistry... attribute:: device_registry
Required. The new values for the device registry. Theid field must be empty, and thename field must indicate the path of the resource. For example,projects/example-project/locations/us-central1/registries/my-registry.
UpdateDeviceRequest
Request forUpdateDevice... attribute:: device
Required. The new values for the device. Theid andnum_id fields must be empty, and the fieldname must specify the name path. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0\ orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
X509CertificateDetails
Details of an X.509 certificate. For informational purposesonly.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.