Class v1.CloudCatalogClient (4.2.0)

A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs. v1

Package

@google-cloud/billing

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of CloudCatalogClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof 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 CloudCatalogClient({fallback: true}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

cloudCatalogStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

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

billingAccountPath(billingAccount)

billingAccountPath(billingAccount: string): string;

Return a fully-qualified billingAccount resource name string.

Parameter
NameDescription
billingAccount string
Returns
TypeDescription
string

{string} Resource name string.

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listServices(request, options)

listServices(request?: protos.google.cloud.billing.v1.IListServicesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.billing.v1.IService[],
        protos.google.cloud.billing.v1.IListServicesRequest | null,
        protos.google.cloud.billing.v1.IListServicesResponse
    ]>;

Lists all public cloud services.

Parameters
NameDescription
request IListServicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.billing.v1.IService[], protos.google.cloud.billing.v1.IListServicesRequest | null, protos.google.cloud.billing.v1.IListServicesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Service. 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 listServicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listServices(request, options, callback)

listServices(request: protos.google.cloud.billing.v1.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.billing.v1.IListServicesRequest, protos.google.cloud.billing.v1.IListServicesResponse | null | undefined, protos.google.cloud.billing.v1.IService>): void;
Parameters
NameDescription
request IListServicesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.billing.v1.IListServicesRequest, protos.google.cloud.billing.v1.IListServicesResponse | null | undefined, protos.google.cloud.billing.v1.IService>
Returns
TypeDescription
void

listServices(request, callback)

listServices(request: protos.google.cloud.billing.v1.IListServicesRequest, callback: PaginationCallback<protos.google.cloud.billing.v1.IListServicesRequest, protos.google.cloud.billing.v1.IListServicesResponse | null | undefined, protos.google.cloud.billing.v1.IService>): void;
Parameters
NameDescription
request IListServicesRequest
callback PaginationCallback<protos.google.cloud.billing.v1.IListServicesRequest, protos.google.cloud.billing.v1.IListServicesResponse | null | undefined, protos.google.cloud.billing.v1.IService>
Returns
TypeDescription
void

listServicesAsync(request, options)

listServicesAsync(request?: protos.google.cloud.billing.v1.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.billing.v1.IService>;

Equivalent to listServices, but returns an iterable object.

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

Parameters
NameDescription
request IListServicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.billing.v1.IService>

{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, options)

listServicesStream(request?: protos.google.cloud.billing.v1.IListServicesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListServicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{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.

listSkus(request, options)

listSkus(request?: protos.google.cloud.billing.v1.IListSkusRequest, options?: CallOptions): Promise<[
        protos.google.cloud.billing.v1.ISku[],
        protos.google.cloud.billing.v1.IListSkusRequest | null,
        protos.google.cloud.billing.v1.IListSkusResponse
    ]>;

Lists all publicly available SKUs for a given cloud service.

Parameters
NameDescription
request IListSkusRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.billing.v1.ISku[], protos.google.cloud.billing.v1.IListSkusRequest | null, protos.google.cloud.billing.v1.IListSkusResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Sku. 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 listSkusAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSkus(request, options, callback)

listSkus(request: protos.google.cloud.billing.v1.IListSkusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.billing.v1.IListSkusRequest, protos.google.cloud.billing.v1.IListSkusResponse | null | undefined, protos.google.cloud.billing.v1.ISku>): void;
Parameters
NameDescription
request IListSkusRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.billing.v1.IListSkusRequest, protos.google.cloud.billing.v1.IListSkusResponse | null | undefined, protos.google.cloud.billing.v1.ISku>
Returns
TypeDescription
void

listSkus(request, callback)

listSkus(request: protos.google.cloud.billing.v1.IListSkusRequest, callback: PaginationCallback<protos.google.cloud.billing.v1.IListSkusRequest, protos.google.cloud.billing.v1.IListSkusResponse | null | undefined, protos.google.cloud.billing.v1.ISku>): void;
Parameters
NameDescription
request IListSkusRequest
callback PaginationCallback<protos.google.cloud.billing.v1.IListSkusRequest, protos.google.cloud.billing.v1.IListSkusResponse | null | undefined, protos.google.cloud.billing.v1.ISku>
Returns
TypeDescription
void

listSkusAsync(request, options)

listSkusAsync(request?: protos.google.cloud.billing.v1.IListSkusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.billing.v1.ISku>;

Equivalent to listSkus, but returns an iterable object.

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

Parameters
NameDescription
request IListSkusRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.billing.v1.ISku>

{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, options)

listSkusStream(request?: protos.google.cloud.billing.v1.IListSkusRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListSkusRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{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)

matchBillingAccountFromBillingAccountName(billingAccountName: string): string | number;

Parse the billing_account from BillingAccount resource.

Parameter
NameDescription
billingAccountName string

A fully-qualified path representing billing_account resource.

Returns
TypeDescription
string | number

{string} A string representing the billing_account.

matchBillingAccountFromOrganizationBillingAccountName(organizationBillingAccountName)

matchBillingAccountFromOrganizationBillingAccountName(organizationBillingAccountName: string): string | number;

Parse the billing_account from OrganizationBillingAccount resource.

Parameter
NameDescription
organizationBillingAccountName string

A fully-qualified path representing organization_billing_account resource.

Returns
TypeDescription
string | number

{string} A string representing the billing_account.

matchOrganizationFromOrganizationBillingAccountName(organizationBillingAccountName)

matchOrganizationFromOrganizationBillingAccountName(organizationBillingAccountName: string): string | number;

Parse the organization from OrganizationBillingAccount resource.

Parameter
NameDescription
organizationBillingAccountName string

A fully-qualified path representing organization_billing_account resource.

Returns
TypeDescription
string | number

{string} A string representing the organization.

matchProjectFromProjectBillingInfoName(projectBillingInfoName)

matchProjectFromProjectBillingInfoName(projectBillingInfoName: string): string | number;

Parse the project from ProjectBillingInfo resource.

Parameter
NameDescription
projectBillingInfoName string

A fully-qualified path representing ProjectBillingInfo resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchServiceFromServiceName(serviceName)

matchServiceFromServiceName(serviceName: string): string | number;

Parse the service from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the service.

matchServiceFromSkuName(skuName)

matchServiceFromSkuName(skuName: string): string | number;

Parse the service from Sku resource.

Parameter
NameDescription
skuName string

A fully-qualified path representing Sku resource.

Returns
TypeDescription
string | number

{string} A string representing the service.

matchSkuFromSkuName(skuName)

matchSkuFromSkuName(skuName: string): string | number;

Parse the sku from Sku resource.

Parameter
NameDescription
skuName string

A fully-qualified path representing Sku resource.

Returns
TypeDescription
string | number

{string} A string representing the sku.

organizationBillingAccountPath(organization, billingAccount)

organizationBillingAccountPath(organization: string, billingAccount: string): string;

Return a fully-qualified organizationBillingAccount resource name string.

Parameters
NameDescription
organization string
billingAccount string
Returns
TypeDescription
string

{string} Resource name string.

projectBillingInfoPath(project)

projectBillingInfoPath(project: string): string;

Return a fully-qualified projectBillingInfo resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

servicePath(service)

servicePath(service: string): string;

Return a fully-qualified service resource name string.

Parameter
NameDescription
service string
Returns
TypeDescription
string

{string} Resource name string.

skuPath(service, sku)

skuPath(service: string, sku: string): string;

Return a fully-qualified sku resource name string.

Parameters
NameDescription
service string
sku string
Returns
TypeDescription
string

{string} Resource name string.