Class v1p1beta1.AssetServiceClient (4.5.0)

Asset service definition. v1p1beta1

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of AssetServiceClient.

Parameters

Name	Description
opts	`ClientOptions`
gaxInstance	`typeof gax \| typeof gax.fallback` : 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 AssetServiceClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

assetServiceStub

assetServiceStub?: Promise<{
        [name: string]: Function;
    }>;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

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.

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.

searchAllIamPolicies(request, options)

searchAllIamPolicies(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult[],
        protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest | null,
        protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse
    ]>;

Searches all the IAM policies under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the IAM policies under a scope, even if they don't have .getIamPolicy permission of all the IAM policies. Callers should have cloud.assets.SearchAllIamPolicies permission on the requested scope, otherwise it will be rejected.

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult[], protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest | null, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [IamPolicySearchResult]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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.

searchAllIamPolicies(request, options, callback)

searchAllIamPolicies(request: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>): void;

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse \| null \| undefined, protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>`

Returns

Type	Description
void

searchAllIamPolicies(request, callback)

searchAllIamPolicies(request: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>): void;

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest`
callback	`PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesResponse \| null \| undefined, protos.google.cloud.asset.v1p1beta1.IIamPolicySearchResult>`

Returns

Type	Description
void

searchAllIamPoliciesAsync(request, options)

searchAllIamPoliciesAsync(request?: protos.google.cloud.asset.v1p1beta1.ISearchAllIamPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.asset.v1p1beta1.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.v1p1beta1.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.v1p1beta1.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


  /**
   * 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 relative name of an asset. The search is limited to the resources
   *  within the `scope`. The allowed value must be:
   *  * Organization number (such as "organizations/123")
   *  * Folder number(such as "folders/1234")
   *  * Project number (such as "projects/12345")
   *  * Project id (such as "projects/abc")
   */
  // const scope = 'abc123'
  /**
   *  Optional. The query statement.
   *  Examples:
   *  * "policy:myuser@mydomain.com"
   *  * "policy:(myuser@mydomain.com viewer)"
   */
  // const query = 'abc123'
  /**
   *  Optional. The page size for search result pagination. Page size is capped at 500 even
   *  if a larger value is given. If set to zero, server will pick an appropriate
   *  default. Returned results may be fewer than requested. When this happens,
   *  there could be more results as long as `next_page_token` is returned.
   */
  // const pageSize = 1234
  /**
   *  Optional. If present, retrieve the next batch of results from the preceding call to
   *  this method. `page_token` must be the value of `next_page_token` from the
   *  previous response. The values of all other method parameters must be
   *  identical to those in the previous call.
   */
  // const pageToken = 'abc123'

  // Imports the Asset library
  const {AssetServiceClient} = require('@google-cloud/asset').v1p1beta1;

  // Instantiates a client
  const assetClient = new AssetServiceClient();

  async function callSearchAllIamPolicies() {
    // Construct request
    const request = {
      scope,
    };

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

  callSearchAllIamPolicies();

searchAllIamPoliciesStream(request, options)

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

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

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.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.v1p1beta1.ISearchAllResourcesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata[],
        protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest | null,
        protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse
    ]>;

Searches all the resources under a given accessible CRM scope (project/folder/organization). This RPC gives callers especially admins the ability to search all the resources under a scope, even if they don't have .get permission of all the resources. Callers should have cloud.assets.SearchAllResources permission on the requested scope, otherwise it will be rejected.

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata[], protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest | null, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [StandardResourceMetadata]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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.

searchAllResources(request, options, callback)

searchAllResources(request: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>): void;

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse \| null \| undefined, protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>`

Returns

Type	Description
void

searchAllResources(request, callback)

searchAllResources(request: protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, callback: PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse | null | undefined, protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>): void;

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest`
callback	`PaginationCallback<protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesRequest, protos.google.cloud.asset.v1p1beta1.ISearchAllResourcesResponse \| null \| undefined, protos.google.cloud.asset.v1p1beta1.IStandardResourceMetadata>`

Returns

Type	Description
void

searchAllResourcesAsync(request, options)

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

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.v1p1beta1.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.v1p1beta1.IStandardResourceMetadata>

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


  /**
   * 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 relative name of an asset. The search is limited to the resources
   *  within the `scope`. The allowed value must be:
   *  * Organization number (such as "organizations/123")
   *  * Folder number(such as "folders/1234")
   *  * Project number (such as "projects/12345")
   *  * Project id (such as "projects/abc")
   */
  // const scope = 'abc123'
  /**
   *  Optional. The query statement.
   */
  // const query = 'abc123'
  /**
   *  Optional. A list of asset types that this request searches for. If empty, it will
   *  search all the supported asset types.
   */
  // const assetTypes = 'abc123'
  /**
   *  Optional. The page size for search result pagination. Page size is capped at 500 even
   *  if a larger value is given. If set to zero, server will pick an appropriate
   *  default. Returned results may be fewer than requested. When this happens,
   *  there could be more results as long as `next_page_token` is returned.
   */
  // const pageSize = 1234
  /**
   *  Optional. If present, then retrieve the next batch of results from the preceding call
   *  to this method.  `page_token` must be the value of `next_page_token` from
   *  the previous response. The values of all other method parameters, must be
   *  identical to those in the previous call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A comma separated list of fields specifying the sorting order of the
   *  results. The default order is ascending. Add " desc" after the field name
   *  to indicate descending order. Redundant space characters are ignored. For
   *  example, "  foo ,  bar  desc  ".
   */
  // const orderBy = 'abc123'

  // Imports the Asset library
  const {AssetServiceClient} = require('@google-cloud/asset').v1p1beta1;

  // Instantiates a client
  const assetClient = new AssetServiceClient();

  async function callSearchAllResources() {
    // Construct request
    const request = {
      scope,
    };

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

  callSearchAllResources();

searchAllResourcesStream(request, options)

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

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

Parameters

Name	Description
request	`protos.google.cloud.asset.v1p1beta1.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 [StandardResourceMetadata] 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.