cloudbilling

package
v2.3.0-rc.2+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 28, 2016 License: BSD-3-Clause, Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package cloudbilling provides access to the Google Cloud Billing API.

See https://cloud.google.com/billing/

Usage example: 

import "google.golang.org/api/cloudbilling/v1"
...
cloudbillingService, err := cloudbilling.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	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

type BillingAccount 

type BillingAccount struct {
	// DisplayName: The display name given to the billing account, such as
	// `My Billing Account`. This name is displayed in the Google Developers
	// Console.
	DisplayName string `json:"displayName,omitempty"`

	// Name: 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 account `012345-567890-ABCDEF`.
	Name string `json:"name,omitempty"`

	// Open: 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.
	Open bool `json:"open,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

BillingAccount: A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.

func (*BillingAccount) MarshalJSON 

func (s *BillingAccount) MarshalJSON() ([]byte, error)

type BillingAccountsGetCall 

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

func (*BillingAccountsGetCall) Context 

func (c *BillingAccountsGetCall) Context(ctx context.Context) *BillingAccountsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BillingAccountsGetCall) Do 

func (c *BillingAccountsGetCall) Do() (*BillingAccount, error)

Do executes the "cloudbilling.billingAccounts.get" call. Exactly one of *BillingAccount or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BillingAccount.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsGetCall) Fields 

func (c *BillingAccountsGetCall) Fields(s ...googleapi.Field) *BillingAccountsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BillingAccountsGetCall) IfNoneMatch 

func (c *BillingAccountsGetCall) IfNoneMatch(entityTag string) *BillingAccountsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type BillingAccountsListCall 

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

func (*BillingAccountsListCall) Context 

func (c *BillingAccountsListCall) Context(ctx context.Context) *BillingAccountsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BillingAccountsListCall) Do 

func (c *BillingAccountsListCall) Do() (*ListBillingAccountsResponse, error)

Do executes the "cloudbilling.billingAccounts.list" call. Exactly one of *ListBillingAccountsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBillingAccountsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsListCall) Fields 

func (c *BillingAccountsListCall) Fields(s ...googleapi.Field) *BillingAccountsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BillingAccountsListCall) IfNoneMatch 

func (c *BillingAccountsListCall) IfNoneMatch(entityTag string) *BillingAccountsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*BillingAccountsListCall) PageSize 

func (c *BillingAccountsListCall) PageSize(pageSize int64) *BillingAccountsListCall

PageSize sets the optional parameter "pageSize": Requested page size. The maximum page size is 100; this is also the default.

func (*BillingAccountsListCall) PageToken 

func (c *BillingAccountsListCall) PageToken(pageToken string) *BillingAccountsListCall

PageToken sets the optional parameter "pageToken": A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.

type BillingAccountsProjectsListCall 

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

func (*BillingAccountsProjectsListCall) Context 

func (c *BillingAccountsProjectsListCall) Context(ctx context.Context) *BillingAccountsProjectsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BillingAccountsProjectsListCall) Do 

func (c *BillingAccountsProjectsListCall) Do() (*ListProjectBillingInfoResponse, error)

Do executes the "cloudbilling.billingAccounts.projects.list" call. Exactly one of *ListProjectBillingInfoResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListProjectBillingInfoResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsProjectsListCall) Fields 

func (c *BillingAccountsProjectsListCall) Fields(s ...googleapi.Field) *BillingAccountsProjectsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BillingAccountsProjectsListCall) IfNoneMatch 

func (c *BillingAccountsProjectsListCall) IfNoneMatch(entityTag string) *BillingAccountsProjectsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*BillingAccountsProjectsListCall) PageSize 

func (c *BillingAccountsProjectsListCall) PageSize(pageSize int64) *BillingAccountsProjectsListCall

PageSize sets the optional parameter "pageSize": Requested page size. The maximum page size is 100; this is also the default.

func (*BillingAccountsProjectsListCall) PageToken 

func (c *BillingAccountsProjectsListCall) PageToken(pageToken string) *BillingAccountsProjectsListCall

PageToken sets the optional parameter "pageToken": A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.

type BillingAccountsProjectsService 

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

func NewBillingAccountsProjectsService 

func NewBillingAccountsProjectsService(s *Service) *BillingAccountsProjectsService

func (*BillingAccountsProjectsService) List 

func (r *BillingAccountsProjectsService) List(name string) *BillingAccountsProjectsListCall

List: Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).

type BillingAccountsService 

type BillingAccountsService struct {
	Projects *BillingAccountsProjectsService
	// contains filtered or unexported fields
}

func NewBillingAccountsService 

func NewBillingAccountsService(s *Service) *BillingAccountsService

func (*BillingAccountsService) Get 

func (r *BillingAccountsService) Get(name string) *BillingAccountsGetCall

Get: Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).

func (*BillingAccountsService) List 

func (r *BillingAccountsService) List() *BillingAccountsListCall

List: Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).

type ListBillingAccountsResponse 

type ListBillingAccountsResponse struct {
	// BillingAccounts: A list of billing accounts.
	BillingAccounts []*BillingAccount `json:"billingAccounts,omitempty"`

	// NextPageToken: A token to retrieve the next page of results. To
	// retrieve the next page, call `ListBillingAccounts` again with the
	// `page_token` field set to this value. This field is empty if there
	// are no more results to retrieve.
	NextPageToken string `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. "BillingAccounts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ListBillingAccountsResponse: Response message for `ListBillingAccounts`.

func (*ListBillingAccountsResponse) MarshalJSON 

func (s *ListBillingAccountsResponse) MarshalJSON() ([]byte, error)

type ListProjectBillingInfoResponse 

type ListProjectBillingInfoResponse struct {
	// NextPageToken: A token to retrieve the next page of results. To
	// retrieve the next page, call `ListProjectBillingInfo` again with the
	// `page_token` field set to this value. This field is empty if there
	// are no more results to retrieve.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ProjectBillingInfo: A list of `ProjectBillingInfo` resources
	// representing the projects associated with the billing account.
	ProjectBillingInfo []*ProjectBillingInfo `json:"projectBillingInfo,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ListProjectBillingInfoResponse: Request message for `ListProjectBillingInfoResponse`.

func (*ListProjectBillingInfoResponse) MarshalJSON 

func (s *ListProjectBillingInfoResponse) MarshalJSON() ([]byte, error)

type ProjectBillingInfo 

type ProjectBillingInfo struct {
	// BillingAccountName: The resource name of the billing account
	// associated with the project, if any. For example,
	// `billingAccounts/012345-567890-ABCDEF`.
	BillingAccountName string `json:"billingAccountName,omitempty"`

	// BillingEnabled: 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.
	BillingEnabled bool `json:"billingEnabled,omitempty"`

	// Name: The resource name for the `ProjectBillingInfo`; has the form
	// `projects/{project_id}/billingInfo`. For example, the resource name
	// for the billing information for project `tokyo-rain-123` would be
	// `projects/tokyo-rain-123/billingInfo`. This field is read-only.
	Name string `json:"name,omitempty"`

	// ProjectId: The ID of the project that this `ProjectBillingInfo`
	// represents, such as `tokyo-rain-123`. This is a convenience field so
	// that you don't need to parse the `name` field to obtain a project ID.
	// This field is read-only.
	ProjectId string `json:"projectId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "BillingAccountName")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ProjectBillingInfo: Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).

func (*ProjectBillingInfo) MarshalJSON 

func (s *ProjectBillingInfo) MarshalJSON() ([]byte, error)

type ProjectsGetBillingInfoCall 

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

func (*ProjectsGetBillingInfoCall) Context 

func (c *ProjectsGetBillingInfoCall) Context(ctx context.Context) *ProjectsGetBillingInfoCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGetBillingInfoCall) Do 

func (c *ProjectsGetBillingInfoCall) Do() (*ProjectBillingInfo, error)

Do executes the "cloudbilling.projects.getBillingInfo" call. Exactly one of *ProjectBillingInfo or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ProjectBillingInfo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGetBillingInfoCall) Fields 

func (c *ProjectsGetBillingInfoCall) Fields(s ...googleapi.Field) *ProjectsGetBillingInfoCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGetBillingInfoCall) IfNoneMatch 

func (c *ProjectsGetBillingInfoCall) IfNoneMatch(entityTag string) *ProjectsGetBillingInfoCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsService 

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

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) GetBillingInfo 

func (r *ProjectsService) GetBillingInfo(name string) *ProjectsGetBillingInfoCall

GetBillingInfo: Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxof vnoo ).

func (*ProjectsService) UpdateBillingInfo 

func (r *ProjectsService) UpdateBillingInfo(name string, projectbillinginfo *ProjectBillingInfo) *ProjectsUpdateBillingInfoCall

UpdateBillingInfo: 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 Developers Console may 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](https://cloud.google.com/docs/permissions-overview#h.bgs0oxo fvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). 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.

type ProjectsUpdateBillingInfoCall 

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

func (*ProjectsUpdateBillingInfoCall) Context 

func (c *ProjectsUpdateBillingInfoCall) Context(ctx context.Context) *ProjectsUpdateBillingInfoCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsUpdateBillingInfoCall) Do 

func (c *ProjectsUpdateBillingInfoCall) Do() (*ProjectBillingInfo, error)

Do executes the "cloudbilling.projects.updateBillingInfo" call. Exactly one of *ProjectBillingInfo or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ProjectBillingInfo.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsUpdateBillingInfoCall) Fields 

func (c *ProjectsUpdateBillingInfoCall) Fields(s ...googleapi.Field) *ProjectsUpdateBillingInfoCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	BillingAccounts *BillingAccountsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.