google-cloud-dataplex-v1 2.9.0 → 2.10.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.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dataplex/v1/analyze_pb.rb +2 -25
  4. data/lib/google/cloud/dataplex/v1/approval_workflow_pb.rb +33 -0
  5. data/lib/google/cloud/dataplex/v1/bindings_override.rb +24 -24
  6. data/lib/google/cloud/dataplex/v1/business_glossary_pb.rb +3 -26
  7. data/lib/google/cloud/dataplex/v1/business_glossary_service/client.rb +2 -0
  8. data/lib/google/cloud/dataplex/v1/business_glossary_service/credentials.rb +4 -1
  9. data/lib/google/cloud/dataplex/v1/business_glossary_service/operations.rb +2 -0
  10. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/client.rb +2 -0
  11. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/operations.rb +2 -0
  12. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +20 -27
  13. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +1074 -73
  14. data/lib/google/cloud/dataplex/v1/catalog_service/credentials.rb +4 -1
  15. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +2 -0
  16. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
  17. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +1020 -82
  18. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +2 -0
  19. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +554 -0
  20. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +18 -15
  21. data/lib/google/cloud/dataplex/v1/cmek_pb.rb +3 -26
  22. data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +2 -0
  23. data/lib/google/cloud/dataplex/v1/cmek_service/credentials.rb +2 -1
  24. data/lib/google/cloud/dataplex/v1/cmek_service/operations.rb +2 -0
  25. data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +2 -0
  26. data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +2 -0
  27. data/lib/google/cloud/dataplex/v1/content_pb.rb +3 -38
  28. data/lib/google/cloud/dataplex/v1/content_services_pb.rb +0 -49
  29. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +4 -24
  30. data/lib/google/cloud/dataplex/v1/data_documentation_pb.rb +10 -24
  31. data/lib/google/cloud/dataplex/v1/data_product_service/client.rb +1644 -0
  32. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/credentials.rb +7 -4
  33. data/lib/google/cloud/dataplex/v1/data_product_service/operations.rb +843 -0
  34. data/lib/google/cloud/dataplex/v1/data_product_service/paths.rb +231 -0
  35. data/lib/google/cloud/dataplex/v1/data_product_service/rest/client.rb +1533 -0
  36. data/lib/google/cloud/dataplex/v1/data_product_service/rest/operations.rb +956 -0
  37. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest/service_stub.rb +284 -160
  38. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest.rb +11 -10
  39. data/lib/google/cloud/dataplex/v1/{content_service.rb → data_product_service.rb} +15 -14
  40. data/lib/google/cloud/dataplex/v1/data_products_pb.rb +52 -0
  41. data/lib/google/cloud/dataplex/v1/data_products_services_pb.rb +69 -0
  42. data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +4 -26
  43. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +13 -26
  44. data/lib/google/cloud/dataplex/v1/data_quality_rule_template_pb.rb +25 -0
  45. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +99 -1
  46. data/lib/google/cloud/dataplex/v1/data_scan_service/credentials.rb +4 -1
  47. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +2 -0
  48. data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +21 -0
  49. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +92 -1
  50. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -0
  51. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +62 -0
  52. data/lib/google/cloud/dataplex/v1/data_taxonomy_pb.rb +3 -27
  53. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +2 -0
  54. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/credentials.rb +2 -1
  55. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +2 -0
  56. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +2 -0
  57. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +2 -0
  58. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +2 -664
  59. data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +4 -1
  60. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +2 -0
  61. data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +0 -21
  62. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +2 -622
  63. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -0
  64. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +0 -368
  65. data/lib/google/cloud/dataplex/v1/datascans_common_pb.rb +3 -24
  66. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +9 -31
  67. data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
  68. data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -27
  69. data/lib/google/cloud/dataplex/v1/metadata_pb.rb +3 -25
  70. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +2 -0
  71. data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +2 -1
  72. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +2 -0
  73. data/lib/google/cloud/dataplex/v1/processing_pb.rb +5 -24
  74. data/lib/google/cloud/dataplex/v1/resources_pb.rb +2 -25
  75. data/lib/google/cloud/dataplex/v1/rest.rb +1 -1
  76. data/lib/google/cloud/dataplex/v1/security_pb.rb +2 -23
  77. data/lib/google/cloud/dataplex/v1/service_pb.rb +3 -38
  78. data/lib/google/cloud/dataplex/v1/service_services_pb.rb +0 -13
  79. data/lib/google/cloud/dataplex/v1/tasks_pb.rb +2 -25
  80. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  81. data/lib/google/cloud/dataplex/v1.rb +1 -0
  82. data/proto_docs/google/api/client.rb +149 -29
  83. data/proto_docs/google/cloud/dataplex/v1/approval_workflow.rb +263 -0
  84. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +427 -3
  85. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +13 -0
  86. data/proto_docs/google/cloud/dataplex/v1/data_documentation.rb +118 -2
  87. data/proto_docs/google/cloud/dataplex/v1/data_products.rb +567 -0
  88. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +21 -0
  89. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +240 -10
  90. data/proto_docs/google/cloud/dataplex/v1/data_quality_rule_template.rb +88 -0
  91. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +82 -5
  92. data/proto_docs/google/cloud/dataplex/v1/datascans_common.rb +7 -3
  93. data/proto_docs/google/cloud/dataplex/v1/logs.rb +7 -0
  94. data/proto_docs/google/cloud/dataplex/v1/processing.rb +27 -3
  95. data/proto_docs/google/cloud/dataplex/v1/service.rb +0 -148
  96. metadata +20 -12
  97. data/lib/google/cloud/dataplex/v1/content_service/client.rb +0 -1261
  98. data/lib/google/cloud/dataplex/v1/content_service/paths.rb +0 -73
  99. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +0 -1171
  100. data/proto_docs/google/cloud/dataplex/v1/content.rb +0 -142
@@ -1,1171 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2023 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
- require "google/cloud/errors"
20
- require "google/cloud/dataplex/v1/content_pb"
21
- require "google/cloud/dataplex/v1/content_service/rest/service_stub"
22
- require "google/cloud/location/rest"
23
- require "google/iam/v1/rest"
24
-
25
- module Google
26
- module Cloud
27
- module Dataplex
28
- module V1
29
- module ContentService
30
- module Rest
31
- ##
32
- # REST client for the ContentService service.
33
- #
34
- # ContentService manages Notebook and SQL Scripts for Dataplex Universal
35
- # Catalog.
36
- #
37
- class Client
38
- # @private
39
- API_VERSION = ""
40
-
41
- # @private
42
- DEFAULT_ENDPOINT_TEMPLATE = "dataplex.$UNIVERSE_DOMAIN$"
43
-
44
- include Paths
45
-
46
- # @private
47
- attr_reader :content_service_stub
48
-
49
- ##
50
- # Configure the ContentService Client class.
51
- #
52
- # See {::Google::Cloud::Dataplex::V1::ContentService::Rest::Client::Configuration}
53
- # for a description of the configuration fields.
54
- #
55
- # @example
56
- #
57
- # # Modify the configuration for all ContentService clients
58
- # ::Google::Cloud::Dataplex::V1::ContentService::Rest::Client.configure do |config|
59
- # config.timeout = 10.0
60
- # end
61
- #
62
- # @yield [config] Configure the Client client.
63
- # @yieldparam config [Client::Configuration]
64
- #
65
- # @return [Client::Configuration]
66
- #
67
- def self.configure
68
- @configure ||= begin
69
- namespace = ["Google", "Cloud", "Dataplex", "V1"]
70
- parent_config = while namespace.any?
71
- parent_name = namespace.join "::"
72
- parent_const = const_get parent_name
73
- break parent_const.configure if parent_const.respond_to? :configure
74
- namespace.pop
75
- end
76
- default_config = Client::Configuration.new parent_config
77
-
78
- default_config.rpcs.create_content.timeout = 60.0
79
-
80
- default_config.rpcs.update_content.timeout = 60.0
81
-
82
- default_config.rpcs.delete_content.timeout = 60.0
83
-
84
- default_config.rpcs.get_content.timeout = 60.0
85
- default_config.rpcs.get_content.retry_policy = {
86
- initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
87
- }
88
-
89
- default_config.rpcs.get_iam_policy.timeout = 60.0
90
- default_config.rpcs.get_iam_policy.retry_policy = {
91
- initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
92
- }
93
-
94
- default_config.rpcs.set_iam_policy.timeout = 60.0
95
-
96
- default_config.rpcs.test_iam_permissions.timeout = 60.0
97
- default_config.rpcs.test_iam_permissions.retry_policy = {
98
- initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
99
- }
100
-
101
- default_config.rpcs.list_content.timeout = 60.0
102
- default_config.rpcs.list_content.retry_policy = {
103
- initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
104
- }
105
-
106
- default_config
107
- end
108
- yield @configure if block_given?
109
- @configure
110
- end
111
-
112
- ##
113
- # Configure the ContentService Client instance.
114
- #
115
- # The configuration is set to the derived mode, meaning that values can be changed,
116
- # but structural changes (adding new fields, etc.) are not allowed. Structural changes
117
- # should be made on {Client.configure}.
118
- #
119
- # See {::Google::Cloud::Dataplex::V1::ContentService::Rest::Client::Configuration}
120
- # for a description of the configuration fields.
121
- #
122
- # @yield [config] Configure the Client client.
123
- # @yieldparam config [Client::Configuration]
124
- #
125
- # @return [Client::Configuration]
126
- #
127
- def configure
128
- yield @config if block_given?
129
- @config
130
- end
131
-
132
- ##
133
- # The effective universe domain
134
- #
135
- # @return [String]
136
- #
137
- def universe_domain
138
- @content_service_stub.universe_domain
139
- end
140
-
141
- ##
142
- # Create a new ContentService REST client object.
143
- #
144
- # @example
145
- #
146
- # # Create a client using the default configuration
147
- # client = ::Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
148
- #
149
- # # Create a client using a custom configuration
150
- # client = ::Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new do |config|
151
- # config.timeout = 10.0
152
- # end
153
- #
154
- # @yield [config] Configure the ContentService client.
155
- # @yieldparam config [Client::Configuration]
156
- #
157
- def initialize
158
- # Create the configuration object
159
- @config = Configuration.new Client.configure
160
-
161
- # Yield the configuration if needed
162
- yield @config if block_given?
163
-
164
- # Create credentials
165
- credentials = @config.credentials
166
- # Use self-signed JWT if the endpoint is unchanged from default,
167
- # but only if the default endpoint does not have a region prefix.
168
- enable_self_signed_jwt = @config.endpoint.nil? ||
169
- (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
170
- !@config.endpoint.split(".").first.include?("-"))
171
- credentials ||= Credentials.default scope: @config.scope,
172
- enable_self_signed_jwt: enable_self_signed_jwt
173
- if credentials.is_a?(::String) || credentials.is_a?(::Hash)
174
- credentials = Credentials.new credentials, scope: @config.scope
175
- end
176
-
177
- @quota_project_id = @config.quota_project
178
- @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
179
-
180
- @content_service_stub = ::Google::Cloud::Dataplex::V1::ContentService::Rest::ServiceStub.new(
181
- endpoint: @config.endpoint,
182
- endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
- universe_domain: @config.universe_domain,
184
- credentials: credentials,
185
- logger: @config.logger
186
- )
187
-
188
- @content_service_stub.logger(stub: true)&.info do |entry|
189
- entry.set_system_name
190
- entry.set_service
191
- entry.message = "Created client for #{entry.service}"
192
- entry.set_credentials_fields credentials
193
- entry.set "customEndpoint", @config.endpoint if @config.endpoint
194
- entry.set "defaultTimeout", @config.timeout if @config.timeout
195
- entry.set "quotaProject", @quota_project_id if @quota_project_id
196
- end
197
-
198
- @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
199
- config.credentials = credentials
200
- config.quota_project = @quota_project_id
201
- config.endpoint = @content_service_stub.endpoint
202
- config.universe_domain = @content_service_stub.universe_domain
203
- config.bindings_override = @config.bindings_override
204
- config.logger = @content_service_stub.logger if config.respond_to? :logger=
205
- end
206
-
207
- @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
208
- config.credentials = credentials
209
- config.quota_project = @quota_project_id
210
- config.endpoint = @content_service_stub.endpoint
211
- config.universe_domain = @content_service_stub.universe_domain
212
- config.bindings_override = @config.bindings_override
213
- config.logger = @content_service_stub.logger if config.respond_to? :logger=
214
- end
215
- end
216
-
217
- ##
218
- # Get the associated client for mix-in of the Locations.
219
- #
220
- # @return [Google::Cloud::Location::Locations::Rest::Client]
221
- #
222
- attr_reader :location_client
223
-
224
- ##
225
- # Get the associated client for mix-in of the IAMPolicy.
226
- #
227
- # @return [Google::Iam::V1::IAMPolicy::Rest::Client]
228
- #
229
- attr_reader :iam_policy_client
230
-
231
- ##
232
- # The logger used for request/response debug logging.
233
- #
234
- # @return [Logger]
235
- #
236
- def logger
237
- @content_service_stub.logger
238
- end
239
-
240
- # Service calls
241
-
242
- ##
243
- # Create a content.
244
- #
245
- # @overload create_content(request, options = nil)
246
- # Pass arguments to `create_content` via a request object, either of type
247
- # {::Google::Cloud::Dataplex::V1::CreateContentRequest} or an equivalent Hash.
248
- #
249
- # @param request [::Google::Cloud::Dataplex::V1::CreateContentRequest, ::Hash]
250
- # A request object representing the call parameters. Required. To specify no
251
- # parameters, or to keep all the default parameter values, pass an empty Hash.
252
- # @param options [::Gapic::CallOptions, ::Hash]
253
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
254
- #
255
- # @overload create_content(parent: nil, content: nil, validate_only: nil)
256
- # Pass arguments to `create_content` via keyword arguments. Note that at
257
- # least one keyword argument is required. To specify no parameters, or to keep all
258
- # the default parameter values, pass an empty Hash as a request object (see above).
259
- #
260
- # @param parent [::String]
261
- # Required. The resource name of the parent lake:
262
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
263
- # @param content [::Google::Cloud::Dataplex::V1::Content, ::Hash]
264
- # Required. Content resource.
265
- # @param validate_only [::Boolean]
266
- # Optional. Only validate the request, but do not perform mutations.
267
- # The default is false.
268
- # @yield [result, operation] Access the result along with the TransportOperation object
269
- # @yieldparam result [::Google::Cloud::Dataplex::V1::Content]
270
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
271
- #
272
- # @return [::Google::Cloud::Dataplex::V1::Content]
273
- #
274
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
275
- #
276
- # @example Basic example
277
- # require "google/cloud/dataplex/v1"
278
- #
279
- # # Create a client object. The client can be reused for multiple calls.
280
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
281
- #
282
- # # Create a request. To set request fields, pass in keyword arguments.
283
- # request = Google::Cloud::Dataplex::V1::CreateContentRequest.new
284
- #
285
- # # Call the create_content method.
286
- # result = client.create_content request
287
- #
288
- # # The returned object is of type Google::Cloud::Dataplex::V1::Content.
289
- # p result
290
- #
291
- def create_content request, options = nil
292
- raise ::ArgumentError, "request must be provided" if request.nil?
293
-
294
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateContentRequest
295
-
296
- # Converts hash and nil to an options object
297
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
298
-
299
- # Customize the options with defaults
300
- call_metadata = @config.rpcs.create_content.metadata.to_h
301
-
302
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
303
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
304
- lib_name: @config.lib_name, lib_version: @config.lib_version,
305
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
306
- transports_version_send: [:rest]
307
-
308
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
309
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
310
-
311
- options.apply_defaults timeout: @config.rpcs.create_content.timeout,
312
- metadata: call_metadata,
313
- retry_policy: @config.rpcs.create_content.retry_policy
314
-
315
- options.apply_defaults timeout: @config.timeout,
316
- metadata: @config.metadata,
317
- retry_policy: @config.retry_policy
318
-
319
- @content_service_stub.create_content request, options do |result, operation|
320
- yield result, operation if block_given?
321
- end
322
- rescue ::Gapic::Rest::Error => e
323
- raise ::Google::Cloud::Error.from_error(e)
324
- end
325
-
326
- ##
327
- # Update a content. Only supports full resource update.
328
- #
329
- # @overload update_content(request, options = nil)
330
- # Pass arguments to `update_content` via a request object, either of type
331
- # {::Google::Cloud::Dataplex::V1::UpdateContentRequest} or an equivalent Hash.
332
- #
333
- # @param request [::Google::Cloud::Dataplex::V1::UpdateContentRequest, ::Hash]
334
- # A request object representing the call parameters. Required. To specify no
335
- # parameters, or to keep all the default parameter values, pass an empty Hash.
336
- # @param options [::Gapic::CallOptions, ::Hash]
337
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
338
- #
339
- # @overload update_content(update_mask: nil, content: nil, validate_only: nil)
340
- # Pass arguments to `update_content` via keyword arguments. Note that at
341
- # least one keyword argument is required. To specify no parameters, or to keep all
342
- # the default parameter values, pass an empty Hash as a request object (see above).
343
- #
344
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
345
- # Required. Mask of fields to update.
346
- # @param content [::Google::Cloud::Dataplex::V1::Content, ::Hash]
347
- # Required. Update description.
348
- # Only fields specified in `update_mask` are updated.
349
- # @param validate_only [::Boolean]
350
- # Optional. Only validate the request, but do not perform mutations.
351
- # The default is false.
352
- # @yield [result, operation] Access the result along with the TransportOperation object
353
- # @yieldparam result [::Google::Cloud::Dataplex::V1::Content]
354
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
355
- #
356
- # @return [::Google::Cloud::Dataplex::V1::Content]
357
- #
358
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
359
- #
360
- # @example Basic example
361
- # require "google/cloud/dataplex/v1"
362
- #
363
- # # Create a client object. The client can be reused for multiple calls.
364
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
365
- #
366
- # # Create a request. To set request fields, pass in keyword arguments.
367
- # request = Google::Cloud::Dataplex::V1::UpdateContentRequest.new
368
- #
369
- # # Call the update_content method.
370
- # result = client.update_content request
371
- #
372
- # # The returned object is of type Google::Cloud::Dataplex::V1::Content.
373
- # p result
374
- #
375
- def update_content request, options = nil
376
- raise ::ArgumentError, "request must be provided" if request.nil?
377
-
378
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateContentRequest
379
-
380
- # Converts hash and nil to an options object
381
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
382
-
383
- # Customize the options with defaults
384
- call_metadata = @config.rpcs.update_content.metadata.to_h
385
-
386
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
387
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
388
- lib_name: @config.lib_name, lib_version: @config.lib_version,
389
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
390
- transports_version_send: [:rest]
391
-
392
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
393
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
394
-
395
- options.apply_defaults timeout: @config.rpcs.update_content.timeout,
396
- metadata: call_metadata,
397
- retry_policy: @config.rpcs.update_content.retry_policy
398
-
399
- options.apply_defaults timeout: @config.timeout,
400
- metadata: @config.metadata,
401
- retry_policy: @config.retry_policy
402
-
403
- @content_service_stub.update_content request, options do |result, operation|
404
- yield result, operation if block_given?
405
- end
406
- rescue ::Gapic::Rest::Error => e
407
- raise ::Google::Cloud::Error.from_error(e)
408
- end
409
-
410
- ##
411
- # Delete a content.
412
- #
413
- # @overload delete_content(request, options = nil)
414
- # Pass arguments to `delete_content` via a request object, either of type
415
- # {::Google::Cloud::Dataplex::V1::DeleteContentRequest} or an equivalent Hash.
416
- #
417
- # @param request [::Google::Cloud::Dataplex::V1::DeleteContentRequest, ::Hash]
418
- # A request object representing the call parameters. Required. To specify no
419
- # parameters, or to keep all the default parameter values, pass an empty Hash.
420
- # @param options [::Gapic::CallOptions, ::Hash]
421
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
422
- #
423
- # @overload delete_content(name: nil)
424
- # Pass arguments to `delete_content` via keyword arguments. Note that at
425
- # least one keyword argument is required. To specify no parameters, or to keep all
426
- # the default parameter values, pass an empty Hash as a request object (see above).
427
- #
428
- # @param name [::String]
429
- # Required. The resource name of the content:
430
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}/content/\\{content_id}
431
- # @yield [result, operation] Access the result along with the TransportOperation object
432
- # @yieldparam result [::Google::Protobuf::Empty]
433
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
434
- #
435
- # @return [::Google::Protobuf::Empty]
436
- #
437
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
438
- #
439
- # @example Basic example
440
- # require "google/cloud/dataplex/v1"
441
- #
442
- # # Create a client object. The client can be reused for multiple calls.
443
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
444
- #
445
- # # Create a request. To set request fields, pass in keyword arguments.
446
- # request = Google::Cloud::Dataplex::V1::DeleteContentRequest.new
447
- #
448
- # # Call the delete_content method.
449
- # result = client.delete_content request
450
- #
451
- # # The returned object is of type Google::Protobuf::Empty.
452
- # p result
453
- #
454
- def delete_content request, options = nil
455
- raise ::ArgumentError, "request must be provided" if request.nil?
456
-
457
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteContentRequest
458
-
459
- # Converts hash and nil to an options object
460
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
461
-
462
- # Customize the options with defaults
463
- call_metadata = @config.rpcs.delete_content.metadata.to_h
464
-
465
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
466
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
467
- lib_name: @config.lib_name, lib_version: @config.lib_version,
468
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
469
- transports_version_send: [:rest]
470
-
471
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
472
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
473
-
474
- options.apply_defaults timeout: @config.rpcs.delete_content.timeout,
475
- metadata: call_metadata,
476
- retry_policy: @config.rpcs.delete_content.retry_policy
477
-
478
- options.apply_defaults timeout: @config.timeout,
479
- metadata: @config.metadata,
480
- retry_policy: @config.retry_policy
481
-
482
- @content_service_stub.delete_content request, options do |result, operation|
483
- yield result, operation if block_given?
484
- end
485
- rescue ::Gapic::Rest::Error => e
486
- raise ::Google::Cloud::Error.from_error(e)
487
- end
488
-
489
- ##
490
- # Get a content resource.
491
- #
492
- # @overload get_content(request, options = nil)
493
- # Pass arguments to `get_content` via a request object, either of type
494
- # {::Google::Cloud::Dataplex::V1::GetContentRequest} or an equivalent Hash.
495
- #
496
- # @param request [::Google::Cloud::Dataplex::V1::GetContentRequest, ::Hash]
497
- # A request object representing the call parameters. Required. To specify no
498
- # parameters, or to keep all the default parameter values, pass an empty Hash.
499
- # @param options [::Gapic::CallOptions, ::Hash]
500
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
501
- #
502
- # @overload get_content(name: nil, view: nil)
503
- # Pass arguments to `get_content` via keyword arguments. Note that at
504
- # least one keyword argument is required. To specify no parameters, or to keep all
505
- # the default parameter values, pass an empty Hash as a request object (see above).
506
- #
507
- # @param name [::String]
508
- # Required. The resource name of the content:
509
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}/content/\\{content_id}
510
- # @param view [::Google::Cloud::Dataplex::V1::GetContentRequest::ContentView]
511
- # Optional. Specify content view to make a partial request.
512
- # @yield [result, operation] Access the result along with the TransportOperation object
513
- # @yieldparam result [::Google::Cloud::Dataplex::V1::Content]
514
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
515
- #
516
- # @return [::Google::Cloud::Dataplex::V1::Content]
517
- #
518
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
519
- #
520
- # @example Basic example
521
- # require "google/cloud/dataplex/v1"
522
- #
523
- # # Create a client object. The client can be reused for multiple calls.
524
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
525
- #
526
- # # Create a request. To set request fields, pass in keyword arguments.
527
- # request = Google::Cloud::Dataplex::V1::GetContentRequest.new
528
- #
529
- # # Call the get_content method.
530
- # result = client.get_content request
531
- #
532
- # # The returned object is of type Google::Cloud::Dataplex::V1::Content.
533
- # p result
534
- #
535
- def get_content request, options = nil
536
- raise ::ArgumentError, "request must be provided" if request.nil?
537
-
538
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetContentRequest
539
-
540
- # Converts hash and nil to an options object
541
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
542
-
543
- # Customize the options with defaults
544
- call_metadata = @config.rpcs.get_content.metadata.to_h
545
-
546
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
547
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
548
- lib_name: @config.lib_name, lib_version: @config.lib_version,
549
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
550
- transports_version_send: [:rest]
551
-
552
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
553
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
554
-
555
- options.apply_defaults timeout: @config.rpcs.get_content.timeout,
556
- metadata: call_metadata,
557
- retry_policy: @config.rpcs.get_content.retry_policy
558
-
559
- options.apply_defaults timeout: @config.timeout,
560
- metadata: @config.metadata,
561
- retry_policy: @config.retry_policy
562
-
563
- @content_service_stub.get_content request, options do |result, operation|
564
- yield result, operation if block_given?
565
- end
566
- rescue ::Gapic::Rest::Error => e
567
- raise ::Google::Cloud::Error.from_error(e)
568
- end
569
-
570
- ##
571
- # Gets the access control policy for a contentitem resource. A `NOT_FOUND`
572
- # error is returned if the resource does not exist. An empty policy is
573
- # returned if the resource exists but does not have a policy set on it.
574
- #
575
- # Caller must have Google IAM `dataplex.content.getIamPolicy` permission
576
- # on the resource.
577
- #
578
- # @overload get_iam_policy(request, options = nil)
579
- # Pass arguments to `get_iam_policy` via a request object, either of type
580
- # {::Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
581
- #
582
- # @param request [::Google::Iam::V1::GetIamPolicyRequest, ::Hash]
583
- # A request object representing the call parameters. Required. To specify no
584
- # parameters, or to keep all the default parameter values, pass an empty Hash.
585
- # @param options [::Gapic::CallOptions, ::Hash]
586
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
587
- #
588
- # @overload get_iam_policy(resource: nil, options: nil)
589
- # Pass arguments to `get_iam_policy` via keyword arguments. Note that at
590
- # least one keyword argument is required. To specify no parameters, or to keep all
591
- # the default parameter values, pass an empty Hash as a request object (see above).
592
- #
593
- # @param resource [::String]
594
- # REQUIRED: The resource for which the policy is being requested.
595
- # See the operation documentation for the appropriate value for this field.
596
- # @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
597
- # OPTIONAL: A `GetPolicyOptions` object for specifying options to
598
- # `GetIamPolicy`.
599
- # @yield [result, operation] Access the result along with the TransportOperation object
600
- # @yieldparam result [::Google::Iam::V1::Policy]
601
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
602
- #
603
- # @return [::Google::Iam::V1::Policy]
604
- #
605
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
606
- #
607
- # @example Basic example
608
- # require "google/cloud/dataplex/v1"
609
- #
610
- # # Create a client object. The client can be reused for multiple calls.
611
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
612
- #
613
- # # Create a request. To set request fields, pass in keyword arguments.
614
- # request = Google::Iam::V1::GetIamPolicyRequest.new
615
- #
616
- # # Call the get_iam_policy method.
617
- # result = client.get_iam_policy request
618
- #
619
- # # The returned object is of type Google::Iam::V1::Policy.
620
- # p result
621
- #
622
- def get_iam_policy request, options = nil
623
- raise ::ArgumentError, "request must be provided" if request.nil?
624
-
625
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest
626
-
627
- # Converts hash and nil to an options object
628
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
629
-
630
- # Customize the options with defaults
631
- call_metadata = @config.rpcs.get_iam_policy.metadata.to_h
632
-
633
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
634
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
635
- lib_name: @config.lib_name, lib_version: @config.lib_version,
636
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
637
- transports_version_send: [:rest]
638
-
639
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
640
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
641
-
642
- options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
643
- metadata: call_metadata,
644
- retry_policy: @config.rpcs.get_iam_policy.retry_policy
645
-
646
- options.apply_defaults timeout: @config.timeout,
647
- metadata: @config.metadata,
648
- retry_policy: @config.retry_policy
649
-
650
- @content_service_stub.get_iam_policy request, options do |result, operation|
651
- yield result, operation if block_given?
652
- end
653
- rescue ::Gapic::Rest::Error => e
654
- raise ::Google::Cloud::Error.from_error(e)
655
- end
656
-
657
- ##
658
- # Sets the access control policy on the specified contentitem resource.
659
- # Replaces any existing policy.
660
- #
661
- # Caller must have Google IAM `dataplex.content.setIamPolicy` permission
662
- # on the resource.
663
- #
664
- # @overload set_iam_policy(request, options = nil)
665
- # Pass arguments to `set_iam_policy` via a request object, either of type
666
- # {::Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
667
- #
668
- # @param request [::Google::Iam::V1::SetIamPolicyRequest, ::Hash]
669
- # A request object representing the call parameters. Required. To specify no
670
- # parameters, or to keep all the default parameter values, pass an empty Hash.
671
- # @param options [::Gapic::CallOptions, ::Hash]
672
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
673
- #
674
- # @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
675
- # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
676
- # least one keyword argument is required. To specify no parameters, or to keep all
677
- # the default parameter values, pass an empty Hash as a request object (see above).
678
- #
679
- # @param resource [::String]
680
- # REQUIRED: The resource for which the policy is being specified.
681
- # See the operation documentation for the appropriate value for this field.
682
- # @param policy [::Google::Iam::V1::Policy, ::Hash]
683
- # REQUIRED: The complete policy to be applied to the `resource`. The size of
684
- # the policy is limited to a few 10s of KB. An empty policy is a
685
- # valid policy but certain Cloud Platform services (such as Projects)
686
- # might reject them.
687
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
688
- # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
689
- # the fields in the mask will be modified. If no mask is provided, the
690
- # following default mask is used:
691
- #
692
- # `paths: "bindings, etag"`
693
- # @yield [result, operation] Access the result along with the TransportOperation object
694
- # @yieldparam result [::Google::Iam::V1::Policy]
695
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
696
- #
697
- # @return [::Google::Iam::V1::Policy]
698
- #
699
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
700
- #
701
- # @example Basic example
702
- # require "google/cloud/dataplex/v1"
703
- #
704
- # # Create a client object. The client can be reused for multiple calls.
705
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
706
- #
707
- # # Create a request. To set request fields, pass in keyword arguments.
708
- # request = Google::Iam::V1::SetIamPolicyRequest.new
709
- #
710
- # # Call the set_iam_policy method.
711
- # result = client.set_iam_policy request
712
- #
713
- # # The returned object is of type Google::Iam::V1::Policy.
714
- # p result
715
- #
716
- def set_iam_policy request, options = nil
717
- raise ::ArgumentError, "request must be provided" if request.nil?
718
-
719
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest
720
-
721
- # Converts hash and nil to an options object
722
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
723
-
724
- # Customize the options with defaults
725
- call_metadata = @config.rpcs.set_iam_policy.metadata.to_h
726
-
727
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
728
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
729
- lib_name: @config.lib_name, lib_version: @config.lib_version,
730
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
731
- transports_version_send: [:rest]
732
-
733
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
734
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
735
-
736
- options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
737
- metadata: call_metadata,
738
- retry_policy: @config.rpcs.set_iam_policy.retry_policy
739
-
740
- options.apply_defaults timeout: @config.timeout,
741
- metadata: @config.metadata,
742
- retry_policy: @config.retry_policy
743
-
744
- @content_service_stub.set_iam_policy request, options do |result, operation|
745
- yield result, operation if block_given?
746
- end
747
- rescue ::Gapic::Rest::Error => e
748
- raise ::Google::Cloud::Error.from_error(e)
749
- end
750
-
751
- ##
752
- # Returns the caller's permissions on a resource.
753
- # If the resource does not exist, an empty set of
754
- # permissions is returned (a `NOT_FOUND` error is not returned).
755
- #
756
- # A caller is not required to have Google IAM permission to make this
757
- # request.
758
- #
759
- # Note: This operation is designed to be used for building permission-aware
760
- # UIs and command-line tools, not for authorization checking. This operation
761
- # may "fail open" without warning.
762
- #
763
- # @overload test_iam_permissions(request, options = nil)
764
- # Pass arguments to `test_iam_permissions` via a request object, either of type
765
- # {::Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash.
766
- #
767
- # @param request [::Google::Iam::V1::TestIamPermissionsRequest, ::Hash]
768
- # A request object representing the call parameters. Required. To specify no
769
- # parameters, or to keep all the default parameter values, pass an empty Hash.
770
- # @param options [::Gapic::CallOptions, ::Hash]
771
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
772
- #
773
- # @overload test_iam_permissions(resource: nil, permissions: nil)
774
- # Pass arguments to `test_iam_permissions` via keyword arguments. Note that at
775
- # least one keyword argument is required. To specify no parameters, or to keep all
776
- # the default parameter values, pass an empty Hash as a request object (see above).
777
- #
778
- # @param resource [::String]
779
- # REQUIRED: The resource for which the policy detail is being requested.
780
- # See the operation documentation for the appropriate value for this field.
781
- # @param permissions [::Array<::String>]
782
- # The set of permissions to check for the `resource`. Permissions with
783
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
784
- # information see
785
- # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
786
- # @yield [result, operation] Access the result along with the TransportOperation object
787
- # @yieldparam result [::Google::Iam::V1::TestIamPermissionsResponse]
788
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
789
- #
790
- # @return [::Google::Iam::V1::TestIamPermissionsResponse]
791
- #
792
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
793
- #
794
- # @example Basic example
795
- # require "google/cloud/dataplex/v1"
796
- #
797
- # # Create a client object. The client can be reused for multiple calls.
798
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
799
- #
800
- # # Create a request. To set request fields, pass in keyword arguments.
801
- # request = Google::Iam::V1::TestIamPermissionsRequest.new
802
- #
803
- # # Call the test_iam_permissions method.
804
- # result = client.test_iam_permissions request
805
- #
806
- # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
807
- # p result
808
- #
809
- def test_iam_permissions request, options = nil
810
- raise ::ArgumentError, "request must be provided" if request.nil?
811
-
812
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest
813
-
814
- # Converts hash and nil to an options object
815
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
816
-
817
- # Customize the options with defaults
818
- call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h
819
-
820
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
821
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
822
- lib_name: @config.lib_name, lib_version: @config.lib_version,
823
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
824
- transports_version_send: [:rest]
825
-
826
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
827
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
828
-
829
- options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
830
- metadata: call_metadata,
831
- retry_policy: @config.rpcs.test_iam_permissions.retry_policy
832
-
833
- options.apply_defaults timeout: @config.timeout,
834
- metadata: @config.metadata,
835
- retry_policy: @config.retry_policy
836
-
837
- @content_service_stub.test_iam_permissions request, options do |result, operation|
838
- yield result, operation if block_given?
839
- end
840
- rescue ::Gapic::Rest::Error => e
841
- raise ::Google::Cloud::Error.from_error(e)
842
- end
843
-
844
- ##
845
- # List content.
846
- #
847
- # @overload list_content(request, options = nil)
848
- # Pass arguments to `list_content` via a request object, either of type
849
- # {::Google::Cloud::Dataplex::V1::ListContentRequest} or an equivalent Hash.
850
- #
851
- # @param request [::Google::Cloud::Dataplex::V1::ListContentRequest, ::Hash]
852
- # A request object representing the call parameters. Required. To specify no
853
- # parameters, or to keep all the default parameter values, pass an empty Hash.
854
- # @param options [::Gapic::CallOptions, ::Hash]
855
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
856
- #
857
- # @overload list_content(parent: nil, page_size: nil, page_token: nil, filter: nil)
858
- # Pass arguments to `list_content` via keyword arguments. Note that at
859
- # least one keyword argument is required. To specify no parameters, or to keep all
860
- # the default parameter values, pass an empty Hash as a request object (see above).
861
- #
862
- # @param parent [::String]
863
- # Required. The resource name of the parent lake:
864
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
865
- # @param page_size [::Integer]
866
- # Optional. Maximum number of content to return. The service may return fewer
867
- # than this value. If unspecified, at most 10 content will be returned. The
868
- # maximum value is 1000; values above 1000 will be coerced to 1000.
869
- # @param page_token [::String]
870
- # Optional. Page token received from a previous `ListContent` call. Provide
871
- # this to retrieve the subsequent page. When paginating, all other parameters
872
- # provided to `ListContent` must match the call that provided the page
873
- # token.
874
- # @param filter [::String]
875
- # Optional. Filter request. Filters are case-sensitive.
876
- # The following formats are supported:
877
- #
878
- # labels.key1 = "value1"
879
- # labels:key1
880
- # type = "NOTEBOOK"
881
- # type = "SQL_SCRIPT"
882
- #
883
- # These restrictions can be coinjoined with AND, OR and NOT conjunctions.
884
- # @yield [result, operation] Access the result along with the TransportOperation object
885
- # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>]
886
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
887
- #
888
- # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Content>]
889
- #
890
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
891
- #
892
- # @example Basic example
893
- # require "google/cloud/dataplex/v1"
894
- #
895
- # # Create a client object. The client can be reused for multiple calls.
896
- # client = Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new
897
- #
898
- # # Create a request. To set request fields, pass in keyword arguments.
899
- # request = Google::Cloud::Dataplex::V1::ListContentRequest.new
900
- #
901
- # # Call the list_content method.
902
- # result = client.list_content request
903
- #
904
- # # The returned object is of type Gapic::PagedEnumerable. You can iterate
905
- # # over elements, and API calls will be issued to fetch pages as needed.
906
- # result.each do |item|
907
- # # Each element is of type ::Google::Cloud::Dataplex::V1::Content.
908
- # p item
909
- # end
910
- #
911
- def list_content request, options = nil
912
- raise ::ArgumentError, "request must be provided" if request.nil?
913
-
914
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListContentRequest
915
-
916
- # Converts hash and nil to an options object
917
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
918
-
919
- # Customize the options with defaults
920
- call_metadata = @config.rpcs.list_content.metadata.to_h
921
-
922
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
923
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
924
- lib_name: @config.lib_name, lib_version: @config.lib_version,
925
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
926
- transports_version_send: [:rest]
927
-
928
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
929
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
930
-
931
- options.apply_defaults timeout: @config.rpcs.list_content.timeout,
932
- metadata: call_metadata,
933
- retry_policy: @config.rpcs.list_content.retry_policy
934
-
935
- options.apply_defaults timeout: @config.timeout,
936
- metadata: @config.metadata,
937
- retry_policy: @config.retry_policy
938
-
939
- @content_service_stub.list_content request, options do |result, operation|
940
- result = ::Gapic::Rest::PagedEnumerable.new @content_service_stub, :list_content, "content", request, result, options
941
- yield result, operation if block_given?
942
- throw :response, result
943
- end
944
- rescue ::Gapic::Rest::Error => e
945
- raise ::Google::Cloud::Error.from_error(e)
946
- end
947
-
948
- ##
949
- # Configuration class for the ContentService REST API.
950
- #
951
- # This class represents the configuration for ContentService REST,
952
- # providing control over timeouts, retry behavior, logging, transport
953
- # parameters, and other low-level controls. Certain parameters can also be
954
- # applied individually to specific RPCs. See
955
- # {::Google::Cloud::Dataplex::V1::ContentService::Rest::Client::Configuration::Rpcs}
956
- # for a list of RPCs that can be configured independently.
957
- #
958
- # Configuration can be applied globally to all clients, or to a single client
959
- # on construction.
960
- #
961
- # @example
962
- #
963
- # # Modify the global config, setting the timeout for
964
- # # create_content to 20 seconds,
965
- # # and all remaining timeouts to 10 seconds.
966
- # ::Google::Cloud::Dataplex::V1::ContentService::Rest::Client.configure do |config|
967
- # config.timeout = 10.0
968
- # config.rpcs.create_content.timeout = 20.0
969
- # end
970
- #
971
- # # Apply the above configuration only to a new client.
972
- # client = ::Google::Cloud::Dataplex::V1::ContentService::Rest::Client.new do |config|
973
- # config.timeout = 10.0
974
- # config.rpcs.create_content.timeout = 20.0
975
- # end
976
- #
977
- # @!attribute [rw] endpoint
978
- # A custom service endpoint, as a hostname or hostname:port. The default is
979
- # nil, indicating to use the default endpoint in the current universe domain.
980
- # @return [::String,nil]
981
- # @!attribute [rw] credentials
982
- # Credentials to send with calls. You may provide any of the following types:
983
- # * (`String`) The path to a service account key file in JSON format
984
- # * (`Hash`) A service account key as a Hash
985
- # * (`Google::Auth::Credentials`) A googleauth credentials object
986
- # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
987
- # * (`Signet::OAuth2::Client`) A signet oauth2 client object
988
- # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
989
- # * (`nil`) indicating no credentials
990
- #
991
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
992
- # external source for authentication to Google Cloud, you must validate it before
993
- # providing it to a Google API client library. Providing an unvalidated credential
994
- # configuration to Google APIs can compromise the security of your systems and data.
995
- # For more information, refer to [Validate credential configurations from external
996
- # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
997
- # @return [::Object]
998
- # @!attribute [rw] scope
999
- # The OAuth scopes
1000
- # @return [::Array<::String>]
1001
- # @!attribute [rw] lib_name
1002
- # The library name as recorded in instrumentation and logging
1003
- # @return [::String]
1004
- # @!attribute [rw] lib_version
1005
- # The library version as recorded in instrumentation and logging
1006
- # @return [::String]
1007
- # @!attribute [rw] timeout
1008
- # The call timeout in seconds.
1009
- # @return [::Numeric]
1010
- # @!attribute [rw] metadata
1011
- # Additional headers to be sent with the call.
1012
- # @return [::Hash{::Symbol=>::String}]
1013
- # @!attribute [rw] retry_policy
1014
- # The retry policy. The value is a hash with the following keys:
1015
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1016
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1017
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1018
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1019
- # trigger a retry.
1020
- # @return [::Hash]
1021
- # @!attribute [rw] quota_project
1022
- # A separate project against which to charge quota.
1023
- # @return [::String]
1024
- # @!attribute [rw] universe_domain
1025
- # The universe domain within which to make requests. This determines the
1026
- # default endpoint URL. The default value of nil uses the environment
1027
- # universe (usually the default "googleapis.com" universe).
1028
- # @return [::String,nil]
1029
- # @!attribute [rw] logger
1030
- # A custom logger to use for request/response debug logging, or the value
1031
- # `:default` (the default) to construct a default logger, or `nil` to
1032
- # explicitly disable logging.
1033
- # @return [::Logger,:default,nil]
1034
- #
1035
- class Configuration
1036
- extend ::Gapic::Config
1037
-
1038
- # @private
1039
- # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1040
- DEFAULT_ENDPOINT = "dataplex.googleapis.com"
1041
-
1042
- config_attr :endpoint, nil, ::String, nil
1043
- config_attr :credentials, nil do |value|
1044
- allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
1045
- allowed.any? { |klass| klass === value }
1046
- end
1047
- config_attr :scope, nil, ::String, ::Array, nil
1048
- config_attr :lib_name, nil, ::String, nil
1049
- config_attr :lib_version, nil, ::String, nil
1050
- config_attr :timeout, nil, ::Numeric, nil
1051
- config_attr :metadata, nil, ::Hash, nil
1052
- config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1053
- config_attr :quota_project, nil, ::String, nil
1054
- config_attr :universe_domain, nil, ::String, nil
1055
-
1056
- # @private
1057
- # Overrides for http bindings for the RPCs of this service
1058
- # are only used when this service is used as mixin, and only
1059
- # by the host service.
1060
- # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
1061
- config_attr :bindings_override, {}, ::Hash, nil
1062
- config_attr :logger, :default, ::Logger, nil, :default
1063
-
1064
- # @private
1065
- def initialize parent_config = nil
1066
- @parent_config = parent_config unless parent_config.nil?
1067
-
1068
- yield self if block_given?
1069
- end
1070
-
1071
- ##
1072
- # Configurations for individual RPCs
1073
- # @return [Rpcs]
1074
- #
1075
- def rpcs
1076
- @rpcs ||= begin
1077
- parent_rpcs = nil
1078
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
1079
- Rpcs.new parent_rpcs
1080
- end
1081
- end
1082
-
1083
- ##
1084
- # Configuration RPC class for the ContentService API.
1085
- #
1086
- # Includes fields providing the configuration for each RPC in this service.
1087
- # Each configuration object is of type `Gapic::Config::Method` and includes
1088
- # the following configuration fields:
1089
- #
1090
- # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1091
- # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
1092
- # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1093
- # include the following keys:
1094
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1095
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1096
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1097
- # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1098
- # trigger a retry.
1099
- #
1100
- class Rpcs
1101
- ##
1102
- # RPC-specific configuration for `create_content`
1103
- # @return [::Gapic::Config::Method]
1104
- #
1105
- attr_reader :create_content
1106
- ##
1107
- # RPC-specific configuration for `update_content`
1108
- # @return [::Gapic::Config::Method]
1109
- #
1110
- attr_reader :update_content
1111
- ##
1112
- # RPC-specific configuration for `delete_content`
1113
- # @return [::Gapic::Config::Method]
1114
- #
1115
- attr_reader :delete_content
1116
- ##
1117
- # RPC-specific configuration for `get_content`
1118
- # @return [::Gapic::Config::Method]
1119
- #
1120
- attr_reader :get_content
1121
- ##
1122
- # RPC-specific configuration for `get_iam_policy`
1123
- # @return [::Gapic::Config::Method]
1124
- #
1125
- attr_reader :get_iam_policy
1126
- ##
1127
- # RPC-specific configuration for `set_iam_policy`
1128
- # @return [::Gapic::Config::Method]
1129
- #
1130
- attr_reader :set_iam_policy
1131
- ##
1132
- # RPC-specific configuration for `test_iam_permissions`
1133
- # @return [::Gapic::Config::Method]
1134
- #
1135
- attr_reader :test_iam_permissions
1136
- ##
1137
- # RPC-specific configuration for `list_content`
1138
- # @return [::Gapic::Config::Method]
1139
- #
1140
- attr_reader :list_content
1141
-
1142
- # @private
1143
- def initialize parent_rpcs = nil
1144
- create_content_config = parent_rpcs.create_content if parent_rpcs.respond_to? :create_content
1145
- @create_content = ::Gapic::Config::Method.new create_content_config
1146
- update_content_config = parent_rpcs.update_content if parent_rpcs.respond_to? :update_content
1147
- @update_content = ::Gapic::Config::Method.new update_content_config
1148
- delete_content_config = parent_rpcs.delete_content if parent_rpcs.respond_to? :delete_content
1149
- @delete_content = ::Gapic::Config::Method.new delete_content_config
1150
- get_content_config = parent_rpcs.get_content if parent_rpcs.respond_to? :get_content
1151
- @get_content = ::Gapic::Config::Method.new get_content_config
1152
- get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
1153
- @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
1154
- set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
1155
- @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
1156
- test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
1157
- @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
1158
- list_content_config = parent_rpcs.list_content if parent_rpcs.respond_to? :list_content
1159
- @list_content = ::Gapic::Config::Method.new list_content_config
1160
-
1161
- yield self if block_given?
1162
- end
1163
- end
1164
- end
1165
- end
1166
- end
1167
- end
1168
- end
1169
- end
1170
- end
1171
- end