Movatterモバイル変換


[0]ホーム

URL:


bigqueryreservation

package
v0.257.0Latest Latest
Warning

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

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

Details

Repository

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

Links

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, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, 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)))

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

Index

Constants

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAssignment

type Assignment struct {// Assignee: The resource which will use the reservation. E.g.// `projects/myproject`, `folders/123`, or `organizations/456`.Assigneestring `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.//   "ML_EXTERNAL" - BigQuery ML jobs that use services external to// BigQuery for model training. These jobs will not utilize idle slots// from other reservations.JobTypestring `json:"jobType,omitempty"`// Name: Output only. Name of the resource. E.g.:// `projects/myproject/locations/US/reservations/team1-prod/assignments/1// 23`. The assignment_id must only contain lower case alphanumeric// characters or dashes and the max length is 64 characters.Namestring `json:"name,omitempty"`// State: Output only. State of the assignment.//// Possible values://   "STATE_UNSPECIFIED" - Invalid state value.//   "PENDING" - Queries from assignee will be executed as on-demand, if// related assignment is pending.//   "ACTIVE" - Assignment is ready.Statestring `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. "Assignee") to// unconditionally include in API requests. By default, fields with// empty or default 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: An assignment allows a project to submit jobs of acertain type using slots from the specified reservation.

func (*Assignment)MarshalJSON

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

typeBiReservationadded inv0.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`.Namestring `json:"name,omitempty"`// PreferredTables: Preferred tables to use BI capacity for.PreferredTables []*TableReference `json:"preferredTables,omitempty"`// Size: Size of a reservation, in bytes.Sizeint64 `json:"size,omitempty,string"`// UpdateTime: Output only. The last update timestamp of a reservation.UpdateTimestring `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 or default 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)MarshalJSONadded inv0.14.0

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

typeCapacityCommitment

type CapacityCommitment struct {// CommitmentEndTime: Output only. The end of the current commitment// period. It is applicable only for ACTIVE capacity commitments.CommitmentEndTimestring `json:"commitmentEndTime,omitempty"`// CommitmentStartTime: Output only. The start of the current commitment// period. It is applicable only for ACTIVE capacity commitments.CommitmentStartTimestring `json:"commitmentStartTime,omitempty"`// FailureStatus: Output only. For FAILED commitment plan, provides the// reason of failure.FailureStatus *Status `json:"failureStatus,omitempty"`// MultiRegionAuxiliary: Applicable only for commitments located within// one of the BigQuery multi-regions (US or EU). If set to true, this// commitment is placed in the organization's secondary region which is// designated for disaster recovery purposes. If false, this commitment// is placed in the organization's default region.MultiRegionAuxiliarybool `json:"multiRegionAuxiliary,omitempty"`// Name: Output only. The resource name of the capacity commitment,// e.g., `projects/myproject/locations/US/capacityCommitments/123` The// commitment_id must only contain lower case alphanumeric characters or// dashes. It must start with a letter and must not end with a dash. Its// maximum length is 64 characters.Namestring `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`.//   "FLEX" - Flex commitments have committed period of 1 minute after// becoming ACTIVE. After that, they are not in a committed period// anymore and can be removed any time.//   "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" - Monthly commitments have a committed period of 30 days// after becoming ACTIVE. After that, they are not in a committed period// anymore and can be removed any time.//   "ANNUAL" - Annual commitments have a committed period of 365 days// after becoming ACTIVE. After that they are converted to a new// commitment based on the renewal_plan.Planstring `json:"plan,omitempty"`// RenewalPlan: The plan this capacity commitment is converted to after// commitment_end_time passes. Once the plan is changed, committed// period is extended according to commitment plan. Only applicable for// ANNUAL commitments.//// Possible values://   "COMMITMENT_PLAN_UNSPECIFIED" - Invalid plan value. Requests with// this value will be rejected with error code// `google.rpc.Code.INVALID_ARGUMENT`.//   "FLEX" - Flex commitments have committed period of 1 minute after// becoming ACTIVE. After that, they are not in a committed period// anymore and can be removed any time.//   "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" - Monthly commitments have a committed period of 30 days// after becoming ACTIVE. After that, they are not in a committed period// anymore and can be removed any time.//   "ANNUAL" - Annual commitments have a committed period of 365 days// after becoming ACTIVE. After that they are converted to a new// commitment based on the renewal_plan.RenewalPlanstring `json:"renewalPlan,omitempty"`// SlotCount: Number of slots in this commitment.SlotCountint64 `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 project's// slot_capacity.//   "ACTIVE" - Once slots are provisioned, capacity commitment becomes// active. slot_count is added to the project's slot_capacity.//   "FAILED" - Capacity commitment is failed to be activated by the// backend.Statestring `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 or default 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 computecapacity for BigQuery jobs (in the form of slots) with some committedperiod of usage. Annual commitments renew by default. Commitments canbe removed after their commitment end time passes. In order to removeannual commitment, its plan needs to be changed to monthly or flexfirst. A capacity commitment resource exists as a child resource ofthe admin project.

func (*CapacityCommitment)MarshalJSON

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

typeEmpty

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 definingduplicated empty messages in your APIs. A typical example is to useit as the request or the response type of an API method. Forinstance: service Foo { rpc Bar(google.protobuf.Empty) returns(google.protobuf.Empty); }

typeListAssignmentsResponse

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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Assignments") to// unconditionally include in API requests. By default, fields with// empty or default 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 forReservationService.ListAssignments.

func (*ListAssignmentsResponse)MarshalJSON

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

typeListCapacityCommitmentsResponse

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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CapacityCommitments")// to unconditionally include in API requests. By default, fields with// empty or default 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 forReservationService.ListCapacityCommitments.

func (*ListCapacityCommitmentsResponse)MarshalJSON

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

typeListReservationsResponse

type ListReservationsResponse struct {// NextPageToken: Token to retrieve the next page of results, or empty// if there are no more results in the list.NextPageTokenstring `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 or default 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 forReservationService.ListReservations.

func (*ListReservationsResponse)MarshalJSON

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

typeMergeCapacityCommitmentsRequestadded inv0.21.0

type MergeCapacityCommitmentsRequest struct {// CapacityCommitmentIds: Ids of capacity commitments to merge. These// capacity commitments must exist under admin project and location// specified in the parent. ID is the last portion of capacity// commitment name e.g., 'abc' for// projects/myproject/locations/US/capacityCommitments/abcCapacityCommitmentIds []string `json:"capacityCommitmentIds,omitempty"`// ForceSendFields is a list of field names (e.g.// "CapacityCommitmentIds") to unconditionally include in API requests.// By default, fields with empty or default 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. "CapacityCommitmentIds") 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:"-"`}

MergeCapacityCommitmentsRequest: The request forReservationService.MergeCapacityCommitments.

func (*MergeCapacityCommitmentsRequest)MarshalJSONadded inv0.21.0

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

typeMoveAssignmentRequestadded inv0.14.0

type MoveAssignmentRequest struct {// DestinationId: The new reservation ID, e.g.:// `projects/myotherproject/locations/US/reservations/team2-prod`DestinationIdstring `json:"destinationId,omitempty"`// ForceSendFields is a list of field names (e.g. "DestinationId") to// unconditionally include in API requests. By default, fields with// empty or default 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 forReservationService.MoveAssignment. **Note**:"bigquery.reservationAssignments.create" permission is required onthe destination_id. **Note**:"bigquery.reservationAssignments.create" and"bigquery.reservationAssignments.delete" permission are required onthe related assignee.

func (*MoveAssignmentRequest)MarshalJSONadded inv0.14.0

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

typeProjectsLocationsCapacityCommitmentsCreateCalladded inv0.14.0

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

func (*ProjectsLocationsCapacityCommitmentsCreateCall)CapacityCommitmentIdadded inv0.46.0

CapacityCommitmentId sets the optional parameter"capacityCommitmentId": The optional capacity commitment ID. Capacitycommitment name will be generated automatically if this field isempty. This field must only contain lower case alphanumericcharacters or dashes. The first and last character cannot be a dash.Max length is 64 characters. NOTE: this ID won't be kept if thecapacity commitment is split or merged.

func (*ProjectsLocationsCapacityCommitmentsCreateCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsCapacityCommitmentsCreateCall)Doadded inv0.14.0

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.create" call.Exactly one of *CapacityCommitment or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*CapacityCommitment.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsCapacityCommitmentsCreateCall)EnforceSingleAdminProjectPerOrgadded inv0.15.0

func (c *ProjectsLocationsCapacityCommitmentsCreateCall) EnforceSingleAdminProjectPerOrg(enforceSingleAdminProjectPerOrgbool) *ProjectsLocationsCapacityCommitmentsCreateCall

EnforceSingleAdminProjectPerOrg sets the optional parameter"enforceSingleAdminProjectPerOrg": If true, fail the request ifanother project in the organization has a capacity commitment.

func (*ProjectsLocationsCapacityCommitmentsCreateCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsCreateCall)Headeradded inv0.14.0

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

typeProjectsLocationsCapacityCommitmentsDeleteCall

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

func (*ProjectsLocationsCapacityCommitmentsDeleteCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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 statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*ProjectsLocationsCapacityCommitmentsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsDeleteCall)Forceadded inv0.54.0

Force sets the optional parameter "force": Can be used to forcedelete commitments even if assignments exist. Deleting commitmentswith assignments may cause queries to fail if they no longer haveaccess to slots.

func (*ProjectsLocationsCapacityCommitmentsDeleteCall)Header

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

typeProjectsLocationsCapacityCommitmentsGetCall

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

func (*ProjectsLocationsCapacityCommitmentsGetCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsCapacityCommitmentsGetCall)Do

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.get" call.Exactly one of *CapacityCommitment or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*CapacityCommitment.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsCapacityCommitmentsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsGetCall)Header

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

func (*ProjectsLocationsCapacityCommitmentsGetCall)IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeProjectsLocationsCapacityCommitmentsListCall

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

func (*ProjectsLocationsCapacityCommitmentsListCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsCapacityCommitmentsListCall)Do

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.list" call.Exactly one of *ListCapacityCommitmentsResponse or error will benon-nil. Any non-2xx status code is an error. Response headers are ineither *ListCapacityCommitmentsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsCapacityCommitmentsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsListCall)Header

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

func (*ProjectsLocationsCapacityCommitmentsListCall)IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*ProjectsLocationsCapacityCommitmentsListCall)PageSize

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

func (*ProjectsLocationsCapacityCommitmentsListCall)PageToken

PageToken sets the optional parameter "pageToken": Thenext_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.

typeProjectsLocationsCapacityCommitmentsMergeCalladded inv0.21.0

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

func (*ProjectsLocationsCapacityCommitmentsMergeCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsCapacityCommitmentsMergeCall)Doadded inv0.21.0

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.merge" call.Exactly one of *CapacityCommitment or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*CapacityCommitment.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsCapacityCommitmentsMergeCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsMergeCall)Headeradded inv0.21.0

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

typeProjectsLocationsCapacityCommitmentsPatchCalladded inv0.21.0

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

func (*ProjectsLocationsCapacityCommitmentsPatchCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsCapacityCommitmentsPatchCall)Doadded inv0.21.0

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.patch" call.Exactly one of *CapacityCommitment or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*CapacityCommitment.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsCapacityCommitmentsPatchCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsPatchCall)Headeradded inv0.21.0

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

func (*ProjectsLocationsCapacityCommitmentsPatchCall)UpdateMaskadded inv0.21.0

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

typeProjectsLocationsCapacityCommitmentsService

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

func (*ProjectsLocationsCapacityCommitmentsService)Createadded inv0.14.0

Create: Creates a new capacity commitment resource.

  • parent: Resource name of the parent reservation. E.g.,`projects/myproject/locations/US`.

func (*ProjectsLocationsCapacityCommitmentsService)Delete

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

  • name: Resource name of the capacity commitment to delete. E.g.,`projects/myproject/locations/US/capacityCommitments/123`.

func (*ProjectsLocationsCapacityCommitmentsService)Get

Get: Returns information about the capacity commitment.

  • name: Resource name of the capacity commitment to retrieve. E.g.,`projects/myproject/locations/US/capacityCommitments/123`.

func (*ProjectsLocationsCapacityCommitmentsService)List

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

  • parent: Resource name of the parent reservation. E.g.,`projects/myproject/locations/US`.

func (*ProjectsLocationsCapacityCommitmentsService)Mergeadded inv0.21.0

Merge: Merges capacity commitments of the same plan into a singlecommitment. The resulting capacity commitment has the greatercommitment_end_time out of the to-be-merged capacity commitments.Attempting to merge capacity commitments of different plan will failwith the error code `google.rpc.Code.FAILED_PRECONDITION`.

  • parent: Parent resource that identifies admin project and locatione.g., `projects/myproject/locations/us`.

func (*ProjectsLocationsCapacityCommitmentsService)Patchadded inv0.21.0

Patch: Updates an existing capacity commitment. Only `plan` and`renewal_plan` fields can be updated. Plan can only be changed to aplan of a longer commitment period. Attempting to change to a planwith shorter commitment period will fail with the error code`google.rpc.Code.FAILED_PRECONDITION`.

  • name: Output only. The resource name of the capacity commitment,e.g., `projects/myproject/locations/US/capacityCommitments/123` Thecommitment_id must only contain lower case alphanumeric charactersor dashes. It must start with a letter and must not end with adash. Its maximum length is 64 characters.

func (*ProjectsLocationsCapacityCommitmentsService)Splitadded inv0.21.0

Split: Splits capacity commitment to two commitments of the same planand `commitment_end_time`. A common use case is to enable downgradingcommitments. For example, in order to downgrade from 10000 slots to8000, you might split a 10000 capacity commitment into commitments of2000 and 8000. Then, you delete the first one after the commitmentend time passes.

  • name: The resource name e.g.,:`projects/myproject/locations/US/capacityCommitments/123`.

typeProjectsLocationsCapacityCommitmentsSplitCalladded inv0.21.0

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

func (*ProjectsLocationsCapacityCommitmentsSplitCall)Contextadded inv0.21.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsCapacityCommitmentsSplitCall)Doadded inv0.21.0

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.split" call.Exactly one of *SplitCapacityCommitmentResponse or error will benon-nil. Any non-2xx status code is an error. Response headers are ineither *SplitCapacityCommitmentResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsCapacityCommitmentsSplitCall)Fieldsadded inv0.21.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsCapacityCommitmentsSplitCall)Headeradded inv0.21.0

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

typeProjectsLocationsGetBiReservationCalladded inv0.14.0

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

func (*ProjectsLocationsGetBiReservationCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsGetBiReservationCall)Doadded inv0.14.0

Do executes the "bigqueryreservation.projects.locations.getBiReservation" call.Exactly one of *BiReservation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*BiReservation.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsGetBiReservationCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsGetBiReservationCall)Headeradded inv0.14.0

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

func (*ProjectsLocationsGetBiReservationCall)IfNoneMatchadded inv0.14.0

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeProjectsLocationsReservationsAssignmentsCreateCall

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

func (*ProjectsLocationsReservationsAssignmentsCreateCall)AssignmentIdadded inv0.46.0

AssignmentId sets the optional parameter "assignmentId": The optionalassignment ID. Assignment name will be generated automatically ifthis field is empty. This field must only contain lower casealphanumeric characters or dashes. Max length is 64 characters.

func (*ProjectsLocationsReservationsAssignmentsCreateCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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-2xxstatus code is an error. Response headers are in either*Assignment.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsReservationsAssignmentsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsAssignmentsCreateCall)Header

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

typeProjectsLocationsReservationsAssignmentsDeleteCall

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

func (*ProjectsLocationsReservationsAssignmentsDeleteCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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 statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*ProjectsLocationsReservationsAssignmentsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsAssignmentsDeleteCall)Header

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

typeProjectsLocationsReservationsAssignmentsListCall

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

func (*ProjectsLocationsReservationsAssignmentsListCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsReservationsAssignmentsListCall)Do

Do executes the "bigqueryreservation.projects.locations.reservations.assignments.list" call.Exactly one of *ListAssignmentsResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*ListAssignmentsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsReservationsAssignmentsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsAssignmentsListCall)Header

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

func (*ProjectsLocationsReservationsAssignmentsListCall)IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*ProjectsLocationsReservationsAssignmentsListCall)PageSize

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

func (*ProjectsLocationsReservationsAssignmentsListCall)PageToken

PageToken sets the optional parameter "pageToken": Thenext_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.

typeProjectsLocationsReservationsAssignmentsMoveCall

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

func (*ProjectsLocationsReservationsAssignmentsMoveCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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-2xxstatus code is an error. Response headers are in either*Assignment.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsReservationsAssignmentsMoveCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsAssignmentsMoveCall)Header

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

typeProjectsLocationsReservationsAssignmentsPatchCalladded inv0.49.0

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

func (*ProjectsLocationsReservationsAssignmentsPatchCall)Contextadded inv0.49.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsReservationsAssignmentsPatchCall)Doadded inv0.49.0

Do executes the "bigqueryreservation.projects.locations.reservations.assignments.patch" call.Exactly one of *Assignment or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Assignment.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsReservationsAssignmentsPatchCall)Fieldsadded inv0.49.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsAssignmentsPatchCall)Headeradded inv0.49.0

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

func (*ProjectsLocationsReservationsAssignmentsPatchCall)UpdateMaskadded inv0.49.0

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

typeProjectsLocationsReservationsAssignmentsService

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

func (*ProjectsLocationsReservationsAssignmentsService)Create

Create: Creates an assignment object which allows the given projectto submit jobs of a certain type using slots from the specifiedreservation. Currently a resource (project, folder, organization) canonly have one assignment per each (job_type, location) combination,and that reservation will be used for all jobs of the matching type.Different assignments can be created on different levels of theprojects, folders or organization hierarchy. During query execution,the assignment is looked up at the project, folder and organizationlevels in that order. The first assignment found is applied to thequery. When creating assignments, it does not matter if otherassignments exist at higher levels. Example: * The organization`organizationA` contains two projects, `project1` and `project2`. *Assignments for all three entities (`organizationA`, `project1`, and`project2`) could all be created and mapped to the same or differentreservations. "None" assignments represent an absence of theassignment. Projects assigned to None use on-demand pricing. Tocreate a "None" assignment, use "none" as a reservation_id in theparent. Example parent:`projects/myproject/locations/US/reservations/none`. Returns`google.rpc.Code.PERMISSION_DENIED` if user does not have'bigquery.admin' permissions on the project using the reservation andthe project that owns this reservation. Returns`google.rpc.Code.INVALID_ARGUMENT` when location of the assignmentdoes not match location of the reservation.

  • parent: The parent resource name of the assignment E.g.`projects/myproject/locations/US/reservations/team1-prod`.

func (*ProjectsLocationsReservationsAssignmentsService)Delete

Delete: Deletes a assignment. No expansion will happen. Example: *Organization `organizationA` contains two projects, `project1` and`project2`. * Reservation `res1` exists and was created previously. *CreateAssignment was used previously to define the followingassociations between entities and reservations: “ and “ In thisexample, deletion of the “ assignment won't affect the otherassignment “. After said deletion, queries from `project1` willstill use `res1` while queries from `project2` will switch to useon-demand mode.

  • name: Name of the resource, e.g.`projects/myproject/locations/US/reservations/team1-prod/assignments/123`.

func (*ProjectsLocationsReservationsAssignmentsService)List

List: Lists assignments. Only explicitly created assignments will bereturned. Example: * Organization `organizationA` contains twoprojects, `project1` and `project2`. * Reservation `res1` exists andwas created previously. * CreateAssignment was used previously todefine the following associations between entities and reservations:“ and “ In this example, ListAssignments will just return the abovetwo assignments for reservation `res1`, and no expansion/merge willhappen. The wildcard "-" can be used for reservations in the request.In that case all assignments belongs to the specified project andlocation will be listed. **Note** "-" cannot be used for projects norlocations.

  • parent: The parent resource name e.g.:`projects/myproject/locations/US/reservations/team1-prod` Or:`projects/myproject/locations/US/reservations/-`.

func (*ProjectsLocationsReservationsAssignmentsService)Move

Move: Moves an assignment under a new reservation. This differs fromremoving an existing assignment and recreating a new one by providinga transactional change that ensures an assignee always has anassociated reservation.

  • name: The resource name of the assignment, e.g.`projects/myproject/locations/US/reservations/team1-prod/assignments/123`.

func (*ProjectsLocationsReservationsAssignmentsService)Patchadded inv0.49.0

Patch: Updates an existing assignment. Only the `priority` field canbe updated.

  • name: Output only. Name of the resource. E.g.:`projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumericcharacters or dashes and the max length is 64 characters.

typeProjectsLocationsReservationsCreateCall

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

func (*ProjectsLocationsReservationsCreateCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsReservationsCreateCall)Do

Do executes the "bigqueryreservation.projects.locations.reservations.create" call.Exactly one of *Reservation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Reservation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsReservationsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsCreateCall)Header

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

func (*ProjectsLocationsReservationsCreateCall)ReservationId

ReservationId sets the optional parameter "reservationId": Thereservation ID. It must only contain lower case alphanumericcharacters or dashes. It must start with a letter and must not endwith a dash. Its maximum length is 64 characters.

typeProjectsLocationsReservationsDeleteCall

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

func (*ProjectsLocationsReservationsDeleteCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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 statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*ProjectsLocationsReservationsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsDeleteCall)Header

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

typeProjectsLocationsReservationsGetCall

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

func (*ProjectsLocationsReservationsGetCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsReservationsGetCall)Do

Do executes the "bigqueryreservation.projects.locations.reservations.get" call.Exactly one of *Reservation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Reservation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsReservationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsGetCall)Header

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

func (*ProjectsLocationsReservationsGetCall)IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

typeProjectsLocationsReservationsListCall

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

func (*ProjectsLocationsReservationsListCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsReservationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsListCall)Filter

Filter sets the optional parameter "filter": Can be used to filterout 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 toadd HTTP headers to the request.

func (*ProjectsLocationsReservationsListCall)IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*ProjectsLocationsReservationsListCall)PageSize

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

func (*ProjectsLocationsReservationsListCall)PageToken

PageToken sets the optional parameter "pageToken": Thenext_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.

typeProjectsLocationsReservationsPatchCall

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

func (*ProjectsLocationsReservationsPatchCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsReservationsPatchCall)Do

Do executes the "bigqueryreservation.projects.locations.reservations.patch" call.Exactly one of *Reservation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*Reservation.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsReservationsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsReservationsPatchCall)Header

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

func (*ProjectsLocationsReservationsPatchCall)UpdateMask

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

typeProjectsLocationsReservationsService

type ProjectsLocationsReservationsService struct {Assignments *ProjectsLocationsReservationsAssignmentsService// contains filtered or unexported fields}

func (*ProjectsLocationsReservationsService)Create

Create: Creates a new reservation resource.

- parent: Project, location. E.g., `projects/myproject/locations/US`.

func (*ProjectsLocationsReservationsService)Delete

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

  • name: Resource name of the reservation to retrieve. E.g.,`projects/myproject/locations/US/reservations/team1-prod`.

func (*ProjectsLocationsReservationsService)Get

Get: Returns information about the reservation.

  • name: Resource name of the reservation to retrieve. E.g.,`projects/myproject/locations/US/reservations/team1-prod`.

func (*ProjectsLocationsReservationsService)List

List: Lists all the reservations for the project in the specifiedlocation.

  • parent: The parent resource name containing project and location,e.g.: `projects/myproject/locations/US`.

func (*ProjectsLocationsReservationsService)Patch

Patch: Updates an existing reservation resource.

  • name: The resource name of the reservation, e.g.,`projects/*/locations/*/reservations/team1-prod`. Thereservation_id must only contain lower case alphanumeric charactersor dashes. It must start with a letter and must not end with adash. Its maximum length is 64 characters.

typeProjectsLocationsSearchAssignmentsCall

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

func (*ProjectsLocationsSearchAssignmentsCall)Context

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

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 responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsSearchAssignmentsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsSearchAssignmentsCall)Header

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

func (*ProjectsLocationsSearchAssignmentsCall)IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*ProjectsLocationsSearchAssignmentsCall)PageSize

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

func (*ProjectsLocationsSearchAssignmentsCall)PageToken

PageToken sets the optional parameter "pageToken": Thenext_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 resourcename as assignee in the query. Examples: *`assignee=projects/myproject` * `assignee=folders/123` *`assignee=organizations/456`

typeProjectsLocationsService

type ProjectsLocationsService struct {CapacityCommitments *ProjectsLocationsCapacityCommitmentsServiceReservations *ProjectsLocationsReservationsService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)GetBiReservationadded inv0.14.0

GetBiReservation: Retrieves a BI reservation.

  • name: Name of the requested reservation, for example:`projects/{project_id}/locations/{location_id}/biReservation`.

func (*ProjectsLocationsService)SearchAssignments

SearchAssignments: Looks up assignments for a specified resource fora particular region. If the request is about a project: 1.Assignments created on the project will be returned if they exist. 2.Otherwise assignments created on the closest ancestor will bereturned. 3. Assignments for different JobTypes will all be returned.The same logic applies if the request is about a folder. If therequest is about an organization, then assignments created on theorganization 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. Hierarchylookup (project->folder->organization) happens in this API. 3. Parenthere is `projects/*/locations/*`, instead of`projects/*/locations/*reservations/*`. **Note** "-" cannot be usedfor projects nor locations.

  • parent: The resource name of the admin project(containing projectand location), e.g.: `projects/myproject/locations/US`.

func (*ProjectsLocationsService)UpdateBiReservationadded inv0.14.0

UpdateBiReservation: Updates a BI reservation. Only fields specifiedin the `field_mask` are updated. A singleton BI reservation alwaysexists with default size 0. In order to reserve BI capacity it needsto be updated to an amount greater than 0. In order to release BIcapacity reservation size must be set to 0.

  • name: The resource name of the singleton BI reservation.Reservation names have the form`projects/{project_id}/locations/{location_id}/biReservation`.

typeProjectsLocationsUpdateBiReservationCalladded inv0.14.0

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

func (*ProjectsLocationsUpdateBiReservationCall)Contextadded inv0.14.0

Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ProjectsLocationsUpdateBiReservationCall)Doadded inv0.14.0

Do executes the "bigqueryreservation.projects.locations.updateBiReservation" call.Exactly one of *BiReservation or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*BiReservation.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*ProjectsLocationsUpdateBiReservationCall)Fieldsadded inv0.14.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ProjectsLocationsUpdateBiReservationCall)Headeradded inv0.14.0

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

func (*ProjectsLocationsUpdateBiReservationCall)UpdateMaskadded inv0.14.0

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

typeProjectsService

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

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeReservation

type Reservation struct {// Concurrency: Job concurrency target which sets a soft upper bound on// the number of jobs that can run concurrently in this reservation.// This is a soft target due to asynchronous nature of the system and// various optimizations for small queries. Default value is 0 which// means that concurrency target will be automatically computed by the// system. NOTE: this field is exposed as `target_job_concurrency` in// the Information Schema, DDL and BQ CLI.Concurrencyint64 `json:"concurrency,omitempty,string"`// CreationTime: Output only. Creation time of the reservation.CreationTimestring `json:"creationTime,omitempty"`// IgnoreIdleSlots: If false, any query or pipeline job using this// reservation will use idle slots from other reservations within the// same admin project. If true, a query or pipeline job using this// reservation will execute with the slot capacity specified in the// slot_capacity field at most.IgnoreIdleSlotsbool `json:"ignoreIdleSlots,omitempty"`// MultiRegionAuxiliary: Applicable only for reservations located within// one of the BigQuery multi-regions (US or EU). If set to true, this// reservation is placed in the organization's secondary region which is// designated for disaster recovery purposes. If false, this reservation// is placed in the organization's default region.MultiRegionAuxiliarybool `json:"multiRegionAuxiliary,omitempty"`// Name: The resource name of the reservation, e.g.,// `projects/*/locations/*/reservations/team1-prod`. The reservation_id// must only contain lower case alphanumeric characters or dashes. It// must start with a letter and must not end with a dash. Its maximum// length is 64 characters.Namestring `json:"name,omitempty"`// SlotCapacity: Minimum slots available to this reservation. A slot is// a unit of computational power in BigQuery, and serves as the unit of// parallelism. Queries using this reservation might use more slots// during runtime if ignore_idle_slots is set to false. If the new// reservation's slot capacity exceeds the project's slot capacity or if// total slot capacity of the new reservation and its siblings exceeds// the project's slot capacity, the request will fail with// `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or// EU multi-regions, slot capacity constraints are checked separately// for default and auxiliary regions. See multi_region_auxiliary flag// for more details.SlotCapacityint64 `json:"slotCapacity,omitempty,string"`// UpdateTime: Output only. Last update time of the reservation.UpdateTimestring `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. "Concurrency") to// unconditionally include in API requests. By default, fields with// empty or default 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. "Concurrency") 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 tousers.

func (*Reservation)MarshalJSON

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

typeSearchAssignmentsResponse

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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Assignments") to// unconditionally include in API requests. By default, fields with// empty or default 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 forReservationService.SearchAssignments.

func (*SearchAssignmentsResponse)MarshalJSON

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

typeService

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

funcNewdeprecated

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

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

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

funcNewService

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

NewService creates a new Service.

typeSplitCapacityCommitmentRequestadded inv0.21.0

type SplitCapacityCommitmentRequest struct {// SlotCount: Number of slots in the capacity commitment after the// split.SlotCountint64 `json:"slotCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "SlotCount") to// unconditionally include in API requests. By default, fields with// empty or default 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. "SlotCount") 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:"-"`}

SplitCapacityCommitmentRequest: The request forReservationService.SplitCapacityCommitment.

func (*SplitCapacityCommitmentRequest)MarshalJSONadded inv0.21.0

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

typeSplitCapacityCommitmentResponseadded inv0.21.0

type SplitCapacityCommitmentResponse struct {// First: First capacity commitment, result of a split.First *CapacityCommitment `json:"first,omitempty"`// Second: Second capacity commitment, result of a split.Second *CapacityCommitment `json:"second,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "First") to// unconditionally include in API requests. By default, fields with// empty or default 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. "First") 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:"-"`}

SplitCapacityCommitmentResponse: The response forReservationService.SplitCapacityCommitment.

func (*SplitCapacityCommitmentResponse)MarshalJSONadded inv0.21.0

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

typeStatus

type Status struct {// Code: The status code, which should be an enum value of// google.rpc.Code.Codeint64 `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.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to// unconditionally include in API requests. By default, fields with// empty or default 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 issuitable for different programming environments, including REST APIsand RPC APIs. It is used by gRPC (https://github.com/grpc). Each`Status` message contains three pieces of data: error code, errormessage, and error details. You can find out more about this errormodel 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)

typeTableReferenceadded inv0.76.0

type TableReference struct {// DatasetId: The ID of the dataset in the above project.DatasetIdstring `json:"datasetId,omitempty"`// ProjectId: The assigned project ID of the project.ProjectIdstring `json:"projectId,omitempty"`// TableId: The ID of the table in the above dataset.TableIdstring `json:"tableId,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetId") to// unconditionally include in API requests. By default, fields with// empty or default 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. "DatasetId") 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:"-"`}

TableReference: Fully qualified reference to BigQuery table.Internally stored as google.cloud.bi.v1.BqTableReference.

func (*TableReference)MarshalJSONadded inv0.76.0

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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

[8]ページ先頭

©2009-2025 Movatter.jp