1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module BigqueryreservationV1beta1
# BigQuery Reservation API
#
# A service to modify your BigQuery flat-rate reservations.
#
# @example
# require 'google/apis/bigqueryreservation_v1beta1'
#
# Bigqueryreservation = Google::Apis::BigqueryreservationV1beta1 # Alias the module
# service = Bigqueryreservation::BigQueryReservationService.new
#
# @see https://cloud.google.com/bigquery/
class BigQueryReservationService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://bigqueryreservation.googleapis.com/', '')
@batch_path = 'batch'
end
# Retrieves a BI reservation.
# @param [String] name
# Required. Name of the requested reservation, for example: `projects/`
# project_id`/locations/`location_id`/bireservation`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::BiReservation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::BiReservation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Looks up assignments for a specified resource for a particular region. If the
# request is about a project: 1. Assignments created on the project will be
# returned if they exist. 2. Otherwise assignments created on the closest
# ancestor will be returned. 3. Assignments for different JobTypes will all be
# returned. The same logic applies if the request is about a folder. If the
# request is about an organization, then assignments created on the organization
# will be returned (organization doesn't have ancestors). Comparing to
# ListAssignments, there are some behavior differences: 1. permission on the
# assignee will be verified in this API. 2. Hierarchy lookup (project->folder->
# organization) happens in this API. 3. Parent here is `projects/*/locations/*`,
# instead of `projects/*/locations/*reservations/*`. **Note** "-" cannot be used
# for projects nor locations.
# @param [String] parent
# Required. The resource name of the admin project(containing project and
# location), e.g.: `projects/myproject/locations/US`.
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] query
# Please specify resource name as assignee in the query. Examples: * `assignee=
# projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::SearchAssignmentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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
# 0. In order to release BI capacity reservation size must be set to 0.
# @param [String] name
# The resource name of the singleton BI reservation. Reservation names have the
# form `projects/`project_id`/locations/`location_id`/bireservation`.
# @param [Google::Apis::BigqueryreservationV1beta1::BiReservation] bi_reservation_object
# @param [String] update_mask
# A list of fields to be updated in this request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::BiReservation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::BiReservation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a new capacity commitment resource.
# @param [String] parent
# Required. Resource name of the parent reservation. E.g., `projects/myproject/
# locations/US`
# @param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object
# @param [Boolean] enforce_single_admin_project_per_org
# If true, fail the request if another project in the organization has a
# capacity commitment.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a capacity commitment. Attempting to delete capacity commitment before
# its commitment_end_time will fail with the error code `google.rpc.Code.
# FAILED_PRECONDITION`.
# @param [String] name
# Required. Resource name of the capacity commitment to delete. E.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns information about the capacity commitment.
# @param [String] name
# Required. Resource name of the capacity commitment to retrieve. E.g., `
# projects/myproject/locations/US/capacityCommitments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all the capacity commitments for the admin project.
# @param [String] parent
# Required. Resource name of the parent reservation. E.g., `projects/myproject/
# locations/US`
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::ListCapacityCommitmentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Merges capacity commitments of the same plan into a single commitment. The
# resulting capacity commitment has the greater commitment_end_time out of the
# to-be-merged capacity commitments. Attempting to merge capacity commitments of
# different plan will fail with the error code `google.rpc.Code.
# FAILED_PRECONDITION`.
# @param [String] parent
# Parent resource that identifies admin project and location e.g., `projects/
# myproject/locations/us`
# @param [Google::Apis::BigqueryreservationV1beta1::MergeCapacityCommitmentsRequest] merge_capacity_commitments_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields
# can be updated. Plan can only be changed to a plan of a longer commitment
# period. Attempting to change to a plan with shorter commitment period will
# fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.
# @param [String] name
# Output only. The resource name of the capacity commitment, e.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# @param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object
# @param [String] update_mask
# Standard field mask for the set of fields to be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Splits capacity commitment to two commitments of the same plan and `
# commitment_end_time`. A common use case is to enable downgrading commitments.
# For example, in order to downgrade from 10000 slots to 8000, you might split a
# 10000 capacity commitment into commitments of 2000 and 8000. Then, you would
# change the plan of the first one to `FLEX` and then delete it.
# @param [String] name
# Required. The resource name e.g.,: `projects/myproject/locations/US/
# capacityCommitments/123`
# @param [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentRequest] split_capacity_commitment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Creates a new reservation resource.
# @param [String] parent
# Required. Project, location. E.g., `projects/myproject/locations/US`
# @param [Google::Apis::BigqueryreservationV1beta1::Reservation] reservation_object
# @param [String] reservation_id
# The reservation ID. This field must only contain lower case alphanumeric
# characters or dash. Max length is 64 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Reservation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Reservation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when
# reservation has assignments.
# @param [String] name
# Required. Resource name of the reservation to retrieve. E.g., `projects/
# myproject/locations/US/reservations/team1-prod`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Returns information about the reservation.
# @param [String] name
# Required. Resource name of the reservation to retrieve. E.g., `projects/
# myproject/locations/US/reservations/team1-prod`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Reservation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Reservation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists all the reservations for the project in the specified location.
# @param [String] parent
# Required. The parent resource name containing project and location, e.g.: `
# projects/myproject/locations/US`
# @param [String] filter
# Can be used to filter out reservations based on names, capacity, etc, e.g.:
# filter="reservation.slot_capacity > 200" filter="reservation.name = \"*dev/*\""
# Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/
# view/advanced-filters).
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::ListReservationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Updates an existing reservation resource.
# @param [String] name
# The resource name of the reservation, e.g., `projects/*/locations/*/
# reservations/team1-prod`.
# @param [Google::Apis::BigqueryreservationV1beta1::Reservation] reservation_object
# @param [String] update_mask
# Standard field mask for the set of fields to be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Reservation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Reservation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# 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.
# @param [String] parent
# Required. The parent resource name of the assignment E.g. `projects/myproject/
# locations/US/reservations/team1-prod`
# @param [Google::Apis::BigqueryreservationV1beta1::Assignment] assignment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Assignment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Assignment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Deletes a assignment. No expansion will happen. Example: * Organization `
# organizationA` contains two projects, `project1` and `project2`. * Reservation
# `res1` exists and was created previously. * CreateAssignment was used
# previously to define the following associations between entities and
# reservations: `` and `` In this example, deletion of the `` assignment won't
# affect the other assignment ``. After said deletion, queries from `project1`
# will still use `res1` while queries from `project2` will switch to use on-
# demand mode.
# @param [String] name
# Required. Name of the resource, e.g. `projects/myproject/locations/US/
# reservations/team1-prod/assignments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Lists assignments. Only explicitly created assignments will be returned.
# Example: * Organization `organizationA` contains two projects, `project1` and `
# project2`. * Reservation `res1` exists and was created previously. *
# CreateAssignment was used previously to define the following associations
# between entities and reservations: `` and `` In this example, ListAssignments
# will just return the above two assignments for reservation `res1`, and no
# expansion/merge will happen. The wildcard "-" can be used for reservations in
# the request. In that case all assignments belongs to the specified project and
# location will be listed. **Note** "-" cannot be used for projects nor
# locations.
# @param [String] parent
# Required. The parent resource name e.g.: `projects/myproject/locations/US/
# reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-`
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::ListAssignmentsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
# Moves an assignment under a new reservation. This differs from removing an
# existing assignment and recreating a new one by providing a transactional
# change that ensures an assignee always has an associated reservation.
# @param [String] name
# Required. The resource name of the assignment, e.g. `projects/myproject/
# locations/US/reservations/team1-prod/assignments/123`
# @param [Google::Apis::BigqueryreservationV1beta1::MoveAssignmentRequest] move_assignment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::BigqueryreservationV1beta1::Assignment] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::BigqueryreservationV1beta1::Assignment]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|