Constructor
new BudgetServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of BudgetServiceClient.
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
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
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. |
budgetPath(billing_account, budget) → {string}
Return a fully-qualified budget resource name string.
Parameters:
Name | Type | Description |
---|---|---|
billing_account |
string | |
budget |
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. |
listBudgetsAsync(request, optionsopt) → {Object}
Equivalent to listBudgets
, 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
|
|||||||||||||||||
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 Budget. 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 billing account to list budgets under. Values
* are of the form `billingAccounts/{billingAccountId}`.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of budgets to return per page.
* The default and maximum value are 100.
*/
// const pageSize = 1234
/**
* Optional. The value returned by the last `ListBudgetsResponse` which
* indicates that this is a continuation of a prior `ListBudgets` call,
* and that the system should return the next page of data.
*/
// const pageToken = 'abc123'
// Imports the Budgets library
const {BudgetServiceClient} = require('@google-cloud/billing-budgets').v1beta1;
// Instantiates a client
const budgetsClient = new BudgetServiceClient();
async function callListBudgets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await budgetsClient.listBudgetsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListBudgets();
listBudgetsStream(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
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Budget 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 |
matchBillingAccountFromBillingAccountName(billingAccountName) → {string}
Parse the billing_account from BillingAccount resource.
Parameters:
Name | Type | Description |
---|---|---|
billingAccountName |
string |
A fully-qualified path representing BillingAccount resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the billing_account. |
matchBillingAccountFromBudgetName(budgetName) → {string}
Parse the billing_account from Budget resource.
Parameters:
Name | Type | Description |
---|---|---|
budgetName |
string |
A fully-qualified path representing Budget resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the billing_account. |
matchBudgetFromBudgetName(budgetName) → {string}
Parse the budget from Budget resource.
Parameters:
Name | Type | Description |
---|---|---|
budgetName |
string |
A fully-qualified path representing Budget resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the budget. |