google-cloud-bigquery-reservation-v1 0.4.0 → 0.5.0

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
@@ -85,7 +85,7 @@ module Google
               #
               # 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.
+              # you delete the first one after the commitment end time passes.
               rpc :SplitCapacityCommitment, ::Google::Cloud::Bigquery::Reservation::V1::SplitCapacityCommitmentRequest, ::Google::Cloud::Bigquery::Reservation::V1::SplitCapacityCommitmentResponse
               # Merges capacity commitments of the same plan into a single commitment.
               #
@@ -169,8 +169,8 @@ 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
-              # Deprecated: Looks up assignments for a specified resource for a particular region.
-              # If the request is about a project:
+              # 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.
               # 2. Otherwise assignments created on the closest ancestor will be
@@ -220,6 +220,10 @@ module Google
               # by providing a transactional change that ensures an assignee always has an
               # associated reservation.
               rpc :MoveAssignment, ::Google::Cloud::Bigquery::Reservation::V1::MoveAssignmentRequest, ::Google::Cloud::Bigquery::Reservation::V1::Assignment
+              # Updates an existing assignment.
+              #
+              # Only the `priority` field can be updated.
+              rpc :UpdateAssignment, ::Google::Cloud::Bigquery::Reservation::V1::UpdateAssignmentRequest, ::Google::Cloud::Bigquery::Reservation::V1::Assignment
               # Retrieves a BI reservation.
               rpc :GetBiReservation, ::Google::Cloud::Bigquery::Reservation::V1::GetBiReservationRequest, ::Google::Cloud::Bigquery::Reservation::V1::BiReservation
               # Updates a BI reservation.

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

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Reservation
         module V1
-          VERSION = "0.4.0"
+          VERSION = "0.5.0"
         end
       end
     end

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

@@ -26,6 +26,8 @@ module Google
         ##
         # To load this package, including all its services, and instantiate a client:
         #
+        # @example
+        #
         #     require "google/cloud/bigquery/reservation/v1"
         #     client = ::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client.new
         #

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

@@ -27,6 +27,9 @@ module Google
           #   @return [::String]
           #     The resource name of the reservation, e.g.,
           #     `projects/*/locations/*/reservations/team1-prod`.
+          #     The reservation_id must only contain lower case alphanumeric characters or
+          #     dashes. It must start with a letter and must not end with a dash. Its
+          #     maximum length is 64 characters.
           # @!attribute [rw] slot_capacity
           #   @return [::Integer]
           #     Minimum slots available to this reservation. A slot is a unit of
@@ -35,22 +38,41 @@ module Google
           #     Queries using this reservation might use more slots during runtime if
           #     ignore_idle_slots is set to false.
           #
-          #     If the new reservation's slot capacity exceed the parent's slot capacity or
-          #     if total slot capacity of the new reservation and its siblings exceeds the
-          #     parent's slot capacity, the request will fail with
+          #     If the new reservation's slot capacity exceeds the project's slot capacity
+          #     or if total slot capacity of the new reservation and its siblings exceeds
+          #     the project's slot capacity, the request will fail with
           #     `google.rpc.Code.RESOURCE_EXHAUSTED`.
+          #
+          #     NOTE: for reservations in US or EU multi-regions, slot capacity constraints
+          #     are checked separately for default and auxiliary regions. See
+          #     multi_region_auxiliary flag for more details.
           # @!attribute [rw] ignore_idle_slots
           #   @return [::Boolean]
           #     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 [rw] concurrency
+          #   @return [::Integer]
+          #     Maximum number of queries that are allowed to run concurrently in this
+          #     reservation. This is a soft limit due to asynchronous nature of the system
+          #     and various optimizations for small queries.
+          #     Default value is 0 which means that concurrency will be automatically set
+          #     based on the reservation size.
           # @!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.
+          # @!attribute [rw] multi_region_auxiliary
+          #   @return [::Boolean]
+          #     Applicable only for reservations located within one of the BigQuery
+          #     multi-regions (US or EU).
+          #
+          #     If set to true, this reservation is placed in the organization's
+          #     secondary region which is designated for disaster recovery purposes.
+          #     If false, this reservation is placed in the organization's default region.
           class Reservation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -70,6 +92,9 @@ module Google
           #   @return [::String]
           #     Output only. The resource name of the capacity commitment, e.g.,
           #     `projects/myproject/locations/US/capacityCommitments/123`
+          #     The commitment_id must only contain lower case alphanumeric characters or
+          #     dashes. It must start with a letter and must not end
+          #     with a dash. Its maximum length is 64 characters.
           # @!attribute [rw] slot_count
           #   @return [::Integer]
           #     Number of slots in this commitment.
@@ -95,6 +120,14 @@ module Google
           #     The plan this capacity commitment is converted to after commitment_end_time
           #     passes. Once the plan is changed, committed period is extended according to
           #     commitment plan. Only applicable for ANNUAL and TRIAL commitments.
+          # @!attribute [rw] multi_region_auxiliary
+          #   @return [::Boolean]
+          #     Applicable only for commitments located within one of the BigQuery
+          #     multi-regions (US or EU).
+          #
+          #     If set to true, this commitment is placed in the organization's
+          #     secondary region which is designated for disaster recovery purposes.
+          #     If false, this commitment is placed in the organization's default region.
           class CapacityCommitment
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -135,11 +168,11 @@ module Google
               STATE_UNSPECIFIED = 0
 
               # Capacity commitment is pending provisioning. Pending capacity commitment
-              # does not contribute to the parent's slot_capacity.
+              # does not contribute to the project's slot_capacity.
               PENDING = 1
 
               # Once slots are provisioned, capacity commitment becomes active.
-              # slot_count is added to the parent's slot_capacity.
+              # slot_count is added to the project's slot_capacity.
               ACTIVE = 2
 
               # Capacity commitment is failed to be activated by the backend.
@@ -154,8 +187,9 @@ module Google
           #     `projects/myproject/locations/US`
           # @!attribute [rw] reservation_id
           #   @return [::String]
-          #     The reservation ID. This field must only contain lower case alphanumeric
-          #     characters or dash. Max length is 64 characters.
+          #     The reservation ID. It must only contain lower case alphanumeric
+          #     characters or dashes. It must start with a letter and must not end
+          #     with a dash. Its maximum length is 64 characters.
           # @!attribute [rw] reservation
           #   @return [::Google::Cloud::Bigquery::Reservation::V1::Reservation]
           #     Definition of the new reservation to create.
@@ -241,8 +275,8 @@ module Google
           #   @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.
+          #     This field must only contain lower case alphanumeric characters or dashes.
+          #     The first and last character cannot be a 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
@@ -357,12 +391,14 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # A Assignment allows a project to submit jobs
+          # An assignment allows a project to submit jobs
           # of a certain type using slots from the specified reservation.
           # @!attribute [r] name
           #   @return [::String]
           #     Output only. Name of the resource. E.g.:
           #     `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
+          #     The assignment_id must only contain lower case alphanumeric characters or
+          #     dashes and the max length is 64 characters.
           # @!attribute [rw] assignee
           #   @return [::String]
           #     The resource which will use the reservation. E.g.
@@ -424,7 +460,7 @@ module Google
           #   @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.
+          #     This field must only contain lower case alphanumeric characters or dashes.
           #     Max length is 64 characters.
           class CreateAssignmentRequest
             include ::Google::Protobuf::MessageExts
@@ -584,6 +620,34 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_assignment ReservationService.UpdateAssignment}.
+          # @!attribute [rw] assignment
+          #   @return [::Google::Cloud::Bigquery::Reservation::V1::Assignment]
+          #     Content of the assignment to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Standard field mask for the set of fields to be updated.
+          class UpdateAssignmentRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Fully qualified reference to BigQuery table.
+          # Internally stored as google.cloud.bi.v1.BqTableReference.
+          # @!attribute [rw] project_id
+          #   @return [::String]
+          #     The assigned project ID of the project.
+          # @!attribute [rw] dataset_id
+          #   @return [::String]
+          #     The ID of the dataset in the above project.
+          # @!attribute [rw] table_id
+          #   @return [::String]
+          #     The ID of the table in the above dataset.
+          class TableReference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Represents a BI Reservation.
           # @!attribute [rw] name
           #   @return [::String]
@@ -596,6 +660,9 @@ module Google
           # @!attribute [rw] size
           #   @return [::Integer]
           #     Size of a reservation, in bytes.
+          # @!attribute [rw] preferred_tables
+          #   @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::TableReference>]
+          #     Preferred tables to use BI capacity for.
           class BiReservation
             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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -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.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the BigQuery Reservation V1 API