bigqueryreservation

package
v0.14.0 Latest Latest
Warning

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

Go to latest
Published: Nov 15, 2019 License: BSD-3-Clause Imports: 14 Imported by: 0

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/v1beta1"
...
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 Assignment

type Assignment struct {
	// Assignee: The resource which will use the reservation.
	// E.g.
	// projects/myproject, folders/123, organizations/456.
	Assignee string `json:"assignee,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/US/reservations/team1-prod/assignme
	// nts/123.
	Name string `json:"name,omitempty"`

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

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

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

func (*Assignment) MarshalJSON

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

type BiReservation added in v0.14.0

type BiReservation struct {
	// Name: The resource name of the singleton BI reservation.
	// Reservation names have the
	// form
	// `projects/{project_id}/locations/{location_id}/bireservation`.
	Name string `json:"name,omitempty"`

	// Size: Size of a reservation, in bytes.
	Size int64 `json:"size,omitempty,string"`

	// UpdateTime: Output only. The last update timestamp of a reservation.
	UpdateTime string `json:"updateTime,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:"-"`
}

BiReservation: Represents a BI Reservation.

func (*BiReservation) MarshalJSON added in v0.14.0

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

type CapacityCommitment

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

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

	// Name: Output only. The resource name of the capacity commitment,
	// e.g.,
	//    projects/myproject/locations/US/capacityCommitments/123
	Name string `json:"name,omitempty"`

	// Plan: Capacity commitment 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`.
	//   "MONTHLY" - Capacity commitment cannot be removed for 30 days after
	// becoming ACTIVE.
	//   "ANNUAL" - Capacity commitment 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 commitment.
	SlotCount int64 `json:"slotCount,omitempty,string"`

	// State: Output only. State of the commitment.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Invalid state value.
	//   "PENDING" - Capacity commitment is pending provisioning. Pending
	// capacity commitment
	// does not contribute to the parent's slot_capacity.
	//   "ACTIVE" - Once slots are provisioned, capacity commitment becomes
	// active.
	// slot_count is added to the parent's slot_capacity.
	//   "FAILED" - Capacity commitment 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:"-"`
}

CapacityCommitment: Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some minimum committed period of usage. Capacity commitment 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 capacity commitment resource exists as a child resource of the admin project.

func (*CapacityCommitment) MarshalJSON

func (s *CapacityCommitment) 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 ListAssignmentsResponse

type ListAssignmentsResponse struct {
	// Assignments: List of assignments visible to the user.
	Assignments []*Assignment `json:"assignments,omitempty"`

	// 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"`

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

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

ListAssignmentsResponse: The response for ReservationService.ListAssignments.

func (*ListAssignmentsResponse) MarshalJSON

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

type ListCapacityCommitmentsResponse

type ListCapacityCommitmentsResponse struct {
	// CapacityCommitments: List of capacity commitments visible to the
	// user.
	CapacityCommitments []*CapacityCommitment `json:"capacityCommitments,omitempty"`

	// 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"`

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

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

ListCapacityCommitmentsResponse: The response for ReservationService.ListCapacityCommitments.

func (*ListCapacityCommitmentsResponse) MarshalJSON

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

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in
	// the request.
	Locations []*Location `json:"locations,omitempty"`

	// NextPageToken: The standard List next-page token.
	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. "Locations") 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. "Locations") 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:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (*ListLocationsResponse) MarshalJSON

func (s *ListLocationsResponse) 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 Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby
	// city name.
	// For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`

	// Labels: Cross-service attributes for the location. For example
	//
	//     {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`

	// LocationId: The canonical id for this location. For example:
	// "us-east1".
	LocationId string `json:"locationId,omitempty"`

	// Metadata: Service-specific metadata. For example the available
	// capacity at the given
	// location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: Resource name for the location, which may vary between
	// implementations.
	// For example: "projects/example-project/locations/us-east1"
	Name string `json:"name,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:"-"`

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

Location: A resource that represents Google Cloud Platform location.

func (*Location) MarshalJSON

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

type LocationMetadata

type LocationMetadata struct {
	// LegacyLocationId: The legacy BigQuery location ID, e.g. “EU” for
	// the “europe” location.
	// This is for any API consumers that need the legacy “US” and
	// “EU” locations.
	LegacyLocationId string `json:"legacyLocationId,omitempty"`

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

LocationMetadata: BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.

func (*LocationMetadata) MarshalJSON

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

type MoveAssignmentRequest added in v0.14.0

type MoveAssignmentRequest struct {
	// DestinationId: The new reservation ID, e.g.:
	//   projects/myotherproject/locations/US/reservations/team2-prod
	DestinationId string `json:"destinationId,omitempty"`

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

MoveAssignmentRequest: The request for ReservationService.MoveAssignment. Note: "bigquery.reservationAssignments.create" permission is required on the destination_id. Note: "bigquery.reservationAssignments.create" and "bigquery.reservationAssignments.delete" permission is required on the related assignee.

func (*MoveAssignmentRequest) MarshalJSON added in v0.14.0

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

type ProjectsLocationsCapacityCommitmentsCreateCall added in v0.14.0

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

func (*ProjectsLocationsCapacityCommitmentsCreateCall) Context added in v0.14.0

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 (*ProjectsLocationsCapacityCommitmentsCreateCall) Do added in v0.14.0

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

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

func (*ProjectsLocationsCapacityCommitmentsCreateCall) Header added in v0.14.0

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

type ProjectsLocationsCapacityCommitmentsDeleteCall

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

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

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.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 (*ProjectsLocationsCapacityCommitmentsDeleteCall) Fields

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

func (*ProjectsLocationsCapacityCommitmentsDeleteCall) Header

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

type ProjectsLocationsCapacityCommitmentsGetCall

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

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

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

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

func (*ProjectsLocationsCapacityCommitmentsGetCall) Header

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

func (*ProjectsLocationsCapacityCommitmentsGetCall) 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 ProjectsLocationsCapacityCommitmentsListCall

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

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

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

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

func (*ProjectsLocationsCapacityCommitmentsListCall) Header

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

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

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

func (*ProjectsLocationsCapacityCommitmentsListCall) PageToken

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

func (*ProjectsLocationsCapacityCommitmentsListCall) 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 ProjectsLocationsCapacityCommitmentsService

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

func NewProjectsLocationsCapacityCommitmentsService

func NewProjectsLocationsCapacityCommitmentsService(s *Service) *ProjectsLocationsCapacityCommitmentsService

func (*ProjectsLocationsCapacityCommitmentsService) Create added in v0.14.0

Create: Creates a new capacity commitment resource.

func (*ProjectsLocationsCapacityCommitmentsService) Delete

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

func (*ProjectsLocationsCapacityCommitmentsService) Get

Get: Returns information about the capacity commitment.

func (*ProjectsLocationsCapacityCommitmentsService) List

List: Lists all the capacity commitments for the admin project.

type ProjectsLocationsGetBiReservationCall added in v0.14.0

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

func (*ProjectsLocationsGetBiReservationCall) Context added in v0.14.0

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 (*ProjectsLocationsGetBiReservationCall) Do added in v0.14.0

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

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

func (*ProjectsLocationsGetBiReservationCall) Header added in v0.14.0

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

func (*ProjectsLocationsGetBiReservationCall) IfNoneMatch added in v0.14.0

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 ProjectsLocationsGetCall

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

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

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

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

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

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

func (*ProjectsLocationsGetCall) IfNoneMatch

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

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 ProjectsLocationsListCall

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

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

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

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

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsListCall) Header

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

func (*ProjectsLocationsListCall) IfNoneMatch

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

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

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsListCall) 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 ProjectsLocationsReservationsAssignmentsCreateCall

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

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

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

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

func (*ProjectsLocationsReservationsAssignmentsCreateCall) Header

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

type ProjectsLocationsReservationsAssignmentsDeleteCall

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

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

Do executes the "bigqueryreservation.projects.locations.reservations.assignments.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 (*ProjectsLocationsReservationsAssignmentsDeleteCall) Fields

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

func (*ProjectsLocationsReservationsAssignmentsDeleteCall) Header

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

type ProjectsLocationsReservationsAssignmentsListCall

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

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

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

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

func (*ProjectsLocationsReservationsAssignmentsListCall) Header

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

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

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

func (*ProjectsLocationsReservationsAssignmentsListCall) PageToken

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

func (*ProjectsLocationsReservationsAssignmentsListCall) 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 ProjectsLocationsReservationsAssignmentsMoveCall

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

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

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

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

func (*ProjectsLocationsReservationsAssignmentsMoveCall) Header

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

type ProjectsLocationsReservationsAssignmentsService

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

func NewProjectsLocationsReservationsAssignmentsService

func NewProjectsLocationsReservationsAssignmentsService(s *Service) *ProjectsLocationsReservationsAssignmentsService

func (*ProjectsLocationsReservationsAssignmentsService) 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 assignment does not match location of the reservation.

func (*ProjectsLocationsReservationsAssignmentsService) Delete

Delete: Deletes a assignment. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly:

<organizationA, res1>
<project1, res1>

Then deletion of <organizationA, res1> won't affect <project1, res1>. After deletion of <organizationA, res1>, queries from project1 will still use res1, while queries from project2 will use on-demand mode.

func (*ProjectsLocationsReservationsAssignmentsService) List

List: Lists assignments. Only explicitly created assignments will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly:

<organizationA, res1>
<project1, res1>

Then this API will just return the above two assignments for reservation res1, and no expansion/merge will happen. Wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. Note "-" cannot be used for projects nor locations.

func (*ProjectsLocationsReservationsAssignmentsService) Move

Move: Moves a assignment under a new reservation. Customers can do this by deleting the existing assignment followed by creating another assignment under the new reservation, but this method provides a transactional way to do so, to make sure the assignee always has an associated reservation. Without the method customers might see some queries run on-demand which might be unexpected.

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. This field must only contain lower case alphanumeric characters or dash.

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) 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 {
	Assignments *ProjectsLocationsReservationsAssignmentsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsReservationsService

func NewProjectsLocationsReservationsService(s *Service) *ProjectsLocationsReservationsService

func (*ProjectsLocationsReservationsService) Create

Create: Creates a new reservation resource.

func (*ProjectsLocationsReservationsService) Delete

Delete: Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.

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.

type ProjectsLocationsSearchAssignmentsCall

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

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

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

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

func (*ProjectsLocationsSearchAssignmentsCall) Header

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

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

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

func (*ProjectsLocationsSearchAssignmentsCall) PageToken

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

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

Query sets the optional parameter "query": Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject"

"assignee=folders/123"
"assignee=organizations/456"

type ProjectsLocationsService

type ProjectsLocationsService struct {
	CapacityCommitments *ProjectsLocationsCapacityCommitmentsService

	Reservations *ProjectsLocationsReservationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

func (*ProjectsLocationsService) GetBiReservation added in v0.14.0

GetBiReservation: Retrieves a BI reservation.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

func (*ProjectsLocationsService) SearchAssignments

SearchAssignments: Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they

exist.

  1. Otherwise assignments created on the closest ancestor will be returned. 3) Assignments 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 assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this

API.

  1. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.

Note "-" cannot be used for projects nor locations.

func (*ProjectsLocationsService) UpdateBiReservation added in v0.14.0

func (r *ProjectsLocationsService) UpdateBiReservation(name string, bireservation *BiReservation) *ProjectsLocationsUpdateBiReservationCall

UpdateBiReservation: Updates a BI reservation. Only fields specified in the field_mask are updated. Singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

type ProjectsLocationsUpdateBiReservationCall added in v0.14.0

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

func (*ProjectsLocationsUpdateBiReservationCall) Context added in v0.14.0

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 (*ProjectsLocationsUpdateBiReservationCall) Do added in v0.14.0

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

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

func (*ProjectsLocationsUpdateBiReservationCall) Header added in v0.14.0

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

func (*ProjectsLocationsUpdateBiReservationCall) UpdateMask added in v0.14.0

UpdateMask sets the optional parameter "updateMask": A list of fields to be updated in this request.

type ProjectsService

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

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Reservation

type Reservation struct {
	// IgnoreIdleSlots: If false, any query using this reservation will use
	// idle slots from other
	// reservations within the same admin project. If true, a query using
	// this
	// reservation will execute with the maximum slot capacity as specified
	// above.
	IgnoreIdleSlots bool `json:"ignoreIdleSlots,omitempty"`

	// Name: The resource name of the reservation,
	// e.g.,
	// "projects/*/locations/*/reservations/team1-prod".
	Name string `json:"name,omitempty"`

	// SlotCapacity: Maximum slots available to this reservation. 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"`

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

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

type SearchAssignmentsResponse struct {
	// Assignments: List of assignments visible to the user.
	Assignments []*Assignment `json:"assignments,omitempty"`

	// 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"`

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

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

SearchAssignmentsResponse: The response for ReservationService.SearchAssignments.

func (*SearchAssignmentsResponse) MarshalJSON

func (s *SearchAssignmentsResponse) 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 deprecated

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 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)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL