BudgetServiceClient

BudgetServiceClient

BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.

Constructor

new BudgetServiceClient(optionsopt)

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
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 <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

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.

createBudget(request, optionsopt) → {Promise}

Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.

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 billing account to create the budget in. Values are of the form billingAccounts/{billingAccountId}.
budget google.cloud.billing.budgets.v1beta1.Budget

Required. Budget to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Budget. Please see the documentation for more details and examples.
Example
const [response] = await client.createBudget(request);

deleteBudget(request, optionsopt) → {Promise}

Deletes a budget. Returns successfully if already deleted.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. Name of the budget to delete. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteBudget(request);

getBudget(request, optionsopt) → {Promise}

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. Name of budget to get. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Budget. Please see the documentation for more details and examples.
Example
const [response] = await client.getBudget(request);

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.

listBudgets(request, optionsopt) → {Promise}

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. Name of billing account to list budgets under. Values are of the form billingAccounts/{billingAccountId}.
pageSize number <optional>

Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
pageToken string <optional>

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.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Budget. 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 listBudgetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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
Name Type Attributes Description
parent string

Required. Name of billing account to list budgets under. Values are of the form billingAccounts/{billingAccountId}.
pageSize number <optional>

Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
pageToken string <optional>

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.
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
const iterable = client.listBudgetsAsync(request);
for await (const response of iterable) {
  // process response
}

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
Name Type Attributes Description
parent string

Required. Name of billing account to list budgets under. Values are of the form billingAccounts/{billingAccountId}.
pageSize number <optional>

Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
pageToken string <optional>

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.
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 listBudgetsAsync() 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 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.

updateBudget(request, optionsopt) → {Promise}

Updates a budget and returns the updated budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
budget google.cloud.billing.budgets.v1beta1.Budget

Required. The updated budget object. The budget to update is specified by the budget name in the budget.
updateMask google.protobuf.FieldMask <optional>

Optional. Indicates which fields in the provided budget to update. Read-only fields (such as name) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Budget. Please see the documentation for more details and examples.
Example
const [response] = await client.updateBudget(request);