Package types (2.5.0)

API documentation for iot_v1.types package.

Classes

BindDeviceToGatewayRequest

Request for BindDeviceToGateway.

BindDeviceToGatewayResponse

Response for BindDeviceToGateway.

CreateDeviceRegistryRequest

Request for CreateDeviceRegistry.

CreateDeviceRequest

Request for CreateDevice.

DeleteDeviceRegistryRequest

Request for DeleteDeviceRegistry.

DeleteDeviceRequest

Request for DeleteDevice.

Device

The device resource.

DeviceConfig

The device configuration. Eventually delivered to devices.

DeviceCredential

A server-stored device credential used for authentication.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeviceRegistry

A container for a group of devices.

DeviceState

The device state, as reported by the device.

EventNotificationConfig

The configuration for forwarding telemetry events.

GatewayAuthMethod

The gateway authorization/authentication method. This setting determines how Cloud IoT Core authorizes/authenticate devices to access the gateway.

GatewayConfig

Gateway-related configuration and state.

GatewayListOptions

Options for limiting the list based on gateway type and associations.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GatewayType

Gateway type.

GetDeviceRegistryRequest

Request for GetDeviceRegistry.

GetDeviceRequest

Request for GetDevice.

HttpConfig

The configuration of the HTTP bridge for a device registry.

HttpState

Indicates whether DeviceService (HTTP) is enabled or disabled for the registry. See the field description for details.

ListDeviceConfigVersionsRequest

Request for ListDeviceConfigVersions.

ListDeviceConfigVersionsResponse

Response for ListDeviceConfigVersions.

ListDeviceRegistriesRequest

Request for ListDeviceRegistries.

ListDeviceRegistriesResponse

Response for ListDeviceRegistries.

ListDeviceStatesRequest

Request for ListDeviceStates.

ListDeviceStatesResponse

Response for ListDeviceStates.

ListDevicesRequest

Request for ListDevices.

ListDevicesResponse

Response for ListDevices.

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.

ModifyCloudToDeviceConfigRequest

Request for ModifyCloudToDeviceConfig.

MqttConfig

The configuration of MQTT for a device registry.

MqttState

Indicates whether an MQTT connection is enabled or disabled. See the field description for details.

PublicKeyCertificate

A public key certificate format and data.

PublicKeyCertificateFormat

The supported formats for the public key.

PublicKeyCredential

A public key format and data.

PublicKeyFormat

The supported formats for the public key.

RegistryCredential

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SendCommandToDeviceRequest

Request for SendCommandToDevice.

SendCommandToDeviceResponse

Response for SendCommandToDevice.

StateNotificationConfig

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

UnbindDeviceFromGatewayRequest

Request for UnbindDeviceFromGateway.

UnbindDeviceFromGatewayResponse

Response for UnbindDeviceFromGateway.

UpdateDeviceRegistryRequest

Request for UpdateDeviceRegistry.

UpdateDeviceRequest

Request for UpdateDevice.

X509CertificateDetails

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