Class DeviceManagerClient (2.6.4)

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

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

__exit__(type, value, traceback)

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

common_billing_account_path(billing_account: str)

common_folder_path(folder: str)

common_location_path(project: str, location: str)

common_organization_path(organization: str)

common_project_path(project: str)

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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

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

from_service_account_info(info: dict, *args, **kwargs)

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

get_mtls_endpoint_and_cert_source(
 client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

parse_common_billing_account_path(path: str)

parse_common_folder_path(path: str)

parse_common_location_path(path: str)

parse_common_organization_path(path: str)

parse_common_project_path(path: str)

parse_device_path(path: str)

parse_registry_path(path: str)

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

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: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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