Reference documentation and code samples for the Google Cloud Billing Budgets V1 Client class BudgetServiceClient.
Service Description: BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$budgetServiceClient = new BudgetServiceClient();
try {
$formattedParent = $budgetServiceClient->billingAccountName('[BILLING_ACCOUNT]');
$budget = new Budget();
$response = $budgetServiceClient->createBudget($formattedParent, $budget);
} finally {
$budgetServiceClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\Billing\Budgets\V1\Client\BudgetServiceClient to use the new surface.
Namespace
Google \ Cloud \ Billing \ Budgets \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createBudget
Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The name of the billing account to create the budget in. Values
are of the form |
budget |
Google\Cloud\Billing\Budgets\V1\Budget
Required. Budget to create. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Billing\Budgets\V1\Budget |
use Google\ApiCore\ApiException;
use Google\Cloud\Billing\Budgets\V1\Budget;
use Google\Cloud\Billing\Budgets\V1\BudgetAmount;
use Google\Cloud\Billing\Budgets\V1\BudgetServiceClient;
/**
* @param string $formattedParent The name of the billing account to create the budget in. Values
* are of the form `billingAccounts/{billingAccountId}`. Please see
* {@see BudgetServiceClient::billingAccountName()} for help formatting this field.
*/
function create_budget_sample(string $formattedParent): void
{
// Create a client.
$budgetServiceClient = new BudgetServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$budgetAmount = new BudgetAmount();
$budget = (new Budget())
->setAmount($budgetAmount);
// Call the API and handle any network failures.
try {
/** @var Budget $response */
$response = $budgetServiceClient->createBudget($formattedParent, $budget);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample 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.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = BudgetServiceClient::billingAccountName('[BILLING_ACCOUNT]');
create_budget_sample($formattedParent);
}
deleteBudget
Deletes a budget. Returns successfully if already deleted.
Parameters | |
---|---|
Name | Description |
name |
string
Required. Name of the budget to delete. Values are of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Billing\Budgets\V1\BudgetServiceClient;
/**
* @param string $formattedName Name of the budget to delete. Values are of the form
* `billingAccounts/{billingAccountId}/budgets/{budgetId}`. Please see
* {@see BudgetServiceClient::budgetName()} for help formatting this field.
*/
function delete_budget_sample(string $formattedName): void
{
// Create a client.
$budgetServiceClient = new BudgetServiceClient();
// Call the API and handle any network failures.
try {
$budgetServiceClient->deleteBudget($formattedName);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample 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.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = BudgetServiceClient::budgetName('[BILLING_ACCOUNT]', '[BUDGET]');
delete_budget_sample($formattedName);
}
getBudget
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 | Description |
name |
string
Required. Name of budget to get. Values are of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Billing\Budgets\V1\Budget |
use Google\ApiCore\ApiException;
use Google\Cloud\Billing\Budgets\V1\Budget;
use Google\Cloud\Billing\Budgets\V1\BudgetServiceClient;
/**
* @param string $formattedName Name of budget to get. Values are of the form
* `billingAccounts/{billingAccountId}/budgets/{budgetId}`. Please see
* {@see BudgetServiceClient::budgetName()} for help formatting this field.
*/
function get_budget_sample(string $formattedName): void
{
// Create a client.
$budgetServiceClient = new BudgetServiceClient();
// Call the API and handle any network failures.
try {
/** @var Budget $response */
$response = $budgetServiceClient->getBudget($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample 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.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = BudgetServiceClient::budgetName('[BILLING_ACCOUNT]', '[BUDGET]');
get_budget_sample($formattedName);
}
listBudgets
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 | Description |
parent |
string
Required. Name of billing account to list budgets under. Values
are of the form |
optionalArgs |
array
Optional. |
↳ scope |
string
Optional. Set the scope of the budgets to be returned, in the format of the resource name. The scope of a budget is the cost that it tracks, such as costs for a single project, or the costs for all projects in a folder. Only project scope (in the format of "projects/project-id" or "projects/123") is supported in this field. When this field is set to a project's resource name, the budgets returned are tracking the costs for that project. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Billing\Budgets\V1\Budget;
use Google\Cloud\Billing\Budgets\V1\BudgetServiceClient;
/**
* @param string $formattedParent Name of billing account to list budgets under. Values
* are of the form `billingAccounts/{billingAccountId}`. Please see
* {@see BudgetServiceClient::billingAccountName()} for help formatting this field.
*/
function list_budgets_sample(string $formattedParent): void
{
// Create a client.
$budgetServiceClient = new BudgetServiceClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $budgetServiceClient->listBudgets($formattedParent);
/** @var Budget $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample 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.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = BudgetServiceClient::billingAccountName('[BILLING_ACCOUNT]');
list_budgets_sample($formattedParent);
}
updateBudget
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 | Description |
budget |
Google\Cloud\Billing\Budgets\V1\Budget
Required. The updated budget object. The budget to update is specified by the budget name in the budget. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. Indicates which fields in the provided budget to update. Read-only fields (such as |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Billing\Budgets\V1\Budget |
use Google\ApiCore\ApiException;
use Google\Cloud\Billing\Budgets\V1\Budget;
use Google\Cloud\Billing\Budgets\V1\BudgetAmount;
use Google\Cloud\Billing\Budgets\V1\BudgetServiceClient;
/**
* This sample 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.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_budget_sample(): void
{
// Create a client.
$budgetServiceClient = new BudgetServiceClient();
// Prepare any non-scalar elements to be passed along with the request.
$budgetAmount = new BudgetAmount();
$budget = (new Budget())
->setAmount($budgetAmount);
// Call the API and handle any network failures.
try {
/** @var Budget $response */
$response = $budgetServiceClient->updateBudget($budget);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
static::billingAccountName
Formats a string containing the fully-qualified path to represent a billing_account resource.
Parameter | |
---|---|
Name | Description |
billingAccount |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted billing_account resource. |
static::budgetName
Formats a string containing the fully-qualified path to represent a budget resource.
Parameters | |
---|---|
Name | Description |
billingAccount |
string
|
budget |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted budget resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- billingAccount: billingAccounts/{billing_account}
- budget: billingAccounts/{billing_account}/budgets/{budget}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |
Constants
SERVICE_NAME
Value: 'google.cloud.billing.budgets.v1.BudgetService'
The name of the service.
SERVICE_ADDRESS
Value: 'billingbudgets.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.