public sealed class CloudBillingClientImpl : CloudBillingClient
Reference documentation and code samples for the Google Cloud Billing v1 API class CloudBillingClientImpl.
CloudBilling client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Billing.V1Assembly
Google.Cloud.Billing.V1.dll
Remarks
Retrieves the Google Cloud Console billing accounts and associates them with projects.
Constructors
CloudBillingClientImpl(CloudBilling.CloudBillingClient, CloudBillingSettings, ILogger)
public CloudBillingClientImpl(CloudBilling.CloudBillingClient grpcClient, CloudBillingSettings settings, ILogger logger)
Constructs a client wrapper for the CloudBilling service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | CloudBilling.CloudBillingClient The underlying gRPC client. |
settings | CloudBillingSettings The base CloudBillingSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
GrpcClient
public override CloudBilling.CloudBillingClient GrpcClient { get; }
The underlying gRPC CloudBilling client
Property Value | |
---|---|
Type | Description |
CloudBilling.CloudBillingClient |
Methods
CreateBillingAccount(CreateBillingAccountRequest, CallSettings)
public override BillingAccount CreateBillingAccount(CreateBillingAccountRequest request, CallSettings callSettings = null)
This method creates billing subaccounts.
Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create.
When creating a subaccount, the current authenticated user must have the
billing.accounts.update
IAM permission on the parent account, which is
typically given to billing account
administrators.
This method will return an error if the parent account has not been
provisioned as a reseller account.
Parameters | |
---|---|
Name | Description |
request | CreateBillingAccountRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BillingAccount | The RPC response. |
CreateBillingAccountAsync(CreateBillingAccountRequest, CallSettings)
public override Task<BillingAccount> CreateBillingAccountAsync(CreateBillingAccountRequest request, CallSettings callSettings = null)
This method creates billing subaccounts.
Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create.
When creating a subaccount, the current authenticated user must have the
billing.accounts.update
IAM permission on the parent account, which is
typically given to billing account
administrators.
This method will return an error if the parent account has not been
provisioned as a reseller account.
Parameters | |
---|---|
Name | Description |
request | CreateBillingAccountRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<BillingAccount> | A Task containing the RPC response. |
GetBillingAccount(GetBillingAccountRequest, CallSettings)
public override BillingAccount GetBillingAccount(GetBillingAccountRequest request, CallSettings callSettings = null)
Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
Parameters | |
---|---|
Name | Description |
request | GetBillingAccountRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BillingAccount | The RPC response. |
GetBillingAccountAsync(GetBillingAccountRequest, CallSettings)
public override Task<BillingAccount> GetBillingAccountAsync(GetBillingAccountRequest request, CallSettings callSettings = null)
Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
Parameters | |
---|---|
Name | Description |
request | GetBillingAccountRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<BillingAccount> | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Policy> | A Task containing the RPC response. |
GetProjectBillingInfo(GetProjectBillingInfoRequest, CallSettings)
public override ProjectBillingInfo GetProjectBillingInfo(GetProjectBillingInfoRequest request, CallSettings callSettings = null)
Gets the billing information for a project. The current authenticated user
must have the resourcemanager.projects.get
permission for the project,
which can be granted by assigning the Project
Viewer
role.
Parameters | |
---|---|
Name | Description |
request | GetProjectBillingInfoRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ProjectBillingInfo | The RPC response. |
GetProjectBillingInfoAsync(GetProjectBillingInfoRequest, CallSettings)
public override Task<ProjectBillingInfo> GetProjectBillingInfoAsync(GetProjectBillingInfoRequest request, CallSettings callSettings = null)
Gets the billing information for a project. The current authenticated user
must have the resourcemanager.projects.get
permission for the project,
which can be granted by assigning the Project
Viewer
role.
Parameters | |
---|---|
Name | Description |
request | GetProjectBillingInfoRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ProjectBillingInfo> | A Task containing the RPC response. |
ListBillingAccounts(ListBillingAccountsRequest, CallSettings)
public override PagedEnumerable<ListBillingAccountsResponse, BillingAccount> ListBillingAccounts(ListBillingAccountsRequest request, CallSettings callSettings = null)
Lists the billing accounts that the current authenticated user has permission to view.
Parameters | |
---|---|
Name | Description |
request | ListBillingAccountsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListBillingAccountsResponse, BillingAccount> | A pageable sequence of BillingAccount resources. |
ListBillingAccountsAsync(ListBillingAccountsRequest, CallSettings)
public override PagedAsyncEnumerable<ListBillingAccountsResponse, BillingAccount> ListBillingAccountsAsync(ListBillingAccountsRequest request, CallSettings callSettings = null)
Lists the billing accounts that the current authenticated user has permission to view.
Parameters | |
---|---|
Name | Description |
request | ListBillingAccountsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListBillingAccountsResponse, BillingAccount> | A pageable asynchronous sequence of BillingAccount resources. |
ListProjectBillingInfo(ListProjectBillingInfoRequest, CallSettings)
public override PagedEnumerable<ListProjectBillingInfoResponse, ProjectBillingInfo> ListProjectBillingInfo(ListProjectBillingInfoRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | ListProjectBillingInfoRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListProjectBillingInfoResponse, ProjectBillingInfo> | A pageable sequence of ProjectBillingInfo resources. |
ListProjectBillingInfoAsync(ListProjectBillingInfoRequest, CallSettings)
public override PagedAsyncEnumerable<ListProjectBillingInfoResponse, ProjectBillingInfo> ListProjectBillingInfoAsync(ListProjectBillingInfoRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | ListProjectBillingInfoRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListProjectBillingInfoResponse, ProjectBillingInfo> | A pageable asynchronous sequence of ProjectBillingInfo resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Policy> | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)
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 | |
---|---|
Name | Description |
request | TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<TestIamPermissionsResponse> | A Task containing the RPC response. |
UpdateBillingAccount(UpdateBillingAccountRequest, CallSettings)
public override BillingAccount UpdateBillingAccount(UpdateBillingAccountRequest request, CallSettings callSettings = null)
Updates a billing account's fields.
Currently the only field that can be edited is display_name
.
The current authenticated user must have the billing.accounts.update
IAM permission, which is typically given to the
administrator
of the billing account.
Parameters | |
---|---|
Name | Description |
request | UpdateBillingAccountRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
BillingAccount | The RPC response. |
UpdateBillingAccountAsync(UpdateBillingAccountRequest, CallSettings)
public override Task<BillingAccount> UpdateBillingAccountAsync(UpdateBillingAccountRequest request, CallSettings callSettings = null)
Updates a billing account's fields.
Currently the only field that can be edited is display_name
.
The current authenticated user must have the billing.accounts.update
IAM permission, which is typically given to the
administrator
of the billing account.
Parameters | |
---|---|
Name | Description |
request | UpdateBillingAccountRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<BillingAccount> | A Task containing the RPC response. |
UpdateProjectBillingInfo(UpdateProjectBillingInfoRequest, CallSettings)
public override ProjectBillingInfo UpdateProjectBillingInfo(UpdateProjectBillingInfoRequest request, CallSettings callSettings = null)
Sets or updates the billing account associated with a project. You specify
the new billing account by setting the billing_account_name
in the
ProjectBillingInfo
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 Google Cloud 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 | |
---|---|
Name | Description |
request | UpdateProjectBillingInfoRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ProjectBillingInfo | The RPC response. |
UpdateProjectBillingInfoAsync(UpdateProjectBillingInfoRequest, CallSettings)
public override Task<ProjectBillingInfo> UpdateProjectBillingInfoAsync(UpdateProjectBillingInfoRequest request, CallSettings callSettings = null)
Sets or updates the billing account associated with a project. You specify
the new billing account by setting the billing_account_name
in the
ProjectBillingInfo
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 Google Cloud 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 | |
---|---|
Name | Description |
request | UpdateProjectBillingInfoRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ProjectBillingInfo> | A Task containing the RPC response. |