Class: Google::Apis::BigqueryreservationV1beta1::BigQueryReservationService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::BigqueryreservationV1beta1::BigQueryReservationService
- Defined in:
- generated/google/apis/bigqueryreservation_v1beta1/service.rb
Overview
BigQuery Reservation API
A service to modify your BigQuery flat-rate reservations.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#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.
-
#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. -
#delete_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Empty
Deletes a capacity commitment.
-
#delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Empty
Deletes a reservation.
-
#delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Empty
Deletes a assignment.
-
#get_project_location_bi_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::BiReservation
Retrieves a BI reservation.
-
#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.
-
#get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1beta1::Reservation
Returns information about the reservation.
-
#initialize ⇒ BigQueryReservationService
constructor
A new instance of BigQueryReservationService.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ BigQueryReservationService
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
#key ⇒ String
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.
38 39 40 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
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.
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.
208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 208 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', ) 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.
347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 347 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', ) 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.
531 532 533 534 535 536 537 538 539 540 541 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 531 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', ) 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
.
244 245 246 247 248 249 250 251 252 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 244 def delete_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) 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.
383 384 385 386 387 388 389 390 391 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 383 def delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) 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:
573 574 575 576 577 578 579 580 581 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 573 def delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) 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.
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}', ) 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.
275 276 277 278 279 280 281 282 283 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 275 def get_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) 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.
414 415 416 417 418 419 420 421 422 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 414 def get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) 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.
310 311 312 313 314 315 316 317 318 319 320 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 310 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', ) 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:
621 622 623 624 625 626 627 628 629 630 631 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 621 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', ) 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.
455 456 457 458 459 460 461 462 463 464 465 466 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 455 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', ) 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 |
#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.
661 662 663 664 665 666 667 668 669 670 671 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 661 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', ) 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_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.
492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 492 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}', ) 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.
127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 127 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', ) 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 |
#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.
170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'generated/google/apis/bigqueryreservation_v1beta1/service.rb', line 170 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}', ) 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 |