Services for Google Cloud Billing Budgets v1beta1 API¶
-
class
google.cloud.billing.budgets_v1beta1.services.budget_service.
BudgetServiceAsyncClient
(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.billing.budgets_v1beta1.services.budget_service.transports.base.BudgetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
Instantiate the budget service client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, BudgetServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
-
static
budget_path
(billing_account: str, budget: str) → str¶ Return a fully-qualified budget string.
-
static
common_billing_account_path
(billing_account: str) → str¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str¶ Return a fully-qualified organization string.
-
async
create_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.CreateBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.types.budget_model.Budget[source]¶ Creates a new budget. See <a href=”https://cloud.google.com/billing/quotas”>Quotas and limits</a> for more information on the limits of the number of budgets you can create.
- Parameters
request (
CreateBudgetRequest
) – The request object. Request for CreateBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).
- Return type
Budget
-
async
delete_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.DeleteBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes a budget. Returns successfully if already deleted.
- Parameters
request (
DeleteBudgetRequest
) – The request object. Request for DeleteBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
-
classmethod
from_service_account_file
(filename: str, *args, **kwargs)¶ Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
classmethod
from_service_account_json
(filename: str, *args, **kwargs)¶ Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
async
get_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.GetBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.types.budget_model.Budget[source]¶ 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
request (
GetBudgetRequest
) – The request object. Request for GetBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).
- Return type
Budget
-
get_transport_class
() → Type[google.cloud.billing.budgets_v1beta1.services.budget_service.transports.base.BudgetServiceTransport]¶ Return an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
-
async
list_budgets
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.ListBudgetsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.services.budget_service.pagers.ListBudgetsAsyncPager[source]¶ 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
request (
ListBudgetsRequest
) – The request object. Request for ListBudgetsretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response for ListBudgets Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListBudgetsAsyncPager
-
static
parse_budget_path
(path: str) → Dict[str, str]¶ Parse a budget path into its component segments.
-
static
parse_common_billing_account_path
(path: str) → Dict[str, str]¶ Parse a billing_account path into its component segments.
-
static
parse_common_folder_path
(path: str) → Dict[str, str]¶ Parse a folder path into its component segments.
-
static
parse_common_location_path
(path: str) → Dict[str, str]¶ Parse a location path into its component segments.
-
static
parse_common_organization_path
(path: str) → Dict[str, str]¶ Parse a organization path into its component segments.
-
static
parse_common_project_path
(path: str) → Dict[str, str]¶ Parse a project path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
BudgetServiceTransport
-
async
update_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.UpdateBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.types.budget_model.Budget[source]¶ 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
request (
UpdateBudgetRequest
) – The request object. Request for UpdateBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).
- Return type
Budget
-
class
google.cloud.billing.budgets_v1beta1.services.budget_service.
BudgetServiceClient
(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.billing.budgets_v1beta1.services.budget_service.transports.base.BudgetServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶ BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
Instantiate the budget service client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, BudgetServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (client_options_lib.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
-
static
budget_path
(billing_account: str, budget: str) → str[source]¶ Return a fully-qualified budget string.
-
static
common_billing_account_path
(billing_account: str) → str[source]¶ Return a fully-qualified billing_account string.
-
static
common_location_path
(project: str, location: str) → str[source]¶ Return a fully-qualified location string.
-
static
common_organization_path
(organization: str) → str[source]¶ Return a fully-qualified organization string.
-
create_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.CreateBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.types.budget_model.Budget[source]¶ Creates a new budget. See <a href=”https://cloud.google.com/billing/quotas”>Quotas and limits</a> for more information on the limits of the number of budgets you can create.
- Parameters
request (
CreateBudgetRequest
) – The request object. Request for CreateBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).
- Return type
Budget
-
delete_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.DeleteBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶ Deletes a budget. Returns successfully if already deleted.
- Parameters
request (
DeleteBudgetRequest
) – The request object. Request for DeleteBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
-
classmethod
from_service_account_file
(filename: str, *args, **kwargs)[source]¶ Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
classmethod
from_service_account_json
(filename: str, *args, **kwargs)¶ Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
get_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.GetBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.types.budget_model.Budget[source]¶ 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
request (
GetBudgetRequest
) – The request object. Request for GetBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).
- Return type
Budget
-
list_budgets
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.ListBudgetsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.services.budget_service.pagers.ListBudgetsPager[source]¶ 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
request (
ListBudgetsRequest
) – The request object. Request for ListBudgetsretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response for ListBudgets Iterating over this object will yield results and resolve additional pages automatically.
- Return type
ListBudgetsPager
-
static
parse_budget_path
(path: str) → Dict[str, str][source]¶ Parse a budget path into its component segments.
-
static
parse_common_billing_account_path
(path: str) → Dict[str, str][source]¶ Parse a billing_account path into its component segments.
-
static
parse_common_folder_path
(path: str) → Dict[str, str][source]¶ Parse a folder path into its component segments.
-
static
parse_common_location_path
(path: str) → Dict[str, str][source]¶ Parse a location path into its component segments.
-
static
parse_common_organization_path
(path: str) → Dict[str, str][source]¶ Parse a organization path into its component segments.
-
static
parse_common_project_path
(path: str) → Dict[str, str][source]¶ Parse a project path into its component segments.
-
property
transport
¶ Return the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
BudgetServiceTransport
-
update_budget
(request: Optional[google.cloud.billing.budgets_v1beta1.types.budget_service.UpdateBudgetRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.billing.budgets_v1beta1.types.budget_model.Budget[source]¶ 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
request (
UpdateBudgetRequest
) – The request object. Request for UpdateBudgetretry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).
- Return type
Budget