DeviceManagerClient

DeviceManagerClient

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

Constructor

new DeviceManagerClient(optionsopt, gaxInstanceopt)

Construct an instance of DeviceManagerClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean | "rest" <optional>

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DeviceManagerClient({fallback: 'rest'}, gax);

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

devicePath(project, location, registry, device) → {string}

Return a fully-qualified device resource name string.

Parameters:
Name Type Description
project string
location string
registry string
device string
Returns:
Type Description
string

Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listDeviceRegistriesAsync(request, optionsopt) → {Object}

Equivalent to listDeviceRegistries, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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

The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
pageToken string

The value returned by the last ListDeviceRegistriesResponse; indicates that this is a continuation of a prior ListDeviceRegistries call and the system should return the next page of data.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DeviceRegistry. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project and cloud region path. For example,
   *  `projects/example-project/locations/us-central1`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of registries to return in the response. If this value
   *  is zero, the service will select a default size. A call may return fewer
   *  objects than requested. A non-empty `next_page_token` in the response
   *  indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListDeviceRegistriesResponse`; indicates
   *  that this is a continuation of a prior `ListDeviceRegistries` call and
   *  the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Iot library
  const {DeviceManagerClient} = require('@google-cloud/iot').v1;

  // Instantiates a client
  const iotClient = new DeviceManagerClient();

  async function callListDeviceRegistries() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await iotClient.listDeviceRegistriesAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListDeviceRegistries();

listDeviceRegistriesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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

The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
pageToken string

The value returned by the last ListDeviceRegistriesResponse; indicates that this is a continuation of a prior ListDeviceRegistries call and the system should return the next page of data.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing DeviceRegistry on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDeviceRegistriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDevicesAsync(request, optionsopt) → {Object}

Equivalent to listDevices, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.
deviceNumIds Array.<number>

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
deviceIds Array.<string>

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

The fields of the Device resource to be returned in the response. The fields id and num_id are always returned, along with any other fields specified in snake_case format, for example: last_heartbeat_time.
gatewayListOptions google.cloud.iot.v1.GatewayListOptions

Options related to gateways.
pageSize number

The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
pageToken string

The value returned by the last ListDevicesResponse; indicates that this is a continuation of a prior ListDevices call and the system should return the next page of data.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Device. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The device registry path. Required. For example,
   *  `projects/my-project/locations/us-central1/registries/my-registry`.
   */
  // const parent = 'abc123'
  /**
   *  A list of device numeric IDs. If empty, this field is ignored. Maximum
   *  IDs: 10,000.
   */
  // const deviceNumIds = [1,2,3,4]
  /**
   *  A list of device string IDs. For example, `['device0', 'device12']`.
   *  If empty, this field is ignored. Maximum IDs: 10,000
   */
  // const deviceIds = ['abc','def']
  /**
   *  The fields of the `Device` resource to be returned in the response. The
   *  fields `id` and `num_id` are always returned, along with any
   *  other fields specified in snake_case format, for example:
   *  `last_heartbeat_time`.
   */
  // const fieldMask = {}
  /**
   *  Options related to gateways.
   */
  // const gatewayListOptions = {}
  /**
   *  The maximum number of devices to return in the response. If this value
   *  is zero, the service will select a default size. A call may return fewer
   *  objects than requested. A non-empty `next_page_token` in the response
   *  indicates that more data is available.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last `ListDevicesResponse`; indicates
   *  that this is a continuation of a prior `ListDevices` call and
   *  the system should return the next page of data.
   */
  // const pageToken = 'abc123'

  // Imports the Iot library
  const {DeviceManagerClient} = require('@google-cloud/iot').v1;

  // Instantiates a client
  const iotClient = new DeviceManagerClient();

  async function callListDevices() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await iotClient.listDevicesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDevices();

listDevicesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.
deviceNumIds Array.<number>

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
deviceIds Array.<string>

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

The fields of the Device resource to be returned in the response. The fields id and num_id are always returned, along with any other fields specified in snake_case format, for example: last_heartbeat_time.
gatewayListOptions google.cloud.iot.v1.GatewayListOptions

Options related to gateways.
pageSize number

The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.
pageToken string

The value returned by the last ListDevicesResponse; indicates that this is a continuation of a prior ListDevices call and the system should return the next page of data.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Device on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDevicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string
Returns:
Type Description
string

Resource name string.

matchDeviceFromDeviceName(deviceName) → {string}

Parse the device from Device resource.

Parameters:
Name Type Description
deviceName string

A fully-qualified path representing Device resource.
Returns:
Type Description
string

A string representing the device.

matchLocationFromDeviceName(deviceName) → {string}

Parse the location from Device resource.

Parameters:
Name Type Description
deviceName string

A fully-qualified path representing Device resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromRegistryName(registryName) → {string}

Parse the location from Registry resource.

Parameters:
Name Type Description
registryName string

A fully-qualified path representing Registry resource.
Returns:
Type Description
string

A string representing the location.

matchProjectFromDeviceName(deviceName) → {string}

Parse the project from Device resource.

Parameters:
Name Type Description
deviceName string

A fully-qualified path representing Device resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromRegistryName(registryName) → {string}

Parse the project from Registry resource.

Parameters:
Name Type Description
registryName string

A fully-qualified path representing Registry resource.
Returns:
Type Description
string

A string representing the project.

matchRegistryFromDeviceName(deviceName) → {string}

Parse the registry from Device resource.

Parameters:
Name Type Description
deviceName string

A fully-qualified path representing Device resource.
Returns:
Type Description
string

A string representing the registry.

matchRegistryFromRegistryName(registryName) → {string}

Parse the registry from Registry resource.

Parameters:
Name Type Description
registryName string

A fully-qualified path representing Registry resource.
Returns:
Type Description
string

A string representing the registry.

registryPath(project, location, registry) → {string}

Return a fully-qualified registry resource name string.

Parameters:
Name Type Description
project string
location string
registry string
Returns:
Type Description
string

Resource name string.