class Google::Apis::BigqueryreservationV1beta1::BigQueryReservationService

BigQuery Reservation API

A service to modify your BigQuery flat-rate reservations.

@example

require 'google/apis/bigqueryreservation_v1beta1'

Bigqueryreservation = Google::Apis::BigqueryreservationV1beta1 # Alias the module
service = Bigqueryreservation::BigQueryReservationService.new

@see cloud.google.com/bigquery/

Attributes

key[RW]

@return [String]

API key. Your API key identifies your project and provides you with API access,
quota, and reports. Required unless you provide an OAuth 2.0 token.
quota_user[RW]

@return [String]

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 45
def initialize
  super('https://bigqueryreservation.googleapis.com/', '',
        client_name: 'google-apis-bigqueryreservation_v1beta1',
        client_version: Google::Apis::BigqueryreservationV1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

create_project_location_capacity_commitment(parent, capacity_commitment_object = nil, capacity_commitment_id: nil, enforce_single_admin_project_per_org: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a new capacity commitment resource. @param [String] parent

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

@param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object @param [String] 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 dash. Max length is 64 characters. NOTE:
this ID won't be kept if the capacity commitment is split or merged.

@param [Boolean] enforce_single_admin_project_per_org

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 205
def create_project_location_capacity_commitment(parent, capacity_commitment_object = nil, capacity_commitment_id: nil, enforce_single_admin_project_per_org: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/capacityCommitments', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation
  command.request_object = capacity_commitment_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment
  command.params['parent'] = parent unless parent.nil?
  command.query['capacityCommitmentId'] = capacity_commitment_id unless capacity_commitment_id.nil?
  command.query['enforceSingleAdminProjectPerOrg'] = enforce_single_admin_project_per_org unless enforce_single_admin_project_per_org.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
create_project_location_reservation(parent, reservation_object = nil, reservation_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a new reservation resource. @param [String] parent

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

@param [Google::Apis::BigqueryreservationV1beta1::Reservation] reservation_object @param [String] reservation_id

The reservation ID. This field must only contain lower case alphanumeric
characters or dash. Max length is 64 characters.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Reservation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Reservation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 465
def create_project_location_reservation(parent, reservation_object = nil, reservation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/reservations', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::Reservation::Representation
  command.request_object = reservation_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Reservation
  command.params['parent'] = parent unless parent.nil?
  command.query['reservationId'] = reservation_id unless reservation_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
create_project_location_reservation_assignment(parent, assignment_object = nil, assignment_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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

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

@param [Google::Apis::BigqueryreservationV1beta1::Assignment] assignment_object @param [String] 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 dash. Max length is 64 characters.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Assignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Assignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 666
def create_project_location_reservation_assignment(parent, assignment_object = nil, assignment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/assignments', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::Assignment::Representation
  command.request_object = assignment_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Assignment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Assignment
  command.params['parent'] = parent unless parent.nil?
  command.query['assignmentId'] = assignment_id unless assignment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_capacity_commitment(name, force: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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`. @param [String] name

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

@param [Boolean] 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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 246
def delete_project_location_capacity_commitment(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Empty::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 500
def delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Empty::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a assignment. No expansion will happen. Example: * Organization ` organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: “ and “ In this example, deletion of the “ assignment won't affect the other assignment “. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on- demand mode. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 707
def delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Empty::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_bi_reservation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves a BI reservation. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::BiReservation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::BiReservation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 73
def get_project_location_bi_reservation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::BiReservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::BiReservation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns information about the capacity commitment. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 278
def get_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns information about the reservation. @param [String] name

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Reservation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Reservation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 531
def get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Reservation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_capacity_commitments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists all the capacity commitments for the admin project. @param [String] parent

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

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 313
def list_project_location_capacity_commitments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/capacityCommitments', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_reservation_assignments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and ` project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: “ and “ In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard “-” can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. Note “-” cannot be used for projects nor locations. @param [String] parent

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

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 751
def list_project_location_reservation_assignments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/assignments', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_project_location_reservations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists all the reservations for the project in the specified location. @param [String] parent

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

@param [String] filter

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

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 571
def list_project_location_reservations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/reservations', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
merge_capacity_commitments(parent, merge_capacity_commitments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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`. @param [String] parent

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

@param [Google::Apis::BigqueryreservationV1beta1::MergeCapacityCommitmentsRequest] merge_capacity_commitments_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 351
def merge_capacity_commitments(parent, merge_capacity_commitments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/capacityCommitments:merge', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::MergeCapacityCommitmentsRequest::Representation
  command.request_object = merge_capacity_commitments_request_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
move_assignment(name, move_assignment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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. @param [String] name

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

@param [Google::Apis::BigqueryreservationV1beta1::MoveAssignmentRequest] move_assignment_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Assignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Assignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 787
def move_assignment(name, move_assignment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:move', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::MoveAssignmentRequest::Representation
  command.request_object = move_assignment_request_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Assignment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Assignment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_project_location_capacity_commitment(name, capacity_commitment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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`. @param [String] name

Output only. The resource name of the capacity commitment, e.g., `projects/
myproject/locations/US/capacityCommitments/123`

@param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object @param [String] update_mask

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 390
def patch_project_location_capacity_commitment(name, capacity_commitment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation
  command.request_object = capacity_commitment_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_project_location_reservation(name, reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates an existing reservation resource. @param [String] name

The resource name of the reservation, e.g., `projects/*/locations/*/
reservations/team1-prod`.

@param [Google::Apis::BigqueryreservationV1beta1::Reservation] reservation_object @param [String] update_mask

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Reservation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Reservation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 608
def patch_project_location_reservation(name, reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::Reservation::Representation
  command.request_object = reservation_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Reservation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
patch_project_location_reservation_assignment(name, assignment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates an existing assignment. Only the `priority` field can be updated. @param [String] name

Output only. Name of the resource. E.g.: `projects/myproject/locations/US/
reservations/team1-prod/assignments/123`.

@param [Google::Apis::BigqueryreservationV1beta1::Assignment] assignment_object @param [String] update_mask

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Assignment] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::Assignment]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 823
def patch_project_location_reservation_assignment(name, assignment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::Assignment::Representation
  command.request_object = assignment_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::Assignment::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::Assignment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
search_project_location_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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. @param [String] parent

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

@param [Fixnum] page_size

The maximum number of items to return.

@param [String] page_token

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

@param [String] query

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

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 122
def search_project_location_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}:searchAssignments', options)
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
split_capacity_commitment(name, split_capacity_commitment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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. @param [String] name

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

@param [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentRequest] split_capacity_commitment_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 429
def split_capacity_commitment(name, split_capacity_commitment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:split', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentRequest::Representation
  command.request_object = split_capacity_commitment_request_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
update_project_location_bi_reservation(name, bi_reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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

  1. In order to release BI capacity reservation size must be set to 0.

@param [String] name

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

@param [Google::Apis::BigqueryreservationV1beta1::BiReservation] bi_reservation_object @param [String] update_mask

A list of fields to be updated in this request.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryreservationV1beta1::BiReservation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryreservationV1beta1::BiReservation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 162
def update_project_location_bi_reservation(name, bi_reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::BigqueryreservationV1beta1::BiReservation::Representation
  command.request_object = bi_reservation_object
  command.response_representation = Google::Apis::BigqueryreservationV1beta1::BiReservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1beta1::BiReservation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/bigqueryreservation_v1beta1/service.rb, line 838
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end