BudgetService¶
- class google.cloud.billing.budgets_v1.services.budget_service.BudgetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.billing.budgets_v1.services.budget_service.transports.base.BudgetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/usr/lib/python3.10/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.
Instantiates 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 ¶
Returns a fully-qualified budget string.
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_folder_path(folder: str) str ¶
Returns a fully-qualified folder string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static common_project_path(project: str) str ¶
Returns a fully-qualified project string.
- async create_budget(request: Optional[google.cloud.billing.budgets_v1.types.budget_service.CreateBudgetRequest] = None, *, parent: Optional[str] = None, budget: Optional[google.cloud.billing.budgets_v1.types.budget_model.Budget] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.types.budget_model.Budget [source]¶
Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.
- Parameters
request (
google.cloud.billing.budgets_v1.types.CreateBudgetRequest
) – The request object. Request for CreateBudgetparent (
str
) –Required. The name of the billing account to create the budget in. Values are of the form
billingAccounts/{billingAccountId}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.budget (
google.cloud.billing.budgets_v1.types.Budget
) – Required. Budget to create. This corresponds to thebudget
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
- Return type
- async delete_budget(request: Optional[google.cloud.billing.budgets_v1.types.budget_service.DeleteBudgetRequest] = None, *, name: Optional[str] = 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 (
google.cloud.billing.budgets_v1.types.DeleteBudgetRequest
) – The request object. Request for DeleteBudgetname (
str
) –Required. Name of the budget to delete. Values are of the form
billingAccounts/{billingAccountId}/budgets/{budgetId}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
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_v1.types.budget_service.GetBudgetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.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 (
google.cloud.billing.budgets_v1.types.GetBudgetRequest
) – The request object. Request for GetBudgetname (
str
) –Required. Name of budget to get. Values are of the form
billingAccounts/{billingAccountId}/budgets/{budgetId}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
- Return type
- get_transport_class() Type[google.cloud.billing.budgets_v1.services.budget_service.transports.base.BudgetServiceTransport] ¶
Returns 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_v1.types.budget_service.ListBudgetsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.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 (
google.cloud.billing.budgets_v1.types.ListBudgetsRequest
) – The request object. Request for ListBudgetsparent (
str
) –Required. Name of billing account to list budgets under. Values are of the form
billingAccounts/{billingAccountId}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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
google.cloud.billing.budgets_v1.services.budget_service.pagers.ListBudgetsAsyncPager
- static parse_budget_path(path: str) Dict[str, str] ¶
Parses 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: google.cloud.billing.budgets_v1.services.budget_service.transports.base.BudgetServiceTransport¶
Returns 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_v1.types.budget_service.UpdateBudgetRequest] = None, *, budget: Optional[google.cloud.billing.budgets_v1.types.budget_model.Budget] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.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 (
google.cloud.billing.budgets_v1.types.UpdateBudgetRequest
) – The request object. Request for UpdateBudgetbudget (
google.cloud.billing.budgets_v1.types.Budget
) –Required. The updated budget object. The budget to update is specified by the budget name in the budget.
This corresponds to the
budget
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –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.This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
- Return type
- class google.cloud.billing.budgets_v1.services.budget_service.BudgetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.billing.budgets_v1.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.
Instantiates 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 (google.api_core.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.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]¶
Returns a fully-qualified budget string.
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_budget(request: Optional[google.cloud.billing.budgets_v1.types.budget_service.CreateBudgetRequest] = None, *, parent: Optional[str] = None, budget: Optional[google.cloud.billing.budgets_v1.types.budget_model.Budget] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.types.budget_model.Budget [source]¶
Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.
- Parameters
request (google.cloud.billing.budgets_v1.types.CreateBudgetRequest) – The request object. Request for CreateBudget
parent (str) –
Required. The name of the billing account to create the budget in. Values are of the form
billingAccounts/{billingAccountId}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.budget (google.cloud.billing.budgets_v1.types.Budget) – Required. Budget to create. This corresponds to the
budget
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
- Return type
- delete_budget(request: Optional[google.cloud.billing.budgets_v1.types.budget_service.DeleteBudgetRequest] = None, *, name: Optional[str] = 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 (google.cloud.billing.budgets_v1.types.DeleteBudgetRequest) – The request object. Request for DeleteBudget
name (str) –
Required. Name of the budget to delete. Values are of the form
billingAccounts/{billingAccountId}/budgets/{budgetId}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
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_v1.types.budget_service.GetBudgetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.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 (google.cloud.billing.budgets_v1.types.GetBudgetRequest) – The request object. Request for GetBudget
name (str) –
Required. Name of budget to get. Values are of the form
billingAccounts/{billingAccountId}/budgets/{budgetId}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
- Return type
- list_budgets(request: Optional[google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.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 (google.cloud.billing.budgets_v1.types.ListBudgetsRequest) – The request object. Request for ListBudgets
parent (str) –
Required. Name of billing account to list budgets under. Values are of the form
billingAccounts/{billingAccountId}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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
google.cloud.billing.budgets_v1.services.budget_service.pagers.ListBudgetsPager
- static parse_budget_path(path: str) Dict[str, str] [source]¶
Parses 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: google.cloud.billing.budgets_v1.services.budget_service.transports.base.BudgetServiceTransport¶
Returns 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_v1.types.budget_service.UpdateBudgetRequest] = None, *, budget: Optional[google.cloud.billing.budgets_v1.types.budget_model.Budget] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing.budgets_v1.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 (google.cloud.billing.budgets_v1.types.UpdateBudgetRequest) – The request object. Request for UpdateBudget
budget (google.cloud.billing.budgets_v1.types.Budget) –
Required. The updated budget object. The budget to update is specified by the budget name in the budget.
This corresponds to the
budget
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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.This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (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). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.
- Return type
- class google.cloud.billing.budgets_v1.services.budget_service.pagers.ListBudgetsAsyncPager(method: Callable[[...], Awaitable[google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsResponse]], request: google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsRequest, response: google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_budgets
requests.This class thinly wraps an initial
google.cloud.billing.budgets_v1.types.ListBudgetsResponse
object, and provides an__aiter__
method to iterate through itsbudgets
field.If there are more pages, the
__aiter__
method will make additionalListBudgets
requests and continue to iterate through thebudgets
field on the corresponding responses.All the usual
google.cloud.billing.budgets_v1.types.ListBudgetsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.billing.budgets_v1.types.ListBudgetsRequest) – The initial request object.
response (google.cloud.billing.budgets_v1.types.ListBudgetsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.billing.budgets_v1.services.budget_service.pagers.ListBudgetsPager(method: Callable[[...], google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsResponse], request: google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsRequest, response: google.cloud.billing.budgets_v1.types.budget_service.ListBudgetsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_budgets
requests.This class thinly wraps an initial
google.cloud.billing.budgets_v1.types.ListBudgetsResponse
object, and provides an__iter__
method to iterate through itsbudgets
field.If there are more pages, the
__iter__
method will make additionalListBudgets
requests and continue to iterate through thebudgets
field on the corresponding responses.All the usual
google.cloud.billing.budgets_v1.types.ListBudgetsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.billing.budgets_v1.types.ListBudgetsRequest) – The initial request object.
response (google.cloud.billing.budgets_v1.types.ListBudgetsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.