As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Iot v1 API

class google.cloud.iot_v1.types.BindDeviceToGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for BindDeviceToGateway.

parent

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

Type

str

gateway_id

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

Type

str

device_id

Required. The device to associate with the specified gateway. The value of device_id can be either the device numeric ID or the user-defined device identifier.

Type

str

class google.cloud.iot_v1.types.BindDeviceToGatewayResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for BindDeviceToGateway.

class google.cloud.iot_v1.types.CreateDeviceRegistryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for CreateDeviceRegistry.

parent

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

Type

str

device_registry

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

Type

google.cloud.iot_v1.types.DeviceRegistry

class google.cloud.iot_v1.types.CreateDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for CreateDevice.

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

device

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

Type

google.cloud.iot_v1.types.Device

class google.cloud.iot_v1.types.DeleteDeviceRegistryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for DeleteDeviceRegistry.

name

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

Type

str

class google.cloud.iot_v1.types.DeleteDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for DeleteDevice.

name

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

Type

str

class google.cloud.iot_v1.types.Device(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The device resource.

id

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

Type

str

name

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.

Type

str

num_id

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

Type

int

credentials

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.

Type

MutableSequence[google.cloud.iot_v1.types.DeviceCredential]

last_heartbeat_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

last_event_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

last_state_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

last_config_ack_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

last_config_send_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

blocked

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.

Type

bool

last_error_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

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

Type

google.rpc.status_pb2.Status

config

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.

Type

google.cloud.iot_v1.types.DeviceConfig

state

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

Type

google.cloud.iot_v1.types.DeviceState

log_level

Beta Feature

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

Type

google.cloud.iot_v1.types.LogLevel

metadata

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.

Type

MutableMapping[str, str]

gateway_config

Gateway-related configuration and state.

Type

google.cloud.iot_v1.types.GatewayConfig

class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.iot_v1.types.DeviceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The device configuration. Eventually delivered to devices.

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 the CreateDevice request if a config is specified; the response of CreateDevice will always have a value of 1.

Type

int

cloud_update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

device_ack_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

binary_data

The device configuration data.

Type

bytes

class google.cloud.iot_v1.types.DeviceCredential(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A server-stored device credential used for authentication.

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.

This field is a member of oneof credential.

Type

google.cloud.iot_v1.types.PublicKeyCredential

expiration_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.iot_v1.types.DeviceRegistry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A container for a group of devices.

id

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

Type

str

name

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

Type

str

event_notification_configs

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.

Type

MutableSequence[google.cloud.iot_v1.types.EventNotificationConfig]

state_notification_config

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.

Type

google.cloud.iot_v1.types.StateNotificationConfig

mqtt_config

The MQTT configuration for this device registry.

Type

google.cloud.iot_v1.types.MqttConfig

http_config

The DeviceService (HTTP) configuration for this device registry.

Type

google.cloud.iot_v1.types.HttpConfig

log_level

Beta Feature

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

Type

google.cloud.iot_v1.types.LogLevel

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

Type

MutableSequence[google.cloud.iot_v1.types.RegistryCredential]

class google.cloud.iot_v1.types.DeviceState(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The device state, as reported by the device.

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

binary_data

The device state data.

Type

bytes

class google.cloud.iot_v1.types.EventNotificationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The configuration for forwarding telemetry events.

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

pubsub_topic_name

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

Type

str

class google.cloud.iot_v1.types.GatewayAuthMethod(value)

Bases: proto.enums.Enum

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.

class google.cloud.iot_v1.types.GatewayConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Gateway-related configuration and state.

gateway_type

Indicates whether the device is a gateway.

Type

google.cloud.iot_v1.types.GatewayType

gateway_auth_method

Indicates how to authorize and/or authenticate devices to access the gateway.

Type

google.cloud.iot_v1.types.GatewayAuthMethod

last_accessed_gateway_id

[Output only] The ID of the gateway the device accessed most recently.

Type

str

last_accessed_gateway_time

[Output only] The most recent time at which the device accessed the gateway specified in last_accessed_gateway.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.iot_v1.types.GatewayListOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

gateway_type

If GATEWAY is specified, only gateways are returned. If NON_GATEWAY is specified, only non-gateway devices are returned. If GATEWAY_TYPE_UNSPECIFIED is specified, all devices are returned.

This field is a member of oneof filter.

Type

google.cloud.iot_v1.types.GatewayType

associations_gateway_id

If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (num_id) or the user-defined string (id). For example, if 123 is specified, only devices bound to the gateway with num_id 123 are returned.

This field is a member of oneof filter.

Type

str

associations_device_id

If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (num_id) or the user-defined string (id). For example, if 456 is specified, returns only the gateways to which the device with num_id 456 is bound.

This field is a member of oneof filter.

Type

str

class google.cloud.iot_v1.types.GatewayType(value)

Bases: proto.enums.Enum

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.

class google.cloud.iot_v1.types.GetDeviceRegistryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for GetDeviceRegistry.

name

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

Type

str

class google.cloud.iot_v1.types.GetDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for GetDevice.

name

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

Type

str

field_mask

The fields of the Device resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields have to be provided in snake_case format, for example: last_heartbeat_time.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.iot_v1.types.HttpConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The configuration of the HTTP bridge for a device registry.

http_enabled_state

If enabled, allows devices to use DeviceService via the HTTP protocol. Otherwise, any requests to DeviceService will fail for this registry.

Type

google.cloud.iot_v1.types.HttpState

class google.cloud.iot_v1.types.HttpState(value)

Bases: proto.enums.Enum

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.

class google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListDeviceConfigVersions.

name

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

Type

str

num_versions

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.

Type

int

class google.cloud.iot_v1.types.ListDeviceConfigVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListDeviceConfigVersions.

device_configs

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

Type

MutableSequence[google.cloud.iot_v1.types.DeviceConfig]

class google.cloud.iot_v1.types.ListDeviceRegistriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListDeviceRegistries.

parent

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

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.cloud.iot_v1.types.ListDeviceRegistriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListDeviceRegistries.

device_registries

The registries that matched the query.

Type

MutableSequence[google.cloud.iot_v1.types.DeviceRegistry]

next_page_token

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

Type

str

class google.cloud.iot_v1.types.ListDeviceStatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListDeviceStates.

name

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

Type

str

num_states

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.

Type

int

class google.cloud.iot_v1.types.ListDeviceStatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListDeviceStates.

device_states

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

Type

MutableSequence[google.cloud.iot_v1.types.DeviceState]

class google.cloud.iot_v1.types.ListDevicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ListDevices.

parent

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

Type

str

device_num_ids

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

Type

MutableSequence[int]

device_ids

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

Type

MutableSequence[str]

field_mask

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 in snake_case format, for example: last_heartbeat_time.

Type

google.protobuf.field_mask_pb2.FieldMask

gateway_list_options

Options related to gateways.

Type

google.cloud.iot_v1.types.GatewayListOptions

page_size

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.

Type

int

page_token

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.

Type

str

class google.cloud.iot_v1.types.ListDevicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for ListDevices.

devices

The devices that match the request.

Type

MutableSequence[google.cloud.iot_v1.types.Device]

next_page_token

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

Type

str

class google.cloud.iot_v1.types.LogLevel(value)

Bases: proto.enums.Enum

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.

class google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for ModifyCloudToDeviceConfig.

name

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

Type

str

version_to_update

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.

Type

int

binary_data

Required. The configuration data for the device.

Type

bytes

class google.cloud.iot_v1.types.MqttConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The configuration of MQTT for a device registry.

mqtt_enabled_state

If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.

Type

google.cloud.iot_v1.types.MqttState

class google.cloud.iot_v1.types.MqttState(value)

Bases: proto.enums.Enum

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.

class google.cloud.iot_v1.types.PublicKeyCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A public key certificate format and data.

format

The certificate format.

Type

google.cloud.iot_v1.types.PublicKeyCertificateFormat

certificate

The certificate data.

Type

str

x509_details

[Output only] The certificate details. Used only for X.509 certificates.

Type

google.cloud.iot_v1.types.X509CertificateDetails

class google.cloud.iot_v1.types.PublicKeyCertificateFormat(value)

Bases: proto.enums.Enum

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), encoded in base64, and wrapped by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

class google.cloud.iot_v1.types.PublicKeyCredential(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A public key format and data.

format

The format of the key.

Type

google.cloud.iot_v1.types.PublicKeyFormat

key

The key data.

Type

str

class google.cloud.iot_v1.types.PublicKeyFormat(value)

Bases: proto.enums.Enum

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

RSA_X509_PEM (1):

As RSA_PEM, but wrapped in an X.509v3 certificate (RFC5280), 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). This curve is defined in OpenSSL as the prime256v1 curve.

ES256_X509_PEM (4):

As ES256_PEM, but wrapped in an X.509v3 certificate (RFC5280), encoded in base64, and wrapped by -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

class google.cloud.iot_v1.types.RegistryCredential(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

public_key_certificate

A public key certificate used to verify the device credentials.

This field is a member of oneof credential.

Type

google.cloud.iot_v1.types.PublicKeyCertificate

class google.cloud.iot_v1.types.SendCommandToDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for SendCommandToDevice.

name

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

Type

str

binary_data

Required. The command data to send to the device.

Type

bytes

subfolder

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.

Type

str

class google.cloud.iot_v1.types.SendCommandToDeviceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for SendCommandToDevice.

class google.cloud.iot_v1.types.StateNotificationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

pubsub_topic_name

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

Type

str

class google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UnbindDeviceFromGateway.

parent

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

Type

str

gateway_id

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

Type

str

device_id

Required. The device to disassociate from the specified gateway. The value of device_id can be either the device numeric ID or the user-defined device identifier.

Type

str

class google.cloud.iot_v1.types.UnbindDeviceFromGatewayResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for UnbindDeviceFromGateway.

class google.cloud.iot_v1.types.UpdateDeviceRegistryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UpdateDeviceRegistry.

device_registry

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

Type

google.cloud.iot_v1.types.DeviceRegistry

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.iot_v1.types.UpdateDeviceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for UpdateDevice.

device

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

Type

google.cloud.iot_v1.types.Device

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.iot_v1.types.X509CertificateDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

issuer

The entity that signed the certificate.

Type

str

subject

The entity the certificate and public key belong to.

Type

str

start_time

The time the certificate becomes valid.

Type

google.protobuf.timestamp_pb2.Timestamp

expiry_time

The time the certificate becomes invalid.

Type

google.protobuf.timestamp_pb2.Timestamp

signature_algorithm

The algorithm used to sign the certificate.

Type

str

public_key_type

The type of public key in the certificate.

Type

str