bigqueryreservation

package
v0.172.0 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package bigqueryreservation provides access to the BigQuery Reservation API.

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

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/bigqueryreservation/v1"
...
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 google.golang.org/api/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 google.golang.org/api/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 google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption 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 Account
	BigqueryScope = "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

type Assignment added in v0.22.0 

type Assignment struct {
	// Assignee: The resource which will use the reservation. E.g.
	// `projects/myproject`, `folders/123`, or `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.
	//   "ML_EXTERNAL" - BigQuery ML jobs that use services external to
	// BigQuery for model training. These jobs will not utilize idle slots
	// from other reservations.
	//   "BACKGROUND" - Background jobs that BigQuery runs for the customers
	// in the background.
	//   "CONTINUOUS" - Continuous SQL jobs will use this reservation.
	// Reservations with continuous assignments cannot be mixed with
	// non-continuous assignments.
	JobType string `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.
	Name string `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.
	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. "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 a certain type using slots from the specified reservation.

func (*Assignment) MarshalJSON added in v0.22.0 

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

type Autoscale added in v0.109.0 

type Autoscale struct {
	// CurrentSlots: Output only. The slot capacity added to this
	// reservation when autoscale happens. Will be between [0, max_slots].
	CurrentSlots int64 `json:"currentSlots,omitempty,string"`

	// MaxSlots: Number of slots to be scaled when needed.
	MaxSlots int64 `json:"maxSlots,omitempty,string"`

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

Autoscale: Auto scaling settings.

func (*Autoscale) MarshalJSON added in v0.109.0 

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

type BiReservation added in v0.22.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"`

	// PreferredTables: Preferred tables to use BI capacity for.
	PreferredTables []*TableReference `json:"preferredTables,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 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) MarshalJSON added in v0.22.0 

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

type CapacityCommitment added in v0.22.0 

type CapacityCommitment struct {
	// CommitmentEndTime: Output only. The end of the current commitment
	// period. It is applicable only for ACTIVE capacity commitments.
	CommitmentEndTime string `json:"commitmentEndTime,omitempty"`

	// CommitmentStartTime: Output only. The start of the current commitment
	// period. It is applicable only for ACTIVE capacity commitments.
	CommitmentStartTime string `json:"commitmentStartTime,omitempty"`

	// Edition: Edition of the capacity commitment.
	//
	// Possible values:
	//   "EDITION_UNSPECIFIED" - Default value, which will be treated as
	// ENTERPRISE.
	//   "STANDARD" - Standard edition.
	//   "ENTERPRISE" - Enterprise edition.
	//   "ENTERPRISE_PLUS" - Enterprise plus edition.
	Edition string `json:"edition,omitempty"`

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

	// IsFlatRate: Output only. If true, the commitment is a flat-rate
	// commitment, otherwise, it's an edition commitment.
	IsFlatRate bool `json:"isFlatRate,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. NOTE: this is a
	// preview feature. Project must be allow-listed in order to set this
	// field.
	MultiRegionAuxiliary bool `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.
	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`.
	//   "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.
	//   "FLEX_FLAT_RATE" - Same as FLEX, should only be used if flat-rate
	// commitments are still available.
	//   "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.
	//   "MONTHLY_FLAT_RATE" - Same as MONTHLY, should only be used if
	// flat-rate commitments are still available.
	//   "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.
	//   "ANNUAL_FLAT_RATE" - Same as ANNUAL, should only be used if
	// flat-rate commitments are still available.
	//   "THREE_YEAR" - 3-year commitments have a committed period of 1095(3
	// * 365) days after becoming ACTIVE. After that they are converted to a
	// new commitment based on the renewal_plan.
	//   "NONE" - Should only be used for `renewal_plan` and is only
	// meaningful if edition is specified to values other than
	// EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or
	// UpdateCapacityCommitmentRequest will be rejected with error code
	// `google.rpc.Code.INVALID_ARGUMENT`. If the renewal_plan is NONE,
	// capacity commitment will be removed at the end of its commitment
	// period.
	Plan string `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 and TRIAL 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.
	//   "FLEX_FLAT_RATE" - Same as FLEX, should only be used if flat-rate
	// commitments are still available.
	//   "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.
	//   "MONTHLY_FLAT_RATE" - Same as MONTHLY, should only be used if
	// flat-rate commitments are still available.
	//   "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.
	//   "ANNUAL_FLAT_RATE" - Same as ANNUAL, should only be used if
	// flat-rate commitments are still available.
	//   "THREE_YEAR" - 3-year commitments have a committed period of 1095(3
	// * 365) days after becoming ACTIVE. After that they are converted to a
	// new commitment based on the renewal_plan.
	//   "NONE" - Should only be used for `renewal_plan` and is only
	// meaningful if edition is specified to values other than
	// EDITION_UNSPECIFIED. Otherwise CreateCapacityCommitmentRequest or
	// UpdateCapacityCommitmentRequest will be rejected with error code
	// `google.rpc.Code.INVALID_ARGUMENT`. If the renewal_plan is NONE,
	// capacity commitment will be removed at the end of its commitment
	// period.
	RenewalPlan string `json:"renewalPlan,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 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.
	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 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 compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.

func (*CapacityCommitment) MarshalJSON added in v0.22.0 

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

type FailoverReservationRequest added in v0.172.0 

type FailoverReservationRequest struct {
}

FailoverReservationRequest: The request for ReservationService.FailoverReservation.

type ListAssignmentsResponse added in v0.22.0 

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 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 for ReservationService.ListAssignments.

func (*ListAssignmentsResponse) MarshalJSON added in v0.22.0 

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

type ListCapacityCommitmentsResponse added in v0.22.0 

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 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 for ReservationService.ListCapacityCommitments.

func (*ListCapacityCommitmentsResponse) MarshalJSON added in v0.22.0 

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

type ListReservationsResponse added in v0.22.0 

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 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 for ReservationService.ListReservations.

func (*ListReservationsResponse) MarshalJSON added in v0.22.0 

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

type MergeCapacityCommitmentsRequest added in v0.22.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/abc
	CapacityCommitmentIds []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 for ReservationService.MergeCapacityCommitments.

func (*MergeCapacityCommitmentsRequest) MarshalJSON added in v0.22.0 

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

type MoveAssignmentRequest added in v0.22.0 

type MoveAssignmentRequest struct {
	// AssignmentId: The optional assignment ID. A new assignment name is
	// generated if this field is empty. This field can contain only
	// lowercase alphanumeric characters or dashes. Max length is 64
	// characters.
	AssignmentId string `json:"assignmentId,omitempty"`

	// 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. "AssignmentId") 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. "AssignmentId") 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 are required on the related assignee.

func (*MoveAssignmentRequest) MarshalJSON added in v0.22.0 

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

type ProjectsLocationsCapacityCommitmentsCreateCall added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsCreateCall) CapacityCommitmentId added in v0.46.0 

func (c *ProjectsLocationsCapacityCommitmentsCreateCall) CapacityCommitmentId(capacityCommitmentId string) *ProjectsLocationsCapacityCommitmentsCreateCall

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

func (*ProjectsLocationsCapacityCommitmentsCreateCall) Context added in v0.22.0 

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

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.22.0 

func (c *ProjectsLocationsCapacityCommitmentsCreateCall) Do(opts ...googleapi.CallOption) (*CapacityCommitment, error)

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) EnforceSingleAdminProjectPerOrg added in v0.22.0 

func (c *ProjectsLocationsCapacityCommitmentsCreateCall) EnforceSingleAdminProjectPerOrg(enforceSingleAdminProjectPerOrg bool) *ProjectsLocationsCapacityCommitmentsCreateCall

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

func (*ProjectsLocationsCapacityCommitmentsCreateCall) Fields added in v0.22.0 

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

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.22.0 

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

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

type ProjectsLocationsCapacityCommitmentsDeleteCall added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsDeleteCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsCapacityCommitmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsDeleteCall) Force added in v0.54.0 

func (c *ProjectsLocationsCapacityCommitmentsDeleteCall) Force(force bool) *ProjectsLocationsCapacityCommitmentsDeleteCall

Force sets the optional parameter "force": Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

func (*ProjectsLocationsCapacityCommitmentsDeleteCall) Header added in v0.22.0 

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

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

type ProjectsLocationsCapacityCommitmentsGetCall added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsGetCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsCapacityCommitmentsGetCall) Do(opts ...googleapi.CallOption) (*CapacityCommitment, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsGetCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsGetCall) IfNoneMatch added in v0.22.0 

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

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 added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsListCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsCapacityCommitmentsListCall) Do(opts ...googleapi.CallOption) (*ListCapacityCommitmentsResponse, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsListCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsListCall) IfNoneMatch added in v0.22.0 

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

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 added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsListCall) PageToken added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsListCall) Pages added in v0.22.0 

func (c *ProjectsLocationsCapacityCommitmentsListCall) Pages(ctx context.Context, f func(*ListCapacityCommitmentsResponse) error) error

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 ProjectsLocationsCapacityCommitmentsMergeCall added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsMergeCall) Context added in v0.22.0 

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

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

func (c *ProjectsLocationsCapacityCommitmentsMergeCall) Do(opts ...googleapi.CallOption) (*CapacityCommitment, error)

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.merge" 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 (*ProjectsLocationsCapacityCommitmentsMergeCall) Fields added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsMergeCall) Header added in v0.22.0 

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

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

type ProjectsLocationsCapacityCommitmentsPatchCall added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsPatchCall) Context added in v0.22.0 

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

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

func (c *ProjectsLocationsCapacityCommitmentsPatchCall) Do(opts ...googleapi.CallOption) (*CapacityCommitment, error)

Do executes the "bigqueryreservation.projects.locations.capacityCommitments.patch" 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 (*ProjectsLocationsCapacityCommitmentsPatchCall) Fields added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsPatchCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsCapacityCommitmentsPatchCall) UpdateMask added in v0.22.0 

func (c *ProjectsLocationsCapacityCommitmentsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsCapacityCommitmentsPatchCall

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

type ProjectsLocationsCapacityCommitmentsService added in v0.22.0 

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

func NewProjectsLocationsCapacityCommitmentsService added in v0.22.0 

func NewProjectsLocationsCapacityCommitmentsService(s *Service) *ProjectsLocationsCapacityCommitmentsService

func (*ProjectsLocationsCapacityCommitmentsService) Create added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) Create(parent string, capacitycommitment *CapacityCommitment) *ProjectsLocationsCapacityCommitmentsCreateCall

Create: Creates a new capacity commitment resource.

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

func (*ProjectsLocationsCapacityCommitmentsService) Delete added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) Delete(name string) *ProjectsLocationsCapacityCommitmentsDeleteCall

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`.

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

func (*ProjectsLocationsCapacityCommitmentsService) Get added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) Get(name string) *ProjectsLocationsCapacityCommitmentsGetCall

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 added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) List(parent string) *ProjectsLocationsCapacityCommitmentsListCall

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) Merge added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) Merge(parent string, mergecapacitycommitmentsrequest *MergeCapacityCommitmentsRequest) *ProjectsLocationsCapacityCommitmentsMergeCall

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

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

func (*ProjectsLocationsCapacityCommitmentsService) Patch added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) Patch(name string, capacitycommitment *CapacityCommitment) *ProjectsLocationsCapacityCommitmentsPatchCall

Patch: Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with 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` 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.

func (*ProjectsLocationsCapacityCommitmentsService) Split added in v0.22.0 

func (r *ProjectsLocationsCapacityCommitmentsService) Split(name string, splitcapacitycommitmentrequest *SplitCapacityCommitmentRequest) *ProjectsLocationsCapacityCommitmentsSplitCall

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

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

type ProjectsLocationsCapacityCommitmentsSplitCall added in v0.22.0 

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

func (*ProjectsLocationsCapacityCommitmentsSplitCall) Context added in v0.22.0 

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

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

func (c *ProjectsLocationsCapacityCommitmentsSplitCall) Do(opts ...googleapi.CallOption) (*SplitCapacityCommitmentResponse, error)

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

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

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

func (*ProjectsLocationsCapacityCommitmentsSplitCall) Header added in v0.22.0 

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

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

type ProjectsLocationsGetBiReservationCall added in v0.22.0 

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

func (*ProjectsLocationsGetBiReservationCall) Context added in v0.22.0 

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

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.22.0 

func (c *ProjectsLocationsGetBiReservationCall) Do(opts ...googleapi.CallOption) (*BiReservation, error)

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.22.0 

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

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.22.0 

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

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.22.0 

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

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 ProjectsLocationsReservationsAssignmentsCreateCall added in v0.22.0 

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

func (*ProjectsLocationsReservationsAssignmentsCreateCall) AssignmentId added in v0.46.0 

func (c *ProjectsLocationsReservationsAssignmentsCreateCall) AssignmentId(assignmentId string) *ProjectsLocationsReservationsAssignmentsCreateCall

AssignmentId sets the optional parameter "assignmentId": The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. Max length is 64 characters.

func (*ProjectsLocationsReservationsAssignmentsCreateCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsAssignmentsCreateCall) Do(opts ...googleapi.CallOption) (*Assignment, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsCreateCall) Header added in v0.22.0 

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

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

type ProjectsLocationsReservationsAssignmentsDeleteCall added in v0.22.0 

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

func (*ProjectsLocationsReservationsAssignmentsDeleteCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsAssignmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsDeleteCall) Header added in v0.22.0 

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

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

type ProjectsLocationsReservationsAssignmentsListCall added in v0.22.0 

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

func (*ProjectsLocationsReservationsAssignmentsListCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsAssignmentsListCall) Do(opts ...googleapi.CallOption) (*ListAssignmentsResponse, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsListCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsListCall) IfNoneMatch added in v0.22.0 

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

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsListCall) PageToken added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsListCall) Pages added in v0.22.0 

func (c *ProjectsLocationsReservationsAssignmentsListCall) Pages(ctx context.Context, f func(*ListAssignmentsResponse) error) error

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 added in v0.22.0 

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

func (*ProjectsLocationsReservationsAssignmentsMoveCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsAssignmentsMoveCall) Do(opts ...googleapi.CallOption) (*Assignment, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsMoveCall) Header added in v0.22.0 

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

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

type ProjectsLocationsReservationsAssignmentsPatchCall added in v0.76.0 

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

func (*ProjectsLocationsReservationsAssignmentsPatchCall) Context added in v0.76.0 

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

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

func (c *ProjectsLocationsReservationsAssignmentsPatchCall) Do(opts ...googleapi.CallOption) (*Assignment, error)

Do executes the "bigqueryreservation.projects.locations.reservations.assignments.patch" 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 (*ProjectsLocationsReservationsAssignmentsPatchCall) Fields added in v0.76.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsPatchCall) Header added in v0.76.0 

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

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

func (*ProjectsLocationsReservationsAssignmentsPatchCall) UpdateMask added in v0.76.0 

func (c *ProjectsLocationsReservationsAssignmentsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsReservationsAssignmentsPatchCall

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

type ProjectsLocationsReservationsAssignmentsService added in v0.22.0 

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

func NewProjectsLocationsReservationsAssignmentsService added in v0.22.0 

func NewProjectsLocationsReservationsAssignmentsService(s *Service) *ProjectsLocationsReservationsAssignmentsService

func (*ProjectsLocationsReservationsAssignmentsService) Create added in v0.22.0 

func (r *ProjectsLocationsReservationsAssignmentsService) Create(parent string, assignment *Assignment) *ProjectsLocationsReservationsAssignmentsCreateCall

Create: Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only 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 the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments 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 different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. 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 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.

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

func (*ProjectsLocationsReservationsAssignmentsService) Delete added in v0.22.0 

func (r *ProjectsLocationsReservationsAssignmentsService) Delete(name string) *ProjectsLocationsReservationsAssignmentsDeleteCall

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 following associations between entities and reservations: “ and “ In this example, deletion of the “ assignment won't affect the other assignment “. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode.

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

func (*ProjectsLocationsReservationsAssignmentsService) List added in v0.22.0 

func (r *ProjectsLocationsReservationsAssignmentsService) List(parent string) *ProjectsLocationsReservationsAssignmentsListCall

List: Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: “ and “ In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The 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.

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

func (*ProjectsLocationsReservationsAssignmentsService) Move added in v0.22.0 

func (r *ProjectsLocationsReservationsAssignmentsService) Move(name string, moveassignmentrequest *MoveAssignmentRequest) *ProjectsLocationsReservationsAssignmentsMoveCall

Move: Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

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

func (*ProjectsLocationsReservationsAssignmentsService) Patch added in v0.76.0 

func (r *ProjectsLocationsReservationsAssignmentsService) Patch(name string, assignment *Assignment) *ProjectsLocationsReservationsAssignmentsPatchCall

Patch: Updates an existing assignment. Only the `priority` field can be 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 alphanumeric characters or dashes and the max length is 64 characters.

type ProjectsLocationsReservationsCreateCall added in v0.22.0 

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

func (*ProjectsLocationsReservationsCreateCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsCreateCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsCreateCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsCreateCall) ReservationId added in v0.22.0 

func (c *ProjectsLocationsReservationsCreateCall) ReservationId(reservationId string) *ProjectsLocationsReservationsCreateCall

ReservationId sets the optional parameter "reservationId": The reservation ID. It 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.

type ProjectsLocationsReservationsDeleteCall added in v0.22.0 

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

func (*ProjectsLocationsReservationsDeleteCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsDeleteCall) Header added in v0.22.0 

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

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

type ProjectsLocationsReservationsFailoverReservationCall added in v0.172.0 

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

func (*ProjectsLocationsReservationsFailoverReservationCall) Context added in v0.172.0 

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

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

func (c *ProjectsLocationsReservationsFailoverReservationCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

Do executes the "bigqueryreservation.projects.locations.reservations.failoverReservation" 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 (*ProjectsLocationsReservationsFailoverReservationCall) Fields added in v0.172.0 

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

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

func (*ProjectsLocationsReservationsFailoverReservationCall) Header added in v0.172.0 

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

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

type ProjectsLocationsReservationsGetCall added in v0.22.0 

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

func (*ProjectsLocationsReservationsGetCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsGetCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsGetCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsGetCall) IfNoneMatch added in v0.22.0 

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

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 added in v0.22.0 

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

func (*ProjectsLocationsReservationsListCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsListCall) Do(opts ...googleapi.CallOption) (*ListReservationsResponse, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsListCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsListCall) IfNoneMatch added in v0.22.0 

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

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsListCall) PageToken added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsListCall) Pages added in v0.22.0 

func (c *ProjectsLocationsReservationsListCall) Pages(ctx context.Context, f func(*ListReservationsResponse) error) error

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 added in v0.22.0 

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

func (*ProjectsLocationsReservationsPatchCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsReservationsPatchCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsPatchCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsReservationsPatchCall) UpdateMask added in v0.22.0 

func (c *ProjectsLocationsReservationsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsReservationsPatchCall

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

type ProjectsLocationsReservationsService added in v0.22.0 

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

func NewProjectsLocationsReservationsService added in v0.22.0 

func NewProjectsLocationsReservationsService(s *Service) *ProjectsLocationsReservationsService

func (*ProjectsLocationsReservationsService) Create added in v0.22.0 

func (r *ProjectsLocationsReservationsService) Create(parent string, reservation *Reservation) *ProjectsLocationsReservationsCreateCall

Create: Creates a new reservation resource.

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

func (*ProjectsLocationsReservationsService) Delete added in v0.22.0 

func (r *ProjectsLocationsReservationsService) Delete(name string) *ProjectsLocationsReservationsDeleteCall

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

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

func (*ProjectsLocationsReservationsService) FailoverReservation added in v0.172.0 

func (r *ProjectsLocationsReservationsService) FailoverReservation(name string, failoverreservationrequest *FailoverReservationRequest) *ProjectsLocationsReservationsFailoverReservationCall

FailoverReservation: Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.

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

func (*ProjectsLocationsReservationsService) Get added in v0.22.0 

func (r *ProjectsLocationsReservationsService) Get(name string) *ProjectsLocationsReservationsGetCall

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 added in v0.22.0 

func (r *ProjectsLocationsReservationsService) List(parent string) *ProjectsLocationsReservationsListCall

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

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

func (*ProjectsLocationsReservationsService) Patch added in v0.22.0 

func (r *ProjectsLocationsReservationsService) Patch(name string, reservation *Reservation) *ProjectsLocationsReservationsPatchCall

Patch: Updates an existing reservation resource.

  • 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.

type ProjectsLocationsSearchAllAssignmentsCall added in v0.30.0 

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

func (*ProjectsLocationsSearchAllAssignmentsCall) Context added in v0.30.0 

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

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

func (c *ProjectsLocationsSearchAllAssignmentsCall) Do(opts ...googleapi.CallOption) (*SearchAllAssignmentsResponse, error)

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

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

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

func (*ProjectsLocationsSearchAllAssignmentsCall) Header added in v0.30.0 

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

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

func (*ProjectsLocationsSearchAllAssignmentsCall) IfNoneMatch added in v0.30.0 

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

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 (*ProjectsLocationsSearchAllAssignmentsCall) PageSize added in v0.30.0 

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

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

func (*ProjectsLocationsSearchAllAssignmentsCall) PageToken added in v0.30.0 

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

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

func (*ProjectsLocationsSearchAllAssignmentsCall) Pages added in v0.30.0 

func (c *ProjectsLocationsSearchAllAssignmentsCall) Pages(ctx context.Context, f func(*SearchAllAssignmentsResponse) error) error

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 (*ProjectsLocationsSearchAllAssignmentsCall) Query added in v0.30.0 

func (c *ProjectsLocationsSearchAllAssignmentsCall) Query(query string) *ProjectsLocationsSearchAllAssignmentsCall

Query sets the optional parameter "query": Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`

type ProjectsLocationsSearchAssignmentsCall added in v0.22.0 

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

func (*ProjectsLocationsSearchAssignmentsCall) Context added in v0.22.0 

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

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 added in v0.22.0 

func (c *ProjectsLocationsSearchAssignmentsCall) Do(opts ...googleapi.CallOption) (*SearchAssignmentsResponse, error)

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 added in v0.22.0 

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

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

func (*ProjectsLocationsSearchAssignmentsCall) Header added in v0.22.0 

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

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

func (*ProjectsLocationsSearchAssignmentsCall) IfNoneMatch added in v0.22.0 

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

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 added in v0.22.0 

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

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

func (*ProjectsLocationsSearchAssignmentsCall) PageToken added in v0.22.0 

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

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

func (*ProjectsLocationsSearchAssignmentsCall) Pages added in v0.22.0 

func (c *ProjectsLocationsSearchAssignmentsCall) Pages(ctx context.Context, f func(*SearchAssignmentsResponse) error) error

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 added in v0.22.0 

func (c *ProjectsLocationsSearchAssignmentsCall) Query(query string) *ProjectsLocationsSearchAssignmentsCall

Query sets the optional parameter "query": Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`

type ProjectsLocationsService added in v0.22.0 

type ProjectsLocationsService struct {
	CapacityCommitments *ProjectsLocationsCapacityCommitmentsService

	Reservations *ProjectsLocationsReservationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService added in v0.22.0 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) GetBiReservation added in v0.22.0 

func (r *ProjectsLocationsService) GetBiReservation(name string) *ProjectsLocationsGetBiReservationCall

GetBiReservation: Retrieves a BI reservation.

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

func (*ProjectsLocationsService) SearchAllAssignments added in v0.30.0 

func (r *ProjectsLocationsService) SearchAllAssignments(parent string) *ProjectsLocationsSearchAllAssignmentsCall

SearchAllAssignments: 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. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The 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. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`.

  • parent: The resource name with location (project name could be the wildcard '-'), e.g.: `projects/-/locations/US`.

func (*ProjectsLocationsService) SearchAssignments added in v0.22.0 

func (r *ProjectsLocationsService) SearchAssignments(parent string) *ProjectsLocationsSearchAssignmentsCall

SearchAssignments: Deprecated: 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. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The 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. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** "-" cannot be used for projects nor locations.

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

func (*ProjectsLocationsService) UpdateBiReservation added in v0.22.0 

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

UpdateBiReservation: Updates a BI reservation. Only fields specified in the `field_mask` are updated. A 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.

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

type ProjectsLocationsUpdateBiReservationCall added in v0.22.0 

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

func (*ProjectsLocationsUpdateBiReservationCall) Context added in v0.22.0 

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

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.22.0 

func (c *ProjectsLocationsUpdateBiReservationCall) Do(opts ...googleapi.CallOption) (*BiReservation, error)

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.22.0 

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

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.22.0 

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

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.22.0 

func (c *ProjectsLocationsUpdateBiReservationCall) UpdateMask(updateMask string) *ProjectsLocationsUpdateBiReservationCall

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

type ProjectsService added in v0.22.0 

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

func NewProjectsService added in v0.22.0 

func NewProjectsService(s *Service) *ProjectsService

type Reservation added in v0.22.0 

type Reservation struct {
	// Autoscale: The configuration parameters for the auto scaling feature.
	Autoscale *Autoscale `json:"autoscale,omitempty"`

	// 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.
	Concurrency int64 `json:"concurrency,omitempty,string"`

	// CreationTime: Output only. Creation time of the reservation.
	CreationTime string `json:"creationTime,omitempty"`

	// Edition: Edition of the reservation.
	//
	// Possible values:
	//   "EDITION_UNSPECIFIED" - Default value, which will be treated as
	// ENTERPRISE.
	//   "STANDARD" - Standard edition.
	//   "ENTERPRISE" - Enterprise edition.
	//   "ENTERPRISE_PLUS" - Enterprise plus edition.
	Edition string `json:"edition,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.
	IgnoreIdleSlots bool `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. NOTE: this is a
	// preview feature. Project must be allow-listed in order to set this
	// field.
	MultiRegionAuxiliary bool `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.
	Name string `json:"name,omitempty"`

	// OriginalPrimaryLocation: Optional. The original primary location of
	// the reservation which is set only during its creation and remains
	// unchanged afterwards. It can be used by the customer to answer
	// questions about disaster recovery billing. The field is output only
	// for customers and should not be specified, however, the
	// google.api.field_behavior is not set to OUTPUT_ONLY since these
	// fields are set in rerouted requests sent across regions.
	OriginalPrimaryLocation string `json:"originalPrimaryLocation,omitempty"`

	// PrimaryLocation: Optional. The primary location of the reservation.
	// The field is only meaningful for reservation used for cross region
	// disaster recovery. The field is output only for customers and should
	// not be specified, however, the google.api.field_behavior is not set
	// to OUTPUT_ONLY since these fields are set in rerouted requests sent
	// across regions.
	PrimaryLocation string `json:"primaryLocation,omitempty"`

	// SecondaryLocation: Optional. The secondary location of the
	// reservation which is used for cross region disaster recovery
	// purposes. Customer can set this in create/update reservation calls to
	// create a failover reservation or convert a non-failover reservation
	// to a failover reservation.
	SecondaryLocation string `json:"secondaryLocation,omitempty"`

	// SlotCapacity: Baseline 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, or autoscaling
	// is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity
	// of the reservation and its siblings exceeds the total slot_count of
	// all capacity commitments, the request will fail with
	// `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but
	// EDITION_UNSPECIFIED, then the above requirement is not needed. The
	// total slot_capacity of the reservation and its siblings may exceed
	// the total slot_count of capacity commitments. In that case, the
	// exceeding slots will be charged with the autoscale SKU. You can
	// increase the number of baseline slots in a reservation every few
	// minutes. If you want to decrease your baseline slots, you are limited
	// to once an hour if you have recently changed your baseline slot
	// capacity and your baseline slots exceed your committed slots.
	// Otherwise, you can decrease your baseline slots every few minutes.
	SlotCapacity int64 `json:"slotCapacity,omitempty,string"`

	// UpdateTime: Output only. Last update time of the 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. "Autoscale") 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. "Autoscale") 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 added in v0.22.0 

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

type SearchAllAssignmentsResponse added in v0.30.0 

type SearchAllAssignmentsResponse 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 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:"-"`
}

SearchAllAssignmentsResponse: The response for ReservationService.SearchAllAssignments.

func (*SearchAllAssignmentsResponse) MarshalJSON added in v0.30.0 

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

type SearchAssignmentsResponse added in v0.22.0 

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 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 for ReservationService.SearchAssignments.

func (*SearchAssignmentsResponse) MarshalJSON added in v0.22.0 

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 SplitCapacityCommitmentRequest added in v0.22.0 

type SplitCapacityCommitmentRequest struct {
	// SlotCount: Number of slots in the capacity commitment after the
	// split.
	SlotCount int64 `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 for ReservationService.SplitCapacityCommitment.

func (*SplitCapacityCommitmentRequest) MarshalJSON added in v0.22.0 

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

type SplitCapacityCommitmentResponse added in v0.22.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 for ReservationService.SplitCapacityCommitment.

func (*SplitCapacityCommitmentResponse) MarshalJSON added in v0.22.0 

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

type Status 

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

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

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

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty 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 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)

type TableReference added in v0.76.0 

type TableReference struct {
	// DatasetId: The ID of the dataset in the above project.
	DatasetId string `json:"datasetId,omitempty"`

	// ProjectId: The assigned project ID of the project.
	ProjectId string `json:"projectId,omitempty"`

	// TableId: The ID of the table in the above dataset.
	TableId string `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) MarshalJSON added in v0.76.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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