google-cloud-bigquery-reservation-v1 0.3.2 → 0.4.2

data/lib/google/cloud/bigquery/reservation/v1/reservation_service/paths.rb

@@ -51,7 +51,7 @@ module Google
               #
               # The resource will be in the following format:
               #
-              # `projects/{project}/locations/{location}/bireservation`
+              # `projects/{project}/locations/{location}/biReservation`
               #
               # @param project [String]
               # @param location [String]
@@ -60,7 +60,7 @@ module Google
               def bi_reservation_path project:, location:
                 raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
 
-                "projects/#{project}/locations/#{location}/bireservation"
+                "projects/#{project}/locations/#{location}/biReservation"
               end
 
               ##

data/lib/google/cloud/bigquery/reservation/v1/reservation_services_pb.rb

@@ -42,7 +42,7 @@ module Google
             #   `projects/myproject/locations/US/capacityCommitments/id`.
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode
@@ -119,6 +119,11 @@ module Google
               #   `project2`) could all be created and mapped to the same or different
               #   reservations.
               #
+              # "None" assignments represent an absence of the assignment. Projects
+              # assigned to None use on-demand pricing. To create a "None" assignment, use
+              # "none" as a reservation_id in the parent. Example parent:
+              # `projects/myproject/locations/US/reservations/none`.
+              #
               # 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.
@@ -164,7 +169,7 @@ module Google
               # queries from `project1` will still use `res1` while queries from
               # `project2` will switch to use on-demand mode.
               rpc :DeleteAssignment, ::Google::Cloud::Bigquery::Reservation::V1::DeleteAssignmentRequest, ::Google::Protobuf::Empty
-              # Looks up assignments for a specified resource for a particular region.
+              # Deprecated: 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.
@@ -188,6 +193,27 @@ module Google
               # **Note** "-" cannot be used for projects
               # nor locations.
               rpc :SearchAssignments, ::Google::Cloud::Bigquery::Reservation::V1::SearchAssignmentsRequest, ::Google::Cloud::Bigquery::Reservation::V1::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/*`.
+              rpc :SearchAllAssignments, ::Google::Cloud::Bigquery::Reservation::V1::SearchAllAssignmentsRequest, ::Google::Cloud::Bigquery::Reservation::V1::SearchAllAssignmentsResponse
               # Moves an assignment under a new reservation.
               #
               # This differs from removing an existing assignment and recreating a new one

data/lib/google/cloud/bigquery/reservation/v1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Reservation
         module V1
-          VERSION = "0.3.2"
+          VERSION = "0.4.2"
         end
       end
     end

data/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

data/proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb

@@ -41,9 +41,16 @@ module Google
           #     `google.rpc.Code.RESOURCE_EXHAUSTED`.
           # @!attribute [rw] ignore_idle_slots
           #   @return [::Boolean]
-          #     If false, any query using this reservation will use idle slots from other
-          #     reservations within the same admin project. If true, a query using this
-          #     reservation will execute with the slot capacity specified above at most.
+          #     If false, any query or pipeline job using this reservation will use idle
+          #     slots from other reservations within the same admin project. If true, a
+          #     query or pipeline job using this reservation will execute with the slot
+          #     capacity specified in the slot_capacity field at most.
+          # @!attribute [r] creation_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Creation time of the reservation.
+          # @!attribute [r] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Last update time of the reservation.
           class Reservation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -72,6 +79,10 @@ module Google
           # @!attribute [r] state
           #   @return [::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::State]
           #     Output only. State of the commitment.
+          # @!attribute [r] commitment_start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The start of the current commitment period. It is applicable only for
+          #     ACTIVE capacity commitments.
           # @!attribute [r] commitment_end_time
           #   @return [::Google::Protobuf::Timestamp]
           #     Output only. The end of the current commitment period. It is applicable only for ACTIVE
@@ -226,6 +237,13 @@ module Google
           #   @return [::Boolean]
           #     If true, fail the request if another project in the organization has a
           #     capacity commitment.
+          # @!attribute [rw] capacity_commitment_id
+          #   @return [::String]
+          #     The optional capacity commitment ID. Capacity commitment name will be
+          #     generated automatically if this field is empty.
+          #     This field must only contain lower case alphanumeric characters or dash.
+          #     Max length is 64 characters.
+          #     NOTE: this ID won't be kept if the capacity commitment is split or merged.
           class CreateCapacityCommitmentRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -275,6 +293,11 @@ module Google
           #   @return [::String]
           #     Required. Resource name of the capacity commitment to delete. E.g.,
           #        `projects/myproject/locations/US/capacityCommitments/123`
+          # @!attribute [rw] force
+          #   @return [::Boolean]
+          #     Can be used to force delete commitments even if assignments exist. Deleting
+          #     commitments with assignments may cause queries to fail if they no longer
+          #     have access to slots.
           class DeleteCapacityCommitmentRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -365,6 +388,10 @@ module Google
 
               # Query jobs from the project will use the reservation.
               QUERY = 2
+
+              # BigQuery ML jobs that use services external to BigQuery for model
+              # training. These jobs will not utilize idle slots from other reservations.
+              ML_EXTERNAL = 3
             end
 
             # Assignment will remain in PENDING state if no active capacity commitment is
@@ -393,6 +420,12 @@ module Google
           # @!attribute [rw] assignment
           #   @return [::Google::Cloud::Bigquery::Reservation::V1::Assignment]
           #     Assignment resource to create.
+          # @!attribute [rw] assignment_id
+          #   @return [::String]
+          #     The optional assignment ID. Assignment name will be generated automatically
+          #     if this field is empty.
+          #     This field must only contain lower case alphanumeric characters or dash.
+          #     Max length is 64 characters.
           class CreateAssignmentRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -473,6 +506,35 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # The request for
+          # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_all_assignments ReservationService.SearchAllAssignments}.
+          # Note: "bigquery.reservationAssignments.search" permission is required on the
+          # related assignee.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The resource name with location (project name could be the wildcard '-'),
+          #     e.g.:
+          #       `projects/-/locations/US`.
+          # @!attribute [rw] query
+          #   @return [::String]
+          #     Please specify resource name as assignee in the query.
+          #
+          #     Examples:
+          #
+          #     * `assignee=projects/myproject`
+          #     * `assignee=folders/123`
+          #     * `assignee=organizations/456`
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return per page.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous List request, if any.
+          class SearchAllAssignmentsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_assignments ReservationService.SearchAssignments}.
           # @!attribute [rw] assignments
           #   @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::Assignment>]
@@ -486,6 +548,19 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_all_assignments ReservationService.SearchAllAssignments}.
+          # @!attribute [rw] assignments
+          #   @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::Assignment>]
+          #     List of assignments visible to the user.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no
+          #     more results in the list.
+          class SearchAllAssignmentsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The request for
           # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#move_assignment ReservationService.MoveAssignment}.
           #
@@ -514,7 +589,7 @@ module Google
           #   @return [::String]
           #     The resource name of the singleton BI reservation.
           #     Reservation names have the form
-          #     `projects/{project_id}/locations/{location_id}/bireservation`.
+          #     `projects/{project_id}/locations/{location_id}/biReservation`.
           # @!attribute [r] update_time
           #   @return [::Google::Protobuf::Timestamp]
           #     Output only. The last update timestamp of a reservation.
@@ -530,7 +605,7 @@ module Google
           # @!attribute [rw] name
           #   @return [::String]
           #     Required. Name of the requested reservation, for example:
-          #     `projects/{project_id}/locations/{location_id}/bireservation`
+          #     `projects/{project_id}/locations/{location_id}/biReservation`
           class GetBiReservationRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-reservation-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the BigQuery Reservation V1 API