google-cloud-bigquery-reservation-v1 0.7.0 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2fced309d84b0b3968da1ce270764f3534b96e3a7ea7f1cce0bd43a70b843b22
4
- data.tar.gz: 425f3be26e9f9af5bd8871e30d985ebee53b52f6ff8913b69bf2bee9ffd76279
3
+ metadata.gz: a1ebe2c7f28d8f507a068f66471eaf1f00e01a43a8e471e4d32de33e903ea8ff
4
+ data.tar.gz: 84da11db6bfb0ed7198822170f17aca01e5bea02868608e21f422e6312611253
5
5
  SHA512:
6
- metadata.gz: 8ff4feb5aa7ccb0b060d29577fe0fa37562fb14808b93b45be061428356b5b73cbab73f7fa83280e1b2564bf76f1559083522953bb47d6837beae50a8a8d4f9c
7
- data.tar.gz: '0986ed11755dae29f746c1bc44087facef37731c875159827caadff9244910346a45b62c7d8777cd78d707ae00f9a6bf658a47c76cef9f1672c3809ad1a462fa'
6
+ metadata.gz: 3d6b3c696eb7c5dbadbc7c4399e7db060c93284351657abaeeddb9d42d4376a850ed2dfc2456fd51548909c64402cfd7fd8e896516e8090d9ed31ad36977b625
7
+ data.tar.gz: 82df1ab50ab0d885106497b4476b2d0b2deae3b7238e2c1e6717681d3df23947c0398f3a29187ca75f17c788ed0ba373c47abbab886d3022062d1bc52754714b
data/README.md CHANGED
@@ -47,7 +47,7 @@ for general usage information.
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
49
  The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
50
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
53
 
@@ -18,10 +18,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
18
18
  optional :name, :string, 1
19
19
  optional :slot_capacity, :int64, 2
20
20
  optional :ignore_idle_slots, :bool, 4
21
+ optional :autoscale, :message, 7, "google.cloud.bigquery.reservation.v1.Reservation.Autoscale"
21
22
  optional :concurrency, :int64, 16
22
23
  optional :creation_time, :message, 8, "google.protobuf.Timestamp"
23
24
  optional :update_time, :message, 9, "google.protobuf.Timestamp"
24
25
  optional :multi_region_auxiliary, :bool, 14
26
+ optional :edition, :enum, 17, "google.cloud.bigquery.reservation.v1.Edition"
27
+ end
28
+ add_message "google.cloud.bigquery.reservation.v1.Reservation.Autoscale" do
29
+ optional :current_slots, :int64, 1
30
+ optional :max_slots, :int64, 2
25
31
  end
26
32
  add_message "google.cloud.bigquery.reservation.v1.CapacityCommitment" do
27
33
  optional :name, :string, 1
@@ -33,13 +39,19 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
33
39
  optional :failure_status, :message, 7, "google.rpc.Status"
34
40
  optional :renewal_plan, :enum, 8, "google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan"
35
41
  optional :multi_region_auxiliary, :bool, 10
42
+ optional :edition, :enum, 12, "google.cloud.bigquery.reservation.v1.Edition"
36
43
  end
37
44
  add_enum "google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan" do
38
45
  value :COMMITMENT_PLAN_UNSPECIFIED, 0
39
46
  value :FLEX, 3
47
+ value :FLEX_FLAT_RATE, 7
40
48
  value :TRIAL, 5
41
49
  value :MONTHLY, 2
50
+ value :MONTHLY_FLAT_RATE, 8
42
51
  value :ANNUAL, 4
52
+ value :ANNUAL_FLAT_RATE, 9
53
+ value :THREE_YEAR, 10
54
+ value :NONE, 6
43
55
  end
44
56
  add_enum "google.cloud.bigquery.reservation.v1.CapacityCommitment.State" do
45
57
  value :STATE_UNSPECIFIED, 0
@@ -120,6 +132,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
120
132
  value :PIPELINE, 1
121
133
  value :QUERY, 2
122
134
  value :ML_EXTERNAL, 3
135
+ value :BACKGROUND, 4
123
136
  end
124
137
  add_enum "google.cloud.bigquery.reservation.v1.Assignment.State" do
125
138
  value :STATE_UNSPECIFIED, 0
@@ -166,6 +179,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
166
179
  add_message "google.cloud.bigquery.reservation.v1.MoveAssignmentRequest" do
167
180
  optional :name, :string, 1
168
181
  optional :destination_id, :string, 3
182
+ optional :assignment_id, :string, 5
169
183
  end
170
184
  add_message "google.cloud.bigquery.reservation.v1.UpdateAssignmentRequest" do
171
185
  optional :assignment, :message, 1, "google.cloud.bigquery.reservation.v1.Assignment"
@@ -189,6 +203,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
189
203
  optional :bi_reservation, :message, 1, "google.cloud.bigquery.reservation.v1.BiReservation"
190
204
  optional :update_mask, :message, 2, "google.protobuf.FieldMask"
191
205
  end
206
+ add_enum "google.cloud.bigquery.reservation.v1.Edition" do
207
+ value :EDITION_UNSPECIFIED, 0
208
+ value :STANDARD, 1
209
+ value :ENTERPRISE, 2
210
+ value :ENTERPRISE_PLUS, 3
211
+ end
192
212
  end
193
213
  end
194
214
 
@@ -198,6 +218,7 @@ module Google
198
218
  module Reservation
199
219
  module V1
200
220
  Reservation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.Reservation").msgclass
221
+ Reservation::Autoscale = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.Reservation.Autoscale").msgclass
201
222
  CapacityCommitment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.CapacityCommitment").msgclass
202
223
  CapacityCommitment::CommitmentPlan = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan").enummodule
203
224
  CapacityCommitment::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.CapacityCommitment.State").enummodule
@@ -233,6 +254,7 @@ module Google
233
254
  BiReservation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.BiReservation").msgclass
234
255
  GetBiReservationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.GetBiReservationRequest").msgclass
235
256
  UpdateBiReservationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.UpdateBiReservationRequest").msgclass
257
+ Edition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.reservation.v1.Edition").enummodule
236
258
  end
237
259
  end
238
260
  end
@@ -28,7 +28,7 @@ module Google
28
28
  ##
29
29
  # Client for the ReservationService service.
30
30
  #
31
- # This API allows users to manage their flat-rate BigQuery reservations.
31
+ # This API allows users to manage their BigQuery reservations.
32
32
  #
33
33
  # A reservation provides computational resource guarantees, in the form of
34
34
  # [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
@@ -1721,8 +1721,8 @@ module Google
1721
1721
  # the default parameter values, pass an empty Hash as a request object (see above).
1722
1722
  #
1723
1723
  # @param parent [::String]
1724
- # Required. The resource name of the admin project(containing project and location),
1725
- # e.g.:
1724
+ # Required. The resource name of the admin project(containing project and
1725
+ # location), e.g.:
1726
1726
  # `projects/myproject/locations/US`.
1727
1727
  # @param query [::String]
1728
1728
  # Please specify resource name as assignee in the query.
@@ -1844,8 +1844,8 @@ module Google
1844
1844
  # the default parameter values, pass an empty Hash as a request object (see above).
1845
1845
  #
1846
1846
  # @param parent [::String]
1847
- # Required. The resource name with location (project name could be the wildcard '-'),
1848
- # e.g.:
1847
+ # Required. The resource name with location (project name could be the
1848
+ # wildcard '-'), e.g.:
1849
1849
  # `projects/-/locations/US`.
1850
1850
  # @param query [::String]
1851
1851
  # Please specify resource name as assignee in the query.
@@ -1946,7 +1946,7 @@ module Google
1946
1946
  # @param options [::Gapic::CallOptions, ::Hash]
1947
1947
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1948
1948
  #
1949
- # @overload move_assignment(name: nil, destination_id: nil)
1949
+ # @overload move_assignment(name: nil, destination_id: nil, assignment_id: nil)
1950
1950
  # Pass arguments to `move_assignment` via keyword arguments. Note that at
1951
1951
  # least one keyword argument is required. To specify no parameters, or to keep all
1952
1952
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1958,6 +1958,12 @@ module Google
1958
1958
  # @param destination_id [::String]
1959
1959
  # The new reservation ID, e.g.:
1960
1960
  # `projects/myotherproject/locations/US/reservations/team2-prod`
1961
+ # @param assignment_id [::String]
1962
+ # The optional assignment ID. A new assignment name is generated if this
1963
+ # field is empty.
1964
+ #
1965
+ # This field can contain only lowercase alphanumeric characters or dashes.
1966
+ # Max length is 64 characters.
1961
1967
  #
1962
1968
  # @yield [response, operation] Access the result along with the RPC operation
1963
1969
  # @yieldparam response [::Google::Cloud::Bigquery::Reservation::V1::Assignment]
@@ -2330,9 +2336,9 @@ module Google
2330
2336
  # * (`String`) The path to a service account key file in JSON format
2331
2337
  # * (`Hash`) A service account key as a Hash
2332
2338
  # * (`Google::Auth::Credentials`) A googleauth credentials object
2333
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
2339
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2334
2340
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2335
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
2341
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2336
2342
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
2337
2343
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
2338
2344
  # * (`nil`) indicating no credentials
@@ -30,7 +30,7 @@ module Google
30
30
  ##
31
31
  # REST client for the ReservationService service.
32
32
  #
33
- # This API allows users to manage their flat-rate BigQuery reservations.
33
+ # This API allows users to manage their BigQuery reservations.
34
34
  #
35
35
  # A reservation provides computational resource guarantees, in the form of
36
36
  # [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
@@ -1353,8 +1353,8 @@ module Google
1353
1353
  # the default parameter values, pass an empty Hash as a request object (see above).
1354
1354
  #
1355
1355
  # @param parent [::String]
1356
- # Required. The resource name of the admin project(containing project and location),
1357
- # e.g.:
1356
+ # Required. The resource name of the admin project(containing project and
1357
+ # location), e.g.:
1358
1358
  # `projects/myproject/locations/US`.
1359
1359
  # @param query [::String]
1360
1360
  # Please specify resource name as assignee in the query.
@@ -1449,8 +1449,8 @@ module Google
1449
1449
  # the default parameter values, pass an empty Hash as a request object (see above).
1450
1450
  #
1451
1451
  # @param parent [::String]
1452
- # Required. The resource name with location (project name could be the wildcard '-'),
1453
- # e.g.:
1452
+ # Required. The resource name with location (project name could be the
1453
+ # wildcard '-'), e.g.:
1454
1454
  # `projects/-/locations/US`.
1455
1455
  # @param query [::String]
1456
1456
  # Please specify resource name as assignee in the query.
@@ -1524,7 +1524,7 @@ module Google
1524
1524
  # @param options [::Gapic::CallOptions, ::Hash]
1525
1525
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1526
1526
  #
1527
- # @overload move_assignment(name: nil, destination_id: nil)
1527
+ # @overload move_assignment(name: nil, destination_id: nil, assignment_id: nil)
1528
1528
  # Pass arguments to `move_assignment` via keyword arguments. Note that at
1529
1529
  # least one keyword argument is required. To specify no parameters, or to keep all
1530
1530
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1536,6 +1536,12 @@ module Google
1536
1536
  # @param destination_id [::String]
1537
1537
  # The new reservation ID, e.g.:
1538
1538
  # `projects/myotherproject/locations/US/reservations/team2-prod`
1539
+ # @param assignment_id [::String]
1540
+ # The optional assignment ID. A new assignment name is generated if this
1541
+ # field is empty.
1542
+ #
1543
+ # This field can contain only lowercase alphanumeric characters or dashes.
1544
+ # Max length is 64 characters.
1539
1545
  # @yield [result, operation] Access the result along with the TransportOperation object
1540
1546
  # @yieldparam result [::Google::Cloud::Bigquery::Reservation::V1::Assignment]
1541
1547
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1816,9 +1822,9 @@ module Google
1816
1822
  # * (`String`) The path to a service account key file in JSON format
1817
1823
  # * (`Hash`) A service account key as a Hash
1818
1824
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1819
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1825
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1820
1826
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1821
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1827
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1822
1828
  # * (`nil`) indicating no credentials
1823
1829
  # @return [::Object]
1824
1830
  # @!attribute [rw] scope
@@ -32,7 +32,7 @@ module Google
32
32
  module Reservation
33
33
  module V1
34
34
  ##
35
- # This API allows users to manage their flat-rate BigQuery reservations.
35
+ # This API allows users to manage their BigQuery reservations.
36
36
  #
37
37
  # A reservation provides computational resource guarantees, in the form of
38
38
  # [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
@@ -33,7 +33,7 @@ module Google
33
33
  module Reservation
34
34
  module V1
35
35
  ##
36
- # This API allows users to manage their flat-rate BigQuery reservations.
36
+ # This API allows users to manage their BigQuery reservations.
37
37
  #
38
38
  # A reservation provides computational resource guarantees, in the form of
39
39
  # [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
@@ -25,7 +25,7 @@ module Google
25
25
  module Reservation
26
26
  module V1
27
27
  module ReservationService
28
- # This API allows users to manage their flat-rate BigQuery reservations.
28
+ # This API allows users to manage their BigQuery reservations.
29
29
  #
30
30
  # A reservation provides computational resource guarantees, in the form of
31
31
  # [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigquery
23
23
  module Reservation
24
24
  module V1
25
- VERSION = "0.7.0"
25
+ VERSION = "0.8.1"
26
26
  end
27
27
  end
28
28
  end
@@ -35,7 +35,9 @@ module Google
35
35
  # Details about how and where to publish client libraries.
36
36
  # @!attribute [rw] version
37
37
  # @return [::String]
38
- # Version of the API to apply these settings to.
38
+ # Version of the API to apply these settings to. This is the full protobuf
39
+ # package for the API, ending in the version element.
40
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
39
41
  # @!attribute [rw] launch_stage
40
42
  # @return [::Google::Api::LaunchStage]
41
43
  # Launch stage of this version of the API.
@@ -111,6 +113,10 @@ module Google
111
113
  # Client library settings. If the same version string appears multiple
112
114
  # times in this list, then the last one wins. Settings from earlier
113
115
  # settings with the same version string are discarded.
116
+ # @!attribute [rw] proto_reference_documentation_uri
117
+ # @return [::String]
118
+ # Optional link to proto reference documentation. Example:
119
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
114
120
  class Publishing
115
121
  include ::Google::Protobuf::MessageExts
116
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
203
209
  # @!attribute [rw] common
204
210
  # @return [::Google::Api::CommonLanguageSettings]
205
211
  # Some settings.
212
+ # @!attribute [rw] renamed_services
213
+ # @return [::Google::Protobuf::Map{::String => ::String}]
214
+ # Map from original service names to renamed versions.
215
+ # This is used when the default generated types
216
+ # would cause a naming conflict. (Neither name is
217
+ # fully-qualified.)
218
+ # Example: Subscriber to SubscriberServiceApi.
219
+ # @!attribute [rw] renamed_resources
220
+ # @return [::Google::Protobuf::Map{::String => ::String}]
221
+ # Map from full resource types to the effective short name
222
+ # for the resource. This is used when otherwise resource
223
+ # named from different services would cause naming collisions.
224
+ # Example entry:
225
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
226
+ # @!attribute [rw] ignored_resources
227
+ # @return [::Array<::String>]
228
+ # List of full resource types to ignore during generation.
229
+ # This is typically used for API-specific Location resources,
230
+ # which should be handled by the generator as if they were actually
231
+ # the common Location resources.
232
+ # Example entry: "documentai.googleapis.com/Location"
233
+ # @!attribute [rw] forced_namespace_aliases
234
+ # @return [::Array<::String>]
235
+ # Namespaces which must be aliased in snippets due to
236
+ # a known (but non-generator-predictable) naming collision
237
+ # @!attribute [rw] handwritten_signatures
238
+ # @return [::Array<::String>]
239
+ # Method signatures (in the form "service.method(signature)")
240
+ # which are provided separately, so shouldn't be generated.
241
+ # Snippets *calling* these methods are still generated, however.
206
242
  class DotnetSettings
207
243
  include ::Google::Protobuf::MessageExts
208
244
  extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # @!attribute [rw] key
247
+ # @return [::String]
248
+ # @!attribute [rw] value
249
+ # @return [::String]
250
+ class RenamedServicesEntry
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # @!attribute [rw] key
256
+ # @return [::String]
257
+ # @!attribute [rw] value
258
+ # @return [::String]
259
+ class RenamedResourcesEntry
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
209
263
  end
210
264
 
211
265
  # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
240
294
  # Example of a YAML configuration::
241
295
  #
242
296
  # publishing:
243
- # method_behavior:
244
- # - selector: CreateAdDomain
297
+ # method_settings:
298
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
245
299
  # long_running:
246
300
  # initial_poll_delay:
247
301
  # seconds: 60 # 1 minute
@@ -38,10 +38,10 @@ module Google
38
38
  # Queries using this reservation might use more slots during runtime if
39
39
  # ignore_idle_slots is set to false.
40
40
  #
41
- # If the new reservation's slot capacity exceeds the project's slot capacity
42
- # or if total slot capacity of the new reservation and its siblings exceeds
43
- # the project's slot capacity, the request will fail with
44
- # `google.rpc.Code.RESOURCE_EXHAUSTED`.
41
+ # If total slot_capacity of the reservation and its siblings
42
+ # exceeds the total slot_count of all capacity commitments, the request will
43
+ # fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.
44
+ #
45
45
  #
46
46
  # NOTE: for reservations in US or EU multi-regions, slot capacity constraints
47
47
  # are checked separately for default and auxiliary regions. See
@@ -52,13 +52,20 @@ module Google
52
52
  # slots from other reservations within the same admin project. If true, a
53
53
  # query or pipeline job using this reservation will execute with the slot
54
54
  # capacity specified in the slot_capacity field at most.
55
+ # @!attribute [rw] autoscale
56
+ # @return [::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale]
57
+ # The configuration parameters for the auto scaling feature. Note this is an
58
+ # alpha feature.
55
59
  # @!attribute [rw] concurrency
56
60
  # @return [::Integer]
57
- # Maximum number of queries that are allowed to run concurrently in this
58
- # reservation. This is a soft limit due to asynchronous nature of the system
59
- # and various optimizations for small queries.
60
- # Default value is 0 which means that concurrency will be automatically set
61
- # based on the reservation size.
61
+ # Job concurrency target which sets a soft upper bound on the number of jobs
62
+ # that can run concurrently in this reservation. This is a soft target due to
63
+ # asynchronous nature of the system and various optimizations for small
64
+ # queries.
65
+ # Default value is 0 which means that concurrency target will be
66
+ # automatically computed by the system.
67
+ # NOTE: this field is exposed as `target_job_concurrency` in the Information
68
+ # Schema, DDL and BQ CLI.
62
69
  # @!attribute [r] creation_time
63
70
  # @return [::Google::Protobuf::Timestamp]
64
71
  # Output only. Creation time of the reservation.
@@ -73,9 +80,28 @@ module Google
73
80
  # If set to true, this reservation is placed in the organization's
74
81
  # secondary region which is designated for disaster recovery purposes.
75
82
  # If false, this reservation is placed in the organization's default region.
83
+ #
84
+ # NOTE: this is a preview feature. Project must be allow-listed in order to
85
+ # set this field.
86
+ # @!attribute [rw] edition
87
+ # @return [::Google::Cloud::Bigquery::Reservation::V1::Edition]
88
+ # Edition of the reservation.
76
89
  class Reservation
77
90
  include ::Google::Protobuf::MessageExts
78
91
  extend ::Google::Protobuf::MessageExts::ClassMethods
92
+
93
+ # Auto scaling settings.
94
+ # @!attribute [r] current_slots
95
+ # @return [::Integer]
96
+ # Output only. The slot capacity added to this reservation when autoscale
97
+ # happens. Will be between [0, max_slots].
98
+ # @!attribute [rw] max_slots
99
+ # @return [::Integer]
100
+ # Number of slots to be scaled when needed.
101
+ class Autoscale
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
79
105
  end
80
106
 
81
107
  # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
@@ -106,12 +132,12 @@ module Google
106
132
  # Output only. State of the commitment.
107
133
  # @!attribute [r] commitment_start_time
108
134
  # @return [::Google::Protobuf::Timestamp]
109
- # Output only. The start of the current commitment period. It is applicable only for
110
- # ACTIVE capacity commitments.
135
+ # Output only. The start of the current commitment period. It is applicable
136
+ # only for ACTIVE capacity commitments.
111
137
  # @!attribute [r] commitment_end_time
112
138
  # @return [::Google::Protobuf::Timestamp]
113
- # Output only. The end of the current commitment period. It is applicable only for ACTIVE
114
- # capacity commitments.
139
+ # Output only. The end of the current commitment period. It is applicable
140
+ # only for ACTIVE capacity commitments.
115
141
  # @!attribute [r] failure_status
116
142
  # @return [::Google::Rpc::Status]
117
143
  # Output only. For FAILED commitment plan, provides the reason of failure.
@@ -128,6 +154,12 @@ module Google
128
154
  # If set to true, this commitment is placed in the organization's
129
155
  # secondary region which is designated for disaster recovery purposes.
130
156
  # If false, this commitment is placed in the organization's default region.
157
+ #
158
+ # NOTE: this is a preview feature. Project must be allow-listed in order to
159
+ # set this field.
160
+ # @!attribute [rw] edition
161
+ # @return [::Google::Cloud::Bigquery::Reservation::V1::Edition]
162
+ # Edition of the capacity commitment.
131
163
  class CapacityCommitment
132
164
  include ::Google::Protobuf::MessageExts
133
165
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -144,6 +176,10 @@ module Google
144
176
  # any time.
145
177
  FLEX = 3
146
178
 
179
+ # Same as FLEX, should only be used if flat-rate commitments are still
180
+ # available.
181
+ FLEX_FLAT_RATE = 7
182
+
147
183
  # Trial commitments have a committed period of 182 days after becoming
148
184
  # ACTIVE. After that, they are converted to a new commitment based on the
149
185
  # `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so
@@ -155,10 +191,31 @@ module Google
155
191
  # removed any time.
156
192
  MONTHLY = 2
157
193
 
194
+ # Same as MONTHLY, should only be used if flat-rate commitments are still
195
+ # available.
196
+ MONTHLY_FLAT_RATE = 8
197
+
158
198
  # Annual commitments have a committed period of 365 days after becoming
159
199
  # ACTIVE. After that they are converted to a new commitment based on the
160
200
  # renewal_plan.
161
201
  ANNUAL = 4
202
+
203
+ # Same as ANNUAL, should only be used if flat-rate commitments are still
204
+ # available.
205
+ ANNUAL_FLAT_RATE = 9
206
+
207
+ # 3-year commitments have a committed period of 1095(3 * 365) days after
208
+ # becoming ACTIVE. After that they are converted to a new commitment based
209
+ # on the renewal_plan.
210
+ THREE_YEAR = 10
211
+
212
+ # Should only be used for `renewal_plan` and is only meaningful if
213
+ # edition is specified to values other than EDITION_UNSPECIFIED. Otherwise
214
+ # CreateCapacityCommitmentRequest or UpdateCapacityCommitmentRequest will
215
+ # be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. If the
216
+ # renewal_plan is NONE, capacity commitment will be removed at the end of
217
+ # its commitment period.
218
+ NONE = 6
162
219
  end
163
220
 
164
221
  # Capacity commitment can either become ACTIVE right away or transition
@@ -180,7 +237,8 @@ module Google
180
237
  end
181
238
  end
182
239
 
183
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_reservation ReservationService.CreateReservation}.
240
+ # The request for
241
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_reservation ReservationService.CreateReservation}.
184
242
  # @!attribute [rw] parent
185
243
  # @return [::String]
186
244
  # Required. Project, location. E.g.,
@@ -198,7 +256,8 @@ module Google
198
256
  extend ::Google::Protobuf::MessageExts::ClassMethods
199
257
  end
200
258
 
201
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_reservations ReservationService.ListReservations}.
259
+ # The request for
260
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_reservations ReservationService.ListReservations}.
202
261
  # @!attribute [rw] parent
203
262
  # @return [::String]
204
263
  # Required. The parent resource name containing project and location, e.g.:
@@ -214,7 +273,8 @@ module Google
214
273
  extend ::Google::Protobuf::MessageExts::ClassMethods
215
274
  end
216
275
 
217
- # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_reservations ReservationService.ListReservations}.
276
+ # The response for
277
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_reservations ReservationService.ListReservations}.
218
278
  # @!attribute [rw] reservations
219
279
  # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::Reservation>]
220
280
  # List of reservations visible to the user.
@@ -227,7 +287,8 @@ module Google
227
287
  extend ::Google::Protobuf::MessageExts::ClassMethods
228
288
  end
229
289
 
230
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#get_reservation ReservationService.GetReservation}.
290
+ # The request for
291
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#get_reservation ReservationService.GetReservation}.
231
292
  # @!attribute [rw] name
232
293
  # @return [::String]
233
294
  # Required. Resource name of the reservation to retrieve. E.g.,
@@ -237,7 +298,8 @@ module Google
237
298
  extend ::Google::Protobuf::MessageExts::ClassMethods
238
299
  end
239
300
 
240
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_reservation ReservationService.DeleteReservation}.
301
+ # The request for
302
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_reservation ReservationService.DeleteReservation}.
241
303
  # @!attribute [rw] name
242
304
  # @return [::String]
243
305
  # Required. Resource name of the reservation to retrieve. E.g.,
@@ -247,7 +309,8 @@ module Google
247
309
  extend ::Google::Protobuf::MessageExts::ClassMethods
248
310
  end
249
311
 
250
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_reservation ReservationService.UpdateReservation}.
312
+ # The request for
313
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_reservation ReservationService.UpdateReservation}.
251
314
  # @!attribute [rw] reservation
252
315
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Reservation]
253
316
  # Content of the reservation to update.
@@ -259,7 +322,8 @@ module Google
259
322
  extend ::Google::Protobuf::MessageExts::ClassMethods
260
323
  end
261
324
 
262
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_capacity_commitment ReservationService.CreateCapacityCommitment}.
325
+ # The request for
326
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_capacity_commitment ReservationService.CreateCapacityCommitment}.
263
327
  # @!attribute [rw] parent
264
328
  # @return [::String]
265
329
  # Required. Resource name of the parent reservation. E.g.,
@@ -283,7 +347,8 @@ module Google
283
347
  extend ::Google::Protobuf::MessageExts::ClassMethods
284
348
  end
285
349
 
286
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_capacity_commitments ReservationService.ListCapacityCommitments}.
350
+ # The request for
351
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_capacity_commitments ReservationService.ListCapacityCommitments}.
287
352
  # @!attribute [rw] parent
288
353
  # @return [::String]
289
354
  # Required. Resource name of the parent reservation. E.g.,
@@ -299,7 +364,8 @@ module Google
299
364
  extend ::Google::Protobuf::MessageExts::ClassMethods
300
365
  end
301
366
 
302
- # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_capacity_commitments ReservationService.ListCapacityCommitments}.
367
+ # The response for
368
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_capacity_commitments ReservationService.ListCapacityCommitments}.
303
369
  # @!attribute [rw] capacity_commitments
304
370
  # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment>]
305
371
  # List of capacity commitments visible to the user.
@@ -312,7 +378,8 @@ module Google
312
378
  extend ::Google::Protobuf::MessageExts::ClassMethods
313
379
  end
314
380
 
315
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#get_capacity_commitment ReservationService.GetCapacityCommitment}.
381
+ # The request for
382
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#get_capacity_commitment ReservationService.GetCapacityCommitment}.
316
383
  # @!attribute [rw] name
317
384
  # @return [::String]
318
385
  # Required. Resource name of the capacity commitment to retrieve. E.g.,
@@ -322,7 +389,8 @@ module Google
322
389
  extend ::Google::Protobuf::MessageExts::ClassMethods
323
390
  end
324
391
 
325
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_capacity_commitment ReservationService.DeleteCapacityCommitment}.
392
+ # The request for
393
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_capacity_commitment ReservationService.DeleteCapacityCommitment}.
326
394
  # @!attribute [rw] name
327
395
  # @return [::String]
328
396
  # Required. Resource name of the capacity commitment to delete. E.g.,
@@ -337,7 +405,8 @@ module Google
337
405
  extend ::Google::Protobuf::MessageExts::ClassMethods
338
406
  end
339
407
 
340
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_capacity_commitment ReservationService.UpdateCapacityCommitment}.
408
+ # The request for
409
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_capacity_commitment ReservationService.UpdateCapacityCommitment}.
341
410
  # @!attribute [rw] capacity_commitment
342
411
  # @return [::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment]
343
412
  # Content of the capacity commitment to update.
@@ -349,7 +418,8 @@ module Google
349
418
  extend ::Google::Protobuf::MessageExts::ClassMethods
350
419
  end
351
420
 
352
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#split_capacity_commitment ReservationService.SplitCapacityCommitment}.
421
+ # The request for
422
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#split_capacity_commitment ReservationService.SplitCapacityCommitment}.
353
423
  # @!attribute [rw] name
354
424
  # @return [::String]
355
425
  # Required. The resource name e.g.,:
@@ -362,7 +432,8 @@ module Google
362
432
  extend ::Google::Protobuf::MessageExts::ClassMethods
363
433
  end
364
434
 
365
- # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#split_capacity_commitment ReservationService.SplitCapacityCommitment}.
435
+ # The response for
436
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#split_capacity_commitment ReservationService.SplitCapacityCommitment}.
366
437
  # @!attribute [rw] first
367
438
  # @return [::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment]
368
439
  # First capacity commitment, result of a split.
@@ -374,7 +445,8 @@ module Google
374
445
  extend ::Google::Protobuf::MessageExts::ClassMethods
375
446
  end
376
447
 
377
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#merge_capacity_commitments ReservationService.MergeCapacityCommitments}.
448
+ # The request for
449
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#merge_capacity_commitments ReservationService.MergeCapacityCommitments}.
378
450
  # @!attribute [rw] parent
379
451
  # @return [::String]
380
452
  # Parent resource that identifies admin project and location e.g.,
@@ -428,6 +500,9 @@ module Google
428
500
  # BigQuery ML jobs that use services external to BigQuery for model
429
501
  # training. These jobs will not utilize idle slots from other reservations.
430
502
  ML_EXTERNAL = 3
503
+
504
+ # Background jobs that BigQuery runs for the customers in the background.
505
+ BACKGROUND = 4
431
506
  end
432
507
 
433
508
  # Assignment will remain in PENDING state if no active capacity commitment is
@@ -446,7 +521,8 @@ module Google
446
521
  end
447
522
  end
448
523
 
449
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_assignment ReservationService.CreateAssignment}.
524
+ # The request for
525
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_assignment ReservationService.CreateAssignment}.
450
526
  # Note: "bigquery.reservationAssignments.create" permission is required on the
451
527
  # related assignee.
452
528
  # @!attribute [rw] parent
@@ -467,7 +543,8 @@ module Google
467
543
  extend ::Google::Protobuf::MessageExts::ClassMethods
468
544
  end
469
545
 
470
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_assignments ReservationService.ListAssignments}.
546
+ # The request for
547
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_assignments ReservationService.ListAssignments}.
471
548
  # @!attribute [rw] parent
472
549
  # @return [::String]
473
550
  # Required. The parent resource name e.g.:
@@ -488,7 +565,8 @@ module Google
488
565
  extend ::Google::Protobuf::MessageExts::ClassMethods
489
566
  end
490
567
 
491
- # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_assignments ReservationService.ListAssignments}.
568
+ # The response for
569
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_assignments ReservationService.ListAssignments}.
492
570
  # @!attribute [rw] assignments
493
571
  # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::Assignment>]
494
572
  # List of assignments visible to the user.
@@ -501,7 +579,8 @@ module Google
501
579
  extend ::Google::Protobuf::MessageExts::ClassMethods
502
580
  end
503
581
 
504
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_assignment ReservationService.DeleteAssignment}.
582
+ # The request for
583
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_assignment ReservationService.DeleteAssignment}.
505
584
  # Note: "bigquery.reservationAssignments.delete" permission is required on the
506
585
  # related assignee.
507
586
  # @!attribute [rw] name
@@ -519,8 +598,8 @@ module Google
519
598
  # related assignee.
520
599
  # @!attribute [rw] parent
521
600
  # @return [::String]
522
- # Required. The resource name of the admin project(containing project and location),
523
- # e.g.:
601
+ # Required. The resource name of the admin project(containing project and
602
+ # location), e.g.:
524
603
  # `projects/myproject/locations/US`.
525
604
  # @!attribute [rw] query
526
605
  # @return [::String]
@@ -548,8 +627,8 @@ module Google
548
627
  # related assignee.
549
628
  # @!attribute [rw] parent
550
629
  # @return [::String]
551
- # Required. The resource name with location (project name could be the wildcard '-'),
552
- # e.g.:
630
+ # Required. The resource name with location (project name could be the
631
+ # wildcard '-'), e.g.:
553
632
  # `projects/-/locations/US`.
554
633
  # @!attribute [rw] query
555
634
  # @return [::String]
@@ -571,7 +650,8 @@ module Google
571
650
  extend ::Google::Protobuf::MessageExts::ClassMethods
572
651
  end
573
652
 
574
- # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_assignments ReservationService.SearchAssignments}.
653
+ # The response for
654
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_assignments ReservationService.SearchAssignments}.
575
655
  # @!attribute [rw] assignments
576
656
  # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::Assignment>]
577
657
  # List of assignments visible to the user.
@@ -584,7 +664,8 @@ module Google
584
664
  extend ::Google::Protobuf::MessageExts::ClassMethods
585
665
  end
586
666
 
587
- # The response for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_all_assignments ReservationService.SearchAllAssignments}.
667
+ # The response for
668
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#search_all_assignments ReservationService.SearchAllAssignments}.
588
669
  # @!attribute [rw] assignments
589
670
  # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::Assignment>]
590
671
  # List of assignments visible to the user.
@@ -615,12 +696,20 @@ module Google
615
696
  # @return [::String]
616
697
  # The new reservation ID, e.g.:
617
698
  # `projects/myotherproject/locations/US/reservations/team2-prod`
699
+ # @!attribute [rw] assignment_id
700
+ # @return [::String]
701
+ # The optional assignment ID. A new assignment name is generated if this
702
+ # field is empty.
703
+ #
704
+ # This field can contain only lowercase alphanumeric characters or dashes.
705
+ # Max length is 64 characters.
618
706
  class MoveAssignmentRequest
619
707
  include ::Google::Protobuf::MessageExts
620
708
  extend ::Google::Protobuf::MessageExts::ClassMethods
621
709
  end
622
710
 
623
- # The request for {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_assignment ReservationService.UpdateAssignment}.
711
+ # The request for
712
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#update_assignment ReservationService.UpdateAssignment}.
624
713
  # @!attribute [rw] assignment
625
714
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Assignment]
626
715
  # Content of the assignment to update.
@@ -689,6 +778,23 @@ module Google
689
778
  include ::Google::Protobuf::MessageExts
690
779
  extend ::Google::Protobuf::MessageExts::ClassMethods
691
780
  end
781
+
782
+ # The type of editions.
783
+ # Different features and behaviors are provided to different editions
784
+ # Capacity commitments and reservations are linked to editions.
785
+ module Edition
786
+ # Default value, which will be treated as ENTERPRISE.
787
+ EDITION_UNSPECIFIED = 0
788
+
789
+ # Standard edition.
790
+ STANDARD = 1
791
+
792
+ # Enterprise edition.
793
+ ENTERPRISE = 2
794
+
795
+ # Enterprise plus edition.
796
+ ENTERPRISE_PLUS = 3
797
+ end
692
798
  end
693
799
  end
694
800
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigquery-reservation-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.8.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-03-08 00:00:00.000000000 Z
11
+ date: 2023-03-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common