reservationpb

package
v1.65.0 Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2024 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Edition_name = map[int32]string{
		0: "EDITION_UNSPECIFIED",
		1: "STANDARD",
		2: "ENTERPRISE",
		3: "ENTERPRISE_PLUS",
	}
	Edition_value = map[string]int32{
		"EDITION_UNSPECIFIED": 0,
		"STANDARD":            1,
		"ENTERPRISE":          2,
		"ENTERPRISE_PLUS":     3,
	}
)

Enum value maps for Edition.

View Source
var (
	CapacityCommitment_CommitmentPlan_name = map[int32]string{
		0:  "COMMITMENT_PLAN_UNSPECIFIED",
		3:  "FLEX",
		7:  "FLEX_FLAT_RATE",
		5:  "TRIAL",
		2:  "MONTHLY",
		8:  "MONTHLY_FLAT_RATE",
		4:  "ANNUAL",
		9:  "ANNUAL_FLAT_RATE",
		10: "THREE_YEAR",
		6:  "NONE",
	}
	CapacityCommitment_CommitmentPlan_value = map[string]int32{
		"COMMITMENT_PLAN_UNSPECIFIED": 0,
		"FLEX":                        3,
		"FLEX_FLAT_RATE":              7,
		"TRIAL":                       5,
		"MONTHLY":                     2,
		"MONTHLY_FLAT_RATE":           8,
		"ANNUAL":                      4,
		"ANNUAL_FLAT_RATE":            9,
		"THREE_YEAR":                  10,
		"NONE":                        6,
	}
)

Enum value maps for CapacityCommitment_CommitmentPlan.

View Source
var (
	CapacityCommitment_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "ACTIVE",
		3: "FAILED",
	}
	CapacityCommitment_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"ACTIVE":            2,
		"FAILED":            3,
	}
)

Enum value maps for CapacityCommitment_State.

View Source
var (
	Assignment_JobType_name = map[int32]string{
		0: "JOB_TYPE_UNSPECIFIED",
		1: "PIPELINE",
		2: "QUERY",
		3: "ML_EXTERNAL",
		4: "BACKGROUND",
	}
	Assignment_JobType_value = map[string]int32{
		"JOB_TYPE_UNSPECIFIED": 0,
		"PIPELINE":             1,
		"QUERY":                2,
		"ML_EXTERNAL":          3,
		"BACKGROUND":           4,
	}
)

Enum value maps for Assignment_JobType.

View Source
var (
	Assignment_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING",
		2: "ACTIVE",
	}
	Assignment_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING":           1,
		"ACTIVE":            2,
	}
)

Enum value maps for Assignment_State.

View Source
var File_google_cloud_bigquery_reservation_v1_reservation_proto protoreflect.FileDescriptor

Functions

func RegisterReservationServiceServer

func RegisterReservationServiceServer(s *grpc.Server, srv ReservationServiceServer)

Types

type Assignment

type Assignment struct {

	// 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.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The resource which will use the reservation. E.g.
	// `projects/myproject`, `folders/123`, or `organizations/456`.
	Assignee string `protobuf:"bytes,4,opt,name=assignee,proto3" json:"assignee,omitempty"`
	// Which type of jobs will use the reservation.
	JobType Assignment_JobType `` /* 144-byte string literal not displayed */
	// Output only. State of the assignment.
	State Assignment_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.cloud.bigquery.reservation.v1.Assignment_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.

func (*Assignment) Descriptor deprecated

func (*Assignment) Descriptor() ([]byte, []int)

Deprecated: Use Assignment.ProtoReflect.Descriptor instead.

func (*Assignment) GetAssignee

func (x *Assignment) GetAssignee() string

func (*Assignment) GetJobType

func (x *Assignment) GetJobType() Assignment_JobType

func (*Assignment) GetName

func (x *Assignment) GetName() string

func (*Assignment) GetState

func (x *Assignment) GetState() Assignment_State

func (*Assignment) ProtoMessage

func (*Assignment) ProtoMessage()

func (*Assignment) ProtoReflect

func (x *Assignment) ProtoReflect() protoreflect.Message

func (*Assignment) Reset

func (x *Assignment) Reset()

func (*Assignment) String

func (x *Assignment) String() string

type Assignment_JobType

type Assignment_JobType int32

Types of job, which could be specified when using the reservation.

const (
	// Invalid type. Requests with this value will be rejected with
	// error code `google.rpc.Code.INVALID_ARGUMENT`.
	Assignment_JOB_TYPE_UNSPECIFIED Assignment_JobType = 0
	// Pipeline (load/export) jobs from the project will use the reservation.
	Assignment_PIPELINE Assignment_JobType = 1
	// Query jobs from the project will use the reservation.
	Assignment_QUERY Assignment_JobType = 2
	// BigQuery ML jobs that use services external to BigQuery for model
	// training. These jobs will not utilize idle slots from other reservations.
	Assignment_ML_EXTERNAL Assignment_JobType = 3
	// Background jobs that BigQuery runs for the customers in the background.
	Assignment_BACKGROUND Assignment_JobType = 4
)

func (Assignment_JobType) Descriptor

func (Assignment_JobType) Enum

func (Assignment_JobType) EnumDescriptor deprecated

func (Assignment_JobType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Assignment_JobType.Descriptor instead.

func (Assignment_JobType) Number

func (Assignment_JobType) String

func (x Assignment_JobType) String() string

func (Assignment_JobType) Type

type Assignment_State

type Assignment_State int32

Assignment will remain in PENDING state if no active capacity commitment is present. It will become ACTIVE when some capacity commitment becomes active.

const (
	// Invalid state value.
	Assignment_STATE_UNSPECIFIED Assignment_State = 0
	// Queries from assignee will be executed as on-demand, if related
	// assignment is pending.
	Assignment_PENDING Assignment_State = 1
	// Assignment is ready.
	Assignment_ACTIVE Assignment_State = 2
)

func (Assignment_State) Descriptor

func (Assignment_State) Enum

func (Assignment_State) EnumDescriptor deprecated

func (Assignment_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Assignment_State.Descriptor instead.

func (Assignment_State) Number

func (Assignment_State) String

func (x Assignment_State) String() string

func (Assignment_State) Type

type BiReservation

type BiReservation struct {

	// The resource name of the singleton BI reservation.
	// Reservation names have the form
	// `projects/{project_id}/locations/{location_id}/biReservation`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The last update timestamp of a reservation.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Size of a reservation, in bytes.
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// Preferred tables to use BI capacity for.
	PreferredTables []*TableReference `protobuf:"bytes,5,rep,name=preferred_tables,json=preferredTables,proto3" json:"preferred_tables,omitempty"`
	// contains filtered or unexported fields
}

Represents a BI Reservation.

func (*BiReservation) Descriptor deprecated

func (*BiReservation) Descriptor() ([]byte, []int)

Deprecated: Use BiReservation.ProtoReflect.Descriptor instead.

func (*BiReservation) GetName

func (x *BiReservation) GetName() string

func (*BiReservation) GetPreferredTables

func (x *BiReservation) GetPreferredTables() []*TableReference

func (*BiReservation) GetSize

func (x *BiReservation) GetSize() int64

func (*BiReservation) GetUpdateTime

func (x *BiReservation) GetUpdateTime() *timestamppb.Timestamp

func (*BiReservation) ProtoMessage

func (*BiReservation) ProtoMessage()

func (*BiReservation) ProtoReflect

func (x *BiReservation) ProtoReflect() protoreflect.Message

func (*BiReservation) Reset

func (x *BiReservation) Reset()

func (*BiReservation) String

func (x *BiReservation) String() string

type CapacityCommitment

type CapacityCommitment struct {

	// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Number of slots in this commitment.
	SlotCount int64 `protobuf:"varint,2,opt,name=slot_count,json=slotCount,proto3" json:"slot_count,omitempty"`
	// Capacity commitment commitment plan.
	Plan CapacityCommitment_CommitmentPlan `` /* 138-byte string literal not displayed */
	// Output only. State of the commitment.
	State CapacityCommitment_State `` /* 131-byte string literal not displayed */
	// Output only. The start of the current commitment period. It is applicable
	// only for ACTIVE capacity commitments. Note after the commitment is renewed,
	// commitment_start_time won't be changed. It refers to the start time of the
	// original commitment.
	CommitmentStartTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=commitment_start_time,json=commitmentStartTime,proto3" json:"commitment_start_time,omitempty"`
	// Output only. The end of the current commitment period. It is applicable
	// only for ACTIVE capacity commitments. Note after renewal,
	// commitment_end_time is the time the renewed commitment expires. So it would
	// be at a time after commitment_start_time + committed period, because we
	// don't change commitment_start_time ,
	CommitmentEndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=commitment_end_time,json=commitmentEndTime,proto3" json:"commitment_end_time,omitempty"`
	// Output only. For FAILED commitment plan, provides the reason of failure.
	FailureStatus *status.Status `protobuf:"bytes,7,opt,name=failure_status,json=failureStatus,proto3" json:"failure_status,omitempty"`
	// 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.
	RenewalPlan CapacityCommitment_CommitmentPlan `` /* 171-byte string literal not displayed */
	// 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 `protobuf:"varint,10,opt,name=multi_region_auxiliary,json=multiRegionAuxiliary,proto3" json:"multi_region_auxiliary,omitempty"`
	// Edition of the capacity commitment.
	Edition Edition `protobuf:"varint,12,opt,name=edition,proto3,enum=google.cloud.bigquery.reservation.v1.Edition" json:"edition,omitempty"`
	// Output only. If true, the commitment is a flat-rate commitment, otherwise,
	// it's an edition commitment.
	IsFlatRate bool `protobuf:"varint,14,opt,name=is_flat_rate,json=isFlatRate,proto3" json:"is_flat_rate,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CapacityCommitment) Descriptor() ([]byte, []int)

Deprecated: Use CapacityCommitment.ProtoReflect.Descriptor instead.

func (*CapacityCommitment) GetCommitmentEndTime

func (x *CapacityCommitment) GetCommitmentEndTime() *timestamppb.Timestamp

func (*CapacityCommitment) GetCommitmentStartTime

func (x *CapacityCommitment) GetCommitmentStartTime() *timestamppb.Timestamp

func (*CapacityCommitment) GetEdition added in v1.50.0

func (x *CapacityCommitment) GetEdition() Edition

func (*CapacityCommitment) GetFailureStatus

func (x *CapacityCommitment) GetFailureStatus() *status.Status

func (*CapacityCommitment) GetIsFlatRate added in v1.65.0

func (x *CapacityCommitment) GetIsFlatRate() bool

func (*CapacityCommitment) GetMultiRegionAuxiliary

func (x *CapacityCommitment) GetMultiRegionAuxiliary() bool

func (*CapacityCommitment) GetName

func (x *CapacityCommitment) GetName() string

func (*CapacityCommitment) GetPlan

func (*CapacityCommitment) GetRenewalPlan

func (*CapacityCommitment) GetSlotCount

func (x *CapacityCommitment) GetSlotCount() int64

func (*CapacityCommitment) GetState

func (*CapacityCommitment) ProtoMessage

func (*CapacityCommitment) ProtoMessage()

func (*CapacityCommitment) ProtoReflect

func (x *CapacityCommitment) ProtoReflect() protoreflect.Message

func (*CapacityCommitment) Reset

func (x *CapacityCommitment) Reset()

func (*CapacityCommitment) String

func (x *CapacityCommitment) String() string

type CapacityCommitment_CommitmentPlan

type CapacityCommitment_CommitmentPlan int32

Commitment plan defines the current committed period. Capacity commitment cannot be deleted during it's committed period.

const (
	// Invalid plan value. Requests with this value will be rejected with
	// error code `google.rpc.Code.INVALID_ARGUMENT`.
	CapacityCommitment_COMMITMENT_PLAN_UNSPECIFIED CapacityCommitment_CommitmentPlan = 0
	// 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.
	CapacityCommitment_FLEX CapacityCommitment_CommitmentPlan = 3
	// Same as FLEX, should only be used if flat-rate commitments are still
	// available.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/reservation/v1/reservation.proto.
	CapacityCommitment_FLEX_FLAT_RATE CapacityCommitment_CommitmentPlan = 7
	// 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.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/reservation/v1/reservation.proto.
	CapacityCommitment_TRIAL CapacityCommitment_CommitmentPlan = 5
	// 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.
	CapacityCommitment_MONTHLY CapacityCommitment_CommitmentPlan = 2
	// Same as MONTHLY, should only be used if flat-rate commitments are still
	// available.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/reservation/v1/reservation.proto.
	CapacityCommitment_MONTHLY_FLAT_RATE CapacityCommitment_CommitmentPlan = 8
	// 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.
	CapacityCommitment_ANNUAL CapacityCommitment_CommitmentPlan = 4
	// Same as ANNUAL, should only be used if flat-rate commitments are still
	// available.
	//
	// Deprecated: Marked as deprecated in google/cloud/bigquery/reservation/v1/reservation.proto.
	CapacityCommitment_ANNUAL_FLAT_RATE CapacityCommitment_CommitmentPlan = 9
	// 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.
	CapacityCommitment_THREE_YEAR CapacityCommitment_CommitmentPlan = 10
	// 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.
	CapacityCommitment_NONE CapacityCommitment_CommitmentPlan = 6
)

func (CapacityCommitment_CommitmentPlan) Descriptor

func (CapacityCommitment_CommitmentPlan) Enum

func (CapacityCommitment_CommitmentPlan) EnumDescriptor deprecated

func (CapacityCommitment_CommitmentPlan) EnumDescriptor() ([]byte, []int)

Deprecated: Use CapacityCommitment_CommitmentPlan.Descriptor instead.

func (CapacityCommitment_CommitmentPlan) Number

func (CapacityCommitment_CommitmentPlan) String

func (CapacityCommitment_CommitmentPlan) Type

type CapacityCommitment_State

type CapacityCommitment_State int32

Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE or FAILED.

const (
	// Invalid state value.
	CapacityCommitment_STATE_UNSPECIFIED CapacityCommitment_State = 0
	// Capacity commitment is pending provisioning. Pending capacity commitment
	// does not contribute to the project's slot_capacity.
	CapacityCommitment_PENDING CapacityCommitment_State = 1
	// Once slots are provisioned, capacity commitment becomes active.
	// slot_count is added to the project's slot_capacity.
	CapacityCommitment_ACTIVE CapacityCommitment_State = 2
	// Capacity commitment is failed to be activated by the backend.
	CapacityCommitment_FAILED CapacityCommitment_State = 3
)

func (CapacityCommitment_State) Descriptor

func (CapacityCommitment_State) Enum

func (CapacityCommitment_State) EnumDescriptor deprecated

func (CapacityCommitment_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use CapacityCommitment_State.Descriptor instead.

func (CapacityCommitment_State) Number

func (CapacityCommitment_State) String

func (x CapacityCommitment_State) String() string

func (CapacityCommitment_State) Type

type CreateAssignmentRequest

type CreateAssignmentRequest struct {

	// Required. The parent resource name of the assignment
	// E.g. `projects/myproject/locations/US/reservations/team1-prod`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Assignment resource to create.
	Assignment *Assignment `protobuf:"bytes,2,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// 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.
	AssignmentId string `protobuf:"bytes,4,opt,name=assignment_id,json=assignmentId,proto3" json:"assignment_id,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment]. Note: "bigquery.reservationAssignments.create" permission is required on the related assignee.

func (*CreateAssignmentRequest) Descriptor deprecated

func (*CreateAssignmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateAssignmentRequest.ProtoReflect.Descriptor instead.

func (*CreateAssignmentRequest) GetAssignment

func (x *CreateAssignmentRequest) GetAssignment() *Assignment

func (*CreateAssignmentRequest) GetAssignmentId

func (x *CreateAssignmentRequest) GetAssignmentId() string

func (*CreateAssignmentRequest) GetParent

func (x *CreateAssignmentRequest) GetParent() string

func (*CreateAssignmentRequest) ProtoMessage

func (*CreateAssignmentRequest) ProtoMessage()

func (*CreateAssignmentRequest) ProtoReflect

func (x *CreateAssignmentRequest) ProtoReflect() protoreflect.Message

func (*CreateAssignmentRequest) Reset

func (x *CreateAssignmentRequest) Reset()

func (*CreateAssignmentRequest) String

func (x *CreateAssignmentRequest) String() string

type CreateCapacityCommitmentRequest

type CreateCapacityCommitmentRequest struct {

	// Required. Resource name of the parent reservation. E.g.,
	//
	//	`projects/myproject/locations/US`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Content of the capacity commitment to create.
	CapacityCommitment *CapacityCommitment `protobuf:"bytes,2,opt,name=capacity_commitment,json=capacityCommitment,proto3" json:"capacity_commitment,omitempty"`
	// If true, fail the request if another project in the organization has a
	// capacity commitment.
	EnforceSingleAdminProjectPerOrg bool `` /* 163-byte string literal not displayed */
	// 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.
	CapacityCommitmentId string `protobuf:"bytes,5,opt,name=capacity_commitment_id,json=capacityCommitmentId,proto3" json:"capacity_commitment_id,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment].

func (*CreateCapacityCommitmentRequest) Descriptor deprecated

func (*CreateCapacityCommitmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateCapacityCommitmentRequest.ProtoReflect.Descriptor instead.

func (*CreateCapacityCommitmentRequest) GetCapacityCommitment

func (x *CreateCapacityCommitmentRequest) GetCapacityCommitment() *CapacityCommitment

func (*CreateCapacityCommitmentRequest) GetCapacityCommitmentId

func (x *CreateCapacityCommitmentRequest) GetCapacityCommitmentId() string

func (*CreateCapacityCommitmentRequest) GetEnforceSingleAdminProjectPerOrg

func (x *CreateCapacityCommitmentRequest) GetEnforceSingleAdminProjectPerOrg() bool

func (*CreateCapacityCommitmentRequest) GetParent

func (x *CreateCapacityCommitmentRequest) GetParent() string

func (*CreateCapacityCommitmentRequest) ProtoMessage

func (*CreateCapacityCommitmentRequest) ProtoMessage()

func (*CreateCapacityCommitmentRequest) ProtoReflect

func (*CreateCapacityCommitmentRequest) Reset

func (*CreateCapacityCommitmentRequest) String

type CreateReservationRequest

type CreateReservationRequest struct {

	// Required. Project, location. E.g.,
	// `projects/myproject/locations/US`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	ReservationId string `protobuf:"bytes,2,opt,name=reservation_id,json=reservationId,proto3" json:"reservation_id,omitempty"`
	// Definition of the new reservation to create.
	Reservation *Reservation `protobuf:"bytes,3,opt,name=reservation,proto3" json:"reservation,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.CreateReservation][google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation].

func (*CreateReservationRequest) Descriptor deprecated

func (*CreateReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateReservationRequest.ProtoReflect.Descriptor instead.

func (*CreateReservationRequest) GetParent

func (x *CreateReservationRequest) GetParent() string

func (*CreateReservationRequest) GetReservation

func (x *CreateReservationRequest) GetReservation() *Reservation

func (*CreateReservationRequest) GetReservationId

func (x *CreateReservationRequest) GetReservationId() string

func (*CreateReservationRequest) ProtoMessage

func (*CreateReservationRequest) ProtoMessage()

func (*CreateReservationRequest) ProtoReflect

func (x *CreateReservationRequest) ProtoReflect() protoreflect.Message

func (*CreateReservationRequest) Reset

func (x *CreateReservationRequest) Reset()

func (*CreateReservationRequest) String

func (x *CreateReservationRequest) String() string

type DeleteAssignmentRequest

type DeleteAssignmentRequest struct {

	// Required. Name of the resource, e.g.
	//
	//	`projects/myproject/locations/US/reservations/team1-prod/assignments/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.DeleteAssignment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment]. Note: "bigquery.reservationAssignments.delete" permission is required on the related assignee.

func (*DeleteAssignmentRequest) Descriptor deprecated

func (*DeleteAssignmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteAssignmentRequest.ProtoReflect.Descriptor instead.

func (*DeleteAssignmentRequest) GetName

func (x *DeleteAssignmentRequest) GetName() string

func (*DeleteAssignmentRequest) ProtoMessage

func (*DeleteAssignmentRequest) ProtoMessage()

func (*DeleteAssignmentRequest) ProtoReflect

func (x *DeleteAssignmentRequest) ProtoReflect() protoreflect.Message

func (*DeleteAssignmentRequest) Reset

func (x *DeleteAssignmentRequest) Reset()

func (*DeleteAssignmentRequest) String

func (x *DeleteAssignmentRequest) String() string

type DeleteCapacityCommitmentRequest

type DeleteCapacityCommitmentRequest struct {

	// Required. Resource name of the capacity commitment to delete. E.g.,
	//
	//	`projects/myproject/locations/US/capacityCommitments/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// 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.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.DeleteCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment].

func (*DeleteCapacityCommitmentRequest) Descriptor deprecated

func (*DeleteCapacityCommitmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteCapacityCommitmentRequest.ProtoReflect.Descriptor instead.

func (*DeleteCapacityCommitmentRequest) GetForce

func (x *DeleteCapacityCommitmentRequest) GetForce() bool

func (*DeleteCapacityCommitmentRequest) GetName

func (*DeleteCapacityCommitmentRequest) ProtoMessage

func (*DeleteCapacityCommitmentRequest) ProtoMessage()

func (*DeleteCapacityCommitmentRequest) ProtoReflect

func (*DeleteCapacityCommitmentRequest) Reset

func (*DeleteCapacityCommitmentRequest) String

type DeleteReservationRequest

type DeleteReservationRequest struct {

	// Required. Resource name of the reservation to retrieve. E.g.,
	//
	//	`projects/myproject/locations/US/reservations/team1-prod`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.DeleteReservation][google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation].

func (*DeleteReservationRequest) Descriptor deprecated

func (*DeleteReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteReservationRequest.ProtoReflect.Descriptor instead.

func (*DeleteReservationRequest) GetName

func (x *DeleteReservationRequest) GetName() string

func (*DeleteReservationRequest) ProtoMessage

func (*DeleteReservationRequest) ProtoMessage()

func (*DeleteReservationRequest) ProtoReflect

func (x *DeleteReservationRequest) ProtoReflect() protoreflect.Message

func (*DeleteReservationRequest) Reset

func (x *DeleteReservationRequest) Reset()

func (*DeleteReservationRequest) String

func (x *DeleteReservationRequest) String() string

type Edition added in v1.50.0

type Edition int32

The type of editions. Different features and behaviors are provided to different editions Capacity commitments and reservations are linked to editions.

const (
	// Default value, which will be treated as ENTERPRISE.
	Edition_EDITION_UNSPECIFIED Edition = 0
	// Standard edition.
	Edition_STANDARD Edition = 1
	// Enterprise edition.
	Edition_ENTERPRISE Edition = 2
	// Enterprise Plus edition.
	Edition_ENTERPRISE_PLUS Edition = 3
)

func (Edition) Descriptor added in v1.50.0

func (Edition) Descriptor() protoreflect.EnumDescriptor

func (Edition) Enum added in v1.50.0

func (x Edition) Enum() *Edition

func (Edition) EnumDescriptor deprecated added in v1.50.0

func (Edition) EnumDescriptor() ([]byte, []int)

Deprecated: Use Edition.Descriptor instead.

func (Edition) Number added in v1.50.0

func (x Edition) Number() protoreflect.EnumNumber

func (Edition) String added in v1.50.0

func (x Edition) String() string

func (Edition) Type added in v1.50.0

func (Edition) Type() protoreflect.EnumType

type FailoverReservationRequest added in v1.65.0

type FailoverReservationRequest struct {

	// Required. Resource name of the reservation to failover. E.g.,
	//
	//	`projects/myproject/locations/US/reservations/team1-prod`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for ReservationService.FailoverReservation.

func (*FailoverReservationRequest) Descriptor deprecated added in v1.65.0

func (*FailoverReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use FailoverReservationRequest.ProtoReflect.Descriptor instead.

func (*FailoverReservationRequest) GetName added in v1.65.0

func (x *FailoverReservationRequest) GetName() string

func (*FailoverReservationRequest) ProtoMessage added in v1.65.0

func (*FailoverReservationRequest) ProtoMessage()

func (*FailoverReservationRequest) ProtoReflect added in v1.65.0

func (*FailoverReservationRequest) Reset added in v1.65.0

func (x *FailoverReservationRequest) Reset()

func (*FailoverReservationRequest) String added in v1.65.0

func (x *FailoverReservationRequest) String() string

type GetBiReservationRequest

type GetBiReservationRequest struct {

	// Required. Name of the requested reservation, for example:
	// `projects/{project_id}/locations/{location_id}/biReservation`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request to get a singleton BI reservation.

func (*GetBiReservationRequest) Descriptor deprecated

func (*GetBiReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetBiReservationRequest.ProtoReflect.Descriptor instead.

func (*GetBiReservationRequest) GetName

func (x *GetBiReservationRequest) GetName() string

func (*GetBiReservationRequest) ProtoMessage

func (*GetBiReservationRequest) ProtoMessage()

func (*GetBiReservationRequest) ProtoReflect

func (x *GetBiReservationRequest) ProtoReflect() protoreflect.Message

func (*GetBiReservationRequest) Reset

func (x *GetBiReservationRequest) Reset()

func (*GetBiReservationRequest) String

func (x *GetBiReservationRequest) String() string

type GetCapacityCommitmentRequest

type GetCapacityCommitmentRequest struct {

	// Required. Resource name of the capacity commitment to retrieve. E.g.,
	//
	//	`projects/myproject/locations/US/capacityCommitments/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.GetCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment].

func (*GetCapacityCommitmentRequest) Descriptor deprecated

func (*GetCapacityCommitmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCapacityCommitmentRequest.ProtoReflect.Descriptor instead.

func (*GetCapacityCommitmentRequest) GetName

func (x *GetCapacityCommitmentRequest) GetName() string

func (*GetCapacityCommitmentRequest) ProtoMessage

func (*GetCapacityCommitmentRequest) ProtoMessage()

func (*GetCapacityCommitmentRequest) ProtoReflect

func (*GetCapacityCommitmentRequest) Reset

func (x *GetCapacityCommitmentRequest) Reset()

func (*GetCapacityCommitmentRequest) String

type GetReservationRequest

type GetReservationRequest struct {

	// Required. Resource name of the reservation to retrieve. E.g.,
	//
	//	`projects/myproject/locations/US/reservations/team1-prod`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.GetReservation][google.cloud.bigquery.reservation.v1.ReservationService.GetReservation].

func (*GetReservationRequest) Descriptor deprecated

func (*GetReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetReservationRequest.ProtoReflect.Descriptor instead.

func (*GetReservationRequest) GetName

func (x *GetReservationRequest) GetName() string

func (*GetReservationRequest) ProtoMessage

func (*GetReservationRequest) ProtoMessage()

func (*GetReservationRequest) ProtoReflect

func (x *GetReservationRequest) ProtoReflect() protoreflect.Message

func (*GetReservationRequest) Reset

func (x *GetReservationRequest) Reset()

func (*GetReservationRequest) String

func (x *GetReservationRequest) String() string

type ListAssignmentsRequest

type ListAssignmentsRequest struct {

	// Required. The parent resource name e.g.:
	//
	// `projects/myproject/locations/US/reservations/team1-prod`
	//
	// Or:
	//
	// `projects/myproject/locations/US/reservations/-`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of items to return per page.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

func (*ListAssignmentsRequest) Descriptor deprecated

func (*ListAssignmentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*ListAssignmentsRequest) GetPageSize

func (x *ListAssignmentsRequest) GetPageSize() int32

func (*ListAssignmentsRequest) GetPageToken

func (x *ListAssignmentsRequest) GetPageToken() string

func (*ListAssignmentsRequest) GetParent

func (x *ListAssignmentsRequest) GetParent() string

func (*ListAssignmentsRequest) ProtoMessage

func (*ListAssignmentsRequest) ProtoMessage()

func (*ListAssignmentsRequest) ProtoReflect

func (x *ListAssignmentsRequest) ProtoReflect() protoreflect.Message

func (*ListAssignmentsRequest) Reset

func (x *ListAssignmentsRequest) Reset()

func (*ListAssignmentsRequest) String

func (x *ListAssignmentsRequest) String() string

type ListAssignmentsResponse

type ListAssignmentsResponse struct {

	// List of assignments visible to the user.
	Assignments []*Assignment `protobuf:"bytes,1,rep,name=assignments,proto3" json:"assignments,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no
	// more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ReservationService.ListAssignments][google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments].

func (*ListAssignmentsResponse) Descriptor deprecated

func (*ListAssignmentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*ListAssignmentsResponse) GetAssignments

func (x *ListAssignmentsResponse) GetAssignments() []*Assignment

func (*ListAssignmentsResponse) GetNextPageToken

func (x *ListAssignmentsResponse) GetNextPageToken() string

func (*ListAssignmentsResponse) ProtoMessage

func (*ListAssignmentsResponse) ProtoMessage()

func (*ListAssignmentsResponse) ProtoReflect

func (x *ListAssignmentsResponse) ProtoReflect() protoreflect.Message

func (*ListAssignmentsResponse) Reset

func (x *ListAssignmentsResponse) Reset()

func (*ListAssignmentsResponse) String

func (x *ListAssignmentsResponse) String() string

type ListCapacityCommitmentsRequest

type ListCapacityCommitmentsRequest struct {

	// Required. Resource name of the parent reservation. E.g.,
	//
	//	`projects/myproject/locations/US`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of items to return.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

func (*ListCapacityCommitmentsRequest) Descriptor deprecated

func (*ListCapacityCommitmentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCapacityCommitmentsRequest.ProtoReflect.Descriptor instead.

func (*ListCapacityCommitmentsRequest) GetPageSize

func (x *ListCapacityCommitmentsRequest) GetPageSize() int32

func (*ListCapacityCommitmentsRequest) GetPageToken

func (x *ListCapacityCommitmentsRequest) GetPageToken() string

func (*ListCapacityCommitmentsRequest) GetParent

func (x *ListCapacityCommitmentsRequest) GetParent() string

func (*ListCapacityCommitmentsRequest) ProtoMessage

func (*ListCapacityCommitmentsRequest) ProtoMessage()

func (*ListCapacityCommitmentsRequest) ProtoReflect

func (*ListCapacityCommitmentsRequest) Reset

func (x *ListCapacityCommitmentsRequest) Reset()

func (*ListCapacityCommitmentsRequest) String

type ListCapacityCommitmentsResponse

type ListCapacityCommitmentsResponse struct {

	// List of capacity commitments visible to the user.
	CapacityCommitments []*CapacityCommitment `protobuf:"bytes,1,rep,name=capacity_commitments,json=capacityCommitments,proto3" json:"capacity_commitments,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no
	// more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ReservationService.ListCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments].

func (*ListCapacityCommitmentsResponse) Descriptor deprecated

func (*ListCapacityCommitmentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCapacityCommitmentsResponse.ProtoReflect.Descriptor instead.

func (*ListCapacityCommitmentsResponse) GetCapacityCommitments

func (x *ListCapacityCommitmentsResponse) GetCapacityCommitments() []*CapacityCommitment

func (*ListCapacityCommitmentsResponse) GetNextPageToken

func (x *ListCapacityCommitmentsResponse) GetNextPageToken() string

func (*ListCapacityCommitmentsResponse) ProtoMessage

func (*ListCapacityCommitmentsResponse) ProtoMessage()

func (*ListCapacityCommitmentsResponse) ProtoReflect

func (*ListCapacityCommitmentsResponse) Reset

func (*ListCapacityCommitmentsResponse) String

type ListReservationsRequest

type ListReservationsRequest struct {

	// Required. The parent resource name containing project and location, e.g.:
	//
	//	`projects/myproject/locations/US`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of items to return per page.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

func (*ListReservationsRequest) Descriptor deprecated

func (*ListReservationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListReservationsRequest.ProtoReflect.Descriptor instead.

func (*ListReservationsRequest) GetPageSize

func (x *ListReservationsRequest) GetPageSize() int32

func (*ListReservationsRequest) GetPageToken

func (x *ListReservationsRequest) GetPageToken() string

func (*ListReservationsRequest) GetParent

func (x *ListReservationsRequest) GetParent() string

func (*ListReservationsRequest) ProtoMessage

func (*ListReservationsRequest) ProtoMessage()

func (*ListReservationsRequest) ProtoReflect

func (x *ListReservationsRequest) ProtoReflect() protoreflect.Message

func (*ListReservationsRequest) Reset

func (x *ListReservationsRequest) Reset()

func (*ListReservationsRequest) String

func (x *ListReservationsRequest) String() string

type ListReservationsResponse

type ListReservationsResponse struct {

	// List of reservations visible to the user.
	Reservations []*Reservation `protobuf:"bytes,1,rep,name=reservations,proto3" json:"reservations,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no
	// more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ReservationService.ListReservations][google.cloud.bigquery.reservation.v1.ReservationService.ListReservations].

func (*ListReservationsResponse) Descriptor deprecated

func (*ListReservationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListReservationsResponse.ProtoReflect.Descriptor instead.

func (*ListReservationsResponse) GetNextPageToken

func (x *ListReservationsResponse) GetNextPageToken() string

func (*ListReservationsResponse) GetReservations

func (x *ListReservationsResponse) GetReservations() []*Reservation

func (*ListReservationsResponse) ProtoMessage

func (*ListReservationsResponse) ProtoMessage()

func (*ListReservationsResponse) ProtoReflect

func (x *ListReservationsResponse) ProtoReflect() protoreflect.Message

func (*ListReservationsResponse) Reset

func (x *ListReservationsResponse) Reset()

func (*ListReservationsResponse) String

func (x *ListReservationsResponse) String() string

type MergeCapacityCommitmentsRequest

type MergeCapacityCommitmentsRequest struct {

	// Parent resource that identifies admin project and location e.g.,
	//
	//	`projects/myproject/locations/us`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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 `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments].

func (*MergeCapacityCommitmentsRequest) Descriptor deprecated

func (*MergeCapacityCommitmentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use MergeCapacityCommitmentsRequest.ProtoReflect.Descriptor instead.

func (*MergeCapacityCommitmentsRequest) GetCapacityCommitmentIds

func (x *MergeCapacityCommitmentsRequest) GetCapacityCommitmentIds() []string

func (*MergeCapacityCommitmentsRequest) GetParent

func (x *MergeCapacityCommitmentsRequest) GetParent() string

func (*MergeCapacityCommitmentsRequest) ProtoMessage

func (*MergeCapacityCommitmentsRequest) ProtoMessage()

func (*MergeCapacityCommitmentsRequest) ProtoReflect

func (*MergeCapacityCommitmentsRequest) Reset

func (*MergeCapacityCommitmentsRequest) String

type MoveAssignmentRequest

type MoveAssignmentRequest struct {

	// Required. The resource name of the assignment,
	// e.g.
	// `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The new reservation ID, e.g.:
	//
	//	`projects/myotherproject/locations/US/reservations/team2-prod`
	DestinationId string `protobuf:"bytes,3,opt,name=destination_id,json=destinationId,proto3" json:"destination_id,omitempty"`
	// 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 `protobuf:"bytes,5,opt,name=assignment_id,json=assignmentId,proto3" json:"assignment_id,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1.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) Descriptor deprecated

func (*MoveAssignmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use MoveAssignmentRequest.ProtoReflect.Descriptor instead.

func (*MoveAssignmentRequest) GetAssignmentId added in v1.50.0

func (x *MoveAssignmentRequest) GetAssignmentId() string

func (*MoveAssignmentRequest) GetDestinationId

func (x *MoveAssignmentRequest) GetDestinationId() string

func (*MoveAssignmentRequest) GetName

func (x *MoveAssignmentRequest) GetName() string

func (*MoveAssignmentRequest) ProtoMessage

func (*MoveAssignmentRequest) ProtoMessage()

func (*MoveAssignmentRequest) ProtoReflect

func (x *MoveAssignmentRequest) ProtoReflect() protoreflect.Message

func (*MoveAssignmentRequest) Reset

func (x *MoveAssignmentRequest) Reset()

func (*MoveAssignmentRequest) String

func (x *MoveAssignmentRequest) String() string

type Reservation

type Reservation struct {

	// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// 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 `protobuf:"varint,2,opt,name=slot_capacity,json=slotCapacity,proto3" json:"slot_capacity,omitempty"`
	// 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 `protobuf:"varint,4,opt,name=ignore_idle_slots,json=ignoreIdleSlots,proto3" json:"ignore_idle_slots,omitempty"`
	// The configuration parameters for the auto scaling feature.
	Autoscale *Reservation_Autoscale `protobuf:"bytes,7,opt,name=autoscale,proto3" json:"autoscale,omitempty"`
	// 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 BigQuery CLI.
	Concurrency int64 `protobuf:"varint,16,opt,name=concurrency,proto3" json:"concurrency,omitempty"`
	// Output only. Creation time of the reservation.
	CreationTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
	// Output only. Last update time of the reservation.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// 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 `protobuf:"varint,14,opt,name=multi_region_auxiliary,json=multiRegionAuxiliary,proto3" json:"multi_region_auxiliary,omitempty"`
	// Edition of the reservation.
	Edition Edition `protobuf:"varint,17,opt,name=edition,proto3,enum=google.cloud.bigquery.reservation.v1.Edition" json:"edition,omitempty"`
	// Optional. The current location of the reservation's primary replica. This
	// field is only set for reservations using the managed disaster recovery
	// feature.
	PrimaryLocation string `protobuf:"bytes,18,opt,name=primary_location,json=primaryLocation,proto3" json:"primary_location,omitempty"`
	// Optional. The current location of the reservation's secondary replica. This
	// field is only set for reservations using the managed disaster recovery
	// feature. Users can set this in create reservation calls
	// to create a failover reservation or in update reservation calls to convert
	// a non-failover reservation to a failover reservation(or vice versa).
	SecondaryLocation string `protobuf:"bytes,19,opt,name=secondary_location,json=secondaryLocation,proto3" json:"secondary_location,omitempty"`
	// Optional. The location where the reservation was originally created. This
	// is set only during the failover reservation's creation. All billing charges
	// for the failover reservation will be applied to this location.
	OriginalPrimaryLocation string `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*Reservation) Descriptor deprecated

func (*Reservation) Descriptor() ([]byte, []int)

Deprecated: Use Reservation.ProtoReflect.Descriptor instead.

func (*Reservation) GetAutoscale added in v1.50.0

func (x *Reservation) GetAutoscale() *Reservation_Autoscale

func (*Reservation) GetConcurrency

func (x *Reservation) GetConcurrency() int64

func (*Reservation) GetCreationTime

func (x *Reservation) GetCreationTime() *timestamppb.Timestamp

func (*Reservation) GetEdition added in v1.50.0

func (x *Reservation) GetEdition() Edition

func (*Reservation) GetIgnoreIdleSlots

func (x *Reservation) GetIgnoreIdleSlots() bool

func (*Reservation) GetMultiRegionAuxiliary

func (x *Reservation) GetMultiRegionAuxiliary() bool

func (*Reservation) GetName

func (x *Reservation) GetName() string

func (*Reservation) GetOriginalPrimaryLocation added in v1.65.0

func (x *Reservation) GetOriginalPrimaryLocation() string

func (*Reservation) GetPrimaryLocation added in v1.65.0

func (x *Reservation) GetPrimaryLocation() string

func (*Reservation) GetSecondaryLocation added in v1.65.0

func (x *Reservation) GetSecondaryLocation() string

func (*Reservation) GetSlotCapacity

func (x *Reservation) GetSlotCapacity() int64

func (*Reservation) GetUpdateTime

func (x *Reservation) GetUpdateTime() *timestamppb.Timestamp

func (*Reservation) ProtoMessage

func (*Reservation) ProtoMessage()

func (*Reservation) ProtoReflect

func (x *Reservation) ProtoReflect() protoreflect.Message

func (*Reservation) Reset

func (x *Reservation) Reset()

func (*Reservation) String

func (x *Reservation) String() string

type ReservationServiceClient

type ReservationServiceClient interface {
	// Creates a new reservation resource.
	CreateReservation(ctx context.Context, in *CreateReservationRequest, opts ...grpc.CallOption) (*Reservation, error)
	// Lists all the reservations for the project in the specified location.
	ListReservations(ctx context.Context, in *ListReservationsRequest, opts ...grpc.CallOption) (*ListReservationsResponse, error)
	// Returns information about the reservation.
	GetReservation(ctx context.Context, in *GetReservationRequest, opts ...grpc.CallOption) (*Reservation, error)
	// Deletes a reservation.
	// Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has
	// assignments.
	DeleteReservation(ctx context.Context, in *DeleteReservationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates an existing reservation resource.
	UpdateReservation(ctx context.Context, in *UpdateReservationRequest, opts ...grpc.CallOption) (*Reservation, error)
	// Fail over 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`.
	FailoverReservation(ctx context.Context, in *FailoverReservationRequest, opts ...grpc.CallOption) (*Reservation, error)
	// Creates a new capacity commitment resource.
	CreateCapacityCommitment(ctx context.Context, in *CreateCapacityCommitmentRequest, opts ...grpc.CallOption) (*CapacityCommitment, error)
	// Lists all the capacity commitments for the admin project.
	ListCapacityCommitments(ctx context.Context, in *ListCapacityCommitmentsRequest, opts ...grpc.CallOption) (*ListCapacityCommitmentsResponse, error)
	// Returns information about the capacity commitment.
	GetCapacityCommitment(ctx context.Context, in *GetCapacityCommitmentRequest, opts ...grpc.CallOption) (*CapacityCommitment, error)
	// 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`.
	DeleteCapacityCommitment(ctx context.Context, in *DeleteCapacityCommitmentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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`.
	UpdateCapacityCommitment(ctx context.Context, in *UpdateCapacityCommitmentRequest, opts ...grpc.CallOption) (*CapacityCommitment, error)
	// 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.
	SplitCapacityCommitment(ctx context.Context, in *SplitCapacityCommitmentRequest, opts ...grpc.CallOption) (*SplitCapacityCommitmentResponse, error)
	// 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`.
	MergeCapacityCommitments(ctx context.Context, in *MergeCapacityCommitmentsRequest, opts ...grpc.CallOption) (*CapacityCommitment, error)
	// 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.
	CreateAssignment(ctx context.Context, in *CreateAssignmentRequest, opts ...grpc.CallOption) (*Assignment, error)
	// 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: `<organizationA, res1>`
	//     and `<project1, res1>`
	//
	// 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.
	ListAssignments(ctx context.Context, in *ListAssignmentsRequest, opts ...grpc.CallOption) (*ListAssignmentsResponse, error)
	// 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: `<organizationA, res1>`
	//     and `<project1, res1>`
	//
	// In this example, deletion of the `<organizationA, res1>` assignment won't
	// affect the other assignment `<project1, res1>`. After said deletion,
	// queries from `project1` will still use `res1` while queries from
	// `project2` will switch to use on-demand mode.
	DeleteAssignment(ctx context.Context, in *DeleteAssignmentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deprecated: Do not use.
	// 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.
	SearchAssignments(ctx context.Context, in *SearchAssignmentsRequest, opts ...grpc.CallOption) (*SearchAssignmentsResponse, error)
	// 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/*`.
	SearchAllAssignments(ctx context.Context, in *SearchAllAssignmentsRequest, opts ...grpc.CallOption) (*SearchAllAssignmentsResponse, error)
	// 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.
	MoveAssignment(ctx context.Context, in *MoveAssignmentRequest, opts ...grpc.CallOption) (*Assignment, error)
	// Updates an existing assignment.
	//
	// Only the `priority` field can be updated.
	UpdateAssignment(ctx context.Context, in *UpdateAssignmentRequest, opts ...grpc.CallOption) (*Assignment, error)
	// Retrieves a BI reservation.
	GetBiReservation(ctx context.Context, in *GetBiReservationRequest, opts ...grpc.CallOption) (*BiReservation, error)
	// 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.
	UpdateBiReservation(ctx context.Context, in *UpdateBiReservationRequest, opts ...grpc.CallOption) (*BiReservation, error)
}

ReservationServiceClient is the client API for ReservationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type ReservationServiceServer

type ReservationServiceServer interface {
	// Creates a new reservation resource.
	CreateReservation(context.Context, *CreateReservationRequest) (*Reservation, error)
	// Lists all the reservations for the project in the specified location.
	ListReservations(context.Context, *ListReservationsRequest) (*ListReservationsResponse, error)
	// Returns information about the reservation.
	GetReservation(context.Context, *GetReservationRequest) (*Reservation, error)
	// Deletes a reservation.
	// Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has
	// assignments.
	DeleteReservation(context.Context, *DeleteReservationRequest) (*emptypb.Empty, error)
	// Updates an existing reservation resource.
	UpdateReservation(context.Context, *UpdateReservationRequest) (*Reservation, error)
	// Fail over 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`.
	FailoverReservation(context.Context, *FailoverReservationRequest) (*Reservation, error)
	// Creates a new capacity commitment resource.
	CreateCapacityCommitment(context.Context, *CreateCapacityCommitmentRequest) (*CapacityCommitment, error)
	// Lists all the capacity commitments for the admin project.
	ListCapacityCommitments(context.Context, *ListCapacityCommitmentsRequest) (*ListCapacityCommitmentsResponse, error)
	// Returns information about the capacity commitment.
	GetCapacityCommitment(context.Context, *GetCapacityCommitmentRequest) (*CapacityCommitment, error)
	// 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`.
	DeleteCapacityCommitment(context.Context, *DeleteCapacityCommitmentRequest) (*emptypb.Empty, error)
	// 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`.
	UpdateCapacityCommitment(context.Context, *UpdateCapacityCommitmentRequest) (*CapacityCommitment, error)
	// 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.
	SplitCapacityCommitment(context.Context, *SplitCapacityCommitmentRequest) (*SplitCapacityCommitmentResponse, error)
	// 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`.
	MergeCapacityCommitments(context.Context, *MergeCapacityCommitmentsRequest) (*CapacityCommitment, error)
	// 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.
	CreateAssignment(context.Context, *CreateAssignmentRequest) (*Assignment, error)
	// 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: `<organizationA, res1>`
	//     and `<project1, res1>`
	//
	// 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.
	ListAssignments(context.Context, *ListAssignmentsRequest) (*ListAssignmentsResponse, error)
	// 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: `<organizationA, res1>`
	//     and `<project1, res1>`
	//
	// In this example, deletion of the `<organizationA, res1>` assignment won't
	// affect the other assignment `<project1, res1>`. After said deletion,
	// queries from `project1` will still use `res1` while queries from
	// `project2` will switch to use on-demand mode.
	DeleteAssignment(context.Context, *DeleteAssignmentRequest) (*emptypb.Empty, error)
	// Deprecated: Do not use.
	// 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.
	SearchAssignments(context.Context, *SearchAssignmentsRequest) (*SearchAssignmentsResponse, error)
	// 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/*`.
	SearchAllAssignments(context.Context, *SearchAllAssignmentsRequest) (*SearchAllAssignmentsResponse, error)
	// 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.
	MoveAssignment(context.Context, *MoveAssignmentRequest) (*Assignment, error)
	// Updates an existing assignment.
	//
	// Only the `priority` field can be updated.
	UpdateAssignment(context.Context, *UpdateAssignmentRequest) (*Assignment, error)
	// Retrieves a BI reservation.
	GetBiReservation(context.Context, *GetBiReservationRequest) (*BiReservation, error)
	// 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.
	UpdateBiReservation(context.Context, *UpdateBiReservationRequest) (*BiReservation, error)
}

ReservationServiceServer is the server API for ReservationService service.

type Reservation_Autoscale added in v1.50.0

type Reservation_Autoscale struct {

	// Output only. The slot capacity added to this reservation when autoscale
	// happens. Will be between [0, max_slots]. Note: after users reduce
	// max_slots, it may take a while before it can be propagated, so
	// current_slots may stay in the original value and could be larger than
	// max_slots for that brief period (less than one minute)
	CurrentSlots int64 `protobuf:"varint,1,opt,name=current_slots,json=currentSlots,proto3" json:"current_slots,omitempty"`
	// Number of slots to be scaled when needed.
	MaxSlots int64 `protobuf:"varint,2,opt,name=max_slots,json=maxSlots,proto3" json:"max_slots,omitempty"`
	// contains filtered or unexported fields
}

Auto scaling settings.

func (*Reservation_Autoscale) Descriptor deprecated added in v1.50.0

func (*Reservation_Autoscale) Descriptor() ([]byte, []int)

Deprecated: Use Reservation_Autoscale.ProtoReflect.Descriptor instead.

func (*Reservation_Autoscale) GetCurrentSlots added in v1.50.0

func (x *Reservation_Autoscale) GetCurrentSlots() int64

func (*Reservation_Autoscale) GetMaxSlots added in v1.50.0

func (x *Reservation_Autoscale) GetMaxSlots() int64

func (*Reservation_Autoscale) ProtoMessage added in v1.50.0

func (*Reservation_Autoscale) ProtoMessage()

func (*Reservation_Autoscale) ProtoReflect added in v1.50.0

func (x *Reservation_Autoscale) ProtoReflect() protoreflect.Message

func (*Reservation_Autoscale) Reset added in v1.50.0

func (x *Reservation_Autoscale) Reset()

func (*Reservation_Autoscale) String added in v1.50.0

func (x *Reservation_Autoscale) String() string

type SearchAllAssignmentsRequest

type SearchAllAssignmentsRequest struct {

	// Required. The resource name with location (project name could be the
	// wildcard '-'), e.g.:
	//
	//	`projects/-/locations/US`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Please specify resource name as assignee in the query.
	//
	// Examples:
	//
	// * `assignee=projects/myproject`
	// * `assignee=folders/123`
	// * `assignee=organizations/456`
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The maximum number of items to return per page.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

func (*SearchAllAssignmentsRequest) Descriptor deprecated

func (*SearchAllAssignmentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchAllAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*SearchAllAssignmentsRequest) GetPageSize

func (x *SearchAllAssignmentsRequest) GetPageSize() int32

func (*SearchAllAssignmentsRequest) GetPageToken

func (x *SearchAllAssignmentsRequest) GetPageToken() string

func (*SearchAllAssignmentsRequest) GetParent

func (x *SearchAllAssignmentsRequest) GetParent() string

func (*SearchAllAssignmentsRequest) GetQuery

func (x *SearchAllAssignmentsRequest) GetQuery() string

func (*SearchAllAssignmentsRequest) ProtoMessage

func (*SearchAllAssignmentsRequest) ProtoMessage()

func (*SearchAllAssignmentsRequest) ProtoReflect

func (*SearchAllAssignmentsRequest) Reset

func (x *SearchAllAssignmentsRequest) Reset()

func (*SearchAllAssignmentsRequest) String

func (x *SearchAllAssignmentsRequest) String() string

type SearchAllAssignmentsResponse

type SearchAllAssignmentsResponse struct {

	// List of assignments visible to the user.
	Assignments []*Assignment `protobuf:"bytes,1,rep,name=assignments,proto3" json:"assignments,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no
	// more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ReservationService.SearchAllAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments].

func (*SearchAllAssignmentsResponse) Descriptor deprecated

func (*SearchAllAssignmentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchAllAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*SearchAllAssignmentsResponse) GetAssignments

func (x *SearchAllAssignmentsResponse) GetAssignments() []*Assignment

func (*SearchAllAssignmentsResponse) GetNextPageToken

func (x *SearchAllAssignmentsResponse) GetNextPageToken() string

func (*SearchAllAssignmentsResponse) ProtoMessage

func (*SearchAllAssignmentsResponse) ProtoMessage()

func (*SearchAllAssignmentsResponse) ProtoReflect

func (*SearchAllAssignmentsResponse) Reset

func (x *SearchAllAssignmentsResponse) Reset()

func (*SearchAllAssignmentsResponse) String

type SearchAssignmentsRequest

type SearchAssignmentsRequest struct {

	// Required. The resource name of the admin project(containing project and
	// location), e.g.:
	//
	//	`projects/myproject/locations/US`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Please specify resource name as assignee in the query.
	//
	// Examples:
	//
	// * `assignee=projects/myproject`
	// * `assignee=folders/123`
	// * `assignee=organizations/456`
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// The maximum number of items to return per page.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments]. Note: "bigquery.reservationAssignments.search" permission is required on the related assignee.

func (*SearchAssignmentsRequest) Descriptor deprecated

func (*SearchAssignmentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchAssignmentsRequest.ProtoReflect.Descriptor instead.

func (*SearchAssignmentsRequest) GetPageSize

func (x *SearchAssignmentsRequest) GetPageSize() int32

func (*SearchAssignmentsRequest) GetPageToken

func (x *SearchAssignmentsRequest) GetPageToken() string

func (*SearchAssignmentsRequest) GetParent

func (x *SearchAssignmentsRequest) GetParent() string

func (*SearchAssignmentsRequest) GetQuery

func (x *SearchAssignmentsRequest) GetQuery() string

func (*SearchAssignmentsRequest) ProtoMessage

func (*SearchAssignmentsRequest) ProtoMessage()

func (*SearchAssignmentsRequest) ProtoReflect

func (x *SearchAssignmentsRequest) ProtoReflect() protoreflect.Message

func (*SearchAssignmentsRequest) Reset

func (x *SearchAssignmentsRequest) Reset()

func (*SearchAssignmentsRequest) String

func (x *SearchAssignmentsRequest) String() string

type SearchAssignmentsResponse

type SearchAssignmentsResponse struct {

	// List of assignments visible to the user.
	Assignments []*Assignment `protobuf:"bytes,1,rep,name=assignments,proto3" json:"assignments,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no
	// more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ReservationService.SearchAssignments][google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments].

func (*SearchAssignmentsResponse) Descriptor deprecated

func (*SearchAssignmentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchAssignmentsResponse.ProtoReflect.Descriptor instead.

func (*SearchAssignmentsResponse) GetAssignments

func (x *SearchAssignmentsResponse) GetAssignments() []*Assignment

func (*SearchAssignmentsResponse) GetNextPageToken

func (x *SearchAssignmentsResponse) GetNextPageToken() string

func (*SearchAssignmentsResponse) ProtoMessage

func (*SearchAssignmentsResponse) ProtoMessage()

func (*SearchAssignmentsResponse) ProtoReflect

func (*SearchAssignmentsResponse) Reset

func (x *SearchAssignmentsResponse) Reset()

func (*SearchAssignmentsResponse) String

func (x *SearchAssignmentsResponse) String() string

type SplitCapacityCommitmentRequest

type SplitCapacityCommitmentRequest struct {

	// Required. The resource name e.g.,:
	//
	//	`projects/myproject/locations/US/capacityCommitments/123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Number of slots in the capacity commitment after the split.
	SlotCount int64 `protobuf:"varint,2,opt,name=slot_count,json=slotCount,proto3" json:"slot_count,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

func (*SplitCapacityCommitmentRequest) Descriptor deprecated

func (*SplitCapacityCommitmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use SplitCapacityCommitmentRequest.ProtoReflect.Descriptor instead.

func (*SplitCapacityCommitmentRequest) GetName

func (*SplitCapacityCommitmentRequest) GetSlotCount

func (x *SplitCapacityCommitmentRequest) GetSlotCount() int64

func (*SplitCapacityCommitmentRequest) ProtoMessage

func (*SplitCapacityCommitmentRequest) ProtoMessage()

func (*SplitCapacityCommitmentRequest) ProtoReflect

func (*SplitCapacityCommitmentRequest) Reset

func (x *SplitCapacityCommitmentRequest) Reset()

func (*SplitCapacityCommitmentRequest) String

type SplitCapacityCommitmentResponse

type SplitCapacityCommitmentResponse struct {

	// First capacity commitment, result of a split.
	First *CapacityCommitment `protobuf:"bytes,1,opt,name=first,proto3" json:"first,omitempty"`
	// Second capacity commitment, result of a split.
	Second *CapacityCommitment `protobuf:"bytes,2,opt,name=second,proto3" json:"second,omitempty"`
	// contains filtered or unexported fields
}

The response for [ReservationService.SplitCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment].

func (*SplitCapacityCommitmentResponse) Descriptor deprecated

func (*SplitCapacityCommitmentResponse) Descriptor() ([]byte, []int)

Deprecated: Use SplitCapacityCommitmentResponse.ProtoReflect.Descriptor instead.

func (*SplitCapacityCommitmentResponse) GetFirst

func (*SplitCapacityCommitmentResponse) GetSecond

func (*SplitCapacityCommitmentResponse) ProtoMessage

func (*SplitCapacityCommitmentResponse) ProtoMessage()

func (*SplitCapacityCommitmentResponse) ProtoReflect

func (*SplitCapacityCommitmentResponse) Reset

func (*SplitCapacityCommitmentResponse) String

type TableReference

type TableReference struct {

	// The assigned project ID of the project.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The ID of the dataset in the above project.
	DatasetId string `protobuf:"bytes,2,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// The ID of the table in the above dataset.
	TableId string `protobuf:"bytes,3,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*TableReference) Descriptor deprecated

func (*TableReference) Descriptor() ([]byte, []int)

Deprecated: Use TableReference.ProtoReflect.Descriptor instead.

func (*TableReference) GetDatasetId

func (x *TableReference) GetDatasetId() string

func (*TableReference) GetProjectId

func (x *TableReference) GetProjectId() string

func (*TableReference) GetTableId

func (x *TableReference) GetTableId() string

func (*TableReference) ProtoMessage

func (*TableReference) ProtoMessage()

func (*TableReference) ProtoReflect

func (x *TableReference) ProtoReflect() protoreflect.Message

func (*TableReference) Reset

func (x *TableReference) Reset()

func (*TableReference) String

func (x *TableReference) String() string

type UnimplementedReservationServiceServer

type UnimplementedReservationServiceServer struct {
}

UnimplementedReservationServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedReservationServiceServer) CreateAssignment

func (*UnimplementedReservationServiceServer) CreateCapacityCommitment

func (*UnimplementedReservationServiceServer) CreateReservation

func (*UnimplementedReservationServiceServer) DeleteAssignment

func (*UnimplementedReservationServiceServer) DeleteCapacityCommitment

func (*UnimplementedReservationServiceServer) DeleteReservation

func (*UnimplementedReservationServiceServer) FailoverReservation added in v1.65.0

func (*UnimplementedReservationServiceServer) GetBiReservation

func (*UnimplementedReservationServiceServer) GetCapacityCommitment

func (*UnimplementedReservationServiceServer) GetReservation

func (*UnimplementedReservationServiceServer) ListAssignments

func (*UnimplementedReservationServiceServer) ListReservations

func (*UnimplementedReservationServiceServer) MergeCapacityCommitments

func (*UnimplementedReservationServiceServer) MoveAssignment

func (*UnimplementedReservationServiceServer) SearchAllAssignments

func (*UnimplementedReservationServiceServer) SearchAssignments

func (*UnimplementedReservationServiceServer) UpdateAssignment

func (*UnimplementedReservationServiceServer) UpdateBiReservation

func (*UnimplementedReservationServiceServer) UpdateCapacityCommitment

func (*UnimplementedReservationServiceServer) UpdateReservation

type UpdateAssignmentRequest

type UpdateAssignmentRequest struct {

	// Content of the assignment to update.
	Assignment *Assignment `protobuf:"bytes,1,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// Standard field mask for the set of fields to be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.UpdateAssignment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment].

func (*UpdateAssignmentRequest) Descriptor deprecated

func (*UpdateAssignmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateAssignmentRequest.ProtoReflect.Descriptor instead.

func (*UpdateAssignmentRequest) GetAssignment

func (x *UpdateAssignmentRequest) GetAssignment() *Assignment

func (*UpdateAssignmentRequest) GetUpdateMask

func (x *UpdateAssignmentRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateAssignmentRequest) ProtoMessage

func (*UpdateAssignmentRequest) ProtoMessage()

func (*UpdateAssignmentRequest) ProtoReflect

func (x *UpdateAssignmentRequest) ProtoReflect() protoreflect.Message

func (*UpdateAssignmentRequest) Reset

func (x *UpdateAssignmentRequest) Reset()

func (*UpdateAssignmentRequest) String

func (x *UpdateAssignmentRequest) String() string

type UpdateBiReservationRequest

type UpdateBiReservationRequest struct {

	// A reservation to update.
	BiReservation *BiReservation `protobuf:"bytes,1,opt,name=bi_reservation,json=biReservation,proto3" json:"bi_reservation,omitempty"`
	// A list of fields to be updated in this request.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

A request to update a BI reservation.

func (*UpdateBiReservationRequest) Descriptor deprecated

func (*UpdateBiReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateBiReservationRequest.ProtoReflect.Descriptor instead.

func (*UpdateBiReservationRequest) GetBiReservation

func (x *UpdateBiReservationRequest) GetBiReservation() *BiReservation

func (*UpdateBiReservationRequest) GetUpdateMask

func (x *UpdateBiReservationRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateBiReservationRequest) ProtoMessage

func (*UpdateBiReservationRequest) ProtoMessage()

func (*UpdateBiReservationRequest) ProtoReflect

func (*UpdateBiReservationRequest) Reset

func (x *UpdateBiReservationRequest) Reset()

func (*UpdateBiReservationRequest) String

func (x *UpdateBiReservationRequest) String() string

type UpdateCapacityCommitmentRequest

type UpdateCapacityCommitmentRequest struct {

	// Content of the capacity commitment to update.
	CapacityCommitment *CapacityCommitment `protobuf:"bytes,1,opt,name=capacity_commitment,json=capacityCommitment,proto3" json:"capacity_commitment,omitempty"`
	// Standard field mask for the set of fields to be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.UpdateCapacityCommitment][google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment].

func (*UpdateCapacityCommitmentRequest) Descriptor deprecated

func (*UpdateCapacityCommitmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateCapacityCommitmentRequest.ProtoReflect.Descriptor instead.

func (*UpdateCapacityCommitmentRequest) GetCapacityCommitment

func (x *UpdateCapacityCommitmentRequest) GetCapacityCommitment() *CapacityCommitment

func (*UpdateCapacityCommitmentRequest) GetUpdateMask

func (*UpdateCapacityCommitmentRequest) ProtoMessage

func (*UpdateCapacityCommitmentRequest) ProtoMessage()

func (*UpdateCapacityCommitmentRequest) ProtoReflect

func (*UpdateCapacityCommitmentRequest) Reset

func (*UpdateCapacityCommitmentRequest) String

type UpdateReservationRequest

type UpdateReservationRequest struct {

	// Content of the reservation to update.
	Reservation *Reservation `protobuf:"bytes,1,opt,name=reservation,proto3" json:"reservation,omitempty"`
	// Standard field mask for the set of fields to be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [ReservationService.UpdateReservation][google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation].

func (*UpdateReservationRequest) Descriptor deprecated

func (*UpdateReservationRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateReservationRequest.ProtoReflect.Descriptor instead.

func (*UpdateReservationRequest) GetReservation

func (x *UpdateReservationRequest) GetReservation() *Reservation

func (*UpdateReservationRequest) GetUpdateMask

func (x *UpdateReservationRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateReservationRequest) ProtoMessage

func (*UpdateReservationRequest) ProtoMessage()

func (*UpdateReservationRequest) ProtoReflect

func (x *UpdateReservationRequest) ProtoReflect() protoreflect.Message

func (*UpdateReservationRequest) Reset

func (x *UpdateReservationRequest) Reset()

func (*UpdateReservationRequest) String

func (x *UpdateReservationRequest) String() string

Jump to

Keyboard shortcuts

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