Internet of Things (IoT) service. Securely connect and manage IoT devices. v1
Package
@google-cloud/iot!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of DeviceManagerClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
deviceManagerStub
deviceManagerStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
bindDeviceToGateway(request, options)
bindDeviceToGateway(request?: protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IBindDeviceToGatewayResponse, protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IBindDeviceToGatewayResponse, protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest | undefined, {} | undefined]> | |
bindDeviceToGateway(request, options, callback)
bindDeviceToGateway(request: protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IBindDeviceToGatewayResponse, protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IBindDeviceToGatewayResponse, protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest | null | undefined, {} | null | undefined>
|
Returns
bindDeviceToGateway(request, callback)
bindDeviceToGateway(request: protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest, callback: Callback<protos.google.cloud.iot.v1.IBindDeviceToGatewayResponse, protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IBindDeviceToGatewayResponse, protos.google.cloud.iot.v1.IBindDeviceToGatewayRequest | null | undefined, {} | null | undefined>
|
Returns
close()
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<void> | {Promise} A promise that resolves when the client is closed.
|
createDevice(request, options)
createDevice(request?: protos.google.cloud.iot.v1.ICreateDeviceRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.ICreateDeviceRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ICreateDeviceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.ICreateDeviceRequest | undefined, {} | undefined]> | |
createDevice(request, options, callback)
createDevice(request: protos.google.cloud.iot.v1.ICreateDeviceRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.ICreateDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ICreateDeviceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.ICreateDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
createDevice(request, callback)
createDevice(request: protos.google.cloud.iot.v1.ICreateDeviceRequest, callback: Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.ICreateDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ICreateDeviceRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.ICreateDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
createDeviceRegistry(request, options)
createDeviceRegistry(request?: protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest | undefined, {} | undefined]> | |
createDeviceRegistry(request, options, callback)
createDeviceRegistry(request: protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
createDeviceRegistry(request, callback)
createDeviceRegistry(request: protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest, callback: Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.ICreateDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
deleteDevice(request, options)
deleteDevice(request?: protos.google.cloud.iot.v1.IDeleteDeviceRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IDeleteDeviceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRequest | undefined, {} | undefined]> | |
deleteDevice(request, options, callback)
deleteDevice(request: protos.google.cloud.iot.v1.IDeleteDeviceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IDeleteDeviceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
deleteDevice(request, callback)
deleteDevice(request: protos.google.cloud.iot.v1.IDeleteDeviceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IDeleteDeviceRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
deleteDeviceRegistry(request, options)
deleteDeviceRegistry(request?: protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest | undefined, {} | undefined]> | |
deleteDeviceRegistry(request, options, callback)
deleteDeviceRegistry(request: protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
deleteDeviceRegistry(request, callback)
deleteDeviceRegistry(request: protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.iot.v1.IDeleteDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
devicePath(project, location, registry, device)
devicePath(project: string, location: string, registry: string, device: string): string;
Return a fully-qualified device resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
registry |
string
|
device |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
getDevice(request, options)
getDevice(request?: protos.google.cloud.iot.v1.IGetDeviceRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IGetDeviceRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IGetDeviceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IGetDeviceRequest | undefined, {} | undefined]> | |
getDevice(request, options, callback)
getDevice(request: protos.google.cloud.iot.v1.IGetDeviceRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IGetDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IGetDeviceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IGetDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
getDevice(request, callback)
getDevice(request: protos.google.cloud.iot.v1.IGetDeviceRequest, callback: Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IGetDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IGetDeviceRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IGetDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
getDeviceRegistry(request, options)
getDeviceRegistry(request?: protos.google.cloud.iot.v1.IGetDeviceRegistryRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IGetDeviceRegistryRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IGetDeviceRegistryRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IGetDeviceRegistryRequest | undefined, {} | undefined]> | |
getDeviceRegistry(request, options, callback)
getDeviceRegistry(request: protos.google.cloud.iot.v1.IGetDeviceRegistryRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IGetDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IGetDeviceRegistryRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IGetDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
getDeviceRegistry(request, callback)
getDeviceRegistry(request: protos.google.cloud.iot.v1.IGetDeviceRegistryRequest, callback: Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IGetDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IGetDeviceRegistryRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IGetDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, options)
getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.iam.v1.IGetIamPolicyRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]> | |
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.IGetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.IGetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listDeviceConfigVersions(request, options)
listDeviceConfigVersions(request?: protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IListDeviceConfigVersionsResponse, protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IListDeviceConfigVersionsResponse, protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest | undefined, {} | undefined]> | |
listDeviceConfigVersions(request, options, callback)
listDeviceConfigVersions(request: protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IListDeviceConfigVersionsResponse, protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IListDeviceConfigVersionsResponse, protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest | null | undefined, {} | null | undefined>
|
Returns
listDeviceConfigVersions(request, callback)
listDeviceConfigVersions(request: protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest, callback: Callback<protos.google.cloud.iot.v1.IListDeviceConfigVersionsResponse, protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IListDeviceConfigVersionsResponse, protos.google.cloud.iot.v1.IListDeviceConfigVersionsRequest | null | undefined, {} | null | undefined>
|
Returns
listDeviceRegistries(request, options)
listDeviceRegistries(request?: protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDeviceRegistry[], protos.google.cloud.iot.v1.IListDeviceRegistriesRequest | null, protos.google.cloud.iot.v1.IListDeviceRegistriesResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceRegistriesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDeviceRegistry[], protos.google.cloud.iot.v1.IListDeviceRegistriesRequest | null, protos.google.cloud.iot.v1.IListDeviceRegistriesResponse]> | |
listDeviceRegistries(request, options, callback)
listDeviceRegistries(request: protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, protos.google.cloud.iot.v1.IListDeviceRegistriesResponse | null | undefined, protos.google.cloud.iot.v1.IDeviceRegistry>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceRegistriesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, protos.google.cloud.iot.v1.IListDeviceRegistriesResponse | null | undefined, protos.google.cloud.iot.v1.IDeviceRegistry>
|
Returns
listDeviceRegistries(request, callback)
listDeviceRegistries(request: protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, callback: PaginationCallback<protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, protos.google.cloud.iot.v1.IListDeviceRegistriesResponse | null | undefined, protos.google.cloud.iot.v1.IDeviceRegistry>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceRegistriesRequest
|
callback |
PaginationCallback<protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, protos.google.cloud.iot.v1.IListDeviceRegistriesResponse | null | undefined, protos.google.cloud.iot.v1.IDeviceRegistry>
|
Returns
listDeviceRegistriesAsync(request, options)
listDeviceRegistriesAsync(request?: protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.iot.v1.IDeviceRegistry>;
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 | Description |
request |
protos.google.cloud.iot.v1.IListDeviceRegistriesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.iot.v1.IDeviceRegistry> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listDeviceRegistriesStream(request, options)
listDeviceRegistriesStream(request?: protos.google.cloud.iot.v1.IListDeviceRegistriesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceRegistriesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listDevices(request, options)
listDevices(request?: protos.google.cloud.iot.v1.IListDevicesRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDevice[], protos.google.cloud.iot.v1.IListDevicesRequest | null, protos.google.cloud.iot.v1.IListDevicesResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDevicesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDevice[], protos.google.cloud.iot.v1.IListDevicesRequest | null, protos.google.cloud.iot.v1.IListDevicesResponse]> | |
listDevices(request, options, callback)
listDevices(request: protos.google.cloud.iot.v1.IListDevicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.iot.v1.IListDevicesRequest, protos.google.cloud.iot.v1.IListDevicesResponse | null | undefined, protos.google.cloud.iot.v1.IDevice>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDevicesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.iot.v1.IListDevicesRequest, protos.google.cloud.iot.v1.IListDevicesResponse | null | undefined, protos.google.cloud.iot.v1.IDevice>
|
Returns
listDevices(request, callback)
listDevices(request: protos.google.cloud.iot.v1.IListDevicesRequest, callback: PaginationCallback<protos.google.cloud.iot.v1.IListDevicesRequest, protos.google.cloud.iot.v1.IListDevicesResponse | null | undefined, protos.google.cloud.iot.v1.IDevice>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDevicesRequest
|
callback |
PaginationCallback<protos.google.cloud.iot.v1.IListDevicesRequest, protos.google.cloud.iot.v1.IListDevicesResponse | null | undefined, protos.google.cloud.iot.v1.IDevice>
|
Returns
listDevicesAsync(request, options)
listDevicesAsync(request?: protos.google.cloud.iot.v1.IListDevicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.iot.v1.IDevice>;
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 | Description |
request |
protos.google.cloud.iot.v1.IListDevicesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.iot.v1.IDevice> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listDevicesStream(request, options)
listDevicesStream(request?: protos.google.cloud.iot.v1.IListDevicesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDevicesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listDeviceStates(request, options)
listDeviceStates(request?: protos.google.cloud.iot.v1.IListDeviceStatesRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IListDeviceStatesResponse, protos.google.cloud.iot.v1.IListDeviceStatesRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceStatesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IListDeviceStatesResponse, protos.google.cloud.iot.v1.IListDeviceStatesRequest | undefined, {} | undefined]> | |
listDeviceStates(request, options, callback)
listDeviceStates(request: protos.google.cloud.iot.v1.IListDeviceStatesRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IListDeviceStatesResponse, protos.google.cloud.iot.v1.IListDeviceStatesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceStatesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IListDeviceStatesResponse, protos.google.cloud.iot.v1.IListDeviceStatesRequest | null | undefined, {} | null | undefined>
|
Returns
listDeviceStates(request, callback)
listDeviceStates(request: protos.google.cloud.iot.v1.IListDeviceStatesRequest, callback: Callback<protos.google.cloud.iot.v1.IListDeviceStatesResponse, protos.google.cloud.iot.v1.IListDeviceStatesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IListDeviceStatesRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IListDeviceStatesResponse, protos.google.cloud.iot.v1.IListDeviceStatesRequest | null | undefined, {} | null | undefined>
|
Returns
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchDeviceFromDeviceName(deviceName)
matchDeviceFromDeviceName(deviceName: string): string | number;
Parse the device from Device resource.
Parameter
Name | Description |
deviceName |
string
A fully-qualified path representing Device resource.
|
Returns
Type | Description |
string | number | {string} A string representing the device.
|
matchLocationFromDeviceName(deviceName)
matchLocationFromDeviceName(deviceName: string): string | number;
Parse the location from Device resource.
Parameter
Name | Description |
deviceName |
string
A fully-qualified path representing Device resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromRegistryName(registryName)
matchLocationFromRegistryName(registryName: string): string | number;
Parse the location from Registry resource.
Parameter
Name | Description |
registryName |
string
A fully-qualified path representing Registry resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProjectFromDeviceName(deviceName)
matchProjectFromDeviceName(deviceName: string): string | number;
Parse the project from Device resource.
Parameter
Name | Description |
deviceName |
string
A fully-qualified path representing Device resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromRegistryName(registryName)
matchProjectFromRegistryName(registryName: string): string | number;
Parse the project from Registry resource.
Parameter
Name | Description |
registryName |
string
A fully-qualified path representing Registry resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchRegistryFromDeviceName(deviceName)
matchRegistryFromDeviceName(deviceName: string): string | number;
Parse the registry from Device resource.
Parameter
Name | Description |
deviceName |
string
A fully-qualified path representing Device resource.
|
Returns
Type | Description |
string | number | {string} A string representing the registry.
|
matchRegistryFromRegistryName(registryName)
matchRegistryFromRegistryName(registryName: string): string | number;
Parse the registry from Registry resource.
Parameter
Name | Description |
registryName |
string
A fully-qualified path representing Registry resource.
|
Returns
Type | Description |
string | number | {string} A string representing the registry.
|
modifyCloudToDeviceConfig(request, options)
modifyCloudToDeviceConfig(request?: protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDeviceConfig, protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDeviceConfig, protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest | undefined, {} | undefined]> | |
modifyCloudToDeviceConfig(request, options, callback)
modifyCloudToDeviceConfig(request: protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDeviceConfig, protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceConfig, protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest | null | undefined, {} | null | undefined>
|
Returns
modifyCloudToDeviceConfig(request, callback)
modifyCloudToDeviceConfig(request: protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest, callback: Callback<protos.google.cloud.iot.v1.IDeviceConfig, protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceConfig, protos.google.cloud.iot.v1.IModifyCloudToDeviceConfigRequest | null | undefined, {} | null | undefined>
|
Returns
registryPath(project, location, registry)
registryPath(project: string, location: string, registry: string): string;
Return a fully-qualified registry resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
registry |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
sendCommandToDevice(request, options)
sendCommandToDevice(request?: protos.google.cloud.iot.v1.ISendCommandToDeviceRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.ISendCommandToDeviceResponse, protos.google.cloud.iot.v1.ISendCommandToDeviceRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ISendCommandToDeviceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.ISendCommandToDeviceResponse, protos.google.cloud.iot.v1.ISendCommandToDeviceRequest | undefined, {} | undefined]> | |
sendCommandToDevice(request, options, callback)
sendCommandToDevice(request: protos.google.cloud.iot.v1.ISendCommandToDeviceRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.ISendCommandToDeviceResponse, protos.google.cloud.iot.v1.ISendCommandToDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ISendCommandToDeviceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.ISendCommandToDeviceResponse, protos.google.cloud.iot.v1.ISendCommandToDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
sendCommandToDevice(request, callback)
sendCommandToDevice(request: protos.google.cloud.iot.v1.ISendCommandToDeviceRequest, callback: Callback<protos.google.cloud.iot.v1.ISendCommandToDeviceResponse, protos.google.cloud.iot.v1.ISendCommandToDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.ISendCommandToDeviceRequest
|
callback |
Callback<protos.google.cloud.iot.v1.ISendCommandToDeviceResponse, protos.google.cloud.iot.v1.ISendCommandToDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, options)
setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.iam.v1.ISetIamPolicyRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]> | |
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ISetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ISetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.iam.v1.ITestIamPermissionsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]> | |
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ITestIamPermissionsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.iam.v1.ITestIamPermissionsRequest
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
Returns
unbindDeviceFromGateway(request, options)
unbindDeviceFromGateway(request?: protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayResponse, protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayResponse, protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest | undefined, {} | undefined]> | |
unbindDeviceFromGateway(request, options, callback)
unbindDeviceFromGateway(request: protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayResponse, protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayResponse, protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest | null | undefined, {} | null | undefined>
|
Returns
unbindDeviceFromGateway(request, callback)
unbindDeviceFromGateway(request: protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest, callback: Callback<protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayResponse, protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayResponse, protos.google.cloud.iot.v1.IUnbindDeviceFromGatewayRequest | null | undefined, {} | null | undefined>
|
Returns
updateDevice(request, options)
updateDevice(request?: protos.google.cloud.iot.v1.IUpdateDeviceRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IUpdateDeviceRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUpdateDeviceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IUpdateDeviceRequest | undefined, {} | undefined]> | |
updateDevice(request, options, callback)
updateDevice(request: protos.google.cloud.iot.v1.IUpdateDeviceRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IUpdateDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUpdateDeviceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IUpdateDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
updateDevice(request, callback)
updateDevice(request: protos.google.cloud.iot.v1.IUpdateDeviceRequest, callback: Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IUpdateDeviceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUpdateDeviceRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDevice, protos.google.cloud.iot.v1.IUpdateDeviceRequest | null | undefined, {} | null | undefined>
|
Returns
updateDeviceRegistry(request, options)
updateDeviceRegistry(request?: protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest, options?: CallOptions): Promise<[protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest | undefined, {} | undefined]> | |
updateDeviceRegistry(request, options, callback)
updateDeviceRegistry(request: protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest, options: CallOptions, callback: Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns
updateDeviceRegistry(request, callback)
updateDeviceRegistry(request: protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest, callback: Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest
|
callback |
Callback<protos.google.cloud.iot.v1.IDeviceRegistry, protos.google.cloud.iot.v1.IUpdateDeviceRegistryRequest | null | undefined, {} | null | undefined>
|
Returns