Package types (2.9.1)

API documentation for iot_v1.types package.

Classes

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

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.

Values: GATEWAY_AUTH_METHOD_UNSPECIFIED (0): No authentication/authorization method specified. No devices are allowed to access the gateway. ASSOCIATION_ONLY (1): The device is authenticated through the gateway association only. Device credentials are ignored even if provided. DEVICE_AUTH_TOKEN_ONLY (2): The device is authenticated through its own credentials. Gateway association is not checked. ASSOCIATION_AND_DEVICE_AUTH_TOKEN (3): The device is authenticated through both device credentials and gateway association. The device must be bound to the gateway and must provide its own credentials.

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.

Values: GATEWAY_TYPE_UNSPECIFIED (0): If unspecified, the device is considered a non-gateway device. GATEWAY (1): The device is a gateway. NON_GATEWAY (2): The device is not a gateway.

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.

Values: HTTP_STATE_UNSPECIFIED (0): No HTTP state specified. If not specified, DeviceService will be enabled by default. HTTP_ENABLED (1): Enables DeviceService (HTTP) service for the registry. HTTP_DISABLED (2): Disables DeviceService (HTTP) service for the registry.

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.

Values: LOG_LEVEL_UNSPECIFIED (0): No logging specified. If not specified, logging will be disabled. NONE (10): Disables logging. ERROR (20): Error events will be logged. INFO (30): Informational events will be logged, such as connections and disconnections. DEBUG (40): All events will be logged.

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.

Values: MQTT_STATE_UNSPECIFIED (0): No MQTT state specified. If not specified, MQTT will be enabled by default. MQTT_ENABLED (1): Enables a MQTT connection. MQTT_DISABLED (2): Disables a MQTT connection.

PublicKeyCertificate

A public key certificate format and data.

PublicKeyCertificateFormat

The supported formats for the public key.

Values: UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT (0): The format has not been specified. This is an invalid default value and must not be used. X509_CERTIFICATE_PEM (1): An X.509v3 certificate (RFC5280 <https://www.ietf.org/rfc/rfc5280.txt>__), encoded in base64, and wrapped by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

PublicKeyCredential

A public key format and data.

PublicKeyFormat

The supported formats for the public key.

Values: UNSPECIFIED_PUBLIC_KEY_FORMAT (0): The format has not been specified. This is an invalid default value and must not be used. RSA_PEM (3): 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 (1): 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 (2): 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 <https://www.ietf.org/rfc/rfc7518.txt>). This curve is defined in OpenSSL <https://www.openssl.org/> as the prime256v1 curve. ES256_X509_PEM (4): 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-----.