google-cloud-bigquery-analytics_hub-v1 0.a → 0.1.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.
@@ -0,0 +1,497 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Cloud
22
+ module Bigquery
23
+ module AnalyticsHub
24
+ module V1
25
+ # A data exchange is a container that lets you share data. Along with the
26
+ # descriptive information about the data exchange, it contains listings that
27
+ # reference shared datasets.
28
+ # @!attribute [r] name
29
+ # @return [::String]
30
+ # Output only. The resource name of the data exchange.
31
+ # e.g. `projects/myproject/locations/US/dataExchanges/123`.
32
+ # @!attribute [rw] display_name
33
+ # @return [::String]
34
+ # Required. Human-readable display name of the data exchange. The display name must
35
+ # contain only Unicode letters, numbers (0-9), underscores (_), dashes (-),
36
+ # spaces ( ), ampersands (&) and must not start or end with spaces.
37
+ # Default value is an empty string.
38
+ # Max length: 63 bytes.
39
+ # @!attribute [rw] description
40
+ # @return [::String]
41
+ # Optional. Description of the data exchange. The description must not contain Unicode
42
+ # non-characters as well as C0 and C1 control codes except tabs (HT),
43
+ # new lines (LF), carriage returns (CR), and page breaks (FF).
44
+ # Default value is an empty string.
45
+ # Max length: 2000 bytes.
46
+ # @!attribute [rw] primary_contact
47
+ # @return [::String]
48
+ # Optional. Email or URL of the primary point of contact of the data exchange.
49
+ # Max Length: 1000 bytes.
50
+ # @!attribute [rw] documentation
51
+ # @return [::String]
52
+ # Optional. Documentation describing the data exchange.
53
+ # @!attribute [r] listing_count
54
+ # @return [::Integer]
55
+ # Output only. Number of listings contained in the data exchange.
56
+ # @!attribute [rw] icon
57
+ # @return [::String]
58
+ # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB
59
+ # Expected image dimensions are 512x512 pixels, however the API only
60
+ # performs validation on size of the encoded data.
61
+ # Note: For byte fields, the content of the fields are base64-encoded (which
62
+ # increases the size of the data by 33-36%) when using JSON on the wire.
63
+ class DataExchange
64
+ include ::Google::Protobuf::MessageExts
65
+ extend ::Google::Protobuf::MessageExts::ClassMethods
66
+ end
67
+
68
+ # Contains details of the data provider.
69
+ # @!attribute [rw] name
70
+ # @return [::String]
71
+ # Optional. Name of the data provider.
72
+ # @!attribute [rw] primary_contact
73
+ # @return [::String]
74
+ # Optional. Email or URL of the data provider.
75
+ # Max Length: 1000 bytes.
76
+ class DataProvider
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+ end
80
+
81
+ # Contains details of the listing publisher.
82
+ # @!attribute [rw] name
83
+ # @return [::String]
84
+ # Optional. Name of the listing publisher.
85
+ # @!attribute [rw] primary_contact
86
+ # @return [::String]
87
+ # Optional. Email or URL of the listing publisher.
88
+ # Max Length: 1000 bytes.
89
+ class Publisher
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+
94
+ # Contains the reference that identifies a destination bigquery dataset.
95
+ # @!attribute [rw] dataset_id
96
+ # @return [::String]
97
+ # Required. A unique ID for this dataset, without the project name. The ID
98
+ # must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
99
+ # The maximum length is 1,024 characters.
100
+ # @!attribute [rw] project_id
101
+ # @return [::String]
102
+ # Required. The ID of the project containing this dataset.
103
+ class DestinationDatasetReference
104
+ include ::Google::Protobuf::MessageExts
105
+ extend ::Google::Protobuf::MessageExts::ClassMethods
106
+ end
107
+
108
+ # Defines the destination bigquery dataset.
109
+ # @!attribute [rw] dataset_reference
110
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::DestinationDatasetReference]
111
+ # Required. A reference that identifies the destination dataset.
112
+ # @!attribute [rw] friendly_name
113
+ # @return [::Google::Protobuf::StringValue]
114
+ # Optional. A descriptive name for the dataset.
115
+ # @!attribute [rw] description
116
+ # @return [::Google::Protobuf::StringValue]
117
+ # Optional. A user-friendly description of the dataset.
118
+ # @!attribute [rw] labels
119
+ # @return [::Google::Protobuf::Map{::String => ::String}]
120
+ # Optional. The labels associated with this dataset. You can use these
121
+ # to organize and group your datasets.
122
+ # You can set this property when inserting or updating a dataset.
123
+ # See https://cloud.google.com/resource-manager/docs/creating-managing-labels
124
+ # for more information.
125
+ # @!attribute [rw] location
126
+ # @return [::String]
127
+ # Required. The geographic location where the dataset should reside. See
128
+ # https://cloud.google.com/bigquery/docs/locations for supported
129
+ # locations.
130
+ class DestinationDataset
131
+ include ::Google::Protobuf::MessageExts
132
+ extend ::Google::Protobuf::MessageExts::ClassMethods
133
+
134
+ # @!attribute [rw] key
135
+ # @return [::String]
136
+ # @!attribute [rw] value
137
+ # @return [::String]
138
+ class LabelsEntry
139
+ include ::Google::Protobuf::MessageExts
140
+ extend ::Google::Protobuf::MessageExts::ClassMethods
141
+ end
142
+ end
143
+
144
+ # A listing is what gets published into a data exchange that a subscriber can
145
+ # subscribe to. It contains a reference to the data source along with
146
+ # descriptive information that will help subscribers find and subscribe the
147
+ # data.
148
+ # @!attribute [rw] bigquery_dataset
149
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::BigQueryDatasetSource]
150
+ # Required. Shared dataset i.e. BigQuery dataset source.
151
+ # @!attribute [r] name
152
+ # @return [::String]
153
+ # Output only. The resource name of the listing.
154
+ # e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
155
+ # @!attribute [rw] display_name
156
+ # @return [::String]
157
+ # Required. Human-readable display name of the listing. The display name must contain
158
+ # only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces
159
+ # ( ), ampersands (&) and can't start or end with spaces.
160
+ # Default value is an empty string.
161
+ # Max length: 63 bytes.
162
+ # @!attribute [rw] description
163
+ # @return [::String]
164
+ # Optional. Short description of the listing. The description must not contain
165
+ # Unicode non-characters and C0 and C1 control codes except tabs (HT),
166
+ # new lines (LF), carriage returns (CR), and page breaks (FF).
167
+ # Default value is an empty string.
168
+ # Max length: 2000 bytes.
169
+ # @!attribute [rw] primary_contact
170
+ # @return [::String]
171
+ # Optional. Email or URL of the primary point of contact of the listing.
172
+ # Max Length: 1000 bytes.
173
+ # @!attribute [rw] documentation
174
+ # @return [::String]
175
+ # Optional. Documentation describing the listing.
176
+ # @!attribute [r] state
177
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::State]
178
+ # Output only. Current state of the listing.
179
+ # @!attribute [rw] icon
180
+ # @return [::String]
181
+ # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB
182
+ # Expected image dimensions are 512x512 pixels, however the API only
183
+ # performs validation on size of the encoded data.
184
+ # Note: For byte fields, the contents of the field are base64-encoded (which
185
+ # increases the size of the data by 33-36%) when using JSON on the wire.
186
+ # @!attribute [rw] data_provider
187
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::DataProvider]
188
+ # Optional. Details of the data provider who owns the source data.
189
+ # @!attribute [rw] categories
190
+ # @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::Category>]
191
+ # Optional. Categories of the listing. Up to two categories are allowed.
192
+ # @!attribute [rw] publisher
193
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Publisher]
194
+ # Optional. Details of the publisher who owns the listing and who can share
195
+ # the source data.
196
+ # @!attribute [rw] request_access
197
+ # @return [::String]
198
+ # Optional. Email or URL of the request access of the listing.
199
+ # Subscribers can use this reference to request access.
200
+ # Max Length: 1000 bytes.
201
+ class Listing
202
+ include ::Google::Protobuf::MessageExts
203
+ extend ::Google::Protobuf::MessageExts::ClassMethods
204
+
205
+ # A reference to a shared dataset. It is an existing BigQuery dataset with a
206
+ # collection of objects such as tables and views that you want to share
207
+ # with subscribers.
208
+ # When subscriber's subscribe to a listing, Analytics Hub creates a linked
209
+ # dataset in
210
+ # the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
211
+ # dataset that serves as a _symbolic link_ to a shared dataset.
212
+ # @!attribute [rw] dataset
213
+ # @return [::String]
214
+ # Resource name of the dataset source for this listing.
215
+ # e.g. `projects/myproject/datasets/123`
216
+ class BigQueryDatasetSource
217
+ include ::Google::Protobuf::MessageExts
218
+ extend ::Google::Protobuf::MessageExts::ClassMethods
219
+ end
220
+
221
+ # State of the listing.
222
+ module State
223
+ # Default value. This value is unused.
224
+ STATE_UNSPECIFIED = 0
225
+
226
+ # Subscribable state. Users with dataexchange.listings.subscribe permission
227
+ # can subscribe to this listing.
228
+ ACTIVE = 1
229
+ end
230
+
231
+ # Listing categories.
232
+ module Category
233
+ CATEGORY_UNSPECIFIED = 0
234
+
235
+ CATEGORY_OTHERS = 1
236
+
237
+ CATEGORY_ADVERTISING_AND_MARKETING = 2
238
+
239
+ CATEGORY_COMMERCE = 3
240
+
241
+ CATEGORY_CLIMATE_AND_ENVIRONMENT = 4
242
+
243
+ CATEGORY_DEMOGRAPHICS = 5
244
+
245
+ CATEGORY_ECONOMICS = 6
246
+
247
+ CATEGORY_EDUCATION = 7
248
+
249
+ CATEGORY_ENERGY = 8
250
+
251
+ CATEGORY_FINANCIAL = 9
252
+
253
+ CATEGORY_GAMING = 10
254
+
255
+ CATEGORY_GEOSPATIAL = 11
256
+
257
+ CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE = 12
258
+
259
+ CATEGORY_MEDIA = 13
260
+
261
+ CATEGORY_PUBLIC_SECTOR = 14
262
+
263
+ CATEGORY_RETAIL = 15
264
+
265
+ CATEGORY_SPORTS = 16
266
+
267
+ CATEGORY_SCIENCE_AND_RESEARCH = 17
268
+
269
+ CATEGORY_TRANSPORTATION_AND_LOGISTICS = 18
270
+
271
+ CATEGORY_TRAVEL_AND_TOURISM = 19
272
+ end
273
+ end
274
+
275
+ # Message for requesting the list of data exchanges.
276
+ # @!attribute [rw] parent
277
+ # @return [::String]
278
+ # Required. The parent resource path of the data exchanges.
279
+ # e.g. `projects/myproject/locations/US`.
280
+ # @!attribute [rw] page_size
281
+ # @return [::Integer]
282
+ # The maximum number of results to return in a single response page. Leverage
283
+ # the page tokens to iterate through the entire collection.
284
+ # @!attribute [rw] page_token
285
+ # @return [::String]
286
+ # Page token, returned by a previous call, to request the next page of
287
+ # results.
288
+ class ListDataExchangesRequest
289
+ include ::Google::Protobuf::MessageExts
290
+ extend ::Google::Protobuf::MessageExts::ClassMethods
291
+ end
292
+
293
+ # Message for response to the list of data exchanges.
294
+ # @!attribute [rw] data_exchanges
295
+ # @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>]
296
+ # The list of data exchanges.
297
+ # @!attribute [rw] next_page_token
298
+ # @return [::String]
299
+ # A token to request the next page of results.
300
+ class ListDataExchangesResponse
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+ end
304
+
305
+ # Message for requesting the list of data exchanges from projects in an
306
+ # organization and location.
307
+ # @!attribute [rw] organization
308
+ # @return [::String]
309
+ # Required. The organization resource path of the projects containing DataExchanges.
310
+ # e.g. `organizations/myorg/locations/US`.
311
+ # @!attribute [rw] page_size
312
+ # @return [::Integer]
313
+ # The maximum number of results to return in a single response page. Leverage
314
+ # the page tokens to iterate through the entire collection.
315
+ # @!attribute [rw] page_token
316
+ # @return [::String]
317
+ # Page token, returned by a previous call, to request the next page of
318
+ # results.
319
+ class ListOrgDataExchangesRequest
320
+ include ::Google::Protobuf::MessageExts
321
+ extend ::Google::Protobuf::MessageExts::ClassMethods
322
+ end
323
+
324
+ # Message for response to listing data exchanges in an organization and
325
+ # location.
326
+ # @!attribute [rw] data_exchanges
327
+ # @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange>]
328
+ # The list of data exchanges.
329
+ # @!attribute [rw] next_page_token
330
+ # @return [::String]
331
+ # A token to request the next page of results.
332
+ class ListOrgDataExchangesResponse
333
+ include ::Google::Protobuf::MessageExts
334
+ extend ::Google::Protobuf::MessageExts::ClassMethods
335
+ end
336
+
337
+ # Message for getting a data exchange.
338
+ # @!attribute [rw] name
339
+ # @return [::String]
340
+ # Required. The resource name of the data exchange.
341
+ # e.g. `projects/myproject/locations/US/dataExchanges/123`.
342
+ class GetDataExchangeRequest
343
+ include ::Google::Protobuf::MessageExts
344
+ extend ::Google::Protobuf::MessageExts::ClassMethods
345
+ end
346
+
347
+ # Message for creating a data exchange.
348
+ # @!attribute [rw] parent
349
+ # @return [::String]
350
+ # Required. The parent resource path of the data exchange.
351
+ # e.g. `projects/myproject/locations/US`.
352
+ # @!attribute [rw] data_exchange_id
353
+ # @return [::String]
354
+ # Required. The ID of the data exchange.
355
+ # Must contain only Unicode letters, numbers (0-9), underscores (_).
356
+ # Should not use characters that require URL-escaping, or characters
357
+ # outside of ASCII, spaces.
358
+ # Max length: 100 bytes.
359
+ # @!attribute [rw] data_exchange
360
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange]
361
+ # Required. The data exchange to create.
362
+ class CreateDataExchangeRequest
363
+ include ::Google::Protobuf::MessageExts
364
+ extend ::Google::Protobuf::MessageExts::ClassMethods
365
+ end
366
+
367
+ # Message for updating a data exchange.
368
+ # @!attribute [rw] update_mask
369
+ # @return [::Google::Protobuf::FieldMask]
370
+ # Required. Field mask specifies the fields to update in the data exchange
371
+ # resource. The fields specified in the
372
+ # `updateMask` are relative to the resource and are not a full request.
373
+ # @!attribute [rw] data_exchange
374
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::DataExchange]
375
+ # Required. The data exchange to update.
376
+ class UpdateDataExchangeRequest
377
+ include ::Google::Protobuf::MessageExts
378
+ extend ::Google::Protobuf::MessageExts::ClassMethods
379
+ end
380
+
381
+ # Message for deleting a data exchange.
382
+ # @!attribute [rw] name
383
+ # @return [::String]
384
+ # Required. The full name of the data exchange resource that you want to delete.
385
+ # For example, `projects/myproject/locations/US/dataExchanges/123`.
386
+ class DeleteDataExchangeRequest
387
+ include ::Google::Protobuf::MessageExts
388
+ extend ::Google::Protobuf::MessageExts::ClassMethods
389
+ end
390
+
391
+ # Message for requesting the list of listings.
392
+ # @!attribute [rw] parent
393
+ # @return [::String]
394
+ # Required. The parent resource path of the listing.
395
+ # e.g. `projects/myproject/locations/US/dataExchanges/123`.
396
+ # @!attribute [rw] page_size
397
+ # @return [::Integer]
398
+ # The maximum number of results to return in a single response page. Leverage
399
+ # the page tokens to iterate through the entire collection.
400
+ # @!attribute [rw] page_token
401
+ # @return [::String]
402
+ # Page token, returned by a previous call, to request the next page of
403
+ # results.
404
+ class ListListingsRequest
405
+ include ::Google::Protobuf::MessageExts
406
+ extend ::Google::Protobuf::MessageExts::ClassMethods
407
+ end
408
+
409
+ # Message for response to the list of Listings.
410
+ # @!attribute [rw] listings
411
+ # @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing>]
412
+ # The list of Listing.
413
+ # @!attribute [rw] next_page_token
414
+ # @return [::String]
415
+ # A token to request the next page of results.
416
+ class ListListingsResponse
417
+ include ::Google::Protobuf::MessageExts
418
+ extend ::Google::Protobuf::MessageExts::ClassMethods
419
+ end
420
+
421
+ # Message for getting a listing.
422
+ # @!attribute [rw] name
423
+ # @return [::String]
424
+ # Required. The resource name of the listing.
425
+ # e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
426
+ class GetListingRequest
427
+ include ::Google::Protobuf::MessageExts
428
+ extend ::Google::Protobuf::MessageExts::ClassMethods
429
+ end
430
+
431
+ # Message for creating a listing.
432
+ # @!attribute [rw] parent
433
+ # @return [::String]
434
+ # Required. The parent resource path of the listing.
435
+ # e.g. `projects/myproject/locations/US/dataExchanges/123`.
436
+ # @!attribute [rw] listing_id
437
+ # @return [::String]
438
+ # Required. The ID of the listing to create.
439
+ # Must contain only Unicode letters, numbers (0-9), underscores (_).
440
+ # Should not use characters that require URL-escaping, or characters
441
+ # outside of ASCII, spaces.
442
+ # Max length: 100 bytes.
443
+ # @!attribute [rw] listing
444
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing]
445
+ # Required. The listing to create.
446
+ class CreateListingRequest
447
+ include ::Google::Protobuf::MessageExts
448
+ extend ::Google::Protobuf::MessageExts::ClassMethods
449
+ end
450
+
451
+ # Message for updating a Listing.
452
+ # @!attribute [rw] update_mask
453
+ # @return [::Google::Protobuf::FieldMask]
454
+ # Required. Field mask specifies the fields to update in the listing resource. The
455
+ # fields specified in the `updateMask` are relative to the resource and are
456
+ # not a full request.
457
+ # @!attribute [rw] listing
458
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing]
459
+ # Required. The listing to update.
460
+ class UpdateListingRequest
461
+ include ::Google::Protobuf::MessageExts
462
+ extend ::Google::Protobuf::MessageExts::ClassMethods
463
+ end
464
+
465
+ # Message for deleting a listing.
466
+ # @!attribute [rw] name
467
+ # @return [::String]
468
+ # Required. Resource name of the listing to delete.
469
+ # e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
470
+ class DeleteListingRequest
471
+ include ::Google::Protobuf::MessageExts
472
+ extend ::Google::Protobuf::MessageExts::ClassMethods
473
+ end
474
+
475
+ # Message for subscribing to a listing.
476
+ # @!attribute [rw] destination_dataset
477
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::DestinationDataset]
478
+ # BigQuery destination dataset to create for the subscriber.
479
+ # @!attribute [rw] name
480
+ # @return [::String]
481
+ # Required. Resource name of the listing that you want to subscribe to.
482
+ # e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
483
+ class SubscribeListingRequest
484
+ include ::Google::Protobuf::MessageExts
485
+ extend ::Google::Protobuf::MessageExts::ClassMethods
486
+ end
487
+
488
+ # Message for response when you subscribe to a listing.
489
+ class SubscribeListingResponse
490
+ include ::Google::Protobuf::MessageExts
491
+ extend ::Google::Protobuf::MessageExts::ClassMethods
492
+ end
493
+ end
494
+ end
495
+ end
496
+ end
497
+ end
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 2022 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