reservation

package
v0.0.0-...-8c6c420 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 13 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	CapacityCommitment_CommitmentPlan_name = map[int32]string{
		0: "COMMITMENT_PLAN_UNSPECIFIED",
		3: "FLEX",
		5: "TRIAL",
		2: "MONTHLY",
		4: "ANNUAL",
	}
	CapacityCommitment_CommitmentPlan_value = map[string]int32{
		"COMMITMENT_PLAN_UNSPECIFIED": 0,
		"FLEX":                        3,
		"TRIAL":                       5,
		"MONTHLY":                     2,
		"ANNUAL":                      4,
	}
)

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",
	}
	Assignment_JobType_value = map[string]int32{
		"JOB_TYPE_UNSPECIFIED": 0,
		"PIPELINE":             1,
		"QUERY":                2,
	}
)

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_v1beta1_reservation_proto protoreflect.FileDescriptor

Functions

func RegisterReservationServiceServer deprecated

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

Deprecated: Do not use.

Types

type Assignment

type Assignment struct {

	// Output only. 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"`
	// 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 `` /* 149-byte string literal not displayed */
	// Output only. State of the assignment.
	State Assignment_State `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

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"`
	// 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) 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`
	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 `` /* 143-byte string literal not displayed */
	// Output only. State of the commitment.
	State CapacityCommitment_State `` /* 136-byte string literal not displayed */
	// Output only. The end of the current commitment period. It is applicable
	// only for ACTIVE capacity commitments.
	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 commitments.
	RenewalPlan CapacityCommitment_CommitmentPlan `` /* 176-byte string literal not displayed */
	// 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) GetFailureStatus

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

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

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 parent's slot_capacity.
	CapacityCommitment_PENDING CapacityCommitment_State = 1
	// Once slots are provisioned, capacity commitment becomes active.
	// slot_count is added to the parent'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"`
	// contains filtered or unexported fields
}

The request for [ReservationService.CreateAssignment][google.cloud.bigquery.reservation.v1beta1.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) 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 */
	// contains filtered or unexported fields
}

The request for [ReservationService.CreateCapacityCommitment][google.cloud.bigquery.reservation.v1beta1.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) 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. This field must only contain lower case alphanumeric
	// characters or dash. Max length is 64 characters.
	ReservationId string `protobuf:"bytes,2,opt,name=reservation_id,json=reservationId,proto3" json:"reservation_id,omitempty"`
	// Content 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.v1beta1.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.v1beta1.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"`
	// contains filtered or unexported fields
}

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

func (*DeleteCapacityCommitmentRequest) Descriptor deprecated

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

Deprecated: Use DeleteCapacityCommitmentRequest.ProtoReflect.Descriptor instead.

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.v1beta1.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 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.v1beta1.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.v1beta1.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.
	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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.
	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"`
	// Can be used to filter out reservations based on names, capacity, etc, e.g.:
	// filter="reservation.slot_capacity > 200"
	// filter="reservation.name = \"*dev/*\""
	// Advanced filtering syntax can be
	// [here](https://cloud.google.com/logging/docs/view/advanced-filters).
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListReservationsRequest) Descriptor deprecated

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

Deprecated: Use ListReservationsRequest.ProtoReflect.Descriptor instead.

func (*ListReservationsRequest) GetFilter

func (x *ListReservationsRequest) GetFilter() string

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.v1beta1.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.
	CapacityCommitmentIds []string `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request for [ReservationService.MergeCapacityCommitments][google.cloud.bigquery.reservation.v1beta1.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"`
	// contains filtered or unexported fields
}

The request for [ReservationService.MoveAssignment][google.cloud.bigquery.reservation.v1beta1.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) 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`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Minimum slots available to this reservation. A slot is a unit of
	// computational power in BigQuery, and serves as the unit of parallelism.
	//
	// Queries using this reservation might use more slots during runtime if
	// ignore_idle_slots is set to false.
	//
	// If the new reservation's slot capacity exceed the parent's slot capacity or
	// if total slot capacity of the new reservation and its siblings exceeds the
	// parent's slot capacity, the request will fail with
	// `google.rpc.Code.RESOURCE_EXHAUSTED`.
	SlotCapacity int64 `protobuf:"varint,2,opt,name=slot_capacity,json=slotCapacity,proto3" json:"slot_capacity,omitempty"`
	// If false, any query using this reservation will use idle slots from other
	// reservations within the same admin project. If true, a query using this
	// reservation will execute with the slot capacity specified above at most.
	IgnoreIdleSlots bool `protobuf:"varint,4,opt,name=ignore_idle_slots,json=ignoreIdleSlots,proto3" json:"ignore_idle_slots,omitempty"`
	// 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) GetIgnoreIdleSlots

func (x *Reservation) GetIgnoreIdleSlots() bool

func (*Reservation) GetName

func (x *Reservation) GetName() string

func (*Reservation) GetSlotCapacity

func (x *Reservation) GetSlotCapacity() int64

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 deprecated

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)
	// 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 would change the plan of the first one to `FLEX` and then delete it.
	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.
	//
	// 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)
	// 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)
	// 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)
	// 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.

Deprecated: Do not use.

func NewReservationServiceClient deprecated

func NewReservationServiceClient(cc grpc.ClientConnInterface) ReservationServiceClient

Deprecated: Do not use.

type ReservationServiceServer deprecated

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)
	// 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 would change the plan of the first one to `FLEX` and then delete it.
	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.
	//
	// 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)
	// 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)
	// 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)
	// 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.

Deprecated: Do not use.

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.
	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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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 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) GetBiReservation

func (*UnimplementedReservationServiceServer) GetCapacityCommitment

func (*UnimplementedReservationServiceServer) GetReservation

func (*UnimplementedReservationServiceServer) ListAssignments

func (*UnimplementedReservationServiceServer) ListReservations

func (*UnimplementedReservationServiceServer) MergeCapacityCommitments

func (*UnimplementedReservationServiceServer) MoveAssignment

func (*UnimplementedReservationServiceServer) SearchAssignments

func (*UnimplementedReservationServiceServer) UpdateBiReservation

func (*UnimplementedReservationServiceServer) UpdateCapacityCommitment

func (*UnimplementedReservationServiceServer) UpdateReservation

type UpdateBiReservationRequest

type UpdateBiReservationRequest struct {

	// A reservation to update.
	Reservation *BiReservation `protobuf:"bytes,1,opt,name=reservation,proto3" json:"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) GetReservation

func (x *UpdateBiReservationRequest) GetReservation() *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.v1beta1.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.v1beta1.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