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:


198
199
200
201
202
203
204
205
206
207
208
209
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 198

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:


452
453
454
455
456
457
458
459
460
461
462
463
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 452

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

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

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:


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

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:


234
235
236
237
238
239
240
241
242
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 234

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:


487
488
489
490
491
492
493
494
495
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 487

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

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:


686
687
688
689
690
691
692
693
694
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 686

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:


265
266
267
268
269
270
271
272
273
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 265

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:


518
519
520
521
522
523
524
525
526
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 518

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:


300
301
302
303
304
305
306
307
308
309
310
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 300

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

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:


730
731
732
733
734
735
736
737
738
739
740
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 730

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:


558
559
560
561
562
563
564
565
566
567
568
569
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 558

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

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:


338
339
340
341
342
343
344
345
346
347
348
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 338

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

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:


766
767
768
769
770
771
772
773
774
775
776
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 766

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:


377
378
379
380
381
382
383
384
385
386
387
388
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 377

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:


595
596
597
598
599
600
601
602
603
604
605
606
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 595

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

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. Examples: * 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:


120
121
122
123
124
125
126
127
128
129
130
131
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 120

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

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:


416
417
418
419
420
421
422
423
424
425
426
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 416

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

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:


160
161
162
163
164
165
166
167
168
169
170
171
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 160

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