Class v1.AssetServiceClient (3.20.0)

Asset service definition. v1

Package

@google-cloud/asset

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AssetServiceClient.

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
Type Description
string

assetServiceStub

assetServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

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
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

accessLevelPath(accessPolicy, accessLevel)

accessLevelPath(accessPolicy: string, accessLevel: string): string;

Return a fully-qualified accessLevel resource name string.

Parameters
Name Description
accessPolicy string
accessLevel string
Returns
Type Description
string

{string} Resource name string.

accessPolicyPath(accessPolicy)

accessPolicyPath(accessPolicy: string): string;

Return a fully-qualified accessPolicy resource name string.

Parameter
Name Description
accessPolicy string
Returns
Type Description
string

{string} Resource name string.

analyzeIamPolicy(request, options)

analyzeIamPolicy(request?: protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest | undefined, {} | undefined]>

analyzeIamPolicy(request, options, callback)

analyzeIamPolicy(request: protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

analyzeIamPolicy(request, callback)

analyzeIamPolicy(request: protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest, callback: Callback<protos.google.cloud.asset.v1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest
callback Callback<protos.google.cloud.asset.v1.IAnalyzeIamPolicyResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

analyzeIamPolicyLongrunning(request, options)

analyzeIamPolicyLongrunning(request?: protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

analyzeIamPolicyLongrunning(request, options, callback)

analyzeIamPolicyLongrunning(request: protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

analyzeIamPolicyLongrunning(request, callback)

analyzeIamPolicyLongrunning(request: protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningRequest, callback: Callback<LROperation<protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningRequest
callback Callback<LROperation<protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.IAnalyzeIamPolicyLongrunningMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

analyzeMove(request, options)

analyzeMove(request?: protos.google.cloud.asset.v1.IAnalyzeMoveRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IAnalyzeMoveResponse, protos.google.cloud.asset.v1.IAnalyzeMoveRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeMoveRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IAnalyzeMoveResponse, protos.google.cloud.asset.v1.IAnalyzeMoveRequest | undefined, {} | undefined]>

analyzeMove(request, options, callback)

analyzeMove(request: protos.google.cloud.asset.v1.IAnalyzeMoveRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IAnalyzeMoveResponse, protos.google.cloud.asset.v1.IAnalyzeMoveRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeMoveRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IAnalyzeMoveResponse, protos.google.cloud.asset.v1.IAnalyzeMoveRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

analyzeMove(request, callback)

analyzeMove(request: protos.google.cloud.asset.v1.IAnalyzeMoveRequest, callback: Callback<protos.google.cloud.asset.v1.IAnalyzeMoveResponse, protos.google.cloud.asset.v1.IAnalyzeMoveRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IAnalyzeMoveRequest
callback Callback<protos.google.cloud.asset.v1.IAnalyzeMoveResponse, protos.google.cloud.asset.v1.IAnalyzeMoveRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

batchGetAssetsHistory(request, options)

batchGetAssetsHistory(request?: protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IBatchGetAssetsHistoryResponse, protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IBatchGetAssetsHistoryResponse, protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest | undefined, {} | undefined]>

batchGetAssetsHistory(request, options, callback)

batchGetAssetsHistory(request: protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IBatchGetAssetsHistoryResponse, protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IBatchGetAssetsHistoryResponse, protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

batchGetAssetsHistory(request, callback)

batchGetAssetsHistory(request: protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest, callback: Callback<protos.google.cloud.asset.v1.IBatchGetAssetsHistoryResponse, protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest
callback Callback<protos.google.cloud.asset.v1.IBatchGetAssetsHistoryResponse, protos.google.cloud.asset.v1.IBatchGetAssetsHistoryRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

checkAnalyzeIamPolicyLongrunningProgress(name)

checkAnalyzeIamPolicyLongrunningProgress(name: string): Promise<LROperation<protos.google.cloud.asset.v1.AnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.AnalyzeIamPolicyLongrunningMetadata>>;

Check the status of the long running operation returned by analyzeIamPolicyLongrunning().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.asset.v1.AnalyzeIamPolicyLongrunningResponse, protos.google.cloud.asset.v1.AnalyzeIamPolicyLongrunningMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkAnalyzeIamPolicyLongrunningProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkExportAssetsProgress(name)

checkExportAssetsProgress(name: string): Promise<LROperation<protos.google.cloud.asset.v1.ExportAssetsResponse, protos.google.cloud.asset.v1.ExportAssetsRequest>>;

Check the status of the long running operation returned by exportAssets().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.asset.v1.ExportAssetsResponse, protos.google.cloud.asset.v1.ExportAssetsRequest>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkExportAssetsProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

close()

close(): Promise<void>;

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.

createFeed(request, options)

createFeed(request?: protos.google.cloud.asset.v1.ICreateFeedRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.ICreateFeedRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.ICreateFeedRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.ICreateFeedRequest | undefined, {} | undefined]>

createFeed(request, options, callback)

createFeed(request: protos.google.cloud.asset.v1.ICreateFeedRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.ICreateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.ICreateFeedRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.ICreateFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createFeed(request, callback)

createFeed(request: protos.google.cloud.asset.v1.ICreateFeedRequest, callback: Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.ICreateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.ICreateFeedRequest
callback Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.ICreateFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFeed(request, options)

deleteFeed(request?: protos.google.cloud.asset.v1.IDeleteFeedRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1.IDeleteFeedRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IDeleteFeedRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1.IDeleteFeedRequest | undefined, {} | undefined]>

deleteFeed(request, options, callback)

deleteFeed(request: protos.google.cloud.asset.v1.IDeleteFeedRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1.IDeleteFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IDeleteFeedRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1.IDeleteFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteFeed(request, callback)

deleteFeed(request: protos.google.cloud.asset.v1.IDeleteFeedRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1.IDeleteFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IDeleteFeedRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1.IDeleteFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportAssets(request, options)

exportAssets(request?: protos.google.cloud.asset.v1.IExportAssetsRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.asset.v1.IExportAssetsResponse, protos.google.cloud.asset.v1.IExportAssetsRequest>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IExportAssetsRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.asset.v1.IExportAssetsResponse, protos.google.cloud.asset.v1.IExportAssetsRequest>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

exportAssets(request, options, callback)

exportAssets(request: protos.google.cloud.asset.v1.IExportAssetsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.asset.v1.IExportAssetsResponse, protos.google.cloud.asset.v1.IExportAssetsRequest>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IExportAssetsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.asset.v1.IExportAssetsResponse, protos.google.cloud.asset.v1.IExportAssetsRequest>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportAssets(request, callback)

exportAssets(request: protos.google.cloud.asset.v1.IExportAssetsRequest, callback: Callback<LROperation<protos.google.cloud.asset.v1.IExportAssetsResponse, protos.google.cloud.asset.v1.IExportAssetsRequest>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IExportAssetsRequest
callback Callback<LROperation<protos.google.cloud.asset.v1.IExportAssetsResponse, protos.google.cloud.asset.v1.IExportAssetsRequest>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

folderFeedPath(folder, feed)

folderFeedPath(folder: string, feed: string): string;

Return a fully-qualified folderFeed resource name string.

Parameters
Name Description
folder string
feed string
Returns
Type Description
string

{string} Resource name string.

getFeed(request, options)

getFeed(request?: protos.google.cloud.asset.v1.IGetFeedRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IGetFeedRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IGetFeedRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IGetFeedRequest | undefined, {} | undefined]>

getFeed(request, options, callback)

getFeed(request: protos.google.cloud.asset.v1.IGetFeedRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IGetFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IGetFeedRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IGetFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getFeed(request, callback)

getFeed(request: protos.google.cloud.asset.v1.IGetFeedRequest, callback: Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IGetFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IGetFeedRequest
callback Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IGetFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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
Type Description
void

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.

inventoryPath(project, location, instance)

inventoryPath(project: string, location: string, instance: string): string;

Return a fully-qualified inventory resource name string.

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

{string} Resource name string.

listAssets(request, options)

listAssets(request?: protos.google.cloud.asset.v1.IListAssetsRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IAsset[], protos.google.cloud.asset.v1.IListAssetsRequest | null, protos.google.cloud.asset.v1.IListAssetsResponse]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IListAssetsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IAsset[], protos.google.cloud.asset.v1.IListAssetsRequest | null, protos.google.cloud.asset.v1.IListAssetsResponse]>

listAssets(request, options, callback)

listAssets(request: protos.google.cloud.asset.v1.IListAssetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1.IListAssetsRequest, protos.google.cloud.asset.v1.IListAssetsResponse | null | undefined, protos.google.cloud.asset.v1.IAsset>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IListAssetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.asset.v1.IListAssetsRequest, protos.google.cloud.asset.v1.IListAssetsResponse | null | undefined, protos.google.cloud.asset.v1.IAsset>
Returns
Type Description
void

listAssets(request, callback)

listAssets(request: protos.google.cloud.asset.v1.IListAssetsRequest, callback: PaginationCallback<protos.google.cloud.asset.v1.IListAssetsRequest, protos.google.cloud.asset.v1.IListAssetsResponse | null | undefined, protos.google.cloud.asset.v1.IAsset>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IListAssetsRequest
callback PaginationCallback<protos.google.cloud.asset.v1.IListAssetsRequest, protos.google.cloud.asset.v1.IListAssetsResponse | null | undefined, protos.google.cloud.asset.v1.IAsset>
Returns
Type Description
void

listAssetsAsync(request, options)

listAssetsAsync(request?: protos.google.cloud.asset.v1.IListAssetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1.IAsset>;

Equivalent to listAssets, 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.asset.v1.IListAssetsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.asset.v1.IAsset>

{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 [Asset]. 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.
Example

const iterable = client.listAssetsAsync(request); for await (const response of iterable) { // process response }

listAssetsStream(request, options)

listAssetsStream(request?: protos.google.cloud.asset.v1.IListAssetsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.asset.v1.IListAssetsRequest

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 [Asset] 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 listAssetsAsync() 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.

listFeeds(request, options)

listFeeds(request?: protos.google.cloud.asset.v1.IListFeedsRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IListFeedsResponse, protos.google.cloud.asset.v1.IListFeedsRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IListFeedsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IListFeedsResponse, protos.google.cloud.asset.v1.IListFeedsRequest | undefined, {} | undefined]>

listFeeds(request, options, callback)

listFeeds(request: protos.google.cloud.asset.v1.IListFeedsRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IListFeedsResponse, protos.google.cloud.asset.v1.IListFeedsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IListFeedsRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IListFeedsResponse, protos.google.cloud.asset.v1.IListFeedsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listFeeds(request, callback)

listFeeds(request: protos.google.cloud.asset.v1.IListFeedsRequest, callback: Callback<protos.google.cloud.asset.v1.IListFeedsResponse, protos.google.cloud.asset.v1.IListFeedsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IListFeedsRequest
callback Callback<protos.google.cloud.asset.v1.IListFeedsResponse, protos.google.cloud.asset.v1.IListFeedsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

matchAccessLevelFromAccessLevelName(accessLevelName)

matchAccessLevelFromAccessLevelName(accessLevelName: string): string | number;

Parse the access_level from AccessLevel resource.

Parameter
Name Description
accessLevelName string

A fully-qualified path representing AccessLevel resource.
Returns
Type Description
string | number

{string} A string representing the access_level.

matchAccessPolicyFromAccessLevelName(accessLevelName)

matchAccessPolicyFromAccessLevelName(accessLevelName: string): string | number;

Parse the access_policy from AccessLevel resource.

Parameter
Name Description
accessLevelName string

A fully-qualified path representing AccessLevel resource.
Returns
Type Description
string | number

{string} A string representing the access_policy.

matchAccessPolicyFromAccessPolicyName(accessPolicyName)

matchAccessPolicyFromAccessPolicyName(accessPolicyName: string): string | number;

Parse the access_policy from AccessPolicy resource.

Parameter
Name Description
accessPolicyName string

A fully-qualified path representing AccessPolicy resource.
Returns
Type Description
string | number

{string} A string representing the access_policy.

matchAccessPolicyFromServicePerimeterName(servicePerimeterName)

matchAccessPolicyFromServicePerimeterName(servicePerimeterName: string): string | number;

Parse the access_policy from ServicePerimeter resource.

Parameter
Name Description
servicePerimeterName string

A fully-qualified path representing ServicePerimeter resource.
Returns
Type Description
string | number

{string} A string representing the access_policy.

matchFeedFromFolderFeedName(folderFeedName)

matchFeedFromFolderFeedName(folderFeedName: string): string | number;

Parse the feed from FolderFeed resource.

Parameter
Name Description
folderFeedName string

A fully-qualified path representing folder_feed resource.
Returns
Type Description
string | number

{string} A string representing the feed.

matchFeedFromOrganizationFeedName(organizationFeedName)

matchFeedFromOrganizationFeedName(organizationFeedName: string): string | number;

Parse the feed from OrganizationFeed resource.

Parameter
Name Description
organizationFeedName string

A fully-qualified path representing organization_feed resource.
Returns
Type Description
string | number

{string} A string representing the feed.

matchFeedFromProjectFeedName(projectFeedName)

matchFeedFromProjectFeedName(projectFeedName: string): string | number;

Parse the feed from ProjectFeed resource.

Parameter
Name Description
projectFeedName string

A fully-qualified path representing project_feed resource.
Returns
Type Description
string | number

{string} A string representing the feed.

matchFolderFromFolderFeedName(folderFeedName)

matchFolderFromFolderFeedName(folderFeedName: string): string | number;

Parse the folder from FolderFeed resource.

Parameter
Name Description
folderFeedName string

A fully-qualified path representing folder_feed resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchInstanceFromInventoryName(inventoryName)

matchInstanceFromInventoryName(inventoryName: string): string | number;

Parse the instance from Inventory resource.

Parameter
Name Description
inventoryName string

A fully-qualified path representing Inventory resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchLocationFromInventoryName(inventoryName)

matchLocationFromInventoryName(inventoryName: string): string | number;

Parse the location from Inventory resource.

Parameter
Name Description
inventoryName string

A fully-qualified path representing Inventory resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchOrganizationFromOrganizationFeedName(organizationFeedName)

matchOrganizationFromOrganizationFeedName(organizationFeedName: string): string | number;

Parse the organization from OrganizationFeed resource.

Parameter
Name Description
organizationFeedName string

A fully-qualified path representing organization_feed resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchProjectFromInventoryName(inventoryName)

matchProjectFromInventoryName(inventoryName: string): string | number;

Parse the project from Inventory resource.

Parameter
Name Description
inventoryName string

A fully-qualified path representing Inventory resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectFeedName(projectFeedName)

matchProjectFromProjectFeedName(projectFeedName: string): string | number;

Parse the project from ProjectFeed resource.

Parameter
Name Description
projectFeedName string

A fully-qualified path representing project_feed resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchServicePerimeterFromServicePerimeterName(servicePerimeterName)

matchServicePerimeterFromServicePerimeterName(servicePerimeterName: string): string | number;

Parse the service_perimeter from ServicePerimeter resource.

Parameter
Name Description
servicePerimeterName string

A fully-qualified path representing ServicePerimeter resource.
Returns
Type Description
string | number

{string} A string representing the service_perimeter.

organizationFeedPath(organization, feed)

organizationFeedPath(organization: string, feed: string): string;

Return a fully-qualified organizationFeed resource name string.

Parameters
Name Description
organization string
feed string
Returns
Type Description
string

{string} Resource name string.

projectFeedPath(project, feed)

projectFeedPath(project: string, feed: string): string;

Return a fully-qualified projectFeed resource name string.

Parameters
Name Description
project string
feed string
Returns
Type Description
string

{string} Resource name string.

searchAllIamPolicies(request, options)

searchAllIamPolicies(request?: protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IIamPolicySearchResult[], protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest | null, protos.google.cloud.asset.v1.ISearchAllIamPoliciesResponse]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IIamPolicySearchResult[], protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest | null, protos.google.cloud.asset.v1.ISearchAllIamPoliciesResponse]>

searchAllIamPolicies(request, options, callback)

searchAllIamPolicies(request: protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1.IIamPolicySearchResult>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1.IIamPolicySearchResult>
Returns
Type Description
void

searchAllIamPolicies(request, callback)

searchAllIamPolicies(request: protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, callback: PaginationCallback<protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1.IIamPolicySearchResult>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest
callback PaginationCallback<protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1.IIamPolicySearchResult>
Returns
Type Description
void

searchAllIamPoliciesAsync(request, options)

searchAllIamPoliciesAsync(request?: protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1.IIamPolicySearchResult>;

Equivalent to searchAllIamPolicies, 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.asset.v1.ISearchAllIamPoliciesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.asset.v1.IIamPolicySearchResult>

{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 [IamPolicySearchResult]. 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.
Example

const iterable = client.searchAllIamPoliciesAsync(request); for await (const response of iterable) { // process response }

searchAllIamPoliciesStream(request, options)

searchAllIamPoliciesStream(request?: protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllIamPoliciesRequest

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 [IamPolicySearchResult] 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 searchAllIamPoliciesAsync() 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.

searchAllResources(request, options)

searchAllResources(request?: protos.google.cloud.asset.v1.ISearchAllResourcesRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IResourceSearchResult[], protos.google.cloud.asset.v1.ISearchAllResourcesRequest | null, protos.google.cloud.asset.v1.ISearchAllResourcesResponse]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllResourcesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IResourceSearchResult[], protos.google.cloud.asset.v1.ISearchAllResourcesRequest | null, protos.google.cloud.asset.v1.ISearchAllResourcesResponse]>

searchAllResources(request, options, callback)

searchAllResources(request: protos.google.cloud.asset.v1.ISearchAllResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1.IResourceSearchResult>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllResourcesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.asset.v1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1.IResourceSearchResult>
Returns
Type Description
void

searchAllResources(request, callback)

searchAllResources(request: protos.google.cloud.asset.v1.ISearchAllResourcesRequest, callback: PaginationCallback<protos.google.cloud.asset.v1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1.IResourceSearchResult>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllResourcesRequest
callback PaginationCallback<protos.google.cloud.asset.v1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1.IResourceSearchResult>
Returns
Type Description
void

searchAllResourcesAsync(request, options)

searchAllResourcesAsync(request?: protos.google.cloud.asset.v1.ISearchAllResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1.IResourceSearchResult>;

Equivalent to searchAllResources, 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.asset.v1.ISearchAllResourcesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.asset.v1.IResourceSearchResult>

{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 [ResourceSearchResult]. 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.
Example

const iterable = client.searchAllResourcesAsync(request); for await (const response of iterable) { // process response }

searchAllResourcesStream(request, options)

searchAllResourcesStream(request?: protos.google.cloud.asset.v1.ISearchAllResourcesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.asset.v1.ISearchAllResourcesRequest

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 [ResourceSearchResult] 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 searchAllResourcesAsync() 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.

servicePerimeterPath(accessPolicy, servicePerimeter)

servicePerimeterPath(accessPolicy: string, servicePerimeter: string): string;

Return a fully-qualified servicePerimeter resource name string.

Parameters
Name Description
accessPolicy string
servicePerimeter string
Returns
Type Description
string

{string} Resource name string.

updateFeed(request, options)

updateFeed(request?: protos.google.cloud.asset.v1.IUpdateFeedRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IUpdateFeedRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.asset.v1.IUpdateFeedRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IUpdateFeedRequest | undefined, {} | undefined]>

updateFeed(request, options, callback)

updateFeed(request: protos.google.cloud.asset.v1.IUpdateFeedRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IUpdateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IUpdateFeedRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IUpdateFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateFeed(request, callback)

updateFeed(request: protos.google.cloud.asset.v1.IUpdateFeedRequest, callback: Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IUpdateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.asset.v1.IUpdateFeedRequest
callback Callback<protos.google.cloud.asset.v1.IFeed, protos.google.cloud.asset.v1.IUpdateFeedRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void