AssetServiceClient

AssetServiceClient

Asset service definition.

Constructor

new AssetServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of AssetServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

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

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

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

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

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

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean | "rest" <optional>

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

gaxInstance gax <optional>

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

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

accessLevelPath(access_policy, access_level) → {string}

Return a fully-qualified accessLevel resource name string.

Parameters:
Name Type Description
access_policy string
access_level string
Returns:
Type Description
string

Resource name string.

accessPolicyPath(access_policy) → {string}

Return a fully-qualified accessPolicy resource name string.

Parameters:
Name Type Description
access_policy string
Returns:
Type Description
string

Resource name string.

close() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

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

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listAssetsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of the organization or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-number]" (such as "projects/my-project-id"), or "projects/[project-id]" (such as "projects/12345").

readTime google.protobuf.Timestamp

Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.

assetTypes Array.<string>

A list of asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. See Introduction to Cloud Asset Inventory for all supported asset types.

contentType google.cloud.asset.v1p5beta1.ContentType

Asset content type. If not specified, no content but the asset name will be returned.

pageSize number

The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000.

pageToken string

The next_page_token returned from the previous ListAssetsResponse, or unspecified for the first ListAssetsRequest. It is a continuation of a prior ListAssets call, and the API should return the next page of assets.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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 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. Name of the organization or project the assets belong to. Format:
   *  "organizations/[organization-number]" (such as "organizations/123"),
   *  "projects/[project-number]" (such as "projects/my-project-id"), or
   *  "projects/[project-id]" (such as "projects/12345").
   */
  // const parent = 'abc123'
  /**
   *  Timestamp to take an asset snapshot. This can only be set to a timestamp
   *  between 2018-10-02 UTC (inclusive) and the current time. If not specified,
   *  the current time will be used. Due to delays in resource data collection
   *  and indexing, there is a volatile window during which running the same
   *  query may get different results.
   */
  // const readTime = {}
  /**
   *  A list of asset types of which to take a snapshot for. For  example:
   *  "compute.googleapis.com/Disk". If specified, only matching assets will be
   *  returned. See Introduction to Cloud Asset
   *  Inventory (https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
   *  for all supported asset types.
   */
  // const assetTypes = 'abc123'
  /**
   *  Asset content type. If not specified, no content but the asset name will
   *  be returned.
   */
  // const contentType = {}
  /**
   *  The maximum number of assets to be returned in a single response. Default
   *  is 100, minimum is 1, and maximum is 1000.
   */
  // const pageSize = 1234
  /**
   *  The `next_page_token` returned from the previous `ListAssetsResponse`, or
   *  unspecified for the first `ListAssetsRequest`. It is a continuation of a
   *  prior `ListAssets` call, and the API should return the next page of assets.
   */
  // const pageToken = 'abc123'

  // Imports the Asset library
  const {AssetServiceClient} = require('asset').v1p5beta1;

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

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

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

  callListAssets();

listAssetsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Name of the organization or project the assets belong to. Format: "organizations/[organization-number]" (such as "organizations/123"), "projects/[project-number]" (such as "projects/my-project-id"), or "projects/[project-id]" (such as "projects/12345").

readTime google.protobuf.Timestamp

Timestamp to take an asset snapshot. This can only be set to a timestamp between 2018-10-02 UTC (inclusive) and the current time. If not specified, the current time will be used. Due to delays in resource data collection and indexing, there is a volatile window during which running the same query may get different results.

assetTypes Array.<string>

A list of asset types of which to take a snapshot for. For example: "compute.googleapis.com/Disk". If specified, only matching assets will be returned. See Introduction to Cloud Asset Inventory for all supported asset types.

contentType google.cloud.asset.v1p5beta1.ContentType

Asset content type. If not specified, no content but the asset name will be returned.

pageSize number

The maximum number of assets to be returned in a single response. Default is 100, minimum is 1, and maximum is 1000.

pageToken string

The next_page_token returned from the previous ListAssetsResponse, or unspecified for the first ListAssetsRequest. It is a continuation of a prior ListAssets call, and the API should return the next page of assets.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
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 for more details and examples.

matchAccessLevelFromAccessLevelName(accessLevelName) → {string}

Parse the access_level from AccessLevel resource.

Parameters:
Name Type Description
accessLevelName string

A fully-qualified path representing AccessLevel resource.

Returns:
Type Description
string

A string representing the access_level.

matchAccessPolicyFromAccessLevelName(accessLevelName) → {string}

Parse the access_policy from AccessLevel resource.

Parameters:
Name Type Description
accessLevelName string

A fully-qualified path representing AccessLevel resource.

Returns:
Type Description
string

A string representing the access_policy.

matchAccessPolicyFromAccessPolicyName(accessPolicyName) → {string}

Parse the access_policy from AccessPolicy resource.

Parameters:
Name Type Description
accessPolicyName string

A fully-qualified path representing AccessPolicy resource.

Returns:
Type Description
string

A string representing the access_policy.

matchAccessPolicyFromServicePerimeterName(servicePerimeterName) → {string}

Parse the access_policy from ServicePerimeter resource.

Parameters:
Name Type Description
servicePerimeterName string

A fully-qualified path representing ServicePerimeter resource.

Returns:
Type Description
string

A string representing the access_policy.

matchServicePerimeterFromServicePerimeterName(servicePerimeterName) → {string}

Parse the service_perimeter from ServicePerimeter resource.

Parameters:
Name Type Description
servicePerimeterName string

A fully-qualified path representing ServicePerimeter resource.

Returns:
Type Description
string

A string representing the service_perimeter.

servicePerimeterPath(access_policy, service_perimeter) → {string}

Return a fully-qualified servicePerimeter resource name string.

Parameters:
Name Type Description
access_policy string
service_perimeter string
Returns:
Type Description
string

Resource name string.