googleapis.cloudbillingaccount
Module googleapis.cloudbillingaccount
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_googleapis.cloudbillingaccount_1.1.0.png)
ballerinax/googleapis.cloudbillingaccount Ballerina library
Overview
This is a generated connector for Google Cloud Billing Account API OpenAPI specification. The Google Cloud Billing Account API allows developers to manage billing for their Google Cloud Platform projects programmatically.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Google account
- Obtain tokens - Follow this link
Quickstart
To use the Google Cloud Billing Account connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
Import the ballerinax/googleapis.cloudbillingaccount module into the Ballerina project.
import ballerinax/googleapis.cloudbillingaccount as cloudbillingaccount;
Step 2: Create a new connector instance
You can now enter the credentials in the Google Cloud Billing Account client configuration and create Google Cloud Billing client by passing the configuration:
cloudbillingaccount:ClientConfig clientConfig = { auth: { clientId: <CLIENT_ID>, clientSecret: <CLIENT_SECRET>, refreshUrl: <REFRESH_URL>, refreshToken: <REFRESH_TOKEN> } }; cloudbillingaccount:Client baseClient = check new Client(clientConfig);
Step 3: Invoke connector operation
-
You can list billing accounts as follows with
listBillingAccounts
method.cloudbillingaccount:ListBillingAccountsResponse billingAccounts = check baseClient->listBillingAccounts();
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
googleapis.cloudbillingaccount: Client![](/images/permalink.svg)
This is a generated connector for Google Cloud Billing Account API v1 OpenAPI specification. The Google Cloud Billing Account API allows developers to manage billing for their Google Cloud Platform projects programmatically.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Google account and obtain tokens by following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://cloudbilling.googleapis.com/" - URL of the target service
listBillingAccounts![](/images/permalink.svg)
function listBillingAccounts(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, int? pageSize, string? pageToken) returns ListBillingAccountsResponse|error
Lists the billing accounts that the current authenticated user has permission to view.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- filter string? (default ()) - Options for how to filter the returned billing accounts. Currently this only supports filtering for subaccounts under a single provided reseller billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.
- pageSize int? (default ()) - Requested page size. The maximum page size is 100; this is also the default.
- pageToken string? (default ()) - A token identifying a page of results to return. This should be a
next_page_token
value returned from a previousListBillingAccounts
call. If unspecified, the first page of results is returned.
Return Type
- ListBillingAccountsResponse|error - Successful response
createBillingAccounts![](/images/permalink.svg)
function createBillingAccounts(BillingAccount payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns BillingAccount|error
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
- payload BillingAccount - A record of type
BillingAccount
which contains the necessary data to create a billing account
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- BillingAccount|error - Successful response
listServices![](/images/permalink.svg)
function listServices(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListServicesResponse|error
Lists all public cloud services.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - Requested page size. Defaults to 5000.
- pageToken string? (default ()) - A token identifying a page of results to return. This should be a
next_page_token
value returned from a previousListServices
call. If unspecified, the first page of results is returned.
Return Type
- ListServicesResponse|error - Successful response
getBillingAccounts![](/images/permalink.svg)
function getBillingAccounts(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns BillingAccount|error
Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
Parameters
- name string - Required. The resource name of the billing account to retrieve. For example,
billingAccounts/012345-567890-ABCDEF
.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- BillingAccount|error - Successful response
patchBillingAccounts![](/images/permalink.svg)
function patchBillingAccounts(string name, BillingAccount payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns BillingAccount|error
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 string - Required. The name of the billing account resource to be updated.
- payload BillingAccount - A record of type
BillingAccount
which contains the necessary data to update a billing account
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- updateMask string? (default ()) - The update mask applied to the resource. Only "display_name" is currently supported.
Return Type
- BillingAccount|error - Successful response
getProjectsBillingInfo![](/images/permalink.svg)
function getProjectsBillingInfo(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns ProjectBillingInfo|error
Gets the billing information for a project. The current authenticated user must have permission to view the project.
Parameters
- name string - Required. The resource name of the project for which billing information is retrieved. For example,
projects/tokyo-rain-123
.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- ProjectBillingInfo|error - Successful response
updateProjectsBillingInfo![](/images/permalink.svg)
function updateProjectsBillingInfo(string name, ProjectBillingInfo payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns ProjectBillingInfo|error
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 string - Required. The resource name of the project associated with the billing information that you want to update. For example,
projects/tokyo-rain-123
.
- payload ProjectBillingInfo - A record of type
ProjectBillingInfo
which contains the necessary data to update a project billing information
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- ProjectBillingInfo|error - Successful response
listProjectsBillingAccounts![](/images/permalink.svg)
function listProjectsBillingAccounts(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListProjectBillingInfoResponse|error
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 string - Required. The resource name of the billing account associated with the projects that you want to list. For example,
billingAccounts/012345-567890-ABCDEF
.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - Requested page size. The maximum page size is 100; this is also the default.
- pageToken string? (default ()) - A token identifying a page of results to be returned. This should be a
next_page_token
value returned from a previousListProjectBillingInfo
call. If unspecified, the first page of results is returned.
Return Type
- ListProjectBillingInfoResponse|error - Successful response
listServicesSkus![](/images/permalink.svg)
function listServicesSkus(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? currencyCode, string? endTime, int? pageSize, string? pageToken, string? startTime) returns ListSkusResponse|error
Lists all publicly available SKUs for a given cloud service.
Parameters
- parent string - Required. The name of the service. Example: "services/DA34-426B-A397"
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- currencyCode string? (default ()) - The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used.
- endTime string? (default ()) - Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
- pageSize int? (default ()) - Requested page size. Defaults to 5000.
- pageToken string? (default ()) - A token identifying a page of results to return. This should be a
next_page_token
value returned from a previousListSkus
call. If unspecified, the first page of results is returned.
- startTime string? (default ()) - Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
Return Type
- ListSkusResponse|error - Successful response
getBillingAccountsIamPolicy![](/images/permalink.svg)
function getBillingAccountsIamPolicy(string 'resource, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? optionsRequestedpolicyversion) returns Policy|error
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
- 'resource string - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- optionsRequestedpolicyversion int? (default ()) - Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
setBillingAccountsIamPolicy![](/images/permalink.svg)
function setBillingAccountsIamPolicy(string 'resource, SetIamPolicyRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Policy|error
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
- 'resource string - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- payload SetIamPolicyRequest - A record of type
SetIamPolicyRequest
which contains the necessary data to set access control policy
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
testBillingAccountsIamPermissions![](/images/permalink.svg)
function testBillingAccountsIamPermissions(string 'resource, TestIamPermissionsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns TestIamPermissionsResponse|error
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
- 'resource string - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- payload TestIamPermissionsRequest - A record of type
TestIamPermissionsRequest
which contains the necessary data to test access control policy
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- TestIamPermissionsResponse|error - Successful response
Records![](/images/permalink.svg)
googleapis.cloudbillingaccount: AggregationInfo![](/images/permalink.svg)
Represents the aggregation level and interval for pricing of a single SKU.
Fields
- aggregationCount int? - The number of intervals to aggregate over. Example: If aggregation_level is "DAILY" and aggregation_count is 14, aggregation will be over 14 days.
- aggregationInterval string? - The aggregation of interval to aggregate over.
- aggregationLevel string? - The aggregation level to aggregate over.
googleapis.cloudbillingaccount: AuditConfig![](/images/permalink.svg)
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices
and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Fields
- auditLogConfigs AuditLogConfig[]? - The configuration for logging of each type of permission.
- 'service string? - Specifies a service that will be enabled for audit logging. For example,
storage.googleapis.com
,cloudsql.googleapis.com
.allServices
is a special value that covers all services.
googleapis.cloudbillingaccount: AuditLogConfig![](/images/permalink.svg)
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Fields
- exemptedMembers string[]? - Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
- logType string? - The log type that this config enables.
googleapis.cloudbillingaccount: BillingAccount![](/images/permalink.svg)
A billing account in the Google Cloud Console. You can assign a billing account to one or more projects.
Fields
- displayName string? - The display name given to the billing account, such as
My Billing Account
. This name is displayed in the Google Cloud Console.
- masterBillingAccount string? - If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
- name string? - Output only. The resource name of the billing account. The resource name has the form
billingAccounts/{billing_account_id}
. For example,billingAccounts/012345-567890-ABCDEF
would be the resource name for billing account012345-567890-ABCDEF
.
- open boolean? - Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
googleapis.cloudbillingaccount: Binding![](/images/permalink.svg)
Associates members
with a role
.
Fields
- condition Expr? - Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
- members string[]? - Specifies the identities requesting access for a Cloud Platform resource.
members
can have the following values: *allUsers
: A special identifier that represents anyone who is on the internet; with or without a Google account. *allAuthenticatedUsers
: A special identifier that represents anyone who is authenticated with a Google account or a service account. *user:{emailid}
: An email address that represents a specific Google account. For example,alice@example.com
. *serviceAccount:{emailid}
: An email address that represents a service account. For example,my-other-app@appspot.gserviceaccount.com
. *group:{emailid}
: An email address that represents a Google group. For example,admins@example.com
. *deleted:user:{emailid}?uid={uniqueid}
: An email address (plus unique identifier) representing a user that has been recently deleted. For example,alice@example.com?uid=123456789012345678901
. If the user is recovered, this value reverts touser:{emailid}
and the recovered user retains the role in the binding. *deleted:serviceAccount:{emailid}?uid={uniqueid}
: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901
. If the service account is undeleted, this value reverts toserviceAccount:{emailid}
and the undeleted service account retains the role in the binding. *deleted:group:{emailid}?uid={uniqueid}
: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example,admins@example.com?uid=123456789012345678901
. If the group is recovered, this value reverts togroup:{emailid}
and the recovered group retains the role in the binding. *domain:{domain}
: The G Suite domain (primary) that represents all the users of that domain. For example,google.com
orexample.com
.
- role string? - Role that is assigned to
members
. For example,roles/viewer
,roles/editor
, orroles/owner
.
googleapis.cloudbillingaccount: Category![](/images/permalink.svg)
Represents the category hierarchy of a SKU.
Fields
- resourceFamily string? - The type of product the SKU refers to. Example: "Compute", "Storage", "Network", "ApplicationServices" etc.
- resourceGroup string? - A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc.
- serviceDisplayName string? - The display name of the service this SKU belongs to.
- usageType string? - Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc.
googleapis.cloudbillingaccount: ClientConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
googleapis.cloudbillingaccount: Expr![](/images/permalink.svg)
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Fields
- description string? - Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- expression string? - Textual representation of an expression in Common Expression Language syntax.
- location string? - Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- title string? - Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
googleapis.cloudbillingaccount: GeoTaxonomy![](/images/permalink.svg)
Encapsulates the geographic taxonomy data for a sku.
Fields
- regions string[]? - The list of regions associated with a sku. Empty for Global skus, which are associated with all Google Cloud regions.
- 'type string? - The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL.
googleapis.cloudbillingaccount: ListBillingAccountsResponse![](/images/permalink.svg)
Response message for ListBillingAccounts
.
Fields
- billingAccounts BillingAccount[]? - A list of billing accounts.
- nextPageToken string? - A token to retrieve the next page of results. To retrieve the next page, call
ListBillingAccounts
again with thepage_token
field set to this value. This field is empty if there are no more results to retrieve.
googleapis.cloudbillingaccount: ListProjectBillingInfoResponse![](/images/permalink.svg)
Request message for ListProjectBillingInfoResponse
.
Fields
- nextPageToken string? - A token to retrieve the next page of results. To retrieve the next page, call
ListProjectBillingInfo
again with thepage_token
field set to this value. This field is empty if there are no more results to retrieve.
- projectBillingInfo ProjectBillingInfo[]? - A list of
ProjectBillingInfo
resources representing the projects associated with the billing account.
googleapis.cloudbillingaccount: ListServicesResponse![](/images/permalink.svg)
Response message for ListServices
.
Fields
- nextPageToken string? - A token to retrieve the next page of results. To retrieve the next page, call
ListServices
again with thepage_token
field set to this value. This field is empty if there are no more results to retrieve.
- services Service[]? - A list of services.
googleapis.cloudbillingaccount: ListSkusResponse![](/images/permalink.svg)
Response message for ListSkus
.
Fields
- nextPageToken string? - A token to retrieve the next page of results. To retrieve the next page, call
ListSkus
again with thepage_token
field set to this value. This field is empty if there are no more results to retrieve.
- skus Sku[]? - The list of public SKUs of the given service.
googleapis.cloudbillingaccount: Money![](/images/permalink.svg)
Represents an amount of money with its currency type.
Fields
- currencyCode string? - The three-letter currency code defined in ISO 4217.
- nanos int? - Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If
units
is positive,nanos
must be positive or zero. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.
- units string? - The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
googleapis.cloudbillingaccount: Policy![](/images/permalink.svg)
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud 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; each role
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical expression that allows access to a resource only if the expression evaluates to true
. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. 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')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } 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') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.
Fields
- auditConfigs AuditConfig[]? - Specifies cloud audit logging configuration for this policy.
- bindings Binding[]? - Associates a list of
members
to arole
. Optionally, may specify acondition
that determines how and when thebindings
are applied. Each of thebindings
must contain at least one member.
- etag string? -
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetag
in the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetag
is returned in the response togetIamPolicy
, and systems are expected to put that etag in the request tosetIamPolicy
to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include theetag
field whenever you callsetIamPolicy
. If you omit this field, then IAM allows you to overwrite a version3
policy with a version1
policy, and all of the conditions in the version3
policy are lost.
- 'version int? - Specifies the format of the policy. Valid values are
0
,1
, and3
. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3
. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include theetag
field whenever you callsetIamPolicy
. If you omit this field, then IAM allows you to overwrite a version3
policy with a version1
policy, and all of the conditions in the version3
policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
googleapis.cloudbillingaccount: PricingExpression![](/images/permalink.svg)
Expresses a mathematical pricing formula. For Example:- usage_unit: GBy
tiered_rates:
[start_usage_amount: 20, unit_price: $10]
[start_usage_amount: 100, unit_price: $5]
The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage.
Fields
- baseUnit string? - The base unit for the SKU which is the unit used in usage exports. Example: "By"
- baseUnitConversionFactor float? - Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit.
- baseUnitDescription string? - The base unit in human readable form. Example: "byte".
- displayQuantity float? - The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB"
- tieredRates TierRate[]? - The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount.
- usageUnit string? - The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".
- usageUnitDescription string? - The unit of usage in human readable form. Example: "gibi byte".
googleapis.cloudbillingaccount: PricingInfo![](/images/permalink.svg)
Represents the pricing information for a SKU at a single point of time.
Fields
- aggregationInfo AggregationInfo? - Represents the aggregation level and interval for pricing of a single SKU.
- currencyConversionRate float? - Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY
- effectiveTime string? - The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info.
- pricingExpression PricingExpression? - Expresses a mathematical pricing formula. For Example:-
usage_unit: GBy
tiered_rates:
[start_usage_amount: 20, unit_price: $10]
[start_usage_amount: 100, unit_price: $5]
The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage.
- summary string? - An optional human readable summary of the pricing information, has a maximum length of 256 characters.
googleapis.cloudbillingaccount: ProjectBillingInfo![](/images/permalink.svg)
Encapsulation of billing information for a Google Cloud Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
Fields
- billingAccountName string? - The resource name of the billing account associated with the project, if any. For example,
billingAccounts/012345-567890-ABCDEF
.
- billingEnabled boolean? - True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.
- name string? - The resource name for the
ProjectBillingInfo
; has the formprojects/{project_id}/billingInfo
. For example, the resource name for the billing information for projecttokyo-rain-123
would beprojects/tokyo-rain-123/billingInfo
. This field is read-only.
- projectId string? - The ID of the project that this
ProjectBillingInfo
represents, such astokyo-rain-123
. This is a convenience field so that you don't need to parse thename
field to obtain a project ID. This field is read-only.
googleapis.cloudbillingaccount: Service![](/images/permalink.svg)
Encapsulates a single service in Google Cloud Platform.
Fields
- businessEntityName string? - The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps"
- displayName string? - A human readable display name for this service.
- name string? - The resource name for the service. Example: "services/DA34-426B-A397"
- serviceId string? - The identifier for the service. Example: "DA34-426B-A397"
googleapis.cloudbillingaccount: SetIamPolicyRequest![](/images/permalink.svg)
Request message for SetIamPolicy
method.
Fields
- policy Policy? - An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
Policy
is a collection ofbindings
. Abinding
binds one or moremembers
to a singlerole
. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Arole
is a named list of permissions; eachrole
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, abinding
can also specify acondition
, which is a logical expression that allows access to a resource only if the expression evaluates totrue
. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. 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')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } 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') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.
- updateMask string? - OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:
paths: "bindings, etag"
googleapis.cloudbillingaccount: Sku![](/images/permalink.svg)
Encapsulates a single SKU in Google Cloud Platform
Fields
- category Category? - Represents the category hierarchy of a SKU.
- description string? - A human readable description of the SKU, has a maximum length of 256 characters.
- geoTaxonomy GeoTaxonomy? - Encapsulates the geographic taxonomy data for a sku.
- name string? - The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
- pricingInfo PricingInfo[]? - A timeline of pricing info for this SKU in chronological order.
- serviceProviderName string? - Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform.
- serviceRegions string[]? - List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/
- skuId string? - The identifier for the SKU. Example: "AA95-CD31-42FE"
googleapis.cloudbillingaccount: TestIamPermissionsRequest![](/images/permalink.svg)
Request message for TestIamPermissions
method.
Fields
- permissions string[]? - 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.
googleapis.cloudbillingaccount: TestIamPermissionsResponse![](/images/permalink.svg)
Response message for TestIamPermissions
method.
Fields
- permissions string[]? - A subset of
TestPermissionsRequest.permissions
that the caller is allowed.
googleapis.cloudbillingaccount: TierRate![](/images/permalink.svg)
The price rate indicating starting usage and its corresponding price.
Fields
- startUsageAmount float? - Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units.
- unitPrice Money? - Represents an amount of money with its currency type.
Import
import ballerinax/googleapis.cloudbillingaccount;
Metadata
Released date: over 2 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Finance/Billing
Cost/Freemium
Vendor/Google
Contributors
Dependencies