Documentation

Overview

Package bigqueryreservation provides access to the BigQuery Reservation API.

For product documentation, see: https://cloud.google.com/bigquery/

Creating a client

Usage example:

import "google.golang.org/api/bigqueryreservation/v1alpha2"
...
ctx := context.Background()
bigqueryreservationService, err := bigqueryreservation.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://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, use option.WithScopes:

bigqueryreservationService, err := bigqueryreservation.NewService(ctx, option.WithScopes(bigqueryreservation.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

bigqueryreservationService, err := bigqueryreservation.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your data in Google BigQuery
	BigqueryScope = "https://www.googleapis.com/auth/bigquery"

	// 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 CreateSlotPoolMetadata

type CreateSlotPoolMetadata struct {
	// SlotPool: Resource name of the slot pool that is being created. E.g.,
	// projects/myproject/locations/us-central1/reservations/foo/slotPools/12
	// 3
	SlotPool string `json:"slotPool,omitempty"`

	// ForceSendFields is a list of field names (e.g. "SlotPool") 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:"-"`

	// NullFields is a list of field names (e.g. "SlotPool") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateSlotPoolMetadata: The metadata for operation returned from ReservationService.CreateSlotPool.

func (*CreateSlotPoolMetadata) MarshalJSON

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

type Empty

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

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

type ListReservationGrantsResponse

type ListReservationGrantsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ReservationGrants: List of reservation grants visible to the user.
	ReservationGrants []*ReservationGrant `json:"reservationGrants,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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListReservationGrantsResponse: The response for ReservationService.ListReservationGrants.

func (*ListReservationGrantsResponse) MarshalJSON

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

type ListReservationsResponse

type ListReservationsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Reservations: List of reservations visible to the user.
	Reservations []*Reservation `json:"reservations,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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListReservationsResponse: The response for ReservationService.ListReservations.

func (*ListReservationsResponse) MarshalJSON

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

type ListSlotPoolsResponse

type ListSlotPoolsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// SlotPools: List of slot pools visible to the user.
	SlotPools []*SlotPool `json:"slotPools,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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListSlotPoolsResponse: The response for ReservationService.ListSlotPools.

func (*ListSlotPoolsResponse) MarshalJSON

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

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress. If `true`, the operation is completed, and either `error`
	// or `response` is available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as
	// create time. Some services might not provide such metadata. Any
	// method that returns a long-running operation should document the
	// metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that originally returns it. If you use the default HTTP
	// mapping, the `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. If
	// the original method returns no data on success, such as `Delete`, the
	// response is `google.protobuf.Empty`. If the original method is
	// standard `Get`/`Create`/`Update`, the response should be the
	// resource. For other methods, the response should have the type
	// `XxxResponse`, where `Xxx` is the original method name. For example,
	// if the original method name is `TakeSnapshot()`, the inferred
	// response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Done") 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:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (*Operation) MarshalJSON

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

type ProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsOperationsCancelCall) Context

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 (*ProjectsLocationsOperationsCancelCall) Do

Do executes the "bigqueryreservation.projects.locations.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsOperationsCancelCall) Fields

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

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsOperationsGetCall) Context

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 (*ProjectsLocationsOperationsGetCall) Do

Do executes the "bigqueryreservation.projects.locations.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsOperationsGetCall) Fields

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

func (*ProjectsLocationsOperationsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

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 ProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields

}

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

func (*ProjectsLocationsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

type ProjectsLocationsReservationGrantsCreateCall

type ProjectsLocationsReservationGrantsCreateCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationGrantsCreateCall) Context

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 (*ProjectsLocationsReservationGrantsCreateCall) Do

Do executes the "bigqueryreservation.projects.locations.reservationGrants.create" call. Exactly one of *ReservationGrant or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReservationGrant.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 (*ProjectsLocationsReservationGrantsCreateCall) Fields

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

func (*ProjectsLocationsReservationGrantsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsReservationGrantsDeleteCall

type ProjectsLocationsReservationGrantsDeleteCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationGrantsDeleteCall) Context

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 (*ProjectsLocationsReservationGrantsDeleteCall) Do

Do executes the "bigqueryreservation.projects.locations.reservationGrants.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsReservationGrantsDeleteCall) Fields

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

func (*ProjectsLocationsReservationGrantsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsReservationGrantsListCall

type ProjectsLocationsReservationGrantsListCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationGrantsListCall) Context

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 (*ProjectsLocationsReservationGrantsListCall) Do

Do executes the "bigqueryreservation.projects.locations.reservationGrants.list" call. Exactly one of *ListReservationGrantsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListReservationGrantsResponse.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 (*ProjectsLocationsReservationGrantsListCall) Fields

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

func (*ProjectsLocationsReservationGrantsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationGrantsListCall) IfNoneMatch

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 (*ProjectsLocationsReservationGrantsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsReservationGrantsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsReservationGrantsListCall) 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.

type ProjectsLocationsReservationGrantsService

type ProjectsLocationsReservationGrantsService struct {
	// contains filtered or unexported fields

}

func NewProjectsLocationsReservationGrantsService

func NewProjectsLocationsReservationGrantsService(s *Service) *ProjectsLocationsReservationGrantsService

func (*ProjectsLocationsReservationGrantsService) Create

Create: Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the grant does not match location of the reservation.

func (*ProjectsLocationsReservationGrantsService) Delete

Delete: Deletes a reservation grant. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateReservationGrant was invoked previously and following grants were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.

func (*ProjectsLocationsReservationGrantsService) List

List: Lists reservation grants. Only explicitly created grants will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateReservationGrant was invoked previously and following grants were created explicitly: Then this API will just return the above two grants for reservation res1, and no expansion/merge will happen.

type ProjectsLocationsReservationsCreateCall

type ProjectsLocationsReservationsCreateCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsCreateCall) Context

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 (*ProjectsLocationsReservationsCreateCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.create" call. Exactly one of *Reservation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Reservation.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 (*ProjectsLocationsReservationsCreateCall) Fields

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

func (*ProjectsLocationsReservationsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsCreateCall) ReservationId

ReservationId sets the optional parameter "reservationId": The reservation ID relative to the parent, e.g., "dev". This field must only contain alphanumeric characters.

type ProjectsLocationsReservationsCreateReservationCall

type ProjectsLocationsReservationsCreateReservationCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsCreateReservationCall) Context

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 (*ProjectsLocationsReservationsCreateReservationCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.createReservation" call. Exactly one of *Reservation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Reservation.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 (*ProjectsLocationsReservationsCreateReservationCall) Fields

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

func (*ProjectsLocationsReservationsCreateReservationCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsCreateReservationCall) ReservationId

ReservationId sets the optional parameter "reservationId": The reservation ID relative to the parent, e.g., "dev". This field must only contain alphanumeric characters.

type ProjectsLocationsReservationsDeleteCall

type ProjectsLocationsReservationsDeleteCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsDeleteCall) Context

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 (*ProjectsLocationsReservationsDeleteCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsReservationsDeleteCall) Fields

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

func (*ProjectsLocationsReservationsDeleteCall) Force

Force sets the optional parameter "force": If true, deletes all the child reservations of the given reservation. Otherwise, attempting to delete a reservation that has child reservations will fail with error code `google.rpc.Code.FAILED_PRECONDITION`.

func (*ProjectsLocationsReservationsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsReservationsGetCall

type ProjectsLocationsReservationsGetCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsGetCall) Context

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 (*ProjectsLocationsReservationsGetCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.get" call. Exactly one of *Reservation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Reservation.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 (*ProjectsLocationsReservationsGetCall) Fields

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

func (*ProjectsLocationsReservationsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsGetCall) IfNoneMatch

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 ProjectsLocationsReservationsListCall

type ProjectsLocationsReservationsListCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsListCall) Context

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 (*ProjectsLocationsReservationsListCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.list" call. Exactly one of *ListReservationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListReservationsResponse.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 (*ProjectsLocationsReservationsListCall) Fields

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

func (*ProjectsLocationsReservationsListCall) Filter

Filter sets the optional parameter "filter": Can be used to filter out reservations based on names, capacity, etc, e.g.: filter="reservation.slot_capacity > 200" filter="reservation.name = \"*dev/*\"" Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/view/advanced-filters).

func (*ProjectsLocationsReservationsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsListCall) IfNoneMatch

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 (*ProjectsLocationsReservationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsReservationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsReservationsListCall) 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.

type ProjectsLocationsReservationsPatchCall

type ProjectsLocationsReservationsPatchCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsPatchCall) Context

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 (*ProjectsLocationsReservationsPatchCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.patch" call. Exactly one of *Reservation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Reservation.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 (*ProjectsLocationsReservationsPatchCall) Fields

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

func (*ProjectsLocationsReservationsPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Standard field mask for the set of fields to be updated.

type ProjectsLocationsReservationsService

type ProjectsLocationsReservationsService struct {
	SlotPools *ProjectsLocationsReservationsSlotPoolsService // contains filtered or unexported fields

}

func NewProjectsLocationsReservationsService

func NewProjectsLocationsReservationsService(s *Service) *ProjectsLocationsReservationsService

func (*ProjectsLocationsReservationsService) Create

Create: Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.

func (*ProjectsLocationsReservationsService) CreateReservation

CreateReservation: Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.

func (*ProjectsLocationsReservationsService) Delete

Delete: Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` in the following cases: 1. When reservation has child reservations. This check can be bypassed by setting DeleteReservationRequest.force flag to true. 2. When top-level reservation with slot pools is being deleted.

func (*ProjectsLocationsReservationsService) Get

Get: Returns information about the reservation.

func (*ProjectsLocationsReservationsService) List

List: Lists all the reservations for the project in the specified location.

func (*ProjectsLocationsReservationsService) Patch

Patch: Updates an existing reservation resource. Applicable only for child reservations.

type ProjectsLocationsReservationsSlotPoolsDeleteCall

type ProjectsLocationsReservationsSlotPoolsDeleteCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsSlotPoolsDeleteCall) Context

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 (*ProjectsLocationsReservationsSlotPoolsDeleteCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.slotPools.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsReservationsSlotPoolsDeleteCall) Fields

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

func (*ProjectsLocationsReservationsSlotPoolsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsReservationsSlotPoolsGetCall

type ProjectsLocationsReservationsSlotPoolsGetCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsSlotPoolsGetCall) Context

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 (*ProjectsLocationsReservationsSlotPoolsGetCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.slotPools.get" call. Exactly one of *SlotPool or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SlotPool.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 (*ProjectsLocationsReservationsSlotPoolsGetCall) Fields

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

func (*ProjectsLocationsReservationsSlotPoolsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsSlotPoolsGetCall) IfNoneMatch

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 ProjectsLocationsReservationsSlotPoolsListCall

type ProjectsLocationsReservationsSlotPoolsListCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsReservationsSlotPoolsListCall) Context

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 (*ProjectsLocationsReservationsSlotPoolsListCall) Do

Do executes the "bigqueryreservation.projects.locations.reservations.slotPools.list" call. Exactly one of *ListSlotPoolsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSlotPoolsResponse.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 (*ProjectsLocationsReservationsSlotPoolsListCall) Fields

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

func (*ProjectsLocationsReservationsSlotPoolsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsReservationsSlotPoolsListCall) IfNoneMatch

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 (*ProjectsLocationsReservationsSlotPoolsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsReservationsSlotPoolsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsReservationsSlotPoolsListCall) 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.

type ProjectsLocationsReservationsSlotPoolsService

type ProjectsLocationsReservationsSlotPoolsService struct {
	// contains filtered or unexported fields

}

func NewProjectsLocationsReservationsSlotPoolsService

func NewProjectsLocationsReservationsSlotPoolsService(s *Service) *ProjectsLocationsReservationsSlotPoolsService

func (*ProjectsLocationsReservationsSlotPoolsService) Delete

Delete: Deletes a slot pool. Attempting to delete slot pool before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.

func (*ProjectsLocationsReservationsSlotPoolsService) Get

Get: Returns information about the slot pool.

func (*ProjectsLocationsReservationsSlotPoolsService) List

List: Lists all the slot pools for the reservation.

type ProjectsLocationsSearchReservationGrantsCall

type ProjectsLocationsSearchReservationGrantsCall struct {

	// contains filtered or unexported fields

}

func (*ProjectsLocationsSearchReservationGrantsCall) Context

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 (*ProjectsLocationsSearchReservationGrantsCall) Do

Do executes the "bigqueryreservation.projects.locations.searchReservationGrants" call. Exactly one of *SearchReservationGrantsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchReservationGrantsResponse.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 (*ProjectsLocationsSearchReservationGrantsCall) Fields

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

func (*ProjectsLocationsSearchReservationGrantsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsSearchReservationGrantsCall) IfNoneMatch

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 (*ProjectsLocationsSearchReservationGrantsCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsSearchReservationGrantsCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsSearchReservationGrantsCall) 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 (*ProjectsLocationsSearchReservationGrantsCall) Query

Query sets the optional parameter "query": Please specify resource name as grantee in the query. e.g., "grantee=projects/myproject" "grantee=folders/123" "grantee=organizations/456"

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Operations *ProjectsLocationsOperationsService

	ReservationGrants *ProjectsLocationsReservationGrantsService

	Reservations *ProjectsLocationsReservationsService // contains filtered or unexported fields

}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) SearchReservationGrants

SearchReservationGrants: Look up grants for a specified resource for a particular region. If the request is about a project: 1) Grants created on the project will be returned if they exist. 2) Otherwise grants created on the closest ancestor will be returned. 3) Grants for different JobTypes will all be returned. Same logic applies if the request is about a folder. If the request is about an organization, then grants created on the organization will be returned (organization doesn't have ancestors). Comparing to ListReservationGrants, there are two behavior differences: 1) permission on the grantee will be verified in this API. 2) Hierarchy lookup (project->folder->organization) happens in this API.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService // contains filtered or unexported fields

}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Reservation

type Reservation struct {
	// Name: The resource name of the reservation, e.g.,
	// "projects/*/locations/*/reservations/dev/team/product". Reservation
	// names (e.g., "dev/team/product") exceeding a depth of six will fail
	// with `google.rpc.Code.INVALID_ARGUMENT`.
	Name string `json:"name,omitempty"`

	// SlotCapacity: Maximum slots available to this reservation and its
	// children. A slot is a unit of computational power in BigQuery, and
	// serves as the unit of parallelism. In a scan of a multi-partitioned
	// table, a single slot operates on a single partition of the table. If
	// the new reservation's slot capacity exceed the parent's slot capacity
	// or if total slot capacity of the new reservation and its siblings
	// exceeds the parent's slot capacity, the request will fail with
	// `google.rpc.Code.RESOURCE_EXHAUSTED`.
	SlotCapacity int64 `json:"slotCapacity,omitempty,string"`

	// UseParentReservation: If true, any query using this reservation will
	// also be submitted to the parent reservation. This allows the query to
	// share the additional slot capacity of the parent with other queries
	// in the parent reservation. If the parent also has this field set to
	// true, then this process will continue until it encounters a
	// reservation for which this is false. If false, a query using this
	// reservation will execute with the maximum slot capacity as specified
	// above. If not specified, default value is true. Ignored for top-level
	// reservation.
	UseParentReservation bool `json:"useParentReservation,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Name") 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:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Reservation: A reservation is a mechanism used to guarantee slots to users.

func (*Reservation) MarshalJSON

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

type ReservationGrant

type ReservationGrant struct {
	// Grantee: The resource which will use the reservation. E.g.
	// projects/myproject, folders/123, organizations/456.
	Grantee string `json:"grantee,omitempty"`

	// JobType: Which type of jobs will use the reservation.
	//
	// Possible values:
	//   "JOB_TYPE_UNSPECIFIED" - Invalid type. Requests with this value
	// will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
	//   "PIPELINE" - Pipeline (load/export) jobs from the project will use
	// the reservation.
	//   "QUERY" - Query jobs from the project will use the reservation.
	JobType string `json:"jobType,omitempty"`

	// Name: Output only. Name of the resource. E.g.:
	// projects/myproject/locations/eu/reservationGrants/123.
	Name string `json:"name,omitempty"`

	// Reservation: Resource name of the reservation. E.g.,
	// projects/myproject/locations/eu/reservations/my_reservation. This
	// reservation must be in the same location as the grant. This
	// reservation should belong to the same parent project.
	Reservation string `json:"reservation,omitempty"`

	// State: Output only. State of the ReservationGrant.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Invalid state value.
	//   "PENDING" - Queries from grantee will be executed as on-demand, if
	// related ReservationGrant is pending.
	//   "ACTIVE" - ReservationGrant is ready.
	State string `json:"state,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Grantee") 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:"-"`

	// NullFields is a list of field names (e.g. "Grantee") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReservationGrant: A ReservationGrant allows a project to submit jobs of a certain type using slots from the specified reservation.

func (*ReservationGrant) MarshalJSON

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

type SearchReservationGrantsResponse

type SearchReservationGrantsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ReservationGrants: List of reservation grants visible to the user.
	ReservationGrants []*ReservationGrant `json:"reservationGrants,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:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SearchReservationGrantsResponse: The response for ReservationService.SearchReservationGrants.

func (*SearchReservationGrantsResponse) MarshalJSON

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

type Service

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

	Projects *ProjectsService // contains filtered or unexported fields

}

func New

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.

func NewService

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

NewService creates a new Service.

type SlotPool

type SlotPool struct {
	// CommitmentEndTime: Output only. The end of the commitment period.
	// Slot pool cannot be removed before commitment_end_time. It is
	// applicable only for ACTIVE slot pools and is computed as a
	// combination of the plan and the time when the slot pool became
	// ACTIVE.
	CommitmentEndTime string `json:"commitmentEndTime,omitempty"`

	// FailureStatus: Output only. For FAILED slot pool, provides the reason
	// of failure.
	FailureStatus *Status `json:"failureStatus,omitempty"`

	// Name: Output only. The resource name of the slot pool, e.g.,
	// projects/myproject/locations/us-central1/reservations/myreservation/sl
	// otPools/123
	Name string `json:"name,omitempty"`

	// Plan: Slot pool commitment plan.
	//
	// Possible values:
	//   "COMMITMENT_PLAN_UNSPECIFIED" - Invalid plan value. Requests with
	// this value will be rejected with error code
	// `google.rpc.Code.INVALID_ARGUMENT`.
	//   "FLEX" - Slot pool can be removed at any point, even after becoming
	// ACTIVE.
	//   "TRIAL" - Trial commitments have a committed period of 182 days
	// after becoming ACTIVE. After that, they are converted to a new
	// commitment based on the renewal_plan. Default renewal_plan for Trial
	// commitment is Flex so that it can be deleted right after committed
	// period ends.
	//   "MONTHLY" - Slot pool cannot be removed for 30 days after becoming
	// ACTIVE.
	//   "ANNUAL" - Slot pool cannot be removed for 365 days after becoming
	// ACTIVE. Note: annual commitments are automatically downgraded to
	// monthly after 365 days.
	Plan string `json:"plan,omitempty"`

	// SlotCount: Number of slots in this pool.
	SlotCount int64 `json:"slotCount,omitempty,string"`

	// State: Output only.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Invalid state value.
	//   "PENDING" - Slot pool is pending provisioning. Pending slot pool
	// does not contribute to the parent's slot_capacity.
	//   "ACTIVE" - Once slots are provisioned, slot pool becomes active.
	// slot_count is added to the parent's slot_capacity.
	//   "FAILED" - Slot pool is failed to be activated by the backend.
	State string `json:"state,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "CommitmentEndTime")
	// 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:"-"`

	// NullFields is a list of field names (e.g. "CommitmentEndTime") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SlotPool: Slot pool is a way to purchase slots with some minimum committed period of usage. Slot pool is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time. Annual commitments will automatically be downgraded to monthly after the commitment ends. A slot pool resource exists as a child resource of a top-level reservation. Sum of all the ACTIVE pools slot_count is always equal to the reservation slot_capacity.

func (*SlotPool) MarshalJSON

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

type Status

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") 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:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

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