Package budgets is an auto-generated package for the Cloud Billing Budget API.
The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/billing/budgets/apiv1@latest ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := budgets . NewBudgetClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := & budgetspb . CreateBudgetRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#CreateBudgetRequest. } resp , err := c . CreateBudget ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewBudgetClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
BudgetCallOptions
type
BudgetCallOptions
struct
{
CreateBudget
[]
gax
.
CallOption
UpdateBudget
[]
gax
.
CallOption
GetBudget
[]
gax
.
CallOption
ListBudgets
[]
gax
.
CallOption
DeleteBudget
[]
gax
.
CallOption
}
BudgetCallOptions contains the retry settings for each method of BudgetClient.
BudgetClient
type
BudgetClient
struct
{
// The call options for this service.
CallOptions
*
BudgetCallOptions
// contains filtered or unexported fields
}
BudgetClient is a client for interacting with Cloud Billing Budget API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
func NewBudgetClient
func
NewBudgetClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
BudgetClient
,
error
)
NewBudgetClient creates a new budget service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
Example
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewBudgetRESTClient
func
NewBudgetRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
BudgetClient
,
error
)
NewBudgetRESTClient creates a new budget service rest client.
BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.
Example
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*BudgetClient) Close
func
(
c
*
BudgetClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*BudgetClient) Connection (deprecated)
func
(
c
*
BudgetClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*BudgetClient) CreateBudget
func
(
c
*
BudgetClient
)
CreateBudget
(
ctx
context
.
Context
,
req
*
budgetspb
.
CreateBudgetRequest
,
opts
...
gax
.
CallOption
)
(
*
budgetspb
.
Budget
,
error
)
CreateBudget creates a new budget. See Quotas and limits (at https://cloud.google.com/billing/quotas ) for more information on the limits of the number of budgets you can create.
Example
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
budgetspb
"cloud.google.com/go/billing/budgets/apiv1/budgetspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& budgetspb
.
CreateBudgetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#CreateBudgetRequest.
}
resp
,
err
:=
c
.
CreateBudget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*BudgetClient) DeleteBudget
func
(
c
*
BudgetClient
)
DeleteBudget
(
ctx
context
.
Context
,
req
*
budgetspb
.
DeleteBudgetRequest
,
opts
...
gax
.
CallOption
)
error
DeleteBudget deletes a budget. Returns successfully if already deleted.
Example
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
budgetspb
"cloud.google.com/go/billing/budgets/apiv1/budgetspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& budgetspb
.
DeleteBudgetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#DeleteBudgetRequest.
}
err
=
c
.
DeleteBudget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*BudgetClient) GetBudget
func
(
c
*
BudgetClient
)
GetBudget
(
ctx
context
.
Context
,
req
*
budgetspb
.
GetBudgetRequest
,
opts
...
gax
.
CallOption
)
(
*
budgetspb
.
Budget
,
error
)
GetBudget returns a budget.
WARNING: There are some fields exposed on the Google Cloud Console that aren’t available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.
Example
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
budgetspb
"cloud.google.com/go/billing/budgets/apiv1/budgetspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& budgetspb
.
GetBudgetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#GetBudgetRequest.
}
resp
,
err
:=
c
.
GetBudget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*BudgetClient) ListBudgets
func
(
c
*
BudgetClient
)
ListBudgets
(
ctx
context
.
Context
,
req
*
budgetspb
.
ListBudgetsRequest
,
opts
...
gax
.
CallOption
)
*
BudgetIterator
ListBudgets returns a list of budgets for a billing account.
WARNING: There are some fields exposed on the Google Cloud Console that aren’t available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.
Examples
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
budgetspb
"cloud.google.com/go/billing/budgets/apiv1/budgetspb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& budgetspb
.
ListBudgetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#ListBudgetsRequest.
}
it
:=
c
.
ListBudgets
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
budgetspb
.
ListBudgetsResponse
)
}
}
all
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
budgetspb
"cloud.google.com/go/billing/budgets/apiv1/budgetspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& budgetspb
.
ListBudgetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#ListBudgetsRequest.
}
for
resp
,
err
:=
range
c
.
ListBudgets
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*BudgetClient) UpdateBudget
func
(
c
*
BudgetClient
)
UpdateBudget
(
ctx
context
.
Context
,
req
*
budgetspb
.
UpdateBudgetRequest
,
opts
...
gax
.
CallOption
)
(
*
budgetspb
.
Budget
,
error
)
UpdateBudget updates a budget and returns the updated budget.
WARNING: There are some fields exposed on the Google Cloud Console that aren’t available on this API. Budget fields that are not exposed in this API will not be changed by this method.
Example
package
main
import
(
"context"
budgets
"cloud.google.com/go/billing/budgets/apiv1"
budgetspb
"cloud.google.com/go/billing/budgets/apiv1/budgetspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
budgets
.
NewBudgetClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& budgetspb
.
UpdateBudgetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/budgets/apiv1/budgetspb#UpdateBudgetRequest.
}
resp
,
err
:=
c
.
UpdateBudget
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
BudgetIterator
type
BudgetIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
budgetspb
.
Budget
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
BudgetIterator manages a stream of *budgetspb.Budget.
func (*BudgetIterator) All
func
(
it
*
BudgetIterator
)
All
()
iter
.
Seq2
[
*
budgetspb
.
Budget
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BudgetIterator) Next
func
(
it
*
BudgetIterator
)
Next
()
(
*
budgetspb
.
Budget
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*BudgetIterator) PageInfo
func
(
it
*
BudgetIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
