Movatterモバイル変換

[0]ホーム
URL:

billingbudgets

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:1

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package billingbudgets provides access to the Cloud Billing Budget API.

For product documentation, see:https://cloud.google.com/billing/docs/how-to/budget-api-overview

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/billingbudgets/v1"...ctx := context.Background()billingbudgetsService, err := billingbudgets.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

billingbudgetsService, err := billingbudgets.NewService(ctx, option.WithScopes(billingbudgets.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

billingbudgetsService, err := billingbudgets.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)billingbudgetsService, err := billingbudgets.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// View and manage your Google Cloud Platform billing accountsCloudBillingScope = "https://www.googleapis.com/auth/cloud-billing"// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeBillingAccountsBudgetsCreateCall

type BillingAccountsBudgetsCreateCall struct {// contains filtered or unexported fields}

func (*BillingAccountsBudgetsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*BillingAccountsBudgetsCreateCall)Do

Do executes the "billingbudgets.billingAccounts.budgets.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudBillingBudgetsV1Budget.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*BillingAccountsBudgetsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*BillingAccountsBudgetsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeBillingAccountsBudgetsDeleteCall

type BillingAccountsBudgetsDeleteCall struct {// contains filtered or unexported fields}

func (*BillingAccountsBudgetsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*BillingAccountsBudgetsDeleteCall)Do

Do executes the "billingbudgets.billingAccounts.budgets.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*BillingAccountsBudgetsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*BillingAccountsBudgetsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeBillingAccountsBudgetsGetCall

type BillingAccountsBudgetsGetCall struct {// contains filtered or unexported fields}

func (*BillingAccountsBudgetsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*BillingAccountsBudgetsGetCall)Do

Do executes the "billingbudgets.billingAccounts.budgets.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudBillingBudgetsV1Budget.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*BillingAccountsBudgetsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*BillingAccountsBudgetsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*BillingAccountsBudgetsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeBillingAccountsBudgetsListCall

type BillingAccountsBudgetsListCall struct {// contains filtered or unexported fields}

func (*BillingAccountsBudgetsListCall)Context

Context sets the context to be used in this call's Do method.

func (*BillingAccountsBudgetsListCall)Do

Do executes the "billingbudgets.billingAccounts.budgets.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudBillingBudgetsV1ListBudgetsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*BillingAccountsBudgetsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*BillingAccountsBudgetsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*BillingAccountsBudgetsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*BillingAccountsBudgetsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofbudgets to return per page. The default and maximum value are 100.

func (*BillingAccountsBudgetsListCall)PageToken

PageToken sets the optional parameter "pageToken": The value returned by thelast `ListBudgetsResponse` which indicates that this is a continuation of aprior `ListBudgets` call, and that the system should return the next page ofdata.

func (*BillingAccountsBudgetsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*BillingAccountsBudgetsListCall)Scopeadded inv0.139.0

Scope sets the optional parameter "scope": Set the scope of the budgets tobe returned, in the format of the resource name. The scope of a budget isthe cost that it tracks, such as costs for a single project, or the costsfor all projects in a folder. Only project scope (in the format of"projects/project-id" or "projects/123") is supported in this field. Whenthis field is set to a project's resource name, the budgets returned aretracking the costs for that project.

typeBillingAccountsBudgetsPatchCall

type BillingAccountsBudgetsPatchCall struct {// contains filtered or unexported fields}

func (*BillingAccountsBudgetsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*BillingAccountsBudgetsPatchCall)Do

Do executes the "billingbudgets.billingAccounts.budgets.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudBillingBudgetsV1Budget.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*BillingAccountsBudgetsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*BillingAccountsBudgetsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*BillingAccountsBudgetsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided budget to update. Read-only fields (such as `name`) cannotbe changed. If this is not provided, then only fields with non-defaultvalues from the request are updated. Seehttps://developers.google.com/protocol-buffers/docs/proto3#default for moredetails about default values.

typeBillingAccountsBudgetsService

type BillingAccountsBudgetsService struct {// contains filtered or unexported fields}

funcNewBillingAccountsBudgetsService

func NewBillingAccountsBudgetsService(s *Service) *BillingAccountsBudgetsService

func (*BillingAccountsBudgetsService)Create

Create: Creates a new budget. See Quotas and limits(https://cloud.google.com/billing/quotas) for more information on the limitsof the number of budgets you can create.

  • parent: The name of the billing account to create the budget in. Valuesare of the form `billingAccounts/{billingAccountId}`.

func (*BillingAccountsBudgetsService)Delete

Delete: Deletes a budget. Returns successfully if already deleted.

  • name: Name of the budget to delete. Values are of the form`billingAccounts/{billingAccountId}/budgets/{budgetId}`.

func (*BillingAccountsBudgetsService)Get

Get: Returns a budget. WARNING: There are some fields exposed on the GoogleCloud Console that aren't available on this API. When reading from the API,you will not see these fields in the return value, though they may have beenset in the Cloud Console.

  • name: Name of budget to get. Values are of the form`billingAccounts/{billingAccountId}/budgets/{budgetId}`.

func (*BillingAccountsBudgetsService)List

List: Returns a list of budgets for a billing account. WARNING: There aresome fields exposed on the Google Cloud Console that aren't available onthis API. When reading from the API, you will not see these fields in thereturn value, though they may have been set in the Cloud Console.

  • parent: Name of billing account to list budgets under. Values are of theform `billingAccounts/{billingAccountId}`.

func (*BillingAccountsBudgetsService)Patch

Patch: Updates a budget and returns the updated budget. WARNING: There aresome fields exposed on the Google Cloud Console that aren't available onthis API. Budget fields that are not exposed in this API will not be changedby this method.

  • name: Output only. Resource name of the budget. The resource name impliesthe scope of a budget. Values are of the form`billingAccounts/{billingAccountId}/budgets/{budgetId}`.

typeBillingAccountsService

type BillingAccountsService struct {Budgets *BillingAccountsBudgetsService// contains filtered or unexported fields}

funcNewBillingAccountsService

func NewBillingAccountsService(s *Service) *BillingAccountsService

typeGoogleCloudBillingBudgetsV1Budget

type GoogleCloudBillingBudgetsV1Budget struct {// Amount: Required. Budgeted amount.Amount *GoogleCloudBillingBudgetsV1BudgetAmount `json:"amount,omitempty"`// BudgetFilter: Optional. Filters that define which resources are used to// compute the actual spend against the budget amount, such as projects,// services, and the budget's time period, as well as other filters.BudgetFilter *GoogleCloudBillingBudgetsV1Filter `json:"budgetFilter,omitempty"`// DisplayName: User data for display name in UI. The name must be less than or// equal to 60 characters.DisplayNamestring `json:"displayName,omitempty"`// Etag: Optional. Etag to validate that the object is unchanged for a// read-modify-write operation. An empty etag causes an update to overwrite// other changes.Etagstring `json:"etag,omitempty"`// Name: Output only. Resource name of the budget. The resource name implies// the scope of a budget. Values are of the form// `billingAccounts/{billingAccountId}/budgets/{budgetId}`.Namestring `json:"name,omitempty"`// NotificationsRule: Optional. Rules to apply to notifications sent based on// budget spend and thresholds.NotificationsRule *GoogleCloudBillingBudgetsV1NotificationsRule `json:"notificationsRule,omitempty"`// Possible values://   "OWNERSHIP_SCOPE_UNSPECIFIED" - Unspecified ownership scope, same as// ALL_USERS.//   "ALL_USERS" - Both billing account-level users and project-level users// have full access to the budget, if the users have the required IAM// permissions.//   "BILLING_ACCOUNT" - Only billing account-level users have full access to// the budget. Project-level users have read-only access, even if they have the// required IAM permissions.OwnershipScopestring `json:"ownershipScope,omitempty"`// ThresholdRules: Optional. Rules that trigger alerts (notifications of// thresholds being crossed) when spend exceeds the specified percentages of// the budget. Optional for `pubsubTopic` notifications. Required if using// email notifications.ThresholdRules []*GoogleCloudBillingBudgetsV1ThresholdRule `json:"thresholdRules,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Amount") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Amount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1Budget: A budget is a plan that describes whatyou expect to spend on Cloud projects, plus the rules to execute as spend istracked against that plan, (for example, send an alert when 90% of thetarget spend is met). The budget time period is configurable, with optionssuch as month (default), quarter, year, or custom time period.

func (GoogleCloudBillingBudgetsV1Budget)MarshalJSON

func (sGoogleCloudBillingBudgetsV1Budget) MarshalJSON() ([]byte,error)

typeGoogleCloudBillingBudgetsV1BudgetAmount

type GoogleCloudBillingBudgetsV1BudgetAmount struct {// LastPeriodAmount: Use the last period's actual spend as the budget for the// present period. LastPeriodAmount can only be set when the budget's time// period is a Filter.calendar_period. It cannot be set in combination with// Filter.custom_period.LastPeriodAmount *GoogleCloudBillingBudgetsV1LastPeriodAmount `json:"lastPeriodAmount,omitempty"`// SpecifiedAmount: A specified amount to use as the budget. `currency_code` is// optional. If specified when creating a budget, it must match the currency of// the billing account. If specified when updating a budget, it must match the// currency_code of the existing budget. The `currency_code` is provided on// output.SpecifiedAmount *GoogleTypeMoney `json:"specifiedAmount,omitempty"`// ForceSendFields is a list of field names (e.g. "LastPeriodAmount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastPeriodAmount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1BudgetAmount: The budgeted amount for each usageperiod.

func (GoogleCloudBillingBudgetsV1BudgetAmount)MarshalJSON

typeGoogleCloudBillingBudgetsV1CustomPeriodadded inv0.41.0

type GoogleCloudBillingBudgetsV1CustomPeriod struct {// EndDate: Optional. The end date of the time period. Budgets with elapsed end// date won't be processed. If unset, specifies to track all usage incurred// since the start_date.EndDate *GoogleTypeDate `json:"endDate,omitempty"`// StartDate: Required. The start date must be after January 1, 2017.StartDate *GoogleTypeDate `json:"startDate,omitempty"`// ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndDate") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1CustomPeriod: All date times begin at 12 AM USand Canadian Pacific Time (UTC-8).

func (GoogleCloudBillingBudgetsV1CustomPeriod)MarshalJSONadded inv0.41.0

typeGoogleCloudBillingBudgetsV1Filter

type GoogleCloudBillingBudgetsV1Filter struct {// CalendarPeriod: Optional. Specifies to track usage for recurring calendar// period. For example, assume that CalendarPeriod.QUARTER is set. The budget// tracks usage from April 1 to June 30, when the current calendar month is// April, May, June. After that, it tracks usage from July 1 to September 30// when the current calendar month is July, August, September, so on.//// Possible values://   "CALENDAR_PERIOD_UNSPECIFIED" - Calendar period is unset. This is the// default if the budget is for a custom time period (CustomPeriod).//   "MONTH" - A month. Month starts on the first day of each month, such as// January 1, February 1, March 1, and so on.//   "QUARTER" - A quarter. Quarters start on dates January 1, April 1, July 1,// and October 1 of each year.//   "YEAR" - A year. Year starts on January 1.CalendarPeriodstring `json:"calendarPeriod,omitempty"`// CreditTypes: Optional. If Filter.credit_types_treatment is// INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted// from gross cost to determine the spend for threshold calculations. See a// list of acceptable credit type values// (https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).// If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this// field must be empty.CreditTypes []string `json:"creditTypes,omitempty"`// CreditTypesTreatment: Optional. If not set, default behavior is// `INCLUDE_ALL_CREDITS`.//// Possible values://   "CREDIT_TYPES_TREATMENT_UNSPECIFIED"//   "INCLUDE_ALL_CREDITS" - All types of credit are subtracted from the gross// cost to determine the spend for threshold calculations.//   "EXCLUDE_ALL_CREDITS" - All types of credit are added to the net cost to// determine the spend for threshold calculations.//   "INCLUDE_SPECIFIED_CREDITS" - [Credit// types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tabl// es#credits-type) specified in the credit_types field are subtracted from the// gross cost to determine the spend for threshold calculations.CreditTypesTreatmentstring `json:"creditTypesTreatment,omitempty"`// CustomPeriod: Optional. Specifies to track usage from any start date// (required) to any end date (optional). This time period is static, it does// not recur.CustomPeriod *GoogleCloudBillingBudgetsV1CustomPeriod `json:"customPeriod,omitempty"`// Labels: Optional. A single label and value pair specifying that usage from// only this set of labeled resources should be included in the budget. If// omitted, the report includes all labeled and unlabeled usage. An object// containing a single "key": value` pair. Example: `{ "name": "wrench" }`.// _Currently, multiple entries or multiple values per entry are not allowed._Labels map[string][]interface{} `json:"labels,omitempty"`// Projects: Optional. A set of projects of the form `projects/{project}`,// specifying that usage from only this set of projects should be included in// the budget. If omitted, the report includes all usage for the billing// account, regardless of which project the usage occurred on.Projects []string `json:"projects,omitempty"`// ResourceAncestors: Optional. A set of folder and organization names of the// form `folders/{folderId}` or `organizations/{organizationId}`, specifying// that usage from only this set of folders and organizations should be// included in the budget. If omitted, the budget includes all usage that the// billing account pays for. If the folder or organization contains projects// that are paid for by a different Cloud Billing account, the budget *doesn't*// apply to those projects.ResourceAncestors []string `json:"resourceAncestors,omitempty"`// Services: Optional. A set of services of the form `services/{service_id}`,// specifying that usage from only this set of services should be included in// the budget. If omitted, the report includes usage for all the services. The// service names are available through the Catalog API://https://cloud.google.com/billing/v1/how-tos/catalog-api.Services []string `json:"services,omitempty"`// Subaccounts: Optional. A set of subaccounts of the form// `billingAccounts/{account_id}`, specifying that usage from only this set of// subaccounts should be included in the budget. If a subaccount is set to the// name of the parent account, usage from the parent account is included. If// the field is omitted, the report includes usage from the parent account and// all subaccounts, if they exist.Subaccounts []string `json:"subaccounts,omitempty"`// ForceSendFields is a list of field names (e.g. "CalendarPeriod") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CalendarPeriod") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1Filter: A filter for a budget, limiting the scopeof the cost to calculate.

func (GoogleCloudBillingBudgetsV1Filter)MarshalJSON

func (sGoogleCloudBillingBudgetsV1Filter) MarshalJSON() ([]byte,error)

typeGoogleCloudBillingBudgetsV1LastPeriodAmount

type GoogleCloudBillingBudgetsV1LastPeriodAmount struct {}

GoogleCloudBillingBudgetsV1LastPeriodAmount: Describes a budget amounttargeted to the last Filter.calendar_period spend. At this time, the amountis automatically 100% of the last calendar period's spend; that is, thereare no other options yet. LastPeriodAmount cannot be set for a budgetconfigured with a Filter.custom_period.

typeGoogleCloudBillingBudgetsV1ListBudgetsResponse

type GoogleCloudBillingBudgetsV1ListBudgetsResponse struct {// Budgets: List of the budgets owned by the requested billing account.Budgets []*GoogleCloudBillingBudgetsV1Budget `json:"budgets,omitempty"`// NextPageToken: If not empty, indicates that there may be more budgets that// match the request; this value should be passed in a new// `ListBudgetsRequest`.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Budgets") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Budgets") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1ListBudgetsResponse: Response for ListBudgets

func (GoogleCloudBillingBudgetsV1ListBudgetsResponse)MarshalJSON

typeGoogleCloudBillingBudgetsV1NotificationsRule

type GoogleCloudBillingBudgetsV1NotificationsRule struct {// DisableDefaultIamRecipients: Optional. When set to true, disables default// notifications sent when a threshold is exceeded. Default notifications are// sent to those with Billing Account Administrator and Billing Account User// IAM roles for the target account.DisableDefaultIamRecipientsbool `json:"disableDefaultIamRecipients,omitempty"`// EnableProjectLevelRecipients: Optional. When set to true, and when the// budget has a single project configured, notifications will be sent to// project level recipients of that project. This field will be ignored if the// budget has multiple or no project configured. Currently, project level// recipients are the users with `Owner` role on a cloud project.EnableProjectLevelRecipientsbool `json:"enableProjectLevelRecipients,omitempty"`// MonitoringNotificationChannels: Optional. Email targets to send// notifications to when a threshold is exceeded. This is in addition to the// `DefaultIamRecipients` who receive alert emails based on their billing// account IAM role. The value is the full REST resource name of a Cloud// Monitoring email notification channel with the form// `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5// email notifications are allowed. To customize budget alert email recipients// with monitoring notification channels, you _must create the monitoring// notification channels before you link them to a budget_. For guidance on// setting up notification channels to use with budgets, see Customize budget// alert email recipients// (https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients).// For Cloud Billing budget alerts, you _must use email notification channels_.// The other types of notification channels are _not_ supported, such as Slack,// SMS, or PagerDuty. If you want to send budget notifications to Slack// (https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack),// use a pubsubTopic and configure programmatic notifications// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).MonitoringNotificationChannels []string `json:"monitoringNotificationChannels,omitempty"`// PubsubTopic: Optional. The name of the Pub/Sub topic where budget-related// messages are published, in the form// `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at// regular intervals; the timing of the updates is not dependent on the// threshold rules (#thresholdrule) you've set. Note that if you want your// Pub/Sub JSON object// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)// to contain data for `alertThresholdExceeded`, you need at least one alert// threshold rule (#thresholdrule). When you set threshold rules, you must also// enable at least one of the email notification options, either using the// default IAM recipients or Cloud Monitoring email notification channels. To// use Pub/Sub topics with budgets, you must do the following: 1. Create the// Pub/Sub topic before connecting it to your budget. For guidance, see Manage// programmatic budget alert notifications// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).// 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the// Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For// additional details on Pub/Sub roles and permissions, see Permissions// required for this task// (https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).PubsubTopicstring `json:"pubsubTopic,omitempty"`// SchemaVersion: Optional. Required when NotificationsRule.pubsub_topic is// set. The schema version of the notification sent to// NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the// JSON schema as defined in//https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.SchemaVersionstring `json:"schemaVersion,omitempty"`// ForceSendFields is a list of field names (e.g.// "DisableDefaultIamRecipients") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisableDefaultIamRecipients") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1NotificationsRule: NotificationsRule definesnotifications that are sent based on budget spend and thresholds.

func (GoogleCloudBillingBudgetsV1NotificationsRule)MarshalJSON

typeGoogleCloudBillingBudgetsV1ThresholdRule

type GoogleCloudBillingBudgetsV1ThresholdRule struct {// SpendBasis: Optional. The type of basis used to determine if spend has// passed the threshold. Behavior defaults to CURRENT_SPEND if not set.//// Possible values://   "BASIS_UNSPECIFIED" - Unspecified threshold basis.//   "CURRENT_SPEND" - Use current spend as the basis for comparison against// the threshold.//   "FORECASTED_SPEND" - Use forecasted spend for the period as the basis for// comparison against the threshold. FORECASTED_SPEND can only be set when the// budget's time period is a Filter.calendar_period. It cannot be set in// combination with Filter.custom_period.SpendBasisstring `json:"spendBasis,omitempty"`// ThresholdPercent: Required. Send an alert when this threshold is exceeded.// This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative// number.ThresholdPercentfloat64 `json:"thresholdPercent,omitempty"`// ForceSendFields is a list of field names (e.g. "SpendBasis") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SpendBasis") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudBillingBudgetsV1ThresholdRule: ThresholdRule contains thedefinition of a threshold. Threshold rules define the triggering events usedto generate a budget notification email. When a threshold is crossed (spendexceeds the specified percentages of the budget), budget alert emails aresent to the email recipients you specify in the NotificationsRule(#notificationsrule). Threshold rules also affect the fields included in theJSON data object(https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)sent to a Pub/Sub topic. Threshold rules are _required_ if using emailnotifications. Threshold rules are _optional_ if only setting a`pubsubTopic` NotificationsRule (#NotificationsRule), unless you want yourJSON data object to include data about the thresholds you set. For moreinformation, see set budget threshold rules and actions(https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).

func (GoogleCloudBillingBudgetsV1ThresholdRule)MarshalJSON

func (*GoogleCloudBillingBudgetsV1ThresholdRule)UnmarshalJSON

func (s *GoogleCloudBillingBudgetsV1ThresholdRule) UnmarshalJSON(data []byte)error

typeGoogleProtobufEmpty

type GoogleProtobufEmpty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

GoogleProtobufEmpty: A generic empty message that you can re-use to avoiddefining duplicated empty messages in your APIs. A typical example is to useit as the request or the response type of an API method. For instance:service Foo { rpc Bar(google.protobuf.Empty) returns(google.protobuf.Empty); }

typeGoogleTypeDateadded inv0.41.0

type GoogleTypeDate struct {// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,// or 0 to specify a year by itself or a year and month where the day isn't// significant.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeDate: Represents a whole or partial calendar date, such as abirthday. The time of day and time zone are either specified elsewhere orare insignificant. The date is relative to the Gregorian Calendar. This canrepresent one of the following: * A full date, with non-zero year, month,and day values. * A month and day, with a zero year (for example, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (GoogleTypeDate)MarshalJSONadded inv0.41.0

func (sGoogleTypeDate) MarshalJSON() ([]byte,error)

typeGoogleTypeMoney

type GoogleTypeMoney struct {// CurrencyCode: The three-letter currency code defined in ISO 4217.CurrencyCodestring `json:"currencyCode,omitempty"`// Nanos: 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. If `units` is zero, `nanos` can be positive, zero,// or negative. If `units` is negative, `nanos` must be negative or zero. For// example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.Nanosint64 `json:"nanos,omitempty"`// Units: The whole units of the amount. For example if `currencyCode` is// "USD", then 1 unit is one US dollar.Unitsint64 `json:"units,omitempty,string"`// ForceSendFields is a list of field names (e.g. "CurrencyCode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CurrencyCode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeMoney: Represents an amount of money with its currency type.

func (GoogleTypeMoney)MarshalJSON

func (sGoogleTypeMoney) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentBillingAccounts *BillingAccountsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp