Class: Google::Apis::BigqueryreservationV1alpha2::BigQueryReservationService

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

Overview

BigQuery Reservation API

A service to modify your BigQuery flat-rate reservations.

Examples:

require 'google/apis/bigqueryreservation_v1alpha2'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ BigQueryReservationService

Returns a new instance of BigQueryReservationService



45
46
47
48
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/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.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/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.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



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

def quota_user
  @quota_user
end

Instance Method Details

#create_project_location_reservation(parent, reservation_object = nil, reservation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Reservation

Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.

Parameters:

  • parent (String) —

    Project, location, and (optionally) reservation name. E.g., projects/myproject/locations/us-central1/reservations/parent

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

    The reservation ID relative to the parent, e.g., "dev". This field must only contain alphanumeric characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 253

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, 'v1alpha2/{+parent}/reservations', options)
  command.request_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.request_object = reservation_object
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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_grant(parent, reservation_grant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::ReservationGrant

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 grant does not match location of the reservation.

Parameters:

  • parent (String) —

    The parent resource name of the reservation grant E.g.: projects/myproject/location/eu.

  • reservation_grant_object (Google::Apis::BigqueryreservationV1alpha2::ReservationGrant) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



131
132
133
134
135
136
137
138
139
140
141
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 131

def create_project_location_reservation_grant(parent, reservation_grant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}/reservationGrants', options)
  command.request_representation = Google::Apis::BigqueryreservationV1alpha2::ReservationGrant::Representation
  command.request_object = reservation_grant_object
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::ReservationGrant::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::ReservationGrant
  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

#create_project_location_reservation_reservation(parent, reservation_object = nil, reservation_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Reservation

Creates a new reservation resource. Multiple reservations are created if the ancestor reservations do not exist.

Parameters:

  • parent (String) —

    Project, location, and (optionally) reservation name. E.g., projects/myproject/locations/us-central1/reservations/parent

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

    The reservation ID relative to the parent, e.g., "dev". This field must only contain alphanumeric characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 292

def create_project_location_reservation_reservation(parent, reservation_object = nil, reservation_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+parent}', options)
  command.request_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.request_object = reservation_object
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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

#delete_project_location_reservation(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Empty

Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION in the following cases:

  1. When reservation has child reservations. This check can be bypassed by setting DeleteReservationRequest.force flag to true.
  2. When top-level reservation with slot pools is being deleted.

Parameters:

  • name (String) —

    Resource name of the reservation to retrieve. E.g., projects/myproject/locations/us-central1/reservations/my_reservation

  • force (Boolean) —

    If true, deletes all the child reservations of the given reservation. Otherwise, attempting to delete a reservation that has child reservations will fail with error code google.rpc.Code.FAILED_PRECONDITION.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



335
336
337
338
339
340
341
342
343
344
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 335

def delete_project_location_reservation(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Empty::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::Empty
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.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_grant(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Empty

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

Parameters:

  • name (String) —

    Name of the resource, e.g.: projects/myproject/locations/eu/reservationGrants/123

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def delete_project_location_reservation_grant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Empty::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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_slot_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Empty

Deletes a slot pool. Attempting to delete slot pool before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters:

  • name (String) —

    Resource name of the slot pool to delete. E.g., projects/myproject/locations/us-central1/reservations/my_reservation/ slotPools/123

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



485
486
487
488
489
490
491
492
493
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 485

def delete_project_location_reservation_slot_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Empty::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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_reservation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Reservation

Returns information about the reservation.

Parameters:

  • name (String) —

    Resource name of the reservation to retrieve. E.g., projects/myproject/locations/us-central1/reservations/path/to/reserv

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



367
368
369
370
371
372
373
374
375
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 367

def get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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

#get_project_location_reservation_slot_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::SlotPool

Returns information about the slot pool.

Parameters:

  • name (String) —

    Resource name of the slot pool to retrieve. E.g., projects/myproject/locations/us-central1/reservations/my_reservation/ slotPools/123

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_project_location_reservation_slot_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+name}', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::SlotPool::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::SlotPool
  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_reservation_grants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::ListReservationGrantsResponse

Lists reservation grants. Only explicitly created grants will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateReservationGrant was invoked previously and following grants were created explicitly: Then this API will just return the above two grants for reservation res1, and no expansion/merge will happen.

Parameters:

  • parent (String) —

    The parent resource name e.g.: projects/myproject/location/eu.

  • page_size (Fixnum) —

    The maximum number of items to return.

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



215
216
217
218
219
220
221
222
223
224
225
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 215

def list_project_location_reservation_grants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/reservationGrants', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::ListReservationGrantsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::ListReservationGrantsResponse
  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_slot_pools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::ListSlotPoolsResponse

Lists all the slot pools for the reservation.

Parameters:

  • parent (String) —

    Resource name of the parent reservation. Only top-level reservations can have slot pools. E.g., projects/myproject/locations/us-central1/reservations/my_reservation

  • page_size (Fixnum) —

    The maximum number of items to return.

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



553
554
555
556
557
558
559
560
561
562
563
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 553

def list_project_location_reservation_slot_pools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}/slotPools', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::ListSlotPoolsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::ListSlotPoolsResponse
  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::BigqueryreservationV1alpha2::ListReservationsResponse

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

Parameters:

  • parent (String) —

    The parent resource name containing project and location, e.g.: "projects/myproject/locations/us-central1"

  • filter (String) —

    Can be used to filter out reservations based on names, capacity, etc, e.g.: filter="reservation.slot_capacity > 200" filter="reservation.name = \"dev/\"" Advanced filtering syntax can be here.

  • page_size (Fixnum) —

    The maximum number of items to return.

  • page_token (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 408

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, 'v1alpha2/{+parent}/reservations', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::ListReservationsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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

#patch_project_location_reservation(name, reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Reservation

Updates an existing reservation resource. Applicable only for child reservations.

Parameters:

  • name (String) —

    The resource name of the reservation, e.g., "projects//locations//reservations/dev/team/product". Reservation names (e.g., "dev/team/product") exceeding a depth of six will fail with google.rpc.Code.INVALID_ARGUMENT.

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

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 448

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, 'v1alpha2/{+name}', options)
  command.request_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.request_object = reservation_object
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::Reservation::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::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_reservation_grants(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::SearchReservationGrantsResponse

Look up grants for a specified resource for a particular region. If the request is about a project: 1) Grants created on the project will be returned if they exist. 2) Otherwise grants created on the closest ancestor will be returned. 3) Grants 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 grants created on the organization will be returned (organization doesn't have ancestors). Comparing to ListReservationGrants, there are two behavior differences: 1) permission on the grantee will be verified in this API. 2) Hierarchy lookup (project->folder->organization) happens in this API.

Parameters:

  • parent (String) —

    The parent resource name (containing project and location), which owns the grants. e.g.: "projects/myproject/locations/us-central1".

  • page_size (Fixnum) —

    The maximum number of items to return.

  • page_token (String) —

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

  • query (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 92

def search_project_location_reservation_grants(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha2/{+parent}:SearchReservationGrants', options)
  command.response_representation = Google::Apis::BigqueryreservationV1alpha2::SearchReservationGrantsResponse::Representation
  command.response_class = Google::Apis::BigqueryreservationV1alpha2::SearchReservationGrantsResponse
  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