Class: Google::Apis::BigqueryreservationV1::BigQueryReservationService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::BigqueryreservationV1::BigQueryReservationService
- Defined in:
- generated/google/apis/bigqueryreservation_v1/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.
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::BigqueryreservationV1::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::BigqueryreservationV1::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::BigqueryreservationV1::Assignment
Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.
-
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Empty
Deletes a long-running operation.
-
#delete_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Empty
Deletes a capacity commitment.
-
#delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Empty
Deletes a reservation.
-
#delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Empty
Deletes a assignment.
-
#get_project_location_bi_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::BiReservation
Retrieves a BI reservation.
-
#get_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::CapacityCommitment
Returns information about the capacity commitment.
-
#get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Reservation
Returns information about the reservation.
-
#initialize ⇒ BigQueryReservationService
constructor
A new instance of BigQueryReservationService.
-
#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_capacity_commitments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::ListAssignmentsResponse
Lists assignments.
-
#list_project_location_reservations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::ListReservationsResponse
Lists all the reservations for the project in the specified location.
-
#merge_capacity_commitments(parent, merge_capacity_commitments_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::CapacityCommitment
Merges capacity commitments of the same plan into a single commitment.
-
#move_assignment(name, move_assignment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Assignment
Moves an assignment under a new reservation.
-
#patch_project_location_capacity_commitment(name, capacity_commitment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::CapacityCommitment
Updates an existing capacity commitment.
-
#patch_project_location_reservation(name, reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Reservation
Updates an existing reservation resource.
-
#search_project_location_all_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse
Looks up assignments for a specified resource for a particular region.
-
#search_project_location_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::SearchAssignmentsResponse
Looks up assignments for a specified resource for a particular region.
-
#split_capacity_commitment(name, split_capacity_commitment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentResponse
Splits capacity commitment to two commitments of the same plan and
commitment_end_time
. -
#update_project_location_bi_reservation(name, bi_reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::BiReservation
Updates a BI reservation.
Constructor Details
#initialize ⇒ BigQueryReservationService
Returns a new instance of BigQueryReservationService.
45 46 47 48 |
# File 'generated/google/apis/bigqueryreservation_v1/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_v1/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_v1/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::BigqueryreservationV1::CapacityCommitment
Creates a new capacity commitment resource.
328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 328 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, 'v1/{+parent}/capacityCommitments', ) command.request_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation command.request_object = capacity_commitment_object command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::Reservation
Creates a new reservation resource.
582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 582 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, 'v1/{+parent}/reservations', ) command.request_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation command.request_object = reservation_object command.response_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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.
770 771 772 773 774 775 776 777 778 779 780 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 770 def create_project_location_reservation_assignment(parent, assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/assignments', ) command.request_representation = Google::Apis::BigqueryreservationV1::Assignment::Representation command.request_object = assignment_object command.response_representation = Google::Apis::BigqueryreservationV1::Assignment::Representation command.response_class = Google::Apis::BigqueryreservationV1::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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::Empty
Deletes a long-running operation. This method indicates that the client is no
longer interested in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns google.rpc.Code.
UNIMPLEMENTED
.
73 74 75 76 77 78 79 80 81 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 73 def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation command.response_class = Google::Apis::BigqueryreservationV1::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_capacity_commitment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::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
.
364 365 366 367 368 369 370 371 372 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 364 def delete_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::Empty
Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION
when
reservation has assignments.
617 618 619 620 621 622 623 624 625 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 617 def delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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.
810 811 812 813 814 815 816 817 818 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 810 def delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::BiReservation
Retrieves a BI reservation.
150 151 152 153 154 155 156 157 158 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 150 def get_project_location_bi_reservation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::BiReservation::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::CapacityCommitment
Returns information about the capacity commitment.
395 396 397 398 399 400 401 402 403 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 395 def get_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::Reservation
Returns information about the reservation.
648 649 650 651 652 653 654 655 656 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 648 def get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation command.response_class = Google::Apis::BigqueryreservationV1::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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::ListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource
name schemes, such as users/*/operations
. To override the binding, API
services can add a binding such as "/v1/
name=users/*/operations"
to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 116 def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::BigqueryreservationV1::ListOperationsResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::ListOperationsResponse command.params['name'] = name unless name.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 |
#list_project_location_capacity_commitments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::ListCapacityCommitmentsResponse
Lists all the capacity commitments for the admin project.
430 431 432 433 434 435 436 437 438 439 440 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 430 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, 'v1/{+parent}/capacityCommitments', ) command.response_representation = Google::Apis::BigqueryreservationV1::ListCapacityCommitmentsResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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.
854 855 856 857 858 859 860 861 862 863 864 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 854 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, 'v1/{+parent}/assignments', ) command.response_representation = Google::Apis::BigqueryreservationV1::ListAssignmentsResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::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, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::ListReservationsResponse
Lists all the reservations for the project in the specified location.
683 684 685 686 687 688 689 690 691 692 693 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 683 def list_project_location_reservations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/reservations', ) command.response_representation = Google::Apis::BigqueryreservationV1::ListReservationsResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::ListReservationsResponse 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 |
#merge_capacity_commitments(parent, merge_capacity_commitments_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::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
.
468 469 470 471 472 473 474 475 476 477 478 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 468 def merge_capacity_commitments(parent, merge_capacity_commitments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/capacityCommitments:merge', ) command.request_representation = Google::Apis::BigqueryreservationV1::MergeCapacityCommitmentsRequest::Representation command.request_object = merge_capacity_commitments_request_object command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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.
890 891 892 893 894 895 896 897 898 899 900 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 890 def move_assignment(name, move_assignment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:move', ) command.request_representation = Google::Apis::BigqueryreservationV1::MoveAssignmentRequest::Representation command.request_object = move_assignment_request_object command.response_representation = Google::Apis::BigqueryreservationV1::Assignment::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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
.
507 508 509 510 511 512 513 514 515 516 517 518 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 507 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, 'v1/{+name}', ) command.request_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation command.request_object = capacity_commitment_object command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::Reservation
Updates an existing reservation resource.
719 720 721 722 723 724 725 726 727 728 729 730 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 719 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, 'v1/{+name}', ) command.request_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation command.request_object = reservation_object command.response_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation command.response_class = Google::Apis::BigqueryreservationV1::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_all_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse
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/*
.
198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 198 def search_project_location_all_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}:searchAllAssignments', ) command.response_representation = Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::SearchAllAssignmentsResponse 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 |
#search_project_location_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1::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.
250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 250 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, 'v1/{+parent}:searchAssignments', ) command.response_representation = Google::Apis::BigqueryreservationV1::SearchAssignmentsResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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.
546 547 548 549 550 551 552 553 554 555 556 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 546 def split_capacity_commitment(name, split_capacity_commitment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:split', ) command.request_representation = Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentRequest::Representation command.request_object = split_capacity_commitment_request_object command.response_representation = Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentResponse::Representation command.response_class = Google::Apis::BigqueryreservationV1::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::BigqueryreservationV1::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
- In order to release BI capacity reservation size must be set to 0.
290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'generated/google/apis/bigqueryreservation_v1/service.rb', line 290 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, 'v1/{+name}', ) command.request_representation = Google::Apis::BigqueryreservationV1::BiReservation::Representation command.request_object = bi_reservation_object command.response_representation = Google::Apis::BigqueryreservationV1::BiReservation::Representation command.response_class = Google::Apis::BigqueryreservationV1::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 |