Console
    Contact Us Start free

    Class v1.CloudCatalogClient (2.2.7)

    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)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of CloudCatalogClient.

    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

    auth

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

    cloudCatalogStub

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

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

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

    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

    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.

    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 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.billing.v1.IListServicesRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.billing.v1.IService [], protos. google.cloud.billing.v1.IListServicesRequest | null, protos. google.cloud.billing.v1.IListServicesResponse ]>

    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
    Name Description
    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 >
    Returns
    Type Description
    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
    Name Description
    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 >
    Returns
    Type Description
    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
    Name Description
    request protos. google.cloud.billing.v1.IListServicesRequest

    The request object that will be sent.
    options CallOptions

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

    {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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

    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
    Name Description
    request protos. google.cloud.billing.v1.IListServicesRequest

    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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.billing.v1.IListSkusRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.billing.v1.ISku [], protos. google.cloud.billing.v1.IListSkusRequest | null, protos. google.cloud.billing.v1.IListSkusResponse ]>

    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
    Name Description
    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 >
    Returns
    Type Description
    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
    Name Description
    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 >
    Returns
    Type Description
    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
    Name Description
    request protos. google.cloud.billing.v1.IListSkusRequest

    The request object that will be sent.
    options CallOptions

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

    {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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

    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
    Name Description
    request protos. google.cloud.billing.v1.IListSkusRequest

    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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

    matchServiceFromServiceName(serviceName)

      matchServiceFromServiceName 
 ( 
 serviceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the service from Service resource.

    Parameter
    Name Description
    serviceName string

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

    {string} A string representing the service.

    matchServiceFromSkuName(skuName)

      matchServiceFromSkuName 
 ( 
 skuName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the service from Sku resource.

    Parameter
    Name Description
    skuName string

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

    {string} A string representing the service.

    matchSkuFromSkuName(skuName)

      matchSkuFromSkuName 
 ( 
 skuName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the sku from Sku resource.

    Parameter
    Name Description
    skuName string

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

    {string} A string representing the sku.

    servicePath(service)

      servicePath 
 ( 
 service 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified service resource name string.

    Parameter
    Name Description
    service string
    Returns
    Type Description
    string

    {string} Resource name string.

    skuPath(service, sku)

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

    Return a fully-qualified sku resource name string.

    Parameters
    Name Description
    service string
    sku string
    Returns
    Type Description
    string

    {string} Resource name string.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: