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.

DeviceManager¶

class google.cloud.iot_v1.services.device_manager.DeviceManagerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the device manager client.

Parameters

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_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

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

Associates the device with the gateway.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_bind_device_to_gateway():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.BindDeviceToGatewayRequest(
        parent="parent_value",
        gateway_id="gateway_id_value",
        device_id="device_id_value",
    )

    # Make the request
    response = await client.bind_device_to_gateway(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.BindDeviceToGatewayRequest, dict]]) – 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

Response for BindDeviceToGateway.

Return type

google.cloud.iot_v1.types.BindDeviceToGatewayResponse

static common_billing_account_path(billing_account: str) → str ¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str ¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str ¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str ¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str ¶: Returns a fully-qualified project string.

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

Creates a device in a device registry.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_create_device():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.CreateDeviceRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.CreateDeviceRequest, dict]]) – 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 (google.cloud.iot_v1.types.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

The device resource.

Return type

google.cloud.iot_v1.types.Device

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

Creates a device registry that contains devices.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_create_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.CreateDeviceRegistryRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_device_registry(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.CreateDeviceRegistryRequest, dict]]) – 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 (google.cloud.iot_v1.types.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

A container for a group of devices.

Return type

google.cloud.iot_v1.types.DeviceRegistry

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

Deletes a device.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_delete_device():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.DeleteDeviceRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_device(request=request)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.DeleteDeviceRequest, dict]]) – 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.

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

Deletes a device registry configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_delete_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.DeleteDeviceRegistryRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_device_registry(request=request)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.DeleteDeviceRegistryRequest, dict]]) – 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.

static device_path(project: str, location: str, registry: str, device: str) → str ¶: Returns a fully-qualified device string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DeviceManagerAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DeviceManagerAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DeviceManagerAsyncClient

async get_device(request: Optional[Union[google.cloud.iot_v1.types.device_manager.GetDeviceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.resources.Device [source]¶

Gets details about a device.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_get_device():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.GetDeviceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.GetDeviceRequest, dict]]) – 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

The device resource.

Return type

google.cloud.iot_v1.types.Device

async get_device_registry(request: Optional[Union[google.cloud.iot_v1.types.device_manager.GetDeviceRegistryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.resources.DeviceRegistry [source]¶

Gets a device registry configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_get_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.GetDeviceRegistryRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_device_registry(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.GetDeviceRegistryRequest, dict]]) – 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

A container for a group of devices.

Return type

google.cloud.iot_v1.types.DeviceRegistry

async get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_get_iam_policy():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]) – 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

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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’)”, } }

], “etag”: “BwWWja0YfJA=”, “version”: 3

}

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’) etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_transport_class() → Type[google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_device_config_versions(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ListDeviceConfigVersionsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.device_manager.ListDeviceConfigVersionsResponse [source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_list_device_config_versions():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.ListDeviceConfigVersionsRequest(
        name="name_value",
    )

    # Make the request
    response = await client.list_device_config_versions(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest, dict]]) – 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

Response for ListDeviceConfigVersions.

Return type

google.cloud.iot_v1.types.ListDeviceConfigVersionsResponse

async list_device_registries(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.services.device_manager.pagers.ListDeviceRegistriesAsyncPager [source]¶

Lists device registries.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_list_device_registries():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.ListDeviceRegistriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_device_registries(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.ListDeviceRegistriesRequest, dict]]) – 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

Response for ListDeviceRegistries.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.iot_v1.services.device_manager.pagers.ListDeviceRegistriesAsyncPager

async list_device_states(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ListDeviceStatesRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.device_manager.ListDeviceStatesResponse [source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_list_device_states():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.ListDeviceStatesRequest(
        name="name_value",
    )

    # Make the request
    response = await client.list_device_states(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.ListDeviceStatesRequest, dict]]) – 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

Response for ListDeviceStates.

Return type

google.cloud.iot_v1.types.ListDeviceStatesResponse

async list_devices(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ListDevicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.services.device_manager.pagers.ListDevicesAsyncPager [source]¶

List devices in a device registry.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_list_devices():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.ListDevicesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_devices(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.ListDevicesRequest, dict]]) – 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

Response for ListDevices.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.iot_v1.services.device_manager.pagers.ListDevicesAsyncPager

async modify_cloud_to_device_config(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ModifyCloudToDeviceConfigRequest, dict]] = None, *, name: Optional[str] = None, binary_data: Optional[bytes] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.resources.DeviceConfig [source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_modify_cloud_to_device_config():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.ModifyCloudToDeviceConfigRequest(
        name="name_value",
        binary_data=b'binary_data_blob',
    )

    # Make the request
    response = await client.modify_cloud_to_device_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest, dict]]) – 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

The device configuration. Eventually delivered to devices.

Return type

google.cloud.iot_v1.types.DeviceConfig

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_device_path(path: str) → Dict[str, str]¶: Parses a device path into its component segments.

static parse_registry_path(path: str) → Dict[str, str]¶: Parses a registry path into its component segments.

static registry_path(project: str, location: str, registry: str) → str ¶: Returns a fully-qualified registry string.

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

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

be connected to Cloud IoT Core using the MQTT protocol, and
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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_send_command_to_device():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.SendCommandToDeviceRequest(
        name="name_value",
        binary_data=b'binary_data_blob',
    )

    # Make the request
    response = await client.send_command_to_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.SendCommandToDeviceRequest, dict]]) – 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

Response for SendCommandToDevice.

Return type

google.cloud.iot_v1.types.SendCommandToDeviceResponse

async set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_set_iam_policy():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]) – 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

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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’)”, } }

], “etag”: “BwWWja0YfJA=”, “version”: 3

}

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’) etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

async test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[MutableSequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_test_iam_permissions():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = await client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]) – 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 (MutableSequence[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.

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

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: DeviceManagerTransport

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

Deletes the association between the device and the gateway.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_unbind_device_from_gateway():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.UnbindDeviceFromGatewayRequest(
        parent="parent_value",
        gateway_id="gateway_id_value",
        device_id="device_id_value",
    )

    # Make the request
    response = await client.unbind_device_from_gateway(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest, dict]]) – 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

Response for UnbindDeviceFromGateway.

Return type

google.cloud.iot_v1.types.UnbindDeviceFromGatewayResponse

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

Updates a device.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_update_device():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.UpdateDeviceRequest(
    )

    # Make the request
    response = await client.update_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.UpdateDeviceRequest, dict]]) – The request object. Request for UpdateDevice.
device (google.cloud.iot_v1.types.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}.

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

The device resource.

Return type

google.cloud.iot_v1.types.Device

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

Updates a device registry configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

async def sample_update_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerAsyncClient()

    # Initialize request argument(s)
    request = iot_v1.UpdateDeviceRegistryRequest(
    )

    # Make the request
    response = await client.update_device_registry(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.iot_v1.types.UpdateDeviceRegistryRequest, dict]]) – The request object. Request for UpdateDeviceRegistry.
device_registry (google.cloud.iot_v1.types.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 (google.protobuf.field_mask_pb2.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

A container for a group of devices.

Return type

google.cloud.iot_v1.types.DeviceRegistry

class google.cloud.iot_v1.services.device_manager.DeviceManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the device manager client.

Parameters

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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) – 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_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

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

Associates the device with the gateway.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_bind_device_to_gateway():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.BindDeviceToGatewayRequest(
        parent="parent_value",
        gateway_id="gateway_id_value",
        device_id="device_id_value",
    )

    # Make the request
    response = client.bind_device_to_gateway(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.BindDeviceToGatewayRequest, dict]) – 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

Response for BindDeviceToGateway.

Return type

google.cloud.iot_v1.types.BindDeviceToGatewayResponse

static common_billing_account_path(billing_account: str) → str [source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str [source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str [source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str [source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str [source]¶: Returns a fully-qualified project string.

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

Creates a device in a device registry.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_create_device():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.CreateDeviceRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.CreateDeviceRequest, dict]) – 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 (google.cloud.iot_v1.types.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

The device resource.

Return type

google.cloud.iot_v1.types.Device

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

Creates a device registry that contains devices.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_create_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.CreateDeviceRegistryRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_device_registry(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.CreateDeviceRegistryRequest, dict]) – 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 (google.cloud.iot_v1.types.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

A container for a group of devices.

Return type

google.cloud.iot_v1.types.DeviceRegistry

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

Deletes a device.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_delete_device():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.DeleteDeviceRequest(
        name="name_value",
    )

    # Make the request
    client.delete_device(request=request)

Parameters

request (Union[google.cloud.iot_v1.types.DeleteDeviceRequest, dict]) – 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(request: Optional[Union[google.cloud.iot_v1.types.device_manager.DeleteDeviceRegistryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → None [source]¶

Deletes a device registry configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_delete_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.DeleteDeviceRegistryRequest(
        name="name_value",
    )

    # Make the request
    client.delete_device_registry(request=request)

Parameters

request (Union[google.cloud.iot_v1.types.DeleteDeviceRegistryRequest, dict]) – 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.

static device_path(project: str, location: str, registry: str, device: str) → str [source]¶: Returns a fully-qualified device string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DeviceManagerClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DeviceManagerClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DeviceManagerClient

get_device(request: Optional[Union[google.cloud.iot_v1.types.device_manager.GetDeviceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.resources.Device [source]¶

Gets details about a device.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_get_device():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.GetDeviceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.GetDeviceRequest, dict]) – 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

The device resource.

Return type

google.cloud.iot_v1.types.Device

get_device_registry(request: Optional[Union[google.cloud.iot_v1.types.device_manager.GetDeviceRegistryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.types.resources.DeviceRegistry [source]¶

Gets a device registry configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_get_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.GetDeviceRegistryRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_device_registry(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.GetDeviceRegistryRequest, dict]) – 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

A container for a group of devices.

Return type

google.cloud.iot_v1.types.DeviceRegistry

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – 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

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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’)”, } }

], “etag”: “BwWWja0YfJA=”, “version”: 3

}

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’) etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_list_device_config_versions():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.ListDeviceConfigVersionsRequest(
        name="name_value",
    )

    # Make the request
    response = client.list_device_config_versions(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest, dict]) – 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

Response for ListDeviceConfigVersions.

Return type

google.cloud.iot_v1.types.ListDeviceConfigVersionsResponse

list_device_registries(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.services.device_manager.pagers.ListDeviceRegistriesPager [source]¶

Lists device registries.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_list_device_registries():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.ListDeviceRegistriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_device_registries(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.iot_v1.types.ListDeviceRegistriesRequest, dict]) – 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

Response for ListDeviceRegistries.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.iot_v1.services.device_manager.pagers.ListDeviceRegistriesPager

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_list_device_states():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.ListDeviceStatesRequest(
        name="name_value",
    )

    # Make the request
    response = client.list_device_states(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.ListDeviceStatesRequest, dict]) – 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

Response for ListDeviceStates.

Return type

google.cloud.iot_v1.types.ListDeviceStatesResponse

list_devices(request: Optional[Union[google.cloud.iot_v1.types.device_manager.ListDevicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.iot_v1.services.device_manager.pagers.ListDevicesPager [source]¶

List devices in a device registry.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_list_devices():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.ListDevicesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_devices(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.iot_v1.types.ListDevicesRequest, dict]) – 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

Response for ListDevices.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.iot_v1.services.device_manager.pagers.ListDevicesPager

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_modify_cloud_to_device_config():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.ModifyCloudToDeviceConfigRequest(
        name="name_value",
        binary_data=b'binary_data_blob',
    )

    # Make the request
    response = client.modify_cloud_to_device_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest, dict]) – 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

The device configuration. Eventually delivered to devices.

Return type

google.cloud.iot_v1.types.DeviceConfig

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_device_path(path: str) → Dict[str, str][source]¶: Parses a device path into its component segments.

static parse_registry_path(path: str) → Dict[str, str][source]¶: Parses a registry path into its component segments.

static registry_path(project: str, location: str, registry: str) → str [source]¶: Returns a fully-qualified registry string.

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

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

be connected to Cloud IoT Core using the MQTT protocol, and
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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_send_command_to_device():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.SendCommandToDeviceRequest(
        name="name_value",
        binary_data=b'binary_data_blob',
    )

    # Make the request
    response = client.send_command_to_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.SendCommandToDeviceRequest, dict]) – 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

Response for SendCommandToDevice.

Return type

google.cloud.iot_v1.types.SendCommandToDeviceResponse

set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – 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

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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’)”, } }

], “etag”: “BwWWja0YfJA=”, “version”: 3

}

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’) etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[MutableSequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – 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 (MutableSequence[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.

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

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.iot_v1.services.device_manager.transports.base.DeviceManagerTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

DeviceManagerTransport

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

Deletes the association between the device and the gateway.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_unbind_device_from_gateway():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.UnbindDeviceFromGatewayRequest(
        parent="parent_value",
        gateway_id="gateway_id_value",
        device_id="device_id_value",
    )

    # Make the request
    response = client.unbind_device_from_gateway(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest, dict]) – 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

Response for UnbindDeviceFromGateway.

Return type

google.cloud.iot_v1.types.UnbindDeviceFromGatewayResponse

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

Updates a device.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_update_device():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.UpdateDeviceRequest(
    )

    # Make the request
    response = client.update_device(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.UpdateDeviceRequest, dict]) – The request object. Request for UpdateDevice.
device (google.cloud.iot_v1.types.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}.

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

The device resource.

Return type

google.cloud.iot_v1.types.Device

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

Updates a device registry configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iot_v1

def sample_update_device_registry():
    # Create a client
    client = iot_v1.DeviceManagerClient()

    # Initialize request argument(s)
    request = iot_v1.UpdateDeviceRegistryRequest(
    )

    # Make the request
    response = client.update_device_registry(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.iot_v1.types.UpdateDeviceRegistryRequest, dict]) – The request object. Request for UpdateDeviceRegistry.
device_registry (google.cloud.iot_v1.types.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 (google.protobuf.field_mask_pb2.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

A container for a group of devices.

Return type

google.cloud.iot_v1.types.DeviceRegistry

class google.cloud.iot_v1.services.device_manager.pagers.ListDeviceRegistriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesResponse]], request: google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesRequest, response: google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_device_registries requests.

This class thinly wraps an initial google.cloud.iot_v1.types.ListDeviceRegistriesResponse object, and provides an __aiter__ method to iterate through its device_registries field.

If there are more pages, the __aiter__ method will make additional ListDeviceRegistries requests and continue to iterate through the device_registries field on the corresponding responses.

All the usual google.cloud.iot_v1.types.ListDeviceRegistriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.iot_v1.types.ListDeviceRegistriesRequest) – The initial request object.
response (google.cloud.iot_v1.types.ListDeviceRegistriesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.iot_v1.services.device_manager.pagers.ListDeviceRegistriesPager(method: Callable[[...], google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesResponse], request: google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesRequest, response: google.cloud.iot_v1.types.device_manager.ListDeviceRegistriesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_device_registries requests.

This class thinly wraps an initial google.cloud.iot_v1.types.ListDeviceRegistriesResponse object, and provides an __iter__ method to iterate through its device_registries field.

If there are more pages, the __iter__ method will make additional ListDeviceRegistries requests and continue to iterate through the device_registries field on the corresponding responses.

All the usual google.cloud.iot_v1.types.ListDeviceRegistriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.iot_v1.types.ListDeviceRegistriesRequest) – The initial request object.
response (google.cloud.iot_v1.types.ListDeviceRegistriesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.iot_v1.services.device_manager.pagers.ListDevicesAsyncPager(method: Callable[[...], Awaitable[google.cloud.iot_v1.types.device_manager.ListDevicesResponse]], request: google.cloud.iot_v1.types.device_manager.ListDevicesRequest, response: google.cloud.iot_v1.types.device_manager.ListDevicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_devices requests.

This class thinly wraps an initial google.cloud.iot_v1.types.ListDevicesResponse object, and provides an __aiter__ method to iterate through its devices field.

If there are more pages, the __aiter__ method will make additional ListDevices requests and continue to iterate through the devices field on the corresponding responses.

All the usual google.cloud.iot_v1.types.ListDevicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.iot_v1.types.ListDevicesRequest) – The initial request object.
response (google.cloud.iot_v1.types.ListDevicesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.iot_v1.services.device_manager.pagers.ListDevicesPager(method: Callable[[...], google.cloud.iot_v1.types.device_manager.ListDevicesResponse], request: google.cloud.iot_v1.types.device_manager.ListDevicesRequest, response: google.cloud.iot_v1.types.device_manager.ListDevicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_devices requests.

This class thinly wraps an initial google.cloud.iot_v1.types.ListDevicesResponse object, and provides an __iter__ method to iterate through its devices field.

If there are more pages, the __iter__ method will make additional ListDevices requests and continue to iterate through the devices field on the corresponding responses.

All the usual google.cloud.iot_v1.types.ListDevicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.iot_v1.types.ListDevicesRequest) – The initial request object.
response (google.cloud.iot_v1.types.ListDevicesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

DeviceManager¶

google-cloud-iot

Navigation

Related Topics