CloudCatalogClient - Documentation

Constructor

new CloudCatalogClient(optionsopt, gaxInstanceopt)

Construct an instance of CloudCatalogClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

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

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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 CloudCatalogClient({fallback: true}, 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

billingAccountPath(billing_account) → {string}

Return a fully-qualified billingAccount resource name string.

Parameters:

Name	Type	Description
`billing_account`	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.

listServicesAsync(request, optionsopt) → {Object}

Equivalent to listServices, 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
`pageSize`	number	Requested page size. Defaults to 5000.
`pageToken`	string	A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListServices` call. If unspecified, the first page of results is returned.

options

object

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 Service. 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.
   */
  /**
   *  Requested page size. Defaults to 5000.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results to return. This should be a
   *  `next_page_token` value returned from a previous `ListServices`
   *  call. If unspecified, the first page of results is returned.
   */
  // const pageToken = 'abc123'

  // Imports the Billing library
  const {CloudCatalogClient} = require('@google-cloud/billing').v1;

  // Instantiates a client
  const billingClient = new CloudCatalogClient();

  async function callListServices() {
    // Construct request
    const request = {
    };

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

  callListServices();

listServicesStream(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
`pageSize`	number	Requested page size. Defaults to 5000.
`pageToken`	string	A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListServices` call. If unspecified, the first page of results is returned.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Service 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 `listServicesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSkusAsync(request, optionsopt) → {Object}

Equivalent to listSkus, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The name of the service. Example: "services/DA34-426B-A397"
`startTime`	google.protobuf.Timestamp	Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
`endTime`	google.protobuf.Timestamp	Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
`currencyCode`	string	The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used.
`pageSize`	number	Requested page size. Defaults to 5000.
`pageToken`	string	A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListSkus` call. If unspecified, the first page of results is returned.

options

object

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 Sku. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the service.
   *  Example: "services/DA34-426B-A397"
   */
  // const parent = 'abc123'
  /**
   *  Optional inclusive start time of the time range for which the pricing
   *  versions will be returned. Timestamps in the future are not allowed.
   *  The time range has to be within a single calendar month in
   *  America/Los_Angeles timezone. Time range as a whole is optional. If not
   *  specified, the latest pricing will be returned (up to 12 hours old at
   *  most).
   */
  // const startTime = {}
  /**
   *  Optional exclusive end time of the time range for which the pricing
   *  versions will be returned. Timestamps in the future are not allowed.
   *  The time range has to be within a single calendar month in
   *  America/Los_Angeles timezone. Time range as a whole is optional. If not
   *  specified, the latest pricing will be returned (up to 12 hours old at
   *  most).
   */
  // const endTime = {}
  /**
   *  The ISO 4217 currency code for the pricing info in the response proto.
   *  Will use the conversion rate as of start_time.
   *  Optional. If not specified USD will be used.
   */
  // const currencyCode = 'abc123'
  /**
   *  Requested page size. Defaults to 5000.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results to return. This should be a
   *  `next_page_token` value returned from a previous `ListSkus`
   *  call. If unspecified, the first page of results is returned.
   */
  // const pageToken = 'abc123'

  // Imports the Billing library
  const {CloudCatalogClient} = require('@google-cloud/billing').v1;

  // Instantiates a client
  const billingClient = new CloudCatalogClient();

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

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

  callListSkus();

listSkusStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The name of the service. Example: "services/DA34-426B-A397"
`startTime`	google.protobuf.Timestamp	Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
`endTime`	google.protobuf.Timestamp	Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
`currencyCode`	string	The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used.
`pageSize`	number	Requested page size. Defaults to 5000.
`pageToken`	string	A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListSkus` call. If unspecified, the first page of results is returned.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Sku 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 `listSkusAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchBillingAccountFromBillingAccountName(billingAccountName) → {string}

Parse the billing_account from BillingAccount resource.

Parameters:

Name	Type	Description
`billingAccountName`	string	A fully-qualified path representing billing_account resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromOrganizationBillingAccountName(organizationBillingAccountName) → {string}

Parse the billing_account from OrganizationBillingAccount resource.

Parameters:

Name	Type	Description
`organizationBillingAccountName`	string	A fully-qualified path representing organization_billing_account resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchOrganizationFromOrganizationBillingAccountName(organizationBillingAccountName) → {string}

Parse the organization from OrganizationBillingAccount resource.

Parameters:

Name	Type	Description
`organizationBillingAccountName`	string	A fully-qualified path representing organization_billing_account resource.

Returns:

Type	Description
string	A string representing the organization.

matchProjectFromProjectBillingInfoName(projectBillingInfoName) → {string}

Parse the project from ProjectBillingInfo resource.

Parameters:

Name	Type	Description
`projectBillingInfoName`	string	A fully-qualified path representing ProjectBillingInfo resource.

Returns:

Type	Description
string	A string representing the project.

matchServiceFromServiceName(serviceName) → {string}

Parse the service from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromSkuName(skuName) → {string}

Parse the service from Sku resource.

Parameters:

Name	Type	Description
`skuName`	string	A fully-qualified path representing Sku resource.

Returns:

Type	Description
string	A string representing the service.

matchSkuFromSkuName(skuName) → {string}

Parse the sku from Sku resource.

Parameters:

Name	Type	Description
`skuName`	string	A fully-qualified path representing Sku resource.

Returns:

Type	Description
string	A string representing the sku.

organizationBillingAccountPath(organization, billing_account) → {string}

Return a fully-qualified organizationBillingAccount resource name string.

Parameters:

Name	Type	Description
`organization`	string
`billing_account`	string

Returns:

Type	Description
string	Resource name string.

projectBillingInfoPath(project) → {string}

Return a fully-qualified projectBillingInfo resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

servicePath(service) → {string}

Return a fully-qualified service resource name string.

Parameters:

Name	Type	Description
`service`	string

Returns:

Type	Description
string	Resource name string.

skuPath(service, sku) → {string}

Return a fully-qualified sku resource name string.

Parameters:

Name	Type	Description
`service`	string
`sku`	string

Returns:

Type	Description
string	Resource name string.