Class DeviceManagerAsyncClient (2.0.2)

DeviceManagerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-iot/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Internet of Things (IoT) service. Securely connect and manage IoT devices.

Methods

DeviceManagerAsyncClient

DeviceManagerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-iot/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the device manager client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, .DeviceManagerTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

bind_device_to_gateway

bind_device_to_gateway(request: Optional[google.cloud.iot_v1.types.device_manager.BindDeviceToGatewayRequest] = None, *, parent: Optional[str] = None, gateway_id: Optional[str] = None, device_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Associates the device with the gateway.

Parameters
NameDescription
request .device_manager.BindDeviceToGatewayRequest

The request object. Request for BindDeviceToGateway.

parent str

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

gateway_id str

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier. This corresponds to the gateway_id field on the request instance; if request is provided, this should not be set.

device_id str

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. This corresponds to the device_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.device_manager.BindDeviceToGatewayResponseResponse for BindDeviceToGateway.

create_device

create_device(request: Optional[google.cloud.iot_v1.types.device_manager.CreateDeviceRequest] = None, *, parent: Optional[str] = None, device: Optional[google.cloud.iot_v1.types.resources.Device] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a device in a device registry.

Parameters
NameDescription
request .device_manager.CreateDeviceRequest

The request object. Request for CreateDevice.

parent str

Required. The name of the device registry where this device should be created. For example, projects/example-project/locations/us-central1/registries/my-registry. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

device .resources.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. This corresponds to the device field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceThe device resource.

create_device_registry

create_device_registry(request: Optional[google.cloud.iot_v1.types.device_manager.CreateDeviceRegistryRequest] = None, *, parent: Optional[str] = None, device_registry: Optional[google.cloud.iot_v1.types.resources.DeviceRegistry] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a device registry that contains devices.

Parameters
NameDescription
request .device_manager.CreateDeviceRegistryRequest

The request object. Request for CreateDeviceRegistry.

parent str

Required. The project and cloud region where this device registry must be created. For example, projects/example-project/locations/us-central1. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

device_registry .resources.DeviceRegistry

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. This corresponds to the device_registry field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceRegistryA container for a group of devices.

delete_device

delete_device(request: Optional[google.cloud.iot_v1.types.device_manager.DeleteDeviceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a device.

Parameters
NameDescription
request .device_manager.DeleteDeviceRequest

The request object. Request for DeleteDevice.

name str

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}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_device_registry

delete_device_registry(request: Optional[google.cloud.iot_v1.types.device_manager.DeleteDeviceRegistryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a device registry configuration.

Parameters
NameDescription
request .device_manager.DeleteDeviceRegistryRequest

The request object. Request for DeleteDeviceRegistry.

name str

Required. The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

device_path

device_path(project: str, location: str, registry: str, device: str)

Return a fully-qualified device string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

get_device

get_device(request: Optional[google.cloud.iot_v1.types.device_manager.GetDeviceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details about a device.

Parameters
NameDescription
request .device_manager.GetDeviceRequest

The request object. Request for GetDevice.

name str

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}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceThe device resource.

get_device_registry

get_device_registry(request: Optional[google.cloud.iot_v1.types.device_manager.GetDeviceRegistryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a device registry configuration.

Parameters
NameDescription
request .device_manager.GetDeviceRegistryRequest

The request object. Request for GetDeviceRegistry.

name str

Required. The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceRegistryA container for a group of devices.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
NameDescription
request .iam_policy.GetIamPolicyRequest

The request object. Request message for GetIamPolicy method.

resource str

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.policy.PolicyDefines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_device_config_versions

list_device_config_versions(request: Optional[google.cloud.iot_v1.types.device_manager.ListDeviceConfigVersionsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the last few versions of the device configuration in descending order (i.e.: newest first).

Parameters
NameDescription
request .device_manager.ListDeviceConfigVersionsRequest

The request object. Request for ListDeviceConfigVersions.

name str

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}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.device_manager.ListDeviceConfigVersionsResponseResponse for ListDeviceConfigVersions.

list_device_registries

list_device_registries(request: Optional[google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists device registries.

Parameters
NameDescription
request .device_manager.ListDeviceRegistriesRequest

The request object. Request for ListDeviceRegistries.

parent str

Required. The project and cloud region path. For example, projects/example-project/locations/us-central1. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.ListDeviceRegistriesAsyncPagerResponse for ListDeviceRegistries. Iterating over this object will yield results and resolve additional pages automatically.

list_device_states

list_device_states(request: Optional[google.cloud.iot_v1.types.device_manager.ListDeviceStatesRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the last few versions of the device state in descending order (i.e.: newest first).

Parameters
NameDescription
request .device_manager.ListDeviceStatesRequest

The request object. Request for ListDeviceStates.

name str

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}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.device_manager.ListDeviceStatesResponseResponse for ListDeviceStates.

list_devices

list_devices(request: Optional[google.cloud.iot_v1.types.device_manager.ListDevicesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List devices in a device registry.

Parameters
NameDescription
request .device_manager.ListDevicesRequest

The request object. Request for ListDevices.

parent str

Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.pagers.ListDevicesAsyncPagerResponse for ListDevices. Iterating over this object will yield results and resolve additional pages automatically.

modify_cloud_to_device_config

modify_cloud_to_device_config(request: Optional[google.cloud.iot_v1.types.device_manager.ModifyCloudToDeviceConfigRequest] = None, *, name: Optional[str] = None, binary_data: Optional[bytes] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.

Parameters
NameDescription
request .device_manager.ModifyCloudToDeviceConfigRequest

The request object. Request for ModifyCloudToDeviceConfig.

name str

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}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

binary_data bytes

Required. The configuration data for the device. This corresponds to the binary_data field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceConfigThe device configuration. Eventually delivered to devices.

registry_path

registry_path(project: str, location: str, registry: str)

Return a fully-qualified registry string.

send_command_to_device

send_command_to_device(request: Optional[google.cloud.iot_v1.types.device_manager.SendCommandToDeviceRequest] = None, *, name: Optional[str] = None, binary_data: Optional[bytes] = None, subfolder: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sends a command to the specified device. In order for a device to be able to receive commands, it must:

1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.

Parameters
NameDescription
request .device_manager.SendCommandToDeviceRequest

The request object. Request for SendCommandToDevice.

name str

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}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

binary_data bytes

Required. The command data to send to the device. This corresponds to the binary_data field on the request instance; if request is provided, this should not be set.

subfolder str

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. This corresponds to the subfolder field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.device_manager.SendCommandToDeviceResponseResponse for SendCommandToDevice.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
request .iam_policy.SetIamPolicyRequest

The request object. Request message for SetIamPolicy method.

resource str

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.policy.PolicyDefines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
NameDescription
request .iam_policy.TestIamPermissionsRequest

The request object. Request message for TestIamPermissions method.

resource str

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

permissions :class:Sequence[str]

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 https://cloud.google.com/iam/docs/overview#permissions__. This corresponds to the permissions field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.iam_policy.TestIamPermissionsResponseResponse message for TestIamPermissions method.

unbind_device_from_gateway

unbind_device_from_gateway(request: Optional[google.cloud.iot_v1.types.device_manager.UnbindDeviceFromGatewayRequest] = None, *, parent: Optional[str] = None, gateway_id: Optional[str] = None, device_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the association between the device and the gateway.

Parameters
NameDescription
request .device_manager.UnbindDeviceFromGatewayRequest

The request object. Request for UnbindDeviceFromGateway.

parent str

Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

gateway_id str

Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier. This corresponds to the gateway_id field on the request instance; if request is provided, this should not be set.

device_id str

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. This corresponds to the device_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.device_manager.UnbindDeviceFromGatewayResponseResponse for UnbindDeviceFromGateway.

update_device

update_device(request: Optional[google.cloud.iot_v1.types.device_manager.UpdateDeviceRequest] = None, *, device: Optional[google.cloud.iot_v1.types.resources.Device] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a device.

Parameters
NameDescription
request .device_manager.UpdateDeviceRequest

The request object. Request for UpdateDevice.

device .resources.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/device0\ or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}. This corresponds to the device field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

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 This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceThe device resource.

update_device_registry

update_device_registry(request: Optional[google.cloud.iot_v1.types.device_manager.UpdateDeviceRegistryRequest] = None, *, device_registry: Optional[google.cloud.iot_v1.types.resources.DeviceRegistry] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a device registry configuration.

Parameters
NameDescription
request .device_manager.UpdateDeviceRegistryRequest

The request object. Request for UpdateDeviceRegistry.

device_registry .resources.DeviceRegistry

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. This corresponds to the device_registry field on the request instance; if request is provided, this should not be set.

update_mask .field_mask.FieldMask

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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
.resources.DeviceRegistryA container for a group of devices.