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

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

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • 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:



203
204
205
206
207
208
209
210
211
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 203

def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha2/{+name}:cancel', 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

#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:



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 393

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:



271
272
273
274
275
276
277
278
279
280
281
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 271

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:



432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 432

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:



475
476
477
478
479
480
481
482
483
484
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 475

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:



313
314
315
316
317
318
319
320
321
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 313

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:



625
626
627
628
629
630
631
632
633
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 625

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(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

  • 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:



70
71
72
73
74
75
76
77
78
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 70

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

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • 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:



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

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



507
508
509
510
511
512
513
514
515
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 507

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:



657
658
659
660
661
662
663
664
665
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 657

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:



355
356
357
358
359
360
361
362
363
364
365
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 355

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:



693
694
695
696
697
698
699
700
701
702
703
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 693

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:



548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 548

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

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigqueryreservationV1alpha2::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • 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:



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 106

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

#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:



588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'generated/google/apis/bigqueryreservation_v1alpha2/service.rb', line 588

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:



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

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