As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Bigquery Reservation v1 API

class google.cloud.bigquery_reservation_v1.types.Assignment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

assignee

The resource which will use the reservation. E.g. projects/myproject, folders/123, or organizations/456.

Type

str

job_type

Which type of jobs will use the reservation.

Type

google.cloud.bigquery_reservation_v1.types.Assignment.JobType

state

Output only. State of the assignment.

Type

google.cloud.bigquery_reservation_v1.types.Assignment.State

class JobType(value)

Bases: proto.enums.Enum

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

Values:

JOB_TYPE_UNSPECIFIED (0):

Invalid type. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT.

PIPELINE (1):

Pipeline (load/export) jobs from the project will use the reservation.

QUERY (2):

Query jobs from the project will use the reservation.

ML_EXTERNAL (3):

BigQuery ML jobs that use services external to BigQuery for model training. These jobs will not utilize idle slots from other reservations.

BACKGROUND (4):

Background jobs that BigQuery runs for the customers in the background.

class State(value)

Bases: proto.enums.Enum

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

Values:

STATE_UNSPECIFIED (0):

Invalid state value.

PENDING (1):

Queries from assignee will be executed as on-demand, if related assignment is pending.

ACTIVE (2):

Assignment is ready.

class google.cloud.bigquery_reservation_v1.types.BiReservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a BI Reservation.

name

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

Type

str

update_time

Output only. The last update timestamp of a reservation.

Type

google.protobuf.timestamp_pb2.Timestamp

size

Size of a reservation, in bytes.

Type

int

preferred_tables

Preferred tables to use BI capacity for.

Type

MutableSequence[google.cloud.bigquery_reservation_v1.types.TableReference]

class google.cloud.bigquery_reservation_v1.types.CapacityCommitment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

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

Type

str

slot_count

Number of slots in this commitment.

Type

int

plan

Capacity commitment commitment plan.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan

state

Output only. State of the commitment.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment.State

commitment_start_time

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

Type

google.protobuf.timestamp_pb2.Timestamp

commitment_end_time

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

Type

google.protobuf.timestamp_pb2.Timestamp

failure_status

Output only. For FAILED commitment plan, provides the reason of failure.

Type

google.rpc.status_pb2.Status

renewal_plan

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.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment.CommitmentPlan

multi_region_auxiliary

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.

Type

bool

edition

Edition of the capacity commitment.

Type

google.cloud.bigquery_reservation_v1.types.Edition

class CommitmentPlan(value)

Bases: proto.enums.Enum

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

Values:

COMMITMENT_PLAN_UNSPECIFIED (0):

Invalid plan value. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT.

FLEX (3):

Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.

FLEX_FLAT_RATE (7):

Same as FLEX, should only be used if flat-rate commitments are still available.

TRIAL (5):

Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the renewal_plan. Default renewal_plan for Trial commitment is Flex so that it can be deleted right after committed period ends.

MONTHLY (2):

Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.

MONTHLY_FLAT_RATE (8):

Same as MONTHLY, should only be used if flat-rate commitments are still available.

ANNUAL (4):

Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.

ANNUAL_FLAT_RATE (9):

Same as ANNUAL, should only be used if flat-rate commitments are still available.

THREE_YEAR (10):

3-year commitments have a committed period of 1095(3 * 365) days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.

NONE (6):

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.

class State(value)

Bases: proto.enums.Enum

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

Values:

STATE_UNSPECIFIED (0):

Invalid state value.

PENDING (1):

Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the project’s slot_capacity.

ACTIVE (2):

Once slots are provisioned, capacity commitment becomes active. slot_count is added to the project’s slot_capacity.

FAILED (3):

Capacity commitment is failed to be activated by the backend.

class google.cloud.bigquery_reservation_v1.types.CreateAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

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

Type

str

assignment

Assignment resource to create.

Type

google.cloud.bigquery_reservation_v1.types.Assignment

assignment_id

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.

Type

str

class google.cloud.bigquery_reservation_v1.types.CreateCapacityCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Type

str

capacity_commitment

Content of the capacity commitment to create.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment

enforce_single_admin_project_per_org

If true, fail the request if another project in the organization has a capacity commitment.

Type

bool

capacity_commitment_id

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.

Type

str

class google.cloud.bigquery_reservation_v1.types.CreateReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

Required. Project, location. E.g., projects/myproject/locations/US

Type

str

reservation_id

The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.

Type

str

reservation

Definition of the new reservation to create.

Type

google.cloud.bigquery_reservation_v1.types.Reservation

class google.cloud.bigquery_reservation_v1.types.DeleteAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Required. Name of the resource, e.g. projects/myproject/locations/US/reservations/team1-prod/assignments/123

Type

str

class google.cloud.bigquery_reservation_v1.types.DeleteCapacityCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

force

Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.

Type

bool

class google.cloud.bigquery_reservation_v1.types.DeleteReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

class google.cloud.bigquery_reservation_v1.types.Edition(value)

Bases: proto.enums.Enum

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

Values:

EDITION_UNSPECIFIED (0):

Default value, which will be treated as ENTERPRISE.

STANDARD (1):

Standard edition.

ENTERPRISE (2):

Enterprise edition.

ENTERPRISE_PLUS (3):

Enterprise plus edition.

class google.cloud.bigquery_reservation_v1.types.GetBiReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to get a singleton BI reservation.

name

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

Type

str

class google.cloud.bigquery_reservation_v1.types.GetCapacityCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

class google.cloud.bigquery_reservation_v1.types.GetReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

class google.cloud.bigquery_reservation_v1.types.ListAssignmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

Required. The parent resource name e.g.:

projects/myproject/locations/US/reservations/team1-prod

Or:

projects/myproject/locations/US/reservations/-

Type

str

page_size

The maximum number of items to return per page.

Type

int

page_token

The next_page_token value returned from a previous List request, if any.

Type

str

class google.cloud.bigquery_reservation_v1.types.ListAssignmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

assignments

List of assignments visible to the user.

Type

MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

class google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Type

str

page_size

The maximum number of items to return.

Type

int

page_token

The next_page_token value returned from a previous List request, if any.

Type

str

class google.cloud.bigquery_reservation_v1.types.ListCapacityCommitmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

capacity_commitments

List of capacity commitments visible to the user.

Type

MutableSequence[google.cloud.bigquery_reservation_v1.types.CapacityCommitment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

class google.cloud.bigquery_reservation_v1.types.ListReservationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

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

Type

str

page_size

The maximum number of items to return per page.

Type

int

page_token

The next_page_token value returned from a previous List request, if any.

Type

str

class google.cloud.bigquery_reservation_v1.types.ListReservationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

reservations

List of reservations visible to the user.

Type

MutableSequence[google.cloud.bigquery_reservation_v1.types.Reservation]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

class google.cloud.bigquery_reservation_v1.types.MergeCapacityCommitmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

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

Type

str

capacity_commitment_ids

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

Type

MutableSequence[str]

class google.cloud.bigquery_reservation_v1.types.MoveAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

name

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

Type

str

destination_id

The new reservation ID, e.g.: projects/myotherproject/locations/US/reservations/team2-prod

Type

str

assignment_id

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.

Type

str

class google.cloud.bigquery_reservation_v1.types.Reservation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

slot_capacity

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

NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.

Type

int

ignore_idle_slots

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.

Type

bool

autoscale

The configuration parameters for the auto scaling feature. Note this is an alpha feature.

Type

google.cloud.bigquery_reservation_v1.types.Reservation.Autoscale

concurrency

Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target_job_concurrency in the Information Schema, DDL and BQ CLI.

Type

int

creation_time

Output only. Creation time of the reservation.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Last update time of the reservation.

Type

google.protobuf.timestamp_pb2.Timestamp

multi_region_auxiliary

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.

Type

bool

edition

Edition of the reservation.

Type

google.cloud.bigquery_reservation_v1.types.Edition

class Autoscale(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Auto scaling settings.

current_slots

Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].

Type

int

max_slots

Number of slots to be scaled when needed.

Type

int

class google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

Required. The resource name with location (project name could be the wildcard ‘-‘), e.g.: projects/-/locations/US.

Type

str

query

Please specify resource name as assignee in the query.

Examples:

• assignee=projects/myproject

• assignee=folders/123

• assignee=organizations/456

Type

str

page_size

The maximum number of items to return per page.

Type

int

page_token

The next_page_token value returned from a previous List request, if any.

Type

str

class google.cloud.bigquery_reservation_v1.types.SearchAllAssignmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

assignments

List of assignments visible to the user.

Type

MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

class google.cloud.bigquery_reservation_v1.types.SearchAssignmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

parent

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

Type

str

query

Please specify resource name as assignee in the query.

Examples:

• assignee=projects/myproject

• assignee=folders/123

• assignee=organizations/456

Type

str

page_size

The maximum number of items to return per page.

Type

int

page_token

The next_page_token value returned from a previous List request, if any.

Type

str

class google.cloud.bigquery_reservation_v1.types.SearchAssignmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

assignments

List of assignments visible to the user.

Type

MutableSequence[google.cloud.bigquery_reservation_v1.types.Assignment]

next_page_token

Token to retrieve the next page of results, or empty if there are no more results in the list.

Type

str

class google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

slot_count

Number of slots in the capacity commitment after the split.

Type

int

class google.cloud.bigquery_reservation_v1.types.SplitCapacityCommitmentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

first

First capacity commitment, result of a split.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment

second

Second capacity commitment, result of a split.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment

class google.cloud.bigquery_reservation_v1.types.TableReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

project_id

The assigned project ID of the project.

Type

str

dataset_id

The ID of the dataset in the above project.

Type

str

table_id

The ID of the table in the above dataset.

Type

str

class google.cloud.bigquery_reservation_v1.types.UpdateAssignmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

assignment

Content of the assignment to update.

Type

google.cloud.bigquery_reservation_v1.types.Assignment

update_mask

Standard field mask for the set of fields to be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.bigquery_reservation_v1.types.UpdateBiReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request to update a BI reservation.

bi_reservation

A reservation to update.

Type

google.cloud.bigquery_reservation_v1.types.BiReservation

update_mask

A list of fields to be updated in this request.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.bigquery_reservation_v1.types.UpdateCapacityCommitmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

capacity_commitment

Content of the capacity commitment to update.

Type

google.cloud.bigquery_reservation_v1.types.CapacityCommitment

update_mask

Standard field mask for the set of fields to be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.bigquery_reservation_v1.types.UpdateReservationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

reservation

Content of the reservation to update.

Type

google.cloud.bigquery_reservation_v1.types.Reservation

update_mask

Standard field mask for the set of fields to be updated.

Type

google.protobuf.field_mask_pb2.FieldMask