google-cloud-bigquery-reservation-v1 1.8.0 → 1.9.0

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.
@@ -25,14 +25,14 @@ module Google
25
25
  # A reservation is a mechanism used to guarantee slots to users.
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
- # The resource name of the reservation, e.g.,
28
+ # Identifier. The resource name of the reservation, e.g.,
29
29
  # `projects/*/locations/*/reservations/team1-prod`.
30
30
  # The reservation_id must only contain lower case alphanumeric characters or
31
31
  # dashes. It must start with a letter and must not end with a dash. Its
32
32
  # maximum length is 64 characters.
33
33
  # @!attribute [rw] slot_capacity
34
34
  # @return [::Integer]
35
- # Baseline slots available to this reservation. A slot is a unit of
35
+ # Optional. Baseline slots available to this reservation. A slot is a unit of
36
36
  # computational power in BigQuery, and serves as the unit of parallelism.
37
37
  #
38
38
  # Queries using this reservation might use more slots during runtime if
@@ -48,23 +48,22 @@ module Google
48
48
  # baseline slots every few minutes.
49
49
  # @!attribute [rw] ignore_idle_slots
50
50
  # @return [::Boolean]
51
- # If false, any query or pipeline job using this reservation will use idle
52
- # slots from other reservations within the same admin project. If true, a
53
- # query or pipeline job using this reservation will execute with the slot
54
- # capacity specified in the slot_capacity field at most.
51
+ # Optional. If false, any query or pipeline job using this reservation will
52
+ # use idle slots from other reservations within the same admin project. If
53
+ # true, a query or pipeline job using this reservation will execute with the
54
+ # slot capacity specified in the slot_capacity field at most.
55
55
  # @!attribute [rw] autoscale
56
56
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale]
57
- # The configuration parameters for the auto scaling feature.
57
+ # Optional. The configuration parameters for the auto scaling feature.
58
58
  # @!attribute [rw] concurrency
59
59
  # @return [::Integer]
60
- # Job concurrency target which sets a soft upper bound on the number of jobs
61
- # that can run concurrently in this reservation. This is a soft target due to
62
- # asynchronous nature of the system and various optimizations for small
63
- # queries.
64
- # Default value is 0 which means that concurrency target will be
65
- # automatically computed by the system.
66
- # NOTE: this field is exposed as target job concurrency in the Information
67
- # Schema, DDL and BigQuery CLI.
60
+ # Optional. Job concurrency target which sets a soft upper bound on the
61
+ # number of jobs that can run concurrently in this reservation. This is a
62
+ # soft target due to asynchronous nature of the system and various
63
+ # optimizations for small queries. Default value is 0 which means that
64
+ # concurrency target will be automatically computed by the system. NOTE: this
65
+ # field is exposed as target job concurrency in the Information Schema, DDL
66
+ # and BigQuery CLI.
68
67
  # @!attribute [r] creation_time
69
68
  # @return [::Google::Protobuf::Timestamp]
70
69
  # Output only. Creation time of the reservation.
@@ -72,6 +71,7 @@ module Google
72
71
  # @return [::Google::Protobuf::Timestamp]
73
72
  # Output only. Last update time of the reservation.
74
73
  # @!attribute [rw] multi_region_auxiliary
74
+ # @deprecated This field is deprecated and may be removed in the next major version update.
75
75
  # @return [::Boolean]
76
76
  # Applicable only for reservations located within one of the BigQuery
77
77
  # multi-regions (US or EU).
@@ -84,7 +84,7 @@ module Google
84
84
  # set this field.
85
85
  # @!attribute [rw] edition
86
86
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Edition]
87
- # Edition of the reservation.
87
+ # Optional. Edition of the reservation.
88
88
  # @!attribute [r] primary_location
89
89
  # @return [::String]
90
90
  # Output only. The current location of the reservation's primary replica.
@@ -114,10 +114,13 @@ module Google
114
114
  # will never exceed the max_slots - baseline.
115
115
  #
116
116
  #
117
- # This field must be set together with the scaling_mode enum value.
117
+ # This field must be set together with the scaling_mode enum value,
118
+ # otherwise the request will be rejected with error code
119
+ # `google.rpc.Code.INVALID_ARGUMENT`.
118
120
  #
119
121
  # If the max_slots and scaling_mode are set, the autoscale or
120
- # autoscale.max_slots field must be unset. However, the
122
+ # autoscale.max_slots field must be unset. Otherwise the request will be
123
+ # rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. However, the
121
124
  # autoscale field may still be in the output. The autopscale.max_slots will
122
125
  # always show as 0 and the autoscaler.current_slots will represent the
123
126
  # current slots from autoscaler excluding idle slots.
@@ -134,12 +137,14 @@ module Google
134
137
  #
135
138
  # If the max_slots and scaling_mode are set, then the ignore_idle_slots field
136
139
  # must be aligned with the scaling_mode enum value.(See details in
137
- # ScalingMode comments).
140
+ # ScalingMode comments). Otherwise the request will be rejected with
141
+ # error code `google.rpc.Code.INVALID_ARGUMENT`.
138
142
  #
139
143
  # Please note, the max_slots is for user to manage the part of slots greater
140
144
  # than the baseline. Therefore, we don't allow users to set max_slots smaller
141
145
  # or equal to the baseline as it will not be meaningful. If the field is
142
- # present and slot_capacity>=max_slots.
146
+ # present and slot_capacity>=max_slots, requests will be rejected with error
147
+ # code `google.rpc.Code.INVALID_ARGUMENT`.
143
148
  #
144
149
  # Please note that if max_slots is set to 0, we will treat it as unset.
145
150
  # Customers can set max_slots to 0 and set scaling_mode to
@@ -147,7 +152,21 @@ module Google
147
152
  # @!attribute [rw] scaling_mode
148
153
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Reservation::ScalingMode]
149
154
  # Optional. The scaling mode for the reservation.
150
- # If the field is present but max_slots is not present.
155
+ # If the field is present but max_slots is not present, requests will be
156
+ # rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
157
+ # @!attribute [rw] labels
158
+ # @return [::Google::Protobuf::Map{::String => ::String}]
159
+ # Optional. The labels associated with this reservation. You can use these
160
+ # to organize and group your reservations.
161
+ # You can set this property when you create or update a reservation.
162
+ # @!attribute [rw] reservation_group
163
+ # @return [::String]
164
+ # Optional. The reservation group that this reservation belongs to.
165
+ # You can set this property when you create or update a reservation.
166
+ # Reservations do not need to belong to a reservation group.
167
+ # Format:
168
+ # projects/\\{project}/locations/\\{location}/reservationGroups/\\{reservation_group}
169
+ # or just \\{reservation_group}
151
170
  # @!attribute [r] replication_status
152
171
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Reservation::ReplicationStatus]
153
172
  # Output only. The Disaster Recovery(DR) replication status of the
@@ -158,6 +177,13 @@ module Google
158
177
  # the reservation is either not a DR reservation or the reservation is a DR
159
178
  # secondary or that any replication operations on the reservation have
160
179
  # succeeded.
180
+ # @!attribute [rw] scheduling_policy
181
+ # @return [::Google::Cloud::Bigquery::Reservation::V1::SchedulingPolicy]
182
+ # Optional. The scheduling policy to use for jobs and queries running under
183
+ # this reservation. The scheduling policy controls how the reservation's
184
+ # resources are distributed.
185
+ #
186
+ # This feature is not yet generally available.
161
187
  class Reservation
162
188
  include ::Google::Protobuf::MessageExts
163
189
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -172,7 +198,7 @@ module Google
172
198
  # max_slots for that brief period (less than one minute)
173
199
  # @!attribute [rw] max_slots
174
200
  # @return [::Integer]
175
- # Number of slots to be scaled when needed.
201
+ # Optional. Number of slots to be scaled when needed.
176
202
  class Autoscale
177
203
  include ::Google::Protobuf::MessageExts
178
204
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -205,6 +231,15 @@ module Google
205
231
  extend ::Google::Protobuf::MessageExts::ClassMethods
206
232
  end
207
233
 
234
+ # @!attribute [rw] key
235
+ # @return [::String]
236
+ # @!attribute [rw] value
237
+ # @return [::String]
238
+ class LabelsEntry
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
208
243
  # The scaling mode for the reservation. This enum determines how the
209
244
  # reservation scales up and down.
210
245
  module ScalingMode
@@ -219,7 +254,8 @@ module Google
219
254
  # slots and no idle slots will be used.
220
255
  #
221
256
  # Please note, in this mode, the ignore_idle_slots field must be set to
222
- # true.
257
+ # true. Otherwise the request will be rejected with error code
258
+ # `google.rpc.Code.INVALID_ARGUMENT`.
223
259
  AUTOSCALE_ONLY = 1
224
260
 
225
261
  # The reservation will scale up using only idle slots contributed by
@@ -239,7 +275,8 @@ module Google
239
275
  # to max_slots.
240
276
  #
241
277
  # Please note, in this mode, the ignore_idle_slots field must be set to
242
- # false.
278
+ # false. Otherwise the request will be rejected with error code
279
+ # `google.rpc.Code.INVALID_ARGUMENT`.
243
280
  IDLE_SLOTS_ONLY = 2
244
281
 
245
282
  # The reservation will scale up using all slots available to it. It will
@@ -257,11 +294,45 @@ module Google
257
294
  # scale up to 1000 slots with 200 baseline and 800 autoscaling slots.
258
295
  #
259
296
  # Please note, in this mode, the ignore_idle_slots field must be set to
260
- # false.
297
+ # false. Otherwise the request will be rejected with error code
298
+ # `google.rpc.Code.INVALID_ARGUMENT`.
261
299
  ALL_SLOTS = 3
262
300
  end
263
301
  end
264
302
 
303
+ # The scheduling policy controls how a reservation's resources are distributed.
304
+ # @!attribute [rw] concurrency
305
+ # @return [::Integer]
306
+ # Optional. If present and > 0, the reservation will attempt to limit the
307
+ # concurrency of jobs running for any particular project within it to the
308
+ # given value.
309
+ #
310
+ # This feature is not yet generally available.
311
+ # @!attribute [rw] max_slots
312
+ # @return [::Integer]
313
+ # Optional. If present and > 0, the reservation will attempt to limit the
314
+ # slot consumption of queries running for any particular project within it to
315
+ # the given value.
316
+ #
317
+ # This feature is not yet generally available.
318
+ class SchedulingPolicy
319
+ include ::Google::Protobuf::MessageExts
320
+ extend ::Google::Protobuf::MessageExts::ClassMethods
321
+ end
322
+
323
+ # A reservation group is a container for reservations.
324
+ # @!attribute [rw] name
325
+ # @return [::String]
326
+ # Identifier. The resource name of the reservation group, e.g.,
327
+ # `projects/*/locations/*/reservationGroups/team1-prod`.
328
+ # The reservation_group_id must only contain lower case alphanumeric
329
+ # characters or dashes. It must start with a letter and must not end with a
330
+ # dash. Its maximum length is 64 characters.
331
+ class ReservationGroup
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+ end
335
+
265
336
  # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
266
337
  # (in the form of slots) with some committed period of usage. Annual
267
338
  # commitments renew by default. Commitments can be removed after their
@@ -281,10 +352,10 @@ module Google
281
352
  # with a dash. Its maximum length is 64 characters.
282
353
  # @!attribute [rw] slot_count
283
354
  # @return [::Integer]
284
- # Number of slots in this commitment.
355
+ # Optional. Number of slots in this commitment.
285
356
  # @!attribute [rw] plan
286
357
  # @return [::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan]
287
- # Capacity commitment commitment plan.
358
+ # Optional. Capacity commitment commitment plan.
288
359
  # @!attribute [r] state
289
360
  # @return [::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::State]
290
361
  # Output only. State of the commitment.
@@ -298,7 +369,7 @@ module Google
298
369
  # @return [::Google::Protobuf::Timestamp]
299
370
  # Output only. The end of the current commitment period. It is applicable
300
371
  # only for ACTIVE capacity commitments. Note after renewal,
301
- # commitment_end_time is the time the renewed commitment expires. So it would
372
+ # commitment_end_time is the time the renewed commitment expires. So itwould
302
373
  # be at a time after commitment_start_time + committed period, because we
303
374
  # don't change commitment_start_time ,
304
375
  # @!attribute [r] failure_status
@@ -306,10 +377,12 @@ module Google
306
377
  # Output only. For FAILED commitment plan, provides the reason of failure.
307
378
  # @!attribute [rw] renewal_plan
308
379
  # @return [::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan]
309
- # The plan this capacity commitment is converted to after commitment_end_time
310
- # passes. Once the plan is changed, committed period is extended according to
311
- # commitment plan. Only applicable for ANNUAL and TRIAL commitments.
380
+ # Optional. The plan this capacity commitment is converted to after
381
+ # commitment_end_time passes. Once the plan is changed, committed period is
382
+ # extended according to commitment plan. Only applicable for ANNUAL and TRIAL
383
+ # commitments.
312
384
  # @!attribute [rw] multi_region_auxiliary
385
+ # @deprecated This field is deprecated and may be removed in the next major version update.
313
386
  # @return [::Boolean]
314
387
  # Applicable only for commitments located within one of the BigQuery
315
388
  # multi-regions (US or EU).
@@ -322,7 +395,7 @@ module Google
322
395
  # set this field.
323
396
  # @!attribute [rw] edition
324
397
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Edition]
325
- # Edition of the capacity commitment.
398
+ # Optional. Edition of the capacity commitment.
326
399
  # @!attribute [r] is_flat_rate
327
400
  # @return [::Boolean]
328
401
  # Output only. If true, the commitment is a flat-rate commitment, otherwise,
@@ -504,6 +577,78 @@ module Google
504
577
  extend ::Google::Protobuf::MessageExts::ClassMethods
505
578
  end
506
579
 
580
+ # The request for
581
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_reservation_group ReservationService.CreateReservationGroup}.
582
+ # @!attribute [rw] parent
583
+ # @return [::String]
584
+ # Required. Project, location. E.g.,
585
+ # `projects/myproject/locations/US`
586
+ # @!attribute [rw] reservation_group_id
587
+ # @return [::String]
588
+ # Required. The reservation group ID. It must only contain lower case
589
+ # alphanumeric characters or dashes. It must start with a letter and must not
590
+ # end with a dash. Its maximum length is 64 characters.
591
+ # @!attribute [rw] reservation_group
592
+ # @return [::Google::Cloud::Bigquery::Reservation::V1::ReservationGroup]
593
+ # Required. New Reservation Group to create.
594
+ class CreateReservationGroupRequest
595
+ include ::Google::Protobuf::MessageExts
596
+ extend ::Google::Protobuf::MessageExts::ClassMethods
597
+ end
598
+
599
+ # The request for
600
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#get_reservation_group ReservationService.GetReservationGroup}.
601
+ # @!attribute [rw] name
602
+ # @return [::String]
603
+ # Required. Resource name of the reservation group to retrieve. E.g.,
604
+ # `projects/myproject/locations/US/reservationGroups/team1-prod`
605
+ class GetReservationGroupRequest
606
+ include ::Google::Protobuf::MessageExts
607
+ extend ::Google::Protobuf::MessageExts::ClassMethods
608
+ end
609
+
610
+ # The request for
611
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_reservation_groups ReservationService.ListReservationGroups}.
612
+ # @!attribute [rw] parent
613
+ # @return [::String]
614
+ # Required. The parent resource name containing project and location, e.g.:
615
+ # `projects/myproject/locations/US`
616
+ # @!attribute [rw] page_size
617
+ # @return [::Integer]
618
+ # The maximum number of items to return per page.
619
+ # @!attribute [rw] page_token
620
+ # @return [::String]
621
+ # The next_page_token value returned from a previous List request, if any.
622
+ class ListReservationGroupsRequest
623
+ include ::Google::Protobuf::MessageExts
624
+ extend ::Google::Protobuf::MessageExts::ClassMethods
625
+ end
626
+
627
+ # The response for
628
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#list_reservation_groups ReservationService.ListReservationGroups}.
629
+ # @!attribute [rw] reservation_groups
630
+ # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::ReservationGroup>]
631
+ # List of reservations visible to the user.
632
+ # @!attribute [rw] next_page_token
633
+ # @return [::String]
634
+ # Token to retrieve the next page of results, or empty if there are no
635
+ # more results in the list.
636
+ class ListReservationGroupsResponse
637
+ include ::Google::Protobuf::MessageExts
638
+ extend ::Google::Protobuf::MessageExts::ClassMethods
639
+ end
640
+
641
+ # The request for
642
+ # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#delete_reservation_group ReservationService.DeleteReservationGroup}.
643
+ # @!attribute [rw] name
644
+ # @return [::String]
645
+ # Required. Resource name of the reservation group to retrieve. E.g.,
646
+ # `projects/myproject/locations/US/reservationGroups/team1-prod`
647
+ class DeleteReservationGroupRequest
648
+ include ::Google::Protobuf::MessageExts
649
+ extend ::Google::Protobuf::MessageExts::ClassMethods
650
+ end
651
+
507
652
  # The request for
508
653
  # {::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client#create_capacity_commitment ReservationService.CreateCapacityCommitment}.
509
654
  # @!attribute [rw] parent
@@ -640,6 +785,12 @@ module Google
640
785
  # specified in the parent.
641
786
  # ID is the last portion of capacity commitment name e.g., 'abc' for
642
787
  # projects/myproject/locations/US/capacityCommitments/abc
788
+ # @!attribute [rw] capacity_commitment_id
789
+ # @return [::String]
790
+ # Optional. The optional resulting capacity commitment ID. Capacity
791
+ # commitment name will be generated automatically if this field is empty.
792
+ # This field must only contain lower case alphanumeric characters or dashes.
793
+ # The first and last character cannot be a dash. Max length is 64 characters.
643
794
  class MergeCapacityCommitmentsRequest
644
795
  include ::Google::Protobuf::MessageExts
645
796
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -655,11 +806,11 @@ module Google
655
806
  # dashes and the max length is 64 characters.
656
807
  # @!attribute [rw] assignee
657
808
  # @return [::String]
658
- # The resource which will use the reservation. E.g.
809
+ # Optional. The resource which will use the reservation. E.g.
659
810
  # `projects/myproject`, `folders/123`, or `organizations/456`.
660
811
  # @!attribute [rw] job_type
661
812
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Assignment::JobType]
662
- # Which type of jobs will use the reservation.
813
+ # Optional. Which type of jobs will use the reservation.
663
814
  # @!attribute [r] state
664
815
  # @return [::Google::Cloud::Bigquery::Reservation::V1::Assignment::State]
665
816
  # Output only. State of the assignment.
@@ -673,6 +824,14 @@ module Google
673
824
  # the parent reservation edition is ENTERPRISE_PLUS, then the assignment will
674
825
  # give the grantee project/organization access to "Gemini in BigQuery"
675
826
  # features.
827
+ # @!attribute [rw] scheduling_policy
828
+ # @return [::Google::Cloud::Bigquery::Reservation::V1::SchedulingPolicy]
829
+ # Optional. The scheduling policy to use for jobs and queries of this
830
+ # assignee when running under the associated reservation. The scheduling
831
+ # policy controls how the reservation's resources are distributed. This
832
+ # overrides the default scheduling policy specified on the reservation.
833
+ #
834
+ # This feature is not yet generally available.
676
835
  class Assignment
677
836
  include ::Google::Protobuf::MessageExts
678
837
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -699,6 +858,23 @@ module Google
699
858
  # Continuous SQL jobs will use this reservation. Reservations with
700
859
  # continuous assignments cannot be mixed with non-continuous assignments.
701
860
  CONTINUOUS = 6
861
+
862
+ # Finer granularity background jobs for capturing changes in a source
863
+ # database and streaming them into BigQuery. Reservations with this job
864
+ # type take priority over a default BACKGROUND reservation assignment (if
865
+ # it exists).
866
+ BACKGROUND_CHANGE_DATA_CAPTURE = 7
867
+
868
+ # Finer granularity background jobs for refreshing cached metadata for
869
+ # BigQuery tables. Reservations with this job type take priority over a
870
+ # default BACKGROUND reservation assignment (if it exists).
871
+ BACKGROUND_COLUMN_METADATA_INDEX = 8
872
+
873
+ # Finer granularity background jobs for refreshing search indexes upon
874
+ # BigQuery table columns. Reservations with this job type
875
+ # take priority over a default BACKGROUND reservation assignment (if it
876
+ # exists).
877
+ BACKGROUND_SEARCH_INDEX_REFRESH = 9
702
878
  end
703
879
 
704
880
  # Assignment will remain in PENDING state if no active capacity commitment is
@@ -921,13 +1097,13 @@ module Google
921
1097
  # Internally stored as google.cloud.bi.v1.BqTableReference.
922
1098
  # @!attribute [rw] project_id
923
1099
  # @return [::String]
924
- # The assigned project ID of the project.
1100
+ # Optional. The assigned project ID of the project.
925
1101
  # @!attribute [rw] dataset_id
926
1102
  # @return [::String]
927
- # The ID of the dataset in the above project.
1103
+ # Optional. The ID of the dataset in the above project.
928
1104
  # @!attribute [rw] table_id
929
1105
  # @return [::String]
930
- # The ID of the table in the above dataset.
1106
+ # Optional. The ID of the table in the above dataset.
931
1107
  class TableReference
932
1108
  include ::Google::Protobuf::MessageExts
933
1109
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -936,7 +1112,7 @@ module Google
936
1112
  # Represents a BI Reservation.
937
1113
  # @!attribute [rw] name
938
1114
  # @return [::String]
939
- # The resource name of the singleton BI reservation.
1115
+ # Identifier. The resource name of the singleton BI reservation.
940
1116
  # Reservation names have the form
941
1117
  # `projects/{project_id}/locations/{location_id}/biReservation`.
942
1118
  # @!attribute [r] update_time
@@ -944,10 +1120,10 @@ module Google
944
1120
  # Output only. The last update timestamp of a reservation.
945
1121
  # @!attribute [rw] size
946
1122
  # @return [::Integer]
947
- # Size of a reservation, in bytes.
1123
+ # Optional. Size of a reservation, in bytes.
948
1124
  # @!attribute [rw] preferred_tables
949
1125
  # @return [::Array<::Google::Cloud::Bigquery::Reservation::V1::TableReference>]
950
- # Preferred tables to use BI capacity for.
1126
+ # Optional. Preferred tables to use BI capacity for.
951
1127
  class BiReservation
952
1128
  include ::Google::Protobuf::MessageExts
953
1129
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -993,7 +1169,7 @@ module Google
993
1169
  end
994
1170
 
995
1171
  # The failover mode when a user initiates a failover on a reservation
996
- # determines how writes that arepending replication are handled after the
1172
+ # determines how writes that are pending replication are handled after the
997
1173
  # failover is initiated.
998
1174
  module FailoverMode
999
1175
  # Invalid value.
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Iam
22
+ module V1
23
+ # Request message for `SetIamPolicy` method.
24
+ # @!attribute [rw] resource
25
+ # @return [::String]
26
+ # REQUIRED: The resource for which the policy is being specified.
27
+ # See the operation documentation for the appropriate value for this field.
28
+ # @!attribute [rw] policy
29
+ # @return [::Google::Iam::V1::Policy]
30
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
31
+ # the policy is limited to a few 10s of KB. An empty policy is a
32
+ # valid policy but certain Cloud Platform services (such as Projects)
33
+ # might reject them.
34
+ # @!attribute [rw] update_mask
35
+ # @return [::Google::Protobuf::FieldMask]
36
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
37
+ # the fields in the mask will be modified. If no mask is provided, the
38
+ # following default mask is used:
39
+ #
40
+ # `paths: "bindings, etag"`
41
+ class SetIamPolicyRequest
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+
46
+ # Request message for `GetIamPolicy` method.
47
+ # @!attribute [rw] resource
48
+ # @return [::String]
49
+ # REQUIRED: The resource for which the policy is being requested.
50
+ # See the operation documentation for the appropriate value for this field.
51
+ # @!attribute [rw] options
52
+ # @return [::Google::Iam::V1::GetPolicyOptions]
53
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
54
+ # `GetIamPolicy`.
55
+ class GetIamPolicyRequest
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+ end
59
+
60
+ # Request message for `TestIamPermissions` method.
61
+ # @!attribute [rw] resource
62
+ # @return [::String]
63
+ # REQUIRED: The resource for which the policy detail is being requested.
64
+ # See the operation documentation for the appropriate value for this field.
65
+ # @!attribute [rw] permissions
66
+ # @return [::Array<::String>]
67
+ # The set of permissions to check for the `resource`. Permissions with
68
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
69
+ # information see
70
+ # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
71
+ class TestIamPermissionsRequest
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+
76
+ # Response message for `TestIamPermissions` method.
77
+ # @!attribute [rw] permissions
78
+ # @return [::Array<::String>]
79
+ # A subset of `TestPermissionsRequest.permissions` that the caller is
80
+ # allowed.
81
+ class TestIamPermissionsResponse
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,50 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Iam
22
+ module V1
23
+ # Encapsulates settings provided to GetIamPolicy.
24
+ # @!attribute [rw] requested_policy_version
25
+ # @return [::Integer]
26
+ # Optional. The maximum policy version that will be used to format the
27
+ # policy.
28
+ #
29
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
30
+ # rejected.
31
+ #
32
+ # Requests for policies with any conditional role bindings must specify
33
+ # version 3. Policies with no conditional role bindings may specify any valid
34
+ # value or leave the field unset.
35
+ #
36
+ # The policy in the response might use the policy version that you specified,
37
+ # or it might use a lower policy version. For example, if you specify version
38
+ # 3, but the policy has no conditional role bindings, the response uses
39
+ # version 1.
40
+ #
41
+ # To learn which resources support conditions in their IAM policies, see the
42
+ # [IAM
43
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
44
+ class GetPolicyOptions
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+ end
49
+ end
50
+ end