Types for Cloud IoT API Client¶

class google.cloud.iot_v1.types.Any¶

type_url¶: Field google.protobuf.Any.type_url

value¶: Field google.protobuf.Any.value

class google.cloud.iot_v1.types.BindDeviceToGatewayRequest¶

Request for BindDeviceToGateway.

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

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

device_id¶: 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.

device_id: Field google.cloud.iot.v1.BindDeviceToGatewayRequest.device_id

gateway_id: Field google.cloud.iot.v1.BindDeviceToGatewayRequest.gateway_id

parent: Field google.cloud.iot.v1.BindDeviceToGatewayRequest.parent

class google.cloud.iot_v1.types.BindDeviceToGatewayResponse¶: Response for BindDeviceToGateway.

class google.cloud.iot_v1.types.Binding¶

Associates members with a role.

role¶: Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required

members¶: Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: - allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. - allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. - user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. - serviceAccount:{emailid}: An email address that represents a service account. For example, my-other- app@appspot.gserviceaccount.com. - group:{emailid}: An email address that represents a Google group. For example, admins@example.com. - domain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.

members: Field google.iam.v1.Binding.members

role: Field google.iam.v1.Binding.role

class google.cloud.iot_v1.types.BindingDelta¶

One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.

action¶: The action that was performed on a Binding. Required

role¶: Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required

member¶: A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required

action: Field google.iam.v1.BindingDelta.action

member: Field google.iam.v1.BindingDelta.member

role: Field google.iam.v1.BindingDelta.role

class google.cloud.iot_v1.types.CreateDeviceRegistryRequest¶

Request for CreateDeviceRegistry.

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

device_registry¶: 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.

device_registry: Field google.cloud.iot.v1.CreateDeviceRegistryRequest.device_registry

parent: Field google.cloud.iot.v1.CreateDeviceRegistryRequest.parent

class google.cloud.iot_v1.types.CreateDeviceRequest¶

Request for CreateDevice.

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

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

device: Field google.cloud.iot.v1.CreateDeviceRequest.device

parent: Field google.cloud.iot.v1.CreateDeviceRequest.parent

class google.cloud.iot_v1.types.DeleteDeviceRegistryRequest¶

Request for DeleteDeviceRegistry.

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

name: Field google.cloud.iot.v1.DeleteDeviceRegistryRequest.name

class google.cloud.iot_v1.types.DeleteDeviceRequest¶

Request for DeleteDevice.

name¶: 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}.

name: Field google.cloud.iot.v1.DeleteDeviceRequest.name

class google.cloud.iot_v1.types.Device¶

The device resource.

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

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.

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.

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.

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.

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.

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.

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.

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

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.

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

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.

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.

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

log_level¶: Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.

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.

gateway_config¶: Gateway-related configuration and state.

class MetadataEntry¶

key¶: Field google.cloud.iot.v1.Device.MetadataEntry.key

value¶: Field google.cloud.iot.v1.Device.MetadataEntry.value

blocked: Field google.cloud.iot.v1.Device.blocked

config: Field google.cloud.iot.v1.Device.config

credentials: Field google.cloud.iot.v1.Device.credentials

gateway_config: Field google.cloud.iot.v1.Device.gateway_config

id: Field google.cloud.iot.v1.Device.id

last_config_ack_time: Field google.cloud.iot.v1.Device.last_config_ack_time

last_config_send_time: Field google.cloud.iot.v1.Device.last_config_send_time

last_error_status: Field google.cloud.iot.v1.Device.last_error_status

last_error_time: Field google.cloud.iot.v1.Device.last_error_time

last_event_time: Field google.cloud.iot.v1.Device.last_event_time

last_heartbeat_time: Field google.cloud.iot.v1.Device.last_heartbeat_time

last_state_time: Field google.cloud.iot.v1.Device.last_state_time

log_level: Field google.cloud.iot.v1.Device.log_level

metadata: Field google.cloud.iot.v1.Device.metadata

name: Field google.cloud.iot.v1.Device.name

num_id: Field google.cloud.iot.v1.Device.num_id

state: Field google.cloud.iot.v1.Device.state

class google.cloud.iot_v1.types.DeviceConfig¶

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.

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.

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.

binary_data¶: The device configuration data.

binary_data: Field google.cloud.iot.v1.DeviceConfig.binary_data

cloud_update_time: Field google.cloud.iot.v1.DeviceConfig.cloud_update_time

device_ack_time: Field google.cloud.iot.v1.DeviceConfig.device_ack_time

version: Field google.cloud.iot.v1.DeviceConfig.version

class google.cloud.iot_v1.types.DeviceCredential¶

A server-stored device credential used for authentication.

credential¶: The credential data. Reserved for expansion in the future.

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.

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.

expiration_time: Field google.cloud.iot.v1.DeviceCredential.expiration_time

public_key: Field google.cloud.iot.v1.DeviceCredential.public_key

class google.cloud.iot_v1.types.DeviceRegistry¶

A container for a group of devices.

id¶: The identifier of this device registry. For example, myRegistry.

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

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.

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.

mqtt_config¶: The MQTT configuration for this device registry.

http_config¶: The DeviceService (HTTP) configuration for this device registry.

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.

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.

credentials: Field google.cloud.iot.v1.DeviceRegistry.credentials

event_notification_configs: Field google.cloud.iot.v1.DeviceRegistry.event_notification_configs

http_config: Field google.cloud.iot.v1.DeviceRegistry.http_config

id: Field google.cloud.iot.v1.DeviceRegistry.id

log_level: Field google.cloud.iot.v1.DeviceRegistry.log_level

mqtt_config: Field google.cloud.iot.v1.DeviceRegistry.mqtt_config

name: Field google.cloud.iot.v1.DeviceRegistry.name

state_notification_config: Field google.cloud.iot.v1.DeviceRegistry.state_notification_config

class google.cloud.iot_v1.types.DeviceState¶

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.

binary_data¶: The device state data.

binary_data: Field google.cloud.iot.v1.DeviceState.binary_data

update_time: Field google.cloud.iot.v1.DeviceState.update_time

class google.cloud.iot_v1.types.Empty¶

class google.cloud.iot_v1.types.EventNotificationConfig¶

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.

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

pubsub_topic_name: Field google.cloud.iot.v1.EventNotificationConfig.pubsub_topic_name

subfolder_matches: Field google.cloud.iot.v1.EventNotificationConfig.subfolder_matches

class google.cloud.iot_v1.types.Expr¶

description¶: Field google.type.Expr.description

expression¶: Field google.type.Expr.expression

location¶: Field google.type.Expr.location

title¶: Field google.type.Expr.title

class google.cloud.iot_v1.types.FieldMask¶

paths¶: Field google.protobuf.FieldMask.paths

class google.cloud.iot_v1.types.GatewayConfig¶

Gateway-related configuration and state.

gateway_type¶: Indicates whether the device is a gateway.

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

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

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

gateway_auth_method: Field google.cloud.iot.v1.GatewayConfig.gateway_auth_method

gateway_type: Field google.cloud.iot.v1.GatewayConfig.gateway_type

last_accessed_gateway_id: Field google.cloud.iot.v1.GatewayConfig.last_accessed_gateway_id

last_accessed_gateway_time: Field google.cloud.iot.v1.GatewayConfig.last_accessed_gateway_time

class google.cloud.iot_v1.types.GatewayListOptions¶

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

filter¶: If not set, all devices and gateways are returned. If set, the list is filtered based on gateway type and associations.

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.

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.

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.

associations_device_id: Field google.cloud.iot.v1.GatewayListOptions.associations_device_id

associations_gateway_id: Field google.cloud.iot.v1.GatewayListOptions.associations_gateway_id

gateway_type: Field google.cloud.iot.v1.GatewayListOptions.gateway_type

class google.cloud.iot_v1.types.GetDeviceRegistryRequest¶

Request for GetDeviceRegistry.

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

name: Field google.cloud.iot.v1.GetDeviceRegistryRequest.name

class google.cloud.iot_v1.types.GetDeviceRequest¶

Request for GetDevice.

name¶: 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}.

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.

field_mask: Field google.cloud.iot.v1.GetDeviceRequest.field_mask

name: Field google.cloud.iot.v1.GetDeviceRequest.name

class google.cloud.iot_v1.types.GetIamPolicyRequest¶

Request message for GetIamPolicy method.

resource¶: REQUIRED: The resource for which the policy is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

resource: Field google.iam.v1.GetIamPolicyRequest.resource

class google.cloud.iot_v1.types.HttpConfig¶

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.

http_enabled_state: Field google.cloud.iot.v1.HttpConfig.http_enabled_state

class google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest¶

Request for ListDeviceConfigVersions.

name¶: 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}.

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.

name: Field google.cloud.iot.v1.ListDeviceConfigVersionsRequest.name

num_versions: Field google.cloud.iot.v1.ListDeviceConfigVersionsRequest.num_versions

class google.cloud.iot_v1.types.ListDeviceConfigVersionsResponse¶

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.

device_configs: Field google.cloud.iot.v1.ListDeviceConfigVersionsResponse.device_configs

class google.cloud.iot_v1.types.ListDeviceRegistriesRequest¶

Request for ListDeviceRegistries.

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

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.

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.

page_size: Field google.cloud.iot.v1.ListDeviceRegistriesRequest.page_size

page_token: Field google.cloud.iot.v1.ListDeviceRegistriesRequest.page_token

parent: Field google.cloud.iot.v1.ListDeviceRegistriesRequest.parent

class google.cloud.iot_v1.types.ListDeviceRegistriesResponse¶

Response for ListDeviceRegistries.

device_registries¶: The registries that matched the query.

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.

device_registries: Field google.cloud.iot.v1.ListDeviceRegistriesResponse.device_registries

next_page_token: Field google.cloud.iot.v1.ListDeviceRegistriesResponse.next_page_token

class google.cloud.iot_v1.types.ListDeviceStatesRequest¶

Request for ListDeviceStates.

name¶: 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}.

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.

name: Field google.cloud.iot.v1.ListDeviceStatesRequest.name

num_states: Field google.cloud.iot.v1.ListDeviceStatesRequest.num_states

class google.cloud.iot_v1.types.ListDeviceStatesResponse¶

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.

device_states: Field google.cloud.iot.v1.ListDeviceStatesResponse.device_states

class google.cloud.iot_v1.types.ListDevicesRequest¶

Request for ListDevices.

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

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

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

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.

gateway_list_options¶: Options related to gateways.

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.

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.

device_ids: Field google.cloud.iot.v1.ListDevicesRequest.device_ids

device_num_ids: Field google.cloud.iot.v1.ListDevicesRequest.device_num_ids

field_mask: Field google.cloud.iot.v1.ListDevicesRequest.field_mask

gateway_list_options: Field google.cloud.iot.v1.ListDevicesRequest.gateway_list_options

page_size: Field google.cloud.iot.v1.ListDevicesRequest.page_size

page_token: Field google.cloud.iot.v1.ListDevicesRequest.page_token

parent: Field google.cloud.iot.v1.ListDevicesRequest.parent

class google.cloud.iot_v1.types.ListDevicesResponse¶

Response for ListDevices.

devices¶: The devices that match the request.

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.

devices: Field google.cloud.iot.v1.ListDevicesResponse.devices

next_page_token: Field google.cloud.iot.v1.ListDevicesResponse.next_page_token

class google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest¶

Request for ModifyCloudToDeviceConfig.

name¶: 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}.

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.

binary_data¶: The configuration data for the device.

binary_data: Field google.cloud.iot.v1.ModifyCloudToDeviceConfigRequest.binary_data

name: Field google.cloud.iot.v1.ModifyCloudToDeviceConfigRequest.name

version_to_update: Field google.cloud.iot.v1.ModifyCloudToDeviceConfigRequest.version_to_update

class google.cloud.iot_v1.types.MqttConfig¶

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.

mqtt_enabled_state: Field google.cloud.iot.v1.MqttConfig.mqtt_enabled_state

class google.cloud.iot_v1.types.Policy¶

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.

Example

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-other-app@appspot.gserviceaccount.com",
      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

For a description of IAM and its features, see the IAM developer’s guide.

version¶: Version of the Policy. The default version is 0.

bindings¶: Associates a list of members to a role. Multiple bindings must not be specified for the same role. bindings with no members will result in an error.

etag¶: etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

bindings: Field google.iam.v1.Policy.bindings

etag: Field google.iam.v1.Policy.etag

version: Field google.iam.v1.Policy.version

class google.cloud.iot_v1.types.PolicyDelta¶

The difference delta between two policies.

binding_deltas¶: The delta for Bindings between two policies.

binding_deltas: Field google.iam.v1.PolicyDelta.binding_deltas

class google.cloud.iot_v1.types.PublicKeyCertificate¶

A public key certificate format and data.

format¶: The certificate format.

certificate¶: The certificate data.

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

certificate: Field google.cloud.iot.v1.PublicKeyCertificate.certificate

format: Field google.cloud.iot.v1.PublicKeyCertificate.format

x509_details: Field google.cloud.iot.v1.PublicKeyCertificate.x509_details

class google.cloud.iot_v1.types.PublicKeyCredential¶

A public key format and data.

format¶: The format of the key.

key¶: The key data.

format: Field google.cloud.iot.v1.PublicKeyCredential.format

key: Field google.cloud.iot.v1.PublicKeyCredential.key

class google.cloud.iot_v1.types.RegistryCredential¶

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

credential¶: The credential data. Reserved for expansion in the future.

public_key_certificate¶: A public key certificate used to verify the device credentials.

public_key_certificate: Field google.cloud.iot.v1.RegistryCredential.public_key_certificate

class google.cloud.iot_v1.types.SendCommandToDeviceRequest¶

Request for SendCommandToDevice.

name¶: 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}.

binary_data¶: The command data to send to the device.

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.

binary_data: Field google.cloud.iot.v1.SendCommandToDeviceRequest.binary_data

name: Field google.cloud.iot.v1.SendCommandToDeviceRequest.name

subfolder: Field google.cloud.iot.v1.SendCommandToDeviceRequest.subfolder

class google.cloud.iot_v1.types.SendCommandToDeviceResponse¶: Response for SendCommandToDevice.

class google.cloud.iot_v1.types.SetIamPolicyRequest¶

Request message for SetIamPolicy method.

resource¶: REQUIRED: The resource for which the policy is being specified. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

policy¶: REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

policy: Field google.iam.v1.SetIamPolicyRequest.policy

resource: Field google.iam.v1.SetIamPolicyRequest.resource

class google.cloud.iot_v1.types.StateNotificationConfig¶

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.

pubsub_topic_name: Field google.cloud.iot.v1.StateNotificationConfig.pubsub_topic_name

class google.cloud.iot_v1.types.Status¶

code¶: Field google.rpc.Status.code

details¶: Field google.rpc.Status.details

message¶: Field google.rpc.Status.message

class google.cloud.iot_v1.types.TestIamPermissionsRequest¶

Request message for TestIamPermissions method.

resource¶: REQUIRED: The resource for which the policy detail is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

permissions¶: The set of permissions to check for the resource. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.

permissions: Field google.iam.v1.TestIamPermissionsRequest.permissions

resource: Field google.iam.v1.TestIamPermissionsRequest.resource

class google.cloud.iot_v1.types.TestIamPermissionsResponse¶

Response message for TestIamPermissions method.

permissions¶: A subset of TestPermissionsRequest.permissions that the caller is allowed.

permissions: Field google.iam.v1.TestIamPermissionsResponse.permissions

class google.cloud.iot_v1.types.Timestamp¶

nanos¶: Field google.protobuf.Timestamp.nanos

seconds¶: Field google.protobuf.Timestamp.seconds

class google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest¶

Request for UnbindDeviceFromGateway.

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

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

device_id¶: 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.

device_id: Field google.cloud.iot.v1.UnbindDeviceFromGatewayRequest.device_id

gateway_id: Field google.cloud.iot.v1.UnbindDeviceFromGatewayRequest.gateway_id

parent: Field google.cloud.iot.v1.UnbindDeviceFromGatewayRequest.parent

class google.cloud.iot_v1.types.UnbindDeviceFromGatewayResponse¶: Response for UnbindDeviceFromGateway.

class google.cloud.iot_v1.types.UpdateDeviceRegistryRequest¶

Request for UpdateDeviceRegistry.

device_registry¶: 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.

update_mask¶: 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.

device_registry: Field google.cloud.iot.v1.UpdateDeviceRegistryRequest.device_registry

update_mask: Field google.cloud.iot.v1.UpdateDeviceRegistryRequest.update_mask

class google.cloud.iot_v1.types.UpdateDeviceRequest¶

Request for UpdateDevice.

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

update_mask¶: 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

device: Field google.cloud.iot.v1.UpdateDeviceRequest.device

update_mask: Field google.cloud.iot.v1.UpdateDeviceRequest.update_mask

class google.cloud.iot_v1.types.X509CertificateDetails¶

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

issuer¶: The entity that signed the certificate.

subject¶: The entity the certificate and public key belong to.

start_time¶: The time the certificate becomes valid.

expiry_time¶: The time the certificate becomes invalid.

signature_algorithm¶: The algorithm used to sign the certificate.

public_key_type¶: The type of public key in the certificate.

expiry_time: Field google.cloud.iot.v1.X509CertificateDetails.expiry_time

issuer: Field google.cloud.iot.v1.X509CertificateDetails.issuer

public_key_type: Field google.cloud.iot.v1.X509CertificateDetails.public_key_type

signature_algorithm: Field google.cloud.iot.v1.X509CertificateDetails.signature_algorithm

start_time: Field google.cloud.iot.v1.X509CertificateDetails.start_time

subject: Field google.cloud.iot.v1.X509CertificateDetails.subject

Types for Cloud IoT API Client¶

google-cloud-iot

Navigation

Related Topics