CloudBilling¶
- class google.cloud.billing_v1.services.cloud_billing.CloudBillingAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport] = '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]¶
Retrieves GCP Console billing accounts and associates them with projects.
Instantiates the cloud billing 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, CloudBillingTransport]) – 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 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_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.CreateBillingAccountRequest] = None, *, billing_account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.types.cloud_billing.BillingAccount [source]¶
Creates a billing account. This method can only be used to create billing subaccounts by GCP resellers. When creating a subaccount, the current authenticated user must have the
billing.accounts.update
IAM permission on the master account, which is typically given to billing account administrators. This method will return an error if the master account has not been provisioned as a reseller account.- Parameters
request (
google.cloud.billing_v1.types.CreateBillingAccountRequest
) – The request object. Request message for CreateBillingAccount.billing_account (
google.cloud.billing_v1.types.BillingAccount
) –Required. The billing account resource to create. Currently CreateBillingAccount only supports subaccount creation, so any created billing accounts must be under a provided master billing account.
This corresponds to the
billing_account
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 billing account in [GCP Console](https://console.cloud.google.com/).
You can assign a billing account to one or more projects.
- Return type
- 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_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.GetBillingAccountRequest] = 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_v1.types.cloud_billing.BillingAccount [source]¶
Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
- Parameters
request (
google.cloud.billing_v1.types.GetBillingAccountRequest
) – The request object. Request message for GetBillingAccount.name (
str
) –Required. The resource name of the billing account to retrieve. For example,
billingAccounts/012345-567890-ABCDEF
.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 billing account in [GCP Console](https://console.cloud.google.com/).
You can assign a billing account to one or more projects.
- Return type
- async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Gets the access control policy for a billing account. The caller must have the
billing.accounts.getIamPolicy
permission on the account, which is often given to billing account viewers.- Parameters
request (
google.iam.v1.iam_policy_pb2.GetIamPolicyRequest
) – The request object. Request message for GetIamPolicy method.resource (
str
) –REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
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
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- async get_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.GetProjectBillingInfoRequest] = 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_v1.types.cloud_billing.ProjectBillingInfo [source]¶
Gets the billing information for a project. The current authenticated user must have permission to view the project.
- Parameters
request (
google.cloud.billing_v1.types.GetProjectBillingInfoRequest
) – The request object. Request message for GetProjectBillingInfo.name (
str
) –Required. The resource name of the project for which billing information is retrieved. For example,
projects/tokyo-rain-123
.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
Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
- Return type
- get_transport_class() Type[google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport] ¶
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_billing_accounts(request: Optional[google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsAsyncPager [source]¶
Lists the billing accounts that the current authenticated user has permission to view.
- Parameters
request (
google.cloud.billing_v1.types.ListBillingAccountsRequest
) – The request object. Request message for ListBillingAccounts.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 message for ListBillingAccounts.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsAsyncPager
- async list_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoRequest] = 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_v1.services.cloud_billing.pagers.ListProjectBillingInfoAsyncPager [source]¶
Lists the projects associated with a billing account. The current authenticated user must have the
billing.resourceAssociations.list
IAM permission, which is often given to billing account viewers.- Parameters
request (
google.cloud.billing_v1.types.ListProjectBillingInfoRequest
) – The request object. Request message for ListProjectBillingInfo.name (
str
) –Required. The resource name of the billing account associated with the projects that you want to list. For example,
billingAccounts/012345-567890-ABCDEF
.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
Request message for ListProjectBillingInfoResponse.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoAsyncPager
- 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.
- async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the
billing.accounts.setIamPolicy
permission on the account, which is often given to billing account administrators.- Parameters
request (
google.iam.v1.iam_policy_pb2.SetIamPolicyRequest
) – The request object. Request message for SetIamPolicy method.resource (
str
) –REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
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
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.
- Parameters
request (
google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
) – The request object. Request message for TestIamPermissions method.resource (
str
) –REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (
Sequence[str]
) –The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.This corresponds to the
permissions
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 message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
CloudBillingTransport
- async update_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.UpdateBillingAccountRequest] = None, *, name: Optional[str] = None, account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.types.cloud_billing.BillingAccount [source]¶
Updates a billing account’s fields. Currently the only field that can be edited is
display_name
. The current authenticated user must have thebilling.accounts.update
IAM permission, which is typically given to the administrator of the billing account.- Parameters
request (
google.cloud.billing_v1.types.UpdateBillingAccountRequest
) – The request object. Request message for UpdateBillingAccount.name (
str
) –Required. The name of the billing account resource to be updated.
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.account (
google.cloud.billing_v1.types.BillingAccount
) –Required. The billing account resource to replace the resource on the server.
This corresponds to the
account
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 billing account in [GCP Console](https://console.cloud.google.com/).
You can assign a billing account to one or more projects.
- Return type
- async update_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.UpdateProjectBillingInfoRequest] = None, *, name: Optional[str] = None, project_billing_info: Optional[google.cloud.billing_v1.types.cloud_billing.ProjectBillingInfo] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.types.cloud_billing.ProjectBillingInfo [source]¶
Sets or updates the billing account associated with a project. You specify the new billing account by setting the
billing_account_name
in theProjectBillingInfo
resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges.Note: Incurred charges that have not yet been reported in the transaction history of the GCP Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project.
The current authenticated user must have ownership privileges for both the project and the billing account.
You can disable billing on the project by setting the
billing_account_name
field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project.Note that associating a project with a closed billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an open billing account.
- Parameters
request (
google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest
) – The request object. Request message for UpdateProjectBillingInfo.name (
str
) –Required. The resource name of the project associated with the billing information that you want to update. For example,
projects/tokyo-rain-123
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.project_billing_info (
google.cloud.billing_v1.types.ProjectBillingInfo
) –The new billing information for the project. Read-only fields are ignored; thus, you can leave empty all fields except
billing_account_name
.This corresponds to the
project_billing_info
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
Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
- Return type
- class google.cloud.billing_v1.services.cloud_billing.CloudBillingClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport]] = 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]¶
Retrieves GCP Console billing accounts and associates them with projects.
Instantiates the cloud billing 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, CloudBillingTransport]) – 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 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_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.CreateBillingAccountRequest] = None, *, billing_account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.types.cloud_billing.BillingAccount [source]¶
Creates a billing account. This method can only be used to create billing subaccounts by GCP resellers. When creating a subaccount, the current authenticated user must have the
billing.accounts.update
IAM permission on the master account, which is typically given to billing account administrators. This method will return an error if the master account has not been provisioned as a reseller account.- Parameters
request (google.cloud.billing_v1.types.CreateBillingAccountRequest) – The request object. Request message for CreateBillingAccount.
billing_account (google.cloud.billing_v1.types.BillingAccount) –
Required. The billing account resource to create. Currently CreateBillingAccount only supports subaccount creation, so any created billing accounts must be under a provided master billing account.
This corresponds to the
billing_account
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 billing account in [GCP Console](https://console.cloud.google.com/).
You can assign a billing account to one or more projects.
- Return type
- 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_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.GetBillingAccountRequest] = 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_v1.types.cloud_billing.BillingAccount [source]¶
Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
- Parameters
request (google.cloud.billing_v1.types.GetBillingAccountRequest) – The request object. Request message for GetBillingAccount.
name (str) –
Required. The resource name of the billing account to retrieve. For example,
billingAccounts/012345-567890-ABCDEF
.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 billing account in [GCP Console](https://console.cloud.google.com/).
You can assign a billing account to one or more projects.
- Return type
- get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Gets the access control policy for a billing account. The caller must have the
billing.accounts.getIamPolicy
permission on the account, which is often given to billing account viewers.- Parameters
request (google.iam.v1.iam_policy_pb2.GetIamPolicyRequest) – The request object. Request message for GetIamPolicy method.
resource (str) –
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
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
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- get_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.GetProjectBillingInfoRequest] = 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_v1.types.cloud_billing.ProjectBillingInfo [source]¶
Gets the billing information for a project. The current authenticated user must have permission to view the project.
- Parameters
request (google.cloud.billing_v1.types.GetProjectBillingInfoRequest) – The request object. Request message for GetProjectBillingInfo.
name (str) –
Required. The resource name of the project for which billing information is retrieved. For example,
projects/tokyo-rain-123
.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
Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
- Return type
- list_billing_accounts(request: Optional[google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager [source]¶
Lists the billing accounts that the current authenticated user has permission to view.
- Parameters
request (google.cloud.billing_v1.types.ListBillingAccountsRequest) – The request object. Request message for ListBillingAccounts.
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 message for ListBillingAccounts.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager
- list_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoRequest] = 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_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager [source]¶
Lists the projects associated with a billing account. The current authenticated user must have the
billing.resourceAssociations.list
IAM permission, which is often given to billing account viewers.- Parameters
request (google.cloud.billing_v1.types.ListProjectBillingInfoRequest) – The request object. Request message for ListProjectBillingInfo.
name (str) –
Required. The resource name of the billing account associated with the projects that you want to list. For example,
billingAccounts/012345-567890-ABCDEF
.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
Request message for ListProjectBillingInfoResponse.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager
- 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.
- set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the
billing.accounts.setIamPolicy
permission on the account, which is often given to billing account administrators.- Parameters
request (google.iam.v1.iam_policy_pb2.SetIamPolicyRequest) – The request object. Request message for SetIamPolicy method.
resource (str) –
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
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
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.
- Parameters
request (google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions method.
resource (str) –
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (Sequence[str]) –
The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.This corresponds to the
permissions
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 message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
CloudBillingTransport
- update_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.UpdateBillingAccountRequest] = None, *, name: Optional[str] = None, account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.types.cloud_billing.BillingAccount [source]¶
Updates a billing account’s fields. Currently the only field that can be edited is
display_name
. The current authenticated user must have thebilling.accounts.update
IAM permission, which is typically given to the administrator of the billing account.- Parameters
request (google.cloud.billing_v1.types.UpdateBillingAccountRequest) – The request object. Request message for UpdateBillingAccount.
name (str) –
Required. The name of the billing account resource to be updated.
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.account (google.cloud.billing_v1.types.BillingAccount) –
Required. The billing account resource to replace the resource on the server.
This corresponds to the
account
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 billing account in [GCP Console](https://console.cloud.google.com/).
You can assign a billing account to one or more projects.
- Return type
- update_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.UpdateProjectBillingInfoRequest] = None, *, name: Optional[str] = None, project_billing_info: Optional[google.cloud.billing_v1.types.cloud_billing.ProjectBillingInfo] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.billing_v1.types.cloud_billing.ProjectBillingInfo [source]¶
Sets or updates the billing account associated with a project. You specify the new billing account by setting the
billing_account_name
in theProjectBillingInfo
resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges.Note: Incurred charges that have not yet been reported in the transaction history of the GCP Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project.
The current authenticated user must have ownership privileges for both the project and the billing account.
You can disable billing on the project by setting the
billing_account_name
field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project.Note that associating a project with a closed billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an open billing account.
- Parameters
request (google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest) – The request object. Request message for UpdateProjectBillingInfo.
name (str) –
Required. The resource name of the project associated with the billing information that you want to update. For example,
projects/tokyo-rain-123
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.project_billing_info (google.cloud.billing_v1.types.ProjectBillingInfo) –
The new billing information for the project. Read-only fields are ignored; thus, you can leave empty all fields except
billing_account_name
.This corresponds to the
project_billing_info
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
Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
- Return type
- class google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsAsyncPager(method: Callable[[...], Awaitable[google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsResponse]], request: google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsRequest, response: google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_billing_accounts
requests.This class thinly wraps an initial
google.cloud.billing_v1.types.ListBillingAccountsResponse
object, and provides an__aiter__
method to iterate through itsbilling_accounts
field.If there are more pages, the
__aiter__
method will make additionalListBillingAccounts
requests and continue to iterate through thebilling_accounts
field on the corresponding responses.All the usual
google.cloud.billing_v1.types.ListBillingAccountsResponse
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_v1.types.ListBillingAccountsRequest) – The initial request object.
response (google.cloud.billing_v1.types.ListBillingAccountsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager(method: Callable[[...], google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsResponse], request: google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsRequest, response: google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_billing_accounts
requests.This class thinly wraps an initial
google.cloud.billing_v1.types.ListBillingAccountsResponse
object, and provides an__iter__
method to iterate through itsbilling_accounts
field.If there are more pages, the
__iter__
method will make additionalListBillingAccounts
requests and continue to iterate through thebilling_accounts
field on the corresponding responses.All the usual
google.cloud.billing_v1.types.ListBillingAccountsResponse
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_v1.types.ListBillingAccountsRequest) – The initial request object.
response (google.cloud.billing_v1.types.ListBillingAccountsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoAsyncPager(method: Callable[[...], Awaitable[google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoResponse]], request: google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoRequest, response: google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_project_billing_info
requests.This class thinly wraps an initial
google.cloud.billing_v1.types.ListProjectBillingInfoResponse
object, and provides an__aiter__
method to iterate through itsproject_billing_info
field.If there are more pages, the
__aiter__
method will make additionalListProjectBillingInfo
requests and continue to iterate through theproject_billing_info
field on the corresponding responses.All the usual
google.cloud.billing_v1.types.ListProjectBillingInfoResponse
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_v1.types.ListProjectBillingInfoRequest) – The initial request object.
response (google.cloud.billing_v1.types.ListProjectBillingInfoResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager(method: Callable[[...], google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoResponse], request: google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoRequest, response: google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_project_billing_info
requests.This class thinly wraps an initial
google.cloud.billing_v1.types.ListProjectBillingInfoResponse
object, and provides an__iter__
method to iterate through itsproject_billing_info
field.If there are more pages, the
__iter__
method will make additionalListProjectBillingInfo
requests and continue to iterate through theproject_billing_info
field on the corresponding responses.All the usual
google.cloud.billing_v1.types.ListProjectBillingInfoResponse
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_v1.types.ListProjectBillingInfoRequest) – The initial request object.
response (google.cloud.billing_v1.types.ListProjectBillingInfoResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.