Class: Google::Apis::BigqueryreservationV1beta1::BigQueryReservationService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/bigqueryreservation_v1beta1/service.rb

Overview

BigQuery Reservation API

A service to modify your BigQuery flat-rate reservations.

Examples:

require 'google/apis/bigqueryreservation_v1beta1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeBigQueryReservationService

Returns a new instance of BigQueryReservationService.



45
46
47
48
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 45

def initialize
  super('https://bigqueryreservation.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

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



38
39
40
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 38

def key
  @key
end

#quota_userString

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

Returns:

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



43
44
45
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#create_project_location_capacity_commitment(parent, capacity_commitment_object = nil, enforce_single_admin_project_per_org: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::CapacityCommitment

Creates a new capacity commitment resource.

Parameters:

  • parent (String)

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

  • capacity_commitment_object (Google::Apis::BigqueryreservationV1beta1::CapacityCommitment) (defaults to: nil)
  • enforce_single_admin_project_per_org (Boolean) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



209
210
211
212
213
214
215
216
217
218
219
220
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 209

def create_project_location_capacity_commitment(parent, capacity_commitment_object = 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['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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Reservation

Creates a new reservation resource.

Parameters:

  • parent (String)

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

  • reservation_object (Google::Apis::BigqueryreservationV1beta1::Reservation) (defaults to: nil)
  • reservation_id (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



464
465
466
467
468
469
470
471
472
473
474
475
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 464

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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Assignment

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.

Parameters:

  • parent (String)

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

  • assignment_object (Google::Apis::BigqueryreservationV1beta1::Assignment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



648
649
650
651
652
653
654
655
656
657
658
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 648

def create_project_location_reservation_assignment(parent, assignment_object = 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['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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Empty

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.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



245
246
247
248
249
250
251
252
253
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 245

def delete_project_location_capacity_commitment(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(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Empty

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

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



500
501
502
503
504
505
506
507
508
# File 'generated/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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Empty

Deletes a assignment. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



690
691
692
693
694
695
696
697
698
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 690

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::BiReservation

Retrieves a BI reservation.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



71
72
73
74
75
76
77
78
79
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 71

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::CapacityCommitment

Returns information about the capacity commitment.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



276
277
278
279
280
281
282
283
284
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 276

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Reservation

Returns information about the reservation.

Parameters:

  • name (String)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



531
532
533
534
535
536
537
538
539
# File 'generated/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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse

Lists all the capacity commitments for the admin project.

Parameters:

  • parent (String)

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

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



311
312
313
314
315
316
317
318
319
320
321
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 311

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse

Lists assignments. Only explicitly created assignments will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then this API will just return the above two assignments for reservation res1, and no expansion/merge will happen. 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.

Parameters:

  • parent (String)

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

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



738
739
740
741
742
743
744
745
746
747
748
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 738

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse

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

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    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.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



572
573
574
575
576
577
578
579
580
581
582
583
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 572

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::CapacityCommitment

Merges capacity commitments of the same plan into one. Resulting capacity commitment has the longer commitment_end_time out of the two. Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters:

  • parent (String)

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

  • merge_capacity_commitments_request_object (Google::Apis::BigqueryreservationV1beta1::MergeCapacityCommitmentsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



348
349
350
351
352
353
354
355
356
357
358
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 348

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Assignment

Moves a assignment under a new reservation. Customers can do this by deleting the existing assignment followed by creating another assignment under the new reservation, but this method provides a transactional way to do so, to make sure the assignee always has an associated reservation. Without the method customers might see some queries run on-demand which might be unexpected.

Parameters:

  • name (String)

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

  • move_assignment_request_object (Google::Apis::BigqueryreservationV1beta1::MoveAssignmentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



778
779
780
781
782
783
784
785
786
787
788
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 778

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::CapacityCommitment

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.

Parameters:

  • name (String)

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

  • capacity_commitment_object (Google::Apis::BigqueryreservationV1beta1::CapacityCommitment) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



388
389
390
391
392
393
394
395
396
397
398
399
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 388

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Reservation

Updates an existing reservation resource.

Parameters:

  • name (String)

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

  • reservation_object (Google::Apis::BigqueryreservationV1beta1::Reservation) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



609
610
611
612
613
614
615
616
617
618
619
620
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 609

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

#search_project_location_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse

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

Parameters:

  • parent (String)

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

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of items to return.

  • page_token (String) (defaults to: nil)

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

  • query (String) (defaults to: nil)

    Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456"

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



128
129
130
131
132
133
134
135
136
137
138
139
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 128

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse

Splits capacity commitment to two commitments of the same plan and commitment_end_time. A common use case to do that is to perform a downgrade e.g., in order to downgrade from 10000 slots to 8000, one might split 10000 capacity commitment to 2000 and 8000, change the plan of the first one to flex and then delete it.

Parameters:

  • name (String)

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

  • split_capacity_commitment_request_object (Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



427
428
429
430
431
432
433
434
435
436
437
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 427

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) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::BiReservation

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

Parameters:

  • name (String)

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

  • bi_reservation_object (Google::Apis::BigqueryreservationV1beta1::BiReservation) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    A list of fields to be updated in this request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



171
172
173
174
175
176
177
178
179
180
181
182
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 171

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