google-cloud-dataform-v1 0.3.0 → 0.4.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 (31) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +5 -5
  4. data/lib/google/cloud/dataform/v1/bindings_override.rb +0 -57
  5. data/lib/google/cloud/dataform/v1/dataform/client.rb +2061 -48
  6. data/lib/google/cloud/dataform/v1/dataform/operations.rb +843 -0
  7. data/lib/google/cloud/dataform/v1/dataform/paths.rb +38 -0
  8. data/lib/google/cloud/dataform/v1/dataform/rest/client.rb +1944 -65
  9. data/lib/google/cloud/dataform/v1/dataform/rest/operations.rb +927 -0
  10. data/lib/google/cloud/dataform/v1/dataform/rest/service_stub.rb +1719 -481
  11. data/lib/google/cloud/dataform/v1/dataform/rest.rb +1 -0
  12. data/lib/google/cloud/dataform/v1/dataform.rb +1 -0
  13. data/lib/google/cloud/dataform/v1/dataform_pb.rb +42 -1
  14. data/lib/google/cloud/dataform/v1/dataform_services_pb.rb +54 -0
  15. data/lib/google/cloud/dataform/v1/version.rb +1 -1
  16. data/lib/google/longrunning/bindings_override.rb +71 -0
  17. data/lib/google/longrunning/operations/client.rb +954 -0
  18. data/lib/google/longrunning/operations/credentials.rb +40 -0
  19. data/lib/google/longrunning/operations/operations.rb +839 -0
  20. data/lib/google/longrunning/operations/rest/client.rb +777 -0
  21. data/lib/google/longrunning/operations/rest/operations.rb +923 -0
  22. data/lib/google/longrunning/operations/rest/service_stub.rb +322 -0
  23. data/lib/google/longrunning/operations/rest.rb +57 -0
  24. data/lib/google/longrunning/operations.rb +59 -0
  25. data/lib/google/longrunning/rest.rb +34 -0
  26. data/lib/google/longrunning.rb +41 -0
  27. data/lib/google-cloud-dataform-v1.rb +1 -0
  28. data/proto_docs/google/api/client.rb +149 -29
  29. data/proto_docs/google/cloud/dataform/v1/dataform.rb +759 -3
  30. data/proto_docs/google/longrunning/operations.rb +191 -0
  31. metadata +17 -3
@@ -152,6 +152,13 @@ module Google
152
152
  @quota_project_id = @config.quota_project
153
153
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
154
154
 
155
+ @operations_client = Operations.new do |config|
156
+ config.credentials = credentials
157
+ config.quota_project = @quota_project_id
158
+ config.endpoint = @config.endpoint
159
+ config.universe_domain = @config.universe_domain
160
+ end
161
+
155
162
  @dataform_stub = ::Gapic::ServiceStub.new(
156
163
  ::Google::Cloud::Dataform::V1::Dataform::Stub,
157
164
  credentials: credentials,
@@ -164,57 +171,1532 @@ module Google
164
171
  logger: @config.logger
165
172
  )
166
173
 
167
- @dataform_stub.stub_logger&.info do |entry|
168
- entry.set_system_name
169
- entry.set_service
170
- entry.message = "Created client for #{entry.service}"
171
- entry.set_credentials_fields credentials
172
- entry.set "customEndpoint", @config.endpoint if @config.endpoint
173
- entry.set "defaultTimeout", @config.timeout if @config.timeout
174
- entry.set "quotaProject", @quota_project_id if @quota_project_id
175
- end
174
+ @dataform_stub.stub_logger&.info do |entry|
175
+ entry.set_system_name
176
+ entry.set_service
177
+ entry.message = "Created client for #{entry.service}"
178
+ entry.set_credentials_fields credentials
179
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
180
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
181
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
182
+ end
183
+
184
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
185
+ config.credentials = credentials
186
+ config.quota_project = @quota_project_id
187
+ config.endpoint = @dataform_stub.endpoint
188
+ config.universe_domain = @dataform_stub.universe_domain
189
+ config.logger = @dataform_stub.logger if config.respond_to? :logger=
190
+ end
191
+
192
+ @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
193
+ config.credentials = credentials
194
+ config.quota_project = @quota_project_id
195
+ config.endpoint = @dataform_stub.endpoint
196
+ config.universe_domain = @dataform_stub.universe_domain
197
+ config.logger = @dataform_stub.logger if config.respond_to? :logger=
198
+ end
199
+ end
200
+
201
+ ##
202
+ # Get the associated client for long-running operations.
203
+ #
204
+ # @return [::Google::Cloud::Dataform::V1::Dataform::Operations]
205
+ #
206
+ attr_reader :operations_client
207
+
208
+ ##
209
+ # Get the associated client for mix-in of the Locations.
210
+ #
211
+ # @return [Google::Cloud::Location::Locations::Client]
212
+ #
213
+ attr_reader :location_client
214
+
215
+ ##
216
+ # Get the associated client for mix-in of the IAMPolicy.
217
+ #
218
+ # @return [Google::Iam::V1::IAMPolicy::Client]
219
+ #
220
+ attr_reader :iam_policy_client
221
+
222
+ ##
223
+ # The logger used for request/response debug logging.
224
+ #
225
+ # @return [Logger]
226
+ #
227
+ def logger
228
+ @dataform_stub.logger
229
+ end
230
+
231
+ # Service calls
232
+
233
+ ##
234
+ # Fetches a single TeamFolder.
235
+ #
236
+ # @overload get_team_folder(request, options = nil)
237
+ # Pass arguments to `get_team_folder` via a request object, either of type
238
+ # {::Google::Cloud::Dataform::V1::GetTeamFolderRequest} or an equivalent Hash.
239
+ #
240
+ # @param request [::Google::Cloud::Dataform::V1::GetTeamFolderRequest, ::Hash]
241
+ # A request object representing the call parameters. Required. To specify no
242
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
243
+ # @param options [::Gapic::CallOptions, ::Hash]
244
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
245
+ #
246
+ # @overload get_team_folder(name: nil)
247
+ # Pass arguments to `get_team_folder` via keyword arguments. Note that at
248
+ # least one keyword argument is required. To specify no parameters, or to keep all
249
+ # the default parameter values, pass an empty Hash as a request object (see above).
250
+ #
251
+ # @param name [::String]
252
+ # Required. The TeamFolder's name.
253
+ #
254
+ # @yield [response, operation] Access the result along with the RPC operation
255
+ # @yieldparam response [::Google::Cloud::Dataform::V1::TeamFolder]
256
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
257
+ #
258
+ # @return [::Google::Cloud::Dataform::V1::TeamFolder]
259
+ #
260
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
261
+ #
262
+ # @example Basic example
263
+ # require "google/cloud/dataform/v1"
264
+ #
265
+ # # Create a client object. The client can be reused for multiple calls.
266
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
267
+ #
268
+ # # Create a request. To set request fields, pass in keyword arguments.
269
+ # request = Google::Cloud::Dataform::V1::GetTeamFolderRequest.new
270
+ #
271
+ # # Call the get_team_folder method.
272
+ # result = client.get_team_folder request
273
+ #
274
+ # # The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
275
+ # p result
276
+ #
277
+ def get_team_folder request, options = nil
278
+ raise ::ArgumentError, "request must be provided" if request.nil?
279
+
280
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::GetTeamFolderRequest
281
+
282
+ # Converts hash and nil to an options object
283
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
284
+
285
+ # Customize the options with defaults
286
+ metadata = @config.rpcs.get_team_folder.metadata.to_h
287
+
288
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
289
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
290
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
291
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
292
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
293
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
294
+
295
+ header_params = {}
296
+ if request.name
297
+ header_params["name"] = request.name
298
+ end
299
+
300
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
301
+ metadata[:"x-goog-request-params"] ||= request_params_header
302
+
303
+ options.apply_defaults timeout: @config.rpcs.get_team_folder.timeout,
304
+ metadata: metadata,
305
+ retry_policy: @config.rpcs.get_team_folder.retry_policy
306
+
307
+ options.apply_defaults timeout: @config.timeout,
308
+ metadata: @config.metadata,
309
+ retry_policy: @config.retry_policy
310
+
311
+ @dataform_stub.call_rpc :get_team_folder, request, options: options do |response, operation|
312
+ yield response, operation if block_given?
313
+ end
314
+ rescue ::GRPC::BadStatus => e
315
+ raise ::Google::Cloud::Error.from_error(e)
316
+ end
317
+
318
+ ##
319
+ # Creates a new TeamFolder in a given project and location.
320
+ #
321
+ # @overload create_team_folder(request, options = nil)
322
+ # Pass arguments to `create_team_folder` via a request object, either of type
323
+ # {::Google::Cloud::Dataform::V1::CreateTeamFolderRequest} or an equivalent Hash.
324
+ #
325
+ # @param request [::Google::Cloud::Dataform::V1::CreateTeamFolderRequest, ::Hash]
326
+ # A request object representing the call parameters. Required. To specify no
327
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
328
+ # @param options [::Gapic::CallOptions, ::Hash]
329
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
330
+ #
331
+ # @overload create_team_folder(parent: nil, team_folder: nil)
332
+ # Pass arguments to `create_team_folder` via keyword arguments. Note that at
333
+ # least one keyword argument is required. To specify no parameters, or to keep all
334
+ # the default parameter values, pass an empty Hash as a request object (see above).
335
+ #
336
+ # @param parent [::String]
337
+ # Required. The location in which to create the TeamFolder. Must be in the
338
+ # format `projects/*/locations/*`.
339
+ # @param team_folder [::Google::Cloud::Dataform::V1::TeamFolder, ::Hash]
340
+ # Required. The TeamFolder to create.
341
+ #
342
+ # @yield [response, operation] Access the result along with the RPC operation
343
+ # @yieldparam response [::Google::Cloud::Dataform::V1::TeamFolder]
344
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
345
+ #
346
+ # @return [::Google::Cloud::Dataform::V1::TeamFolder]
347
+ #
348
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
349
+ #
350
+ # @example Basic example
351
+ # require "google/cloud/dataform/v1"
352
+ #
353
+ # # Create a client object. The client can be reused for multiple calls.
354
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
355
+ #
356
+ # # Create a request. To set request fields, pass in keyword arguments.
357
+ # request = Google::Cloud::Dataform::V1::CreateTeamFolderRequest.new
358
+ #
359
+ # # Call the create_team_folder method.
360
+ # result = client.create_team_folder request
361
+ #
362
+ # # The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
363
+ # p result
364
+ #
365
+ def create_team_folder request, options = nil
366
+ raise ::ArgumentError, "request must be provided" if request.nil?
367
+
368
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::CreateTeamFolderRequest
369
+
370
+ # Converts hash and nil to an options object
371
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
372
+
373
+ # Customize the options with defaults
374
+ metadata = @config.rpcs.create_team_folder.metadata.to_h
375
+
376
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
377
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
378
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
379
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
380
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
381
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
382
+
383
+ header_params = {}
384
+ if request.parent
385
+ header_params["parent"] = request.parent
386
+ end
387
+
388
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
389
+ metadata[:"x-goog-request-params"] ||= request_params_header
390
+
391
+ options.apply_defaults timeout: @config.rpcs.create_team_folder.timeout,
392
+ metadata: metadata,
393
+ retry_policy: @config.rpcs.create_team_folder.retry_policy
394
+
395
+ options.apply_defaults timeout: @config.timeout,
396
+ metadata: @config.metadata,
397
+ retry_policy: @config.retry_policy
398
+
399
+ @dataform_stub.call_rpc :create_team_folder, request, options: options do |response, operation|
400
+ yield response, operation if block_given?
401
+ end
402
+ rescue ::GRPC::BadStatus => e
403
+ raise ::Google::Cloud::Error.from_error(e)
404
+ end
405
+
406
+ ##
407
+ # Updates a single TeamFolder.
408
+ #
409
+ # @overload update_team_folder(request, options = nil)
410
+ # Pass arguments to `update_team_folder` via a request object, either of type
411
+ # {::Google::Cloud::Dataform::V1::UpdateTeamFolderRequest} or an equivalent Hash.
412
+ #
413
+ # @param request [::Google::Cloud::Dataform::V1::UpdateTeamFolderRequest, ::Hash]
414
+ # A request object representing the call parameters. Required. To specify no
415
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
416
+ # @param options [::Gapic::CallOptions, ::Hash]
417
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
418
+ #
419
+ # @overload update_team_folder(update_mask: nil, team_folder: nil)
420
+ # Pass arguments to `update_team_folder` via keyword arguments. Note that at
421
+ # least one keyword argument is required. To specify no parameters, or to keep all
422
+ # the default parameter values, pass an empty Hash as a request object (see above).
423
+ #
424
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
425
+ # Optional. Specifies the fields to be updated in the Folder. If left unset,
426
+ # all fields will be updated.
427
+ # @param team_folder [::Google::Cloud::Dataform::V1::TeamFolder, ::Hash]
428
+ # Required. The updated TeamFolder.
429
+ #
430
+ # @yield [response, operation] Access the result along with the RPC operation
431
+ # @yieldparam response [::Google::Cloud::Dataform::V1::TeamFolder]
432
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
433
+ #
434
+ # @return [::Google::Cloud::Dataform::V1::TeamFolder]
435
+ #
436
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
437
+ #
438
+ # @example Basic example
439
+ # require "google/cloud/dataform/v1"
440
+ #
441
+ # # Create a client object. The client can be reused for multiple calls.
442
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
443
+ #
444
+ # # Create a request. To set request fields, pass in keyword arguments.
445
+ # request = Google::Cloud::Dataform::V1::UpdateTeamFolderRequest.new
446
+ #
447
+ # # Call the update_team_folder method.
448
+ # result = client.update_team_folder request
449
+ #
450
+ # # The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
451
+ # p result
452
+ #
453
+ def update_team_folder request, options = nil
454
+ raise ::ArgumentError, "request must be provided" if request.nil?
455
+
456
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::UpdateTeamFolderRequest
457
+
458
+ # Converts hash and nil to an options object
459
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
460
+
461
+ # Customize the options with defaults
462
+ metadata = @config.rpcs.update_team_folder.metadata.to_h
463
+
464
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
465
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
466
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
467
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
468
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
469
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
470
+
471
+ header_params = {}
472
+ if request.team_folder&.name
473
+ header_params["team_folder.name"] = request.team_folder.name
474
+ end
475
+
476
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
477
+ metadata[:"x-goog-request-params"] ||= request_params_header
478
+
479
+ options.apply_defaults timeout: @config.rpcs.update_team_folder.timeout,
480
+ metadata: metadata,
481
+ retry_policy: @config.rpcs.update_team_folder.retry_policy
482
+
483
+ options.apply_defaults timeout: @config.timeout,
484
+ metadata: @config.metadata,
485
+ retry_policy: @config.retry_policy
486
+
487
+ @dataform_stub.call_rpc :update_team_folder, request, options: options do |response, operation|
488
+ yield response, operation if block_given?
489
+ end
490
+ rescue ::GRPC::BadStatus => e
491
+ raise ::Google::Cloud::Error.from_error(e)
492
+ end
493
+
494
+ ##
495
+ # Deletes a single TeamFolder.
496
+ #
497
+ # @overload delete_team_folder(request, options = nil)
498
+ # Pass arguments to `delete_team_folder` via a request object, either of type
499
+ # {::Google::Cloud::Dataform::V1::DeleteTeamFolderRequest} or an equivalent Hash.
500
+ #
501
+ # @param request [::Google::Cloud::Dataform::V1::DeleteTeamFolderRequest, ::Hash]
502
+ # A request object representing the call parameters. Required. To specify no
503
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
504
+ # @param options [::Gapic::CallOptions, ::Hash]
505
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
506
+ #
507
+ # @overload delete_team_folder(name: nil)
508
+ # Pass arguments to `delete_team_folder` via keyword arguments. Note that at
509
+ # least one keyword argument is required. To specify no parameters, or to keep all
510
+ # the default parameter values, pass an empty Hash as a request object (see above).
511
+ #
512
+ # @param name [::String]
513
+ # Required. The TeamFolder's name.
514
+ #
515
+ # @yield [response, operation] Access the result along with the RPC operation
516
+ # @yieldparam response [::Google::Protobuf::Empty]
517
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
518
+ #
519
+ # @return [::Google::Protobuf::Empty]
520
+ #
521
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
522
+ #
523
+ # @example Basic example
524
+ # require "google/cloud/dataform/v1"
525
+ #
526
+ # # Create a client object. The client can be reused for multiple calls.
527
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
528
+ #
529
+ # # Create a request. To set request fields, pass in keyword arguments.
530
+ # request = Google::Cloud::Dataform::V1::DeleteTeamFolderRequest.new
531
+ #
532
+ # # Call the delete_team_folder method.
533
+ # result = client.delete_team_folder request
534
+ #
535
+ # # The returned object is of type Google::Protobuf::Empty.
536
+ # p result
537
+ #
538
+ def delete_team_folder request, options = nil
539
+ raise ::ArgumentError, "request must be provided" if request.nil?
540
+
541
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteTeamFolderRequest
542
+
543
+ # Converts hash and nil to an options object
544
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
545
+
546
+ # Customize the options with defaults
547
+ metadata = @config.rpcs.delete_team_folder.metadata.to_h
548
+
549
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
550
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
551
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
552
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
553
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
554
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
555
+
556
+ header_params = {}
557
+ if request.name
558
+ header_params["name"] = request.name
559
+ end
560
+
561
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
562
+ metadata[:"x-goog-request-params"] ||= request_params_header
563
+
564
+ options.apply_defaults timeout: @config.rpcs.delete_team_folder.timeout,
565
+ metadata: metadata,
566
+ retry_policy: @config.rpcs.delete_team_folder.retry_policy
567
+
568
+ options.apply_defaults timeout: @config.timeout,
569
+ metadata: @config.metadata,
570
+ retry_policy: @config.retry_policy
571
+
572
+ @dataform_stub.call_rpc :delete_team_folder, request, options: options do |response, operation|
573
+ yield response, operation if block_given?
574
+ end
575
+ rescue ::GRPC::BadStatus => e
576
+ raise ::Google::Cloud::Error.from_error(e)
577
+ end
578
+
579
+ ##
580
+ # Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces,
581
+ # ReleaseConfigs, and WorkflowConfigs).
582
+ #
583
+ # @overload delete_team_folder_tree(request, options = nil)
584
+ # Pass arguments to `delete_team_folder_tree` via a request object, either of type
585
+ # {::Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest} or an equivalent Hash.
586
+ #
587
+ # @param request [::Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest, ::Hash]
588
+ # A request object representing the call parameters. Required. To specify no
589
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
590
+ # @param options [::Gapic::CallOptions, ::Hash]
591
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
592
+ #
593
+ # @overload delete_team_folder_tree(name: nil, force: nil)
594
+ # Pass arguments to `delete_team_folder_tree` via keyword arguments. Note that at
595
+ # least one keyword argument is required. To specify no parameters, or to keep all
596
+ # the default parameter values, pass an empty Hash as a request object (see above).
597
+ #
598
+ # @param name [::String]
599
+ # Required. The TeamFolder's name.
600
+ # Format: projects/\\{project}/locations/\\{location}/teamFolders/\\{team_folder}
601
+ # @param force [::Boolean]
602
+ # Optional. If `false` (default): The operation will fail if any
603
+ # Repository within the folder hierarchy has associated Release Configs or
604
+ # Workflow Configs.
605
+ #
606
+ # If `true`: The operation will attempt to delete everything, including any
607
+ # Release Configs and Workflow Configs linked to Repositories within the
608
+ # folder hierarchy. This permanently removes schedules and resources.
609
+ #
610
+ # @yield [response, operation] Access the result along with the RPC operation
611
+ # @yieldparam response [::Gapic::Operation]
612
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
613
+ #
614
+ # @return [::Gapic::Operation]
615
+ #
616
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
617
+ #
618
+ # @example Basic example
619
+ # require "google/cloud/dataform/v1"
620
+ #
621
+ # # Create a client object. The client can be reused for multiple calls.
622
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
623
+ #
624
+ # # Create a request. To set request fields, pass in keyword arguments.
625
+ # request = Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest.new
626
+ #
627
+ # # Call the delete_team_folder_tree method.
628
+ # result = client.delete_team_folder_tree request
629
+ #
630
+ # # The returned object is of type Gapic::Operation. You can use it to
631
+ # # check the status of an operation, cancel it, or wait for results.
632
+ # # Here is how to wait for a response.
633
+ # result.wait_until_done! timeout: 60
634
+ # if result.response?
635
+ # p result.response
636
+ # else
637
+ # puts "No response received."
638
+ # end
639
+ #
640
+ def delete_team_folder_tree request, options = nil
641
+ raise ::ArgumentError, "request must be provided" if request.nil?
642
+
643
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest
644
+
645
+ # Converts hash and nil to an options object
646
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
647
+
648
+ # Customize the options with defaults
649
+ metadata = @config.rpcs.delete_team_folder_tree.metadata.to_h
650
+
651
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
652
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
653
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
654
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
655
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
656
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
657
+
658
+ header_params = {}
659
+ if request.name
660
+ header_params["name"] = request.name
661
+ end
662
+
663
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
664
+ metadata[:"x-goog-request-params"] ||= request_params_header
665
+
666
+ options.apply_defaults timeout: @config.rpcs.delete_team_folder_tree.timeout,
667
+ metadata: metadata,
668
+ retry_policy: @config.rpcs.delete_team_folder_tree.retry_policy
669
+
670
+ options.apply_defaults timeout: @config.timeout,
671
+ metadata: @config.metadata,
672
+ retry_policy: @config.retry_policy
673
+
674
+ @dataform_stub.call_rpc :delete_team_folder_tree, request, options: options do |response, operation|
675
+ response = ::Gapic::Operation.new response, @operations_client, options: options
676
+ yield response, operation if block_given?
677
+ throw :response, response
678
+ end
679
+ rescue ::GRPC::BadStatus => e
680
+ raise ::Google::Cloud::Error.from_error(e)
681
+ end
682
+
683
+ ##
684
+ # Returns the contents of a given TeamFolder.
685
+ #
686
+ # @overload query_team_folder_contents(request, options = nil)
687
+ # Pass arguments to `query_team_folder_contents` via a request object, either of type
688
+ # {::Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest} or an equivalent Hash.
689
+ #
690
+ # @param request [::Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest, ::Hash]
691
+ # A request object representing the call parameters. Required. To specify no
692
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
693
+ # @param options [::Gapic::CallOptions, ::Hash]
694
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
695
+ #
696
+ # @overload query_team_folder_contents(team_folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
697
+ # Pass arguments to `query_team_folder_contents` via keyword arguments. Note that at
698
+ # least one keyword argument is required. To specify no parameters, or to keep all
699
+ # the default parameter values, pass an empty Hash as a request object (see above).
700
+ #
701
+ # @param team_folder [::String]
702
+ # Required. Name of the team_folder whose contents to list.
703
+ # Format: `projects/*/locations/*/teamFolders/*`.
704
+ # @param page_size [::Integer]
705
+ # Optional. Maximum number of paths to return. The server may return fewer
706
+ # items than requested. If unspecified, the server will pick an appropriate
707
+ # default.
708
+ # @param page_token [::String]
709
+ # Optional. Page token received from a previous `QueryTeamFolderContents`
710
+ # call. Provide this to retrieve the subsequent page.
711
+ #
712
+ # When paginating, all other parameters provided to
713
+ # `QueryTeamFolderContents`, with the exception of `page_size`, must match
714
+ # the call that provided the page token.
715
+ # @param order_by [::String]
716
+ # Optional. Field to additionally sort results by.
717
+ # Will order Folders before Repositories, and then by `order_by` in ascending
718
+ # order. Supported keywords: `display_name` (default), `create_time`,
719
+ # last_modified_time.
720
+ # Examples:
721
+ # - `orderBy="display_name"`
722
+ # - `orderBy="display_name desc"`
723
+ # @param filter [::String]
724
+ # Optional. Optional filtering for the returned list. Filtering is currently
725
+ # only supported on the `display_name` field.
726
+ #
727
+ # Example:
728
+ # - `filter="display_name="MyFolder""`
729
+ #
730
+ # @yield [response, operation] Access the result along with the RPC operation
731
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>]
732
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
733
+ #
734
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>]
735
+ #
736
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
737
+ #
738
+ # @example Basic example
739
+ # require "google/cloud/dataform/v1"
740
+ #
741
+ # # Create a client object. The client can be reused for multiple calls.
742
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
743
+ #
744
+ # # Create a request. To set request fields, pass in keyword arguments.
745
+ # request = Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest.new
746
+ #
747
+ # # Call the query_team_folder_contents method.
748
+ # result = client.query_team_folder_contents request
749
+ #
750
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
751
+ # # over elements, and API calls will be issued to fetch pages as needed.
752
+ # result.each do |item|
753
+ # # Each element is of type ::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry.
754
+ # p item
755
+ # end
756
+ #
757
+ def query_team_folder_contents request, options = nil
758
+ raise ::ArgumentError, "request must be provided" if request.nil?
759
+
760
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest
761
+
762
+ # Converts hash and nil to an options object
763
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
764
+
765
+ # Customize the options with defaults
766
+ metadata = @config.rpcs.query_team_folder_contents.metadata.to_h
767
+
768
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
769
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
770
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
771
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
772
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
773
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
774
+
775
+ header_params = {}
776
+ if request.team_folder
777
+ header_params["team_folder"] = request.team_folder
778
+ end
779
+
780
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
781
+ metadata[:"x-goog-request-params"] ||= request_params_header
782
+
783
+ options.apply_defaults timeout: @config.rpcs.query_team_folder_contents.timeout,
784
+ metadata: metadata,
785
+ retry_policy: @config.rpcs.query_team_folder_contents.retry_policy
786
+
787
+ options.apply_defaults timeout: @config.timeout,
788
+ metadata: @config.metadata,
789
+ retry_policy: @config.retry_policy
790
+
791
+ @dataform_stub.call_rpc :query_team_folder_contents, request, options: options do |response, operation|
792
+ response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_team_folder_contents, request, response, operation, options
793
+ yield response, operation if block_given?
794
+ throw :response, response
795
+ end
796
+ rescue ::GRPC::BadStatus => e
797
+ raise ::Google::Cloud::Error.from_error(e)
798
+ end
799
+
800
+ ##
801
+ # Returns all TeamFolders in a given location that the caller has access to
802
+ # and match the provided filter.
803
+ #
804
+ # @overload search_team_folders(request, options = nil)
805
+ # Pass arguments to `search_team_folders` via a request object, either of type
806
+ # {::Google::Cloud::Dataform::V1::SearchTeamFoldersRequest} or an equivalent Hash.
807
+ #
808
+ # @param request [::Google::Cloud::Dataform::V1::SearchTeamFoldersRequest, ::Hash]
809
+ # A request object representing the call parameters. Required. To specify no
810
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
811
+ # @param options [::Gapic::CallOptions, ::Hash]
812
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
813
+ #
814
+ # @overload search_team_folders(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
815
+ # Pass arguments to `search_team_folders` via keyword arguments. Note that at
816
+ # least one keyword argument is required. To specify no parameters, or to keep all
817
+ # the default parameter values, pass an empty Hash as a request object (see above).
818
+ #
819
+ # @param location [::String]
820
+ # Required. Location in which to query TeamFolders.
821
+ # Format: `projects/*/locations/*`.
822
+ # @param page_size [::Integer]
823
+ # Optional. Maximum number of TeamFolders to return. The server may return
824
+ # fewer items than requested. If unspecified, the server will pick an
825
+ # appropriate default.
826
+ # @param page_token [::String]
827
+ # Optional. Page token received from a previous `SearchTeamFolders` call.
828
+ # Provide this to retrieve the subsequent page.
829
+ #
830
+ # When paginating, all other parameters provided to
831
+ # `SearchTeamFolders`, with the exception of `page_size`, must
832
+ # match the call that provided the page token.
833
+ # @param order_by [::String]
834
+ # Optional. Field to additionally sort results by.
835
+ # Supported keywords: `display_name` (default), `create_time`,
836
+ # `last_modified_time`. Examples:
837
+ # - `orderBy="display_name"`
838
+ # - `orderBy="display_name desc"`
839
+ # @param filter [::String]
840
+ # Optional. Optional filtering for the returned list. Filtering is currently
841
+ # only supported on the `display_name` field.
842
+ #
843
+ # Example:
844
+ # - `filter="display_name="MyFolder""`
845
+ #
846
+ # @yield [response, operation] Access the result along with the RPC operation
847
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>]
848
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
849
+ #
850
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>]
851
+ #
852
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
853
+ #
854
+ # @example Basic example
855
+ # require "google/cloud/dataform/v1"
856
+ #
857
+ # # Create a client object. The client can be reused for multiple calls.
858
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
859
+ #
860
+ # # Create a request. To set request fields, pass in keyword arguments.
861
+ # request = Google::Cloud::Dataform::V1::SearchTeamFoldersRequest.new
862
+ #
863
+ # # Call the search_team_folders method.
864
+ # result = client.search_team_folders request
865
+ #
866
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
867
+ # # over elements, and API calls will be issued to fetch pages as needed.
868
+ # result.each do |item|
869
+ # # Each element is of type ::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult.
870
+ # p item
871
+ # end
872
+ #
873
+ def search_team_folders request, options = nil
874
+ raise ::ArgumentError, "request must be provided" if request.nil?
875
+
876
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::SearchTeamFoldersRequest
877
+
878
+ # Converts hash and nil to an options object
879
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
880
+
881
+ # Customize the options with defaults
882
+ metadata = @config.rpcs.search_team_folders.metadata.to_h
883
+
884
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
885
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
886
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
887
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
888
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
889
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
890
+
891
+ header_params = {}
892
+ if request.location
893
+ header_params["location"] = request.location
894
+ end
895
+
896
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
897
+ metadata[:"x-goog-request-params"] ||= request_params_header
898
+
899
+ options.apply_defaults timeout: @config.rpcs.search_team_folders.timeout,
900
+ metadata: metadata,
901
+ retry_policy: @config.rpcs.search_team_folders.retry_policy
902
+
903
+ options.apply_defaults timeout: @config.timeout,
904
+ metadata: @config.metadata,
905
+ retry_policy: @config.retry_policy
906
+
907
+ @dataform_stub.call_rpc :search_team_folders, request, options: options do |response, operation|
908
+ response = ::Gapic::PagedEnumerable.new @dataform_stub, :search_team_folders, request, response, operation, options
909
+ yield response, operation if block_given?
910
+ throw :response, response
911
+ end
912
+ rescue ::GRPC::BadStatus => e
913
+ raise ::Google::Cloud::Error.from_error(e)
914
+ end
915
+
916
+ ##
917
+ # Fetches a single Folder.
918
+ #
919
+ # @overload get_folder(request, options = nil)
920
+ # Pass arguments to `get_folder` via a request object, either of type
921
+ # {::Google::Cloud::Dataform::V1::GetFolderRequest} or an equivalent Hash.
922
+ #
923
+ # @param request [::Google::Cloud::Dataform::V1::GetFolderRequest, ::Hash]
924
+ # A request object representing the call parameters. Required. To specify no
925
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
926
+ # @param options [::Gapic::CallOptions, ::Hash]
927
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
928
+ #
929
+ # @overload get_folder(name: nil)
930
+ # Pass arguments to `get_folder` via keyword arguments. Note that at
931
+ # least one keyword argument is required. To specify no parameters, or to keep all
932
+ # the default parameter values, pass an empty Hash as a request object (see above).
933
+ #
934
+ # @param name [::String]
935
+ # Required. The Folder's name.
936
+ #
937
+ # @yield [response, operation] Access the result along with the RPC operation
938
+ # @yieldparam response [::Google::Cloud::Dataform::V1::Folder]
939
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
940
+ #
941
+ # @return [::Google::Cloud::Dataform::V1::Folder]
942
+ #
943
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
944
+ #
945
+ # @example Basic example
946
+ # require "google/cloud/dataform/v1"
947
+ #
948
+ # # Create a client object. The client can be reused for multiple calls.
949
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
950
+ #
951
+ # # Create a request. To set request fields, pass in keyword arguments.
952
+ # request = Google::Cloud::Dataform::V1::GetFolderRequest.new
953
+ #
954
+ # # Call the get_folder method.
955
+ # result = client.get_folder request
956
+ #
957
+ # # The returned object is of type Google::Cloud::Dataform::V1::Folder.
958
+ # p result
959
+ #
960
+ def get_folder request, options = nil
961
+ raise ::ArgumentError, "request must be provided" if request.nil?
962
+
963
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::GetFolderRequest
964
+
965
+ # Converts hash and nil to an options object
966
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
967
+
968
+ # Customize the options with defaults
969
+ metadata = @config.rpcs.get_folder.metadata.to_h
970
+
971
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
972
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
973
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
974
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
975
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
976
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
977
+
978
+ header_params = {}
979
+ if request.name
980
+ header_params["name"] = request.name
981
+ end
982
+
983
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
984
+ metadata[:"x-goog-request-params"] ||= request_params_header
985
+
986
+ options.apply_defaults timeout: @config.rpcs.get_folder.timeout,
987
+ metadata: metadata,
988
+ retry_policy: @config.rpcs.get_folder.retry_policy
989
+
990
+ options.apply_defaults timeout: @config.timeout,
991
+ metadata: @config.metadata,
992
+ retry_policy: @config.retry_policy
993
+
994
+ @dataform_stub.call_rpc :get_folder, request, options: options do |response, operation|
995
+ yield response, operation if block_given?
996
+ end
997
+ rescue ::GRPC::BadStatus => e
998
+ raise ::Google::Cloud::Error.from_error(e)
999
+ end
1000
+
1001
+ ##
1002
+ # Creates a new Folder in a given project and location.
1003
+ #
1004
+ # @overload create_folder(request, options = nil)
1005
+ # Pass arguments to `create_folder` via a request object, either of type
1006
+ # {::Google::Cloud::Dataform::V1::CreateFolderRequest} or an equivalent Hash.
1007
+ #
1008
+ # @param request [::Google::Cloud::Dataform::V1::CreateFolderRequest, ::Hash]
1009
+ # A request object representing the call parameters. Required. To specify no
1010
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1011
+ # @param options [::Gapic::CallOptions, ::Hash]
1012
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1013
+ #
1014
+ # @overload create_folder(parent: nil, folder: nil)
1015
+ # Pass arguments to `create_folder` via keyword arguments. Note that at
1016
+ # least one keyword argument is required. To specify no parameters, or to keep all
1017
+ # the default parameter values, pass an empty Hash as a request object (see above).
1018
+ #
1019
+ # @param parent [::String]
1020
+ # Required. The location in which to create the Folder. Must be in the format
1021
+ # `projects/*/locations/*`.
1022
+ # @param folder [::Google::Cloud::Dataform::V1::Folder, ::Hash]
1023
+ # Required. The Folder to create.
1024
+ #
1025
+ # @yield [response, operation] Access the result along with the RPC operation
1026
+ # @yieldparam response [::Google::Cloud::Dataform::V1::Folder]
1027
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1028
+ #
1029
+ # @return [::Google::Cloud::Dataform::V1::Folder]
1030
+ #
1031
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1032
+ #
1033
+ # @example Basic example
1034
+ # require "google/cloud/dataform/v1"
1035
+ #
1036
+ # # Create a client object. The client can be reused for multiple calls.
1037
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1038
+ #
1039
+ # # Create a request. To set request fields, pass in keyword arguments.
1040
+ # request = Google::Cloud::Dataform::V1::CreateFolderRequest.new
1041
+ #
1042
+ # # Call the create_folder method.
1043
+ # result = client.create_folder request
1044
+ #
1045
+ # # The returned object is of type Google::Cloud::Dataform::V1::Folder.
1046
+ # p result
1047
+ #
1048
+ def create_folder request, options = nil
1049
+ raise ::ArgumentError, "request must be provided" if request.nil?
1050
+
1051
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::CreateFolderRequest
1052
+
1053
+ # Converts hash and nil to an options object
1054
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1055
+
1056
+ # Customize the options with defaults
1057
+ metadata = @config.rpcs.create_folder.metadata.to_h
1058
+
1059
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1060
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1061
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1062
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1063
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1064
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1065
+
1066
+ header_params = {}
1067
+ if request.parent
1068
+ header_params["parent"] = request.parent
1069
+ end
1070
+
1071
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1072
+ metadata[:"x-goog-request-params"] ||= request_params_header
1073
+
1074
+ options.apply_defaults timeout: @config.rpcs.create_folder.timeout,
1075
+ metadata: metadata,
1076
+ retry_policy: @config.rpcs.create_folder.retry_policy
1077
+
1078
+ options.apply_defaults timeout: @config.timeout,
1079
+ metadata: @config.metadata,
1080
+ retry_policy: @config.retry_policy
1081
+
1082
+ @dataform_stub.call_rpc :create_folder, request, options: options do |response, operation|
1083
+ yield response, operation if block_given?
1084
+ end
1085
+ rescue ::GRPC::BadStatus => e
1086
+ raise ::Google::Cloud::Error.from_error(e)
1087
+ end
1088
+
1089
+ ##
1090
+ # Updates a single Folder.
1091
+ #
1092
+ # @overload update_folder(request, options = nil)
1093
+ # Pass arguments to `update_folder` via a request object, either of type
1094
+ # {::Google::Cloud::Dataform::V1::UpdateFolderRequest} or an equivalent Hash.
1095
+ #
1096
+ # @param request [::Google::Cloud::Dataform::V1::UpdateFolderRequest, ::Hash]
1097
+ # A request object representing the call parameters. Required. To specify no
1098
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1099
+ # @param options [::Gapic::CallOptions, ::Hash]
1100
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1101
+ #
1102
+ # @overload update_folder(update_mask: nil, folder: nil)
1103
+ # Pass arguments to `update_folder` via keyword arguments. Note that at
1104
+ # least one keyword argument is required. To specify no parameters, or to keep all
1105
+ # the default parameter values, pass an empty Hash as a request object (see above).
1106
+ #
1107
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1108
+ # Optional. Specifies the fields to be updated in the Folder. If left unset,
1109
+ # all fields that can be updated, will be updated. A few fields cannot be
1110
+ # updated and will be ignored if specified in the update_mask (e.g.
1111
+ # parent_name, team_folder_name).
1112
+ # @param folder [::Google::Cloud::Dataform::V1::Folder, ::Hash]
1113
+ # Required. The updated Folder.
1114
+ #
1115
+ # @yield [response, operation] Access the result along with the RPC operation
1116
+ # @yieldparam response [::Google::Cloud::Dataform::V1::Folder]
1117
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1118
+ #
1119
+ # @return [::Google::Cloud::Dataform::V1::Folder]
1120
+ #
1121
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1122
+ #
1123
+ # @example Basic example
1124
+ # require "google/cloud/dataform/v1"
1125
+ #
1126
+ # # Create a client object. The client can be reused for multiple calls.
1127
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1128
+ #
1129
+ # # Create a request. To set request fields, pass in keyword arguments.
1130
+ # request = Google::Cloud::Dataform::V1::UpdateFolderRequest.new
1131
+ #
1132
+ # # Call the update_folder method.
1133
+ # result = client.update_folder request
1134
+ #
1135
+ # # The returned object is of type Google::Cloud::Dataform::V1::Folder.
1136
+ # p result
1137
+ #
1138
+ def update_folder request, options = nil
1139
+ raise ::ArgumentError, "request must be provided" if request.nil?
1140
+
1141
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::UpdateFolderRequest
1142
+
1143
+ # Converts hash and nil to an options object
1144
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1145
+
1146
+ # Customize the options with defaults
1147
+ metadata = @config.rpcs.update_folder.metadata.to_h
1148
+
1149
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1150
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1151
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1152
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1153
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1154
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1155
+
1156
+ header_params = {}
1157
+ if request.folder&.name
1158
+ header_params["folder.name"] = request.folder.name
1159
+ end
1160
+
1161
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1162
+ metadata[:"x-goog-request-params"] ||= request_params_header
1163
+
1164
+ options.apply_defaults timeout: @config.rpcs.update_folder.timeout,
1165
+ metadata: metadata,
1166
+ retry_policy: @config.rpcs.update_folder.retry_policy
1167
+
1168
+ options.apply_defaults timeout: @config.timeout,
1169
+ metadata: @config.metadata,
1170
+ retry_policy: @config.retry_policy
1171
+
1172
+ @dataform_stub.call_rpc :update_folder, request, options: options do |response, operation|
1173
+ yield response, operation if block_given?
1174
+ end
1175
+ rescue ::GRPC::BadStatus => e
1176
+ raise ::Google::Cloud::Error.from_error(e)
1177
+ end
1178
+
1179
+ ##
1180
+ # Deletes a single Folder.
1181
+ #
1182
+ # @overload delete_folder(request, options = nil)
1183
+ # Pass arguments to `delete_folder` via a request object, either of type
1184
+ # {::Google::Cloud::Dataform::V1::DeleteFolderRequest} or an equivalent Hash.
1185
+ #
1186
+ # @param request [::Google::Cloud::Dataform::V1::DeleteFolderRequest, ::Hash]
1187
+ # A request object representing the call parameters. Required. To specify no
1188
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1189
+ # @param options [::Gapic::CallOptions, ::Hash]
1190
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1191
+ #
1192
+ # @overload delete_folder(name: nil)
1193
+ # Pass arguments to `delete_folder` via keyword arguments. Note that at
1194
+ # least one keyword argument is required. To specify no parameters, or to keep all
1195
+ # the default parameter values, pass an empty Hash as a request object (see above).
1196
+ #
1197
+ # @param name [::String]
1198
+ # Required. The Folder's name.
1199
+ #
1200
+ # @yield [response, operation] Access the result along with the RPC operation
1201
+ # @yieldparam response [::Google::Protobuf::Empty]
1202
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1203
+ #
1204
+ # @return [::Google::Protobuf::Empty]
1205
+ #
1206
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1207
+ #
1208
+ # @example Basic example
1209
+ # require "google/cloud/dataform/v1"
1210
+ #
1211
+ # # Create a client object. The client can be reused for multiple calls.
1212
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1213
+ #
1214
+ # # Create a request. To set request fields, pass in keyword arguments.
1215
+ # request = Google::Cloud::Dataform::V1::DeleteFolderRequest.new
1216
+ #
1217
+ # # Call the delete_folder method.
1218
+ # result = client.delete_folder request
1219
+ #
1220
+ # # The returned object is of type Google::Protobuf::Empty.
1221
+ # p result
1222
+ #
1223
+ def delete_folder request, options = nil
1224
+ raise ::ArgumentError, "request must be provided" if request.nil?
1225
+
1226
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteFolderRequest
1227
+
1228
+ # Converts hash and nil to an options object
1229
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1230
+
1231
+ # Customize the options with defaults
1232
+ metadata = @config.rpcs.delete_folder.metadata.to_h
1233
+
1234
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1235
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1236
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1237
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1238
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1239
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1240
+
1241
+ header_params = {}
1242
+ if request.name
1243
+ header_params["name"] = request.name
1244
+ end
1245
+
1246
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1247
+ metadata[:"x-goog-request-params"] ||= request_params_header
1248
+
1249
+ options.apply_defaults timeout: @config.rpcs.delete_folder.timeout,
1250
+ metadata: metadata,
1251
+ retry_policy: @config.rpcs.delete_folder.retry_policy
1252
+
1253
+ options.apply_defaults timeout: @config.timeout,
1254
+ metadata: @config.metadata,
1255
+ retry_policy: @config.retry_policy
1256
+
1257
+ @dataform_stub.call_rpc :delete_folder, request, options: options do |response, operation|
1258
+ yield response, operation if block_given?
1259
+ end
1260
+ rescue ::GRPC::BadStatus => e
1261
+ raise ::Google::Cloud::Error.from_error(e)
1262
+ end
1263
+
1264
+ ##
1265
+ # Deletes a Folder with its contents (Folders, Repositories, Workspaces,
1266
+ # ReleaseConfigs, and WorkflowConfigs).
1267
+ #
1268
+ # @overload delete_folder_tree(request, options = nil)
1269
+ # Pass arguments to `delete_folder_tree` via a request object, either of type
1270
+ # {::Google::Cloud::Dataform::V1::DeleteFolderTreeRequest} or an equivalent Hash.
1271
+ #
1272
+ # @param request [::Google::Cloud::Dataform::V1::DeleteFolderTreeRequest, ::Hash]
1273
+ # A request object representing the call parameters. Required. To specify no
1274
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1275
+ # @param options [::Gapic::CallOptions, ::Hash]
1276
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1277
+ #
1278
+ # @overload delete_folder_tree(name: nil, force: nil)
1279
+ # Pass arguments to `delete_folder_tree` via keyword arguments. Note that at
1280
+ # least one keyword argument is required. To specify no parameters, or to keep all
1281
+ # the default parameter values, pass an empty Hash as a request object (see above).
1282
+ #
1283
+ # @param name [::String]
1284
+ # Required. The Folder's name.
1285
+ # Format: projects/\\{project}/locations/\\{location}/folders/\\{folder}
1286
+ # @param force [::Boolean]
1287
+ # Optional. If `false` (default): The operation will fail if any
1288
+ # Repository within the folder hierarchy has associated Release Configs or
1289
+ # Workflow Configs.
1290
+ #
1291
+ # If `true`: The operation will attempt to delete everything, including any
1292
+ # Release Configs and Workflow Configs linked to Repositories within the
1293
+ # folder hierarchy. This permanently removes schedules and resources.
1294
+ #
1295
+ # @yield [response, operation] Access the result along with the RPC operation
1296
+ # @yieldparam response [::Gapic::Operation]
1297
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1298
+ #
1299
+ # @return [::Gapic::Operation]
1300
+ #
1301
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1302
+ #
1303
+ # @example Basic example
1304
+ # require "google/cloud/dataform/v1"
1305
+ #
1306
+ # # Create a client object. The client can be reused for multiple calls.
1307
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1308
+ #
1309
+ # # Create a request. To set request fields, pass in keyword arguments.
1310
+ # request = Google::Cloud::Dataform::V1::DeleteFolderTreeRequest.new
1311
+ #
1312
+ # # Call the delete_folder_tree method.
1313
+ # result = client.delete_folder_tree request
1314
+ #
1315
+ # # The returned object is of type Gapic::Operation. You can use it to
1316
+ # # check the status of an operation, cancel it, or wait for results.
1317
+ # # Here is how to wait for a response.
1318
+ # result.wait_until_done! timeout: 60
1319
+ # if result.response?
1320
+ # p result.response
1321
+ # else
1322
+ # puts "No response received."
1323
+ # end
1324
+ #
1325
+ def delete_folder_tree request, options = nil
1326
+ raise ::ArgumentError, "request must be provided" if request.nil?
1327
+
1328
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteFolderTreeRequest
1329
+
1330
+ # Converts hash and nil to an options object
1331
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1332
+
1333
+ # Customize the options with defaults
1334
+ metadata = @config.rpcs.delete_folder_tree.metadata.to_h
1335
+
1336
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1337
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1338
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1339
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1340
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1341
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1342
+
1343
+ header_params = {}
1344
+ if request.name
1345
+ header_params["name"] = request.name
1346
+ end
1347
+
1348
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1349
+ metadata[:"x-goog-request-params"] ||= request_params_header
1350
+
1351
+ options.apply_defaults timeout: @config.rpcs.delete_folder_tree.timeout,
1352
+ metadata: metadata,
1353
+ retry_policy: @config.rpcs.delete_folder_tree.retry_policy
1354
+
1355
+ options.apply_defaults timeout: @config.timeout,
1356
+ metadata: @config.metadata,
1357
+ retry_policy: @config.retry_policy
1358
+
1359
+ @dataform_stub.call_rpc :delete_folder_tree, request, options: options do |response, operation|
1360
+ response = ::Gapic::Operation.new response, @operations_client, options: options
1361
+ yield response, operation if block_given?
1362
+ throw :response, response
1363
+ end
1364
+ rescue ::GRPC::BadStatus => e
1365
+ raise ::Google::Cloud::Error.from_error(e)
1366
+ end
1367
+
1368
+ ##
1369
+ # Returns the contents of a given Folder.
1370
+ #
1371
+ # @overload query_folder_contents(request, options = nil)
1372
+ # Pass arguments to `query_folder_contents` via a request object, either of type
1373
+ # {::Google::Cloud::Dataform::V1::QueryFolderContentsRequest} or an equivalent Hash.
1374
+ #
1375
+ # @param request [::Google::Cloud::Dataform::V1::QueryFolderContentsRequest, ::Hash]
1376
+ # A request object representing the call parameters. Required. To specify no
1377
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1378
+ # @param options [::Gapic::CallOptions, ::Hash]
1379
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1380
+ #
1381
+ # @overload query_folder_contents(folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
1382
+ # Pass arguments to `query_folder_contents` via keyword arguments. Note that at
1383
+ # least one keyword argument is required. To specify no parameters, or to keep all
1384
+ # the default parameter values, pass an empty Hash as a request object (see above).
1385
+ #
1386
+ # @param folder [::String]
1387
+ # Required. Name of the folder whose contents to list.
1388
+ # Format: projects/*/locations/*/folders/*
1389
+ # @param page_size [::Integer]
1390
+ # Optional. Maximum number of paths to return. The server may return fewer
1391
+ # items than requested. If unspecified, the server will pick an appropriate
1392
+ # default.
1393
+ # @param page_token [::String]
1394
+ # Optional. Page token received from a previous `QueryFolderContents` call.
1395
+ # Provide this to retrieve the subsequent page.
1396
+ #
1397
+ # When paginating, all other parameters provided to
1398
+ # `QueryFolderContents`, with the exception of `page_size`, must match the
1399
+ # call that provided the page token.
1400
+ # @param order_by [::String]
1401
+ # Optional. Field to additionally sort results by.
1402
+ # Will order Folders before Repositories, and then by `order_by` in ascending
1403
+ # order. Supported keywords: display_name (default), create_time,
1404
+ # last_modified_time.
1405
+ # Examples:
1406
+ # - `orderBy="display_name"`
1407
+ # - `orderBy="display_name desc"`
1408
+ # @param filter [::String]
1409
+ # Optional. Optional filtering for the returned list. Filtering is currently
1410
+ # only supported on the `display_name` field.
1411
+ #
1412
+ # Example:
1413
+ # - `filter="display_name="MyFolder""`
1414
+ #
1415
+ # @yield [response, operation] Access the result along with the RPC operation
1416
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>]
1417
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1418
+ #
1419
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>]
1420
+ #
1421
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1422
+ #
1423
+ # @example Basic example
1424
+ # require "google/cloud/dataform/v1"
1425
+ #
1426
+ # # Create a client object. The client can be reused for multiple calls.
1427
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1428
+ #
1429
+ # # Create a request. To set request fields, pass in keyword arguments.
1430
+ # request = Google::Cloud::Dataform::V1::QueryFolderContentsRequest.new
1431
+ #
1432
+ # # Call the query_folder_contents method.
1433
+ # result = client.query_folder_contents request
1434
+ #
1435
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1436
+ # # over elements, and API calls will be issued to fetch pages as needed.
1437
+ # result.each do |item|
1438
+ # # Each element is of type ::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry.
1439
+ # p item
1440
+ # end
1441
+ #
1442
+ def query_folder_contents request, options = nil
1443
+ raise ::ArgumentError, "request must be provided" if request.nil?
1444
+
1445
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::QueryFolderContentsRequest
1446
+
1447
+ # Converts hash and nil to an options object
1448
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1449
+
1450
+ # Customize the options with defaults
1451
+ metadata = @config.rpcs.query_folder_contents.metadata.to_h
1452
+
1453
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1454
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1455
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1456
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1457
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1458
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
176
1459
 
177
- @location_client = Google::Cloud::Location::Locations::Client.new do |config|
178
- config.credentials = credentials
179
- config.quota_project = @quota_project_id
180
- config.endpoint = @dataform_stub.endpoint
181
- config.universe_domain = @dataform_stub.universe_domain
182
- config.logger = @dataform_stub.logger if config.respond_to? :logger=
1460
+ header_params = {}
1461
+ if request.folder
1462
+ header_params["folder"] = request.folder
183
1463
  end
184
1464
 
185
- @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
186
- config.credentials = credentials
187
- config.quota_project = @quota_project_id
188
- config.endpoint = @dataform_stub.endpoint
189
- config.universe_domain = @dataform_stub.universe_domain
190
- config.logger = @dataform_stub.logger if config.respond_to? :logger=
1465
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1466
+ metadata[:"x-goog-request-params"] ||= request_params_header
1467
+
1468
+ options.apply_defaults timeout: @config.rpcs.query_folder_contents.timeout,
1469
+ metadata: metadata,
1470
+ retry_policy: @config.rpcs.query_folder_contents.retry_policy
1471
+
1472
+ options.apply_defaults timeout: @config.timeout,
1473
+ metadata: @config.metadata,
1474
+ retry_policy: @config.retry_policy
1475
+
1476
+ @dataform_stub.call_rpc :query_folder_contents, request, options: options do |response, operation|
1477
+ response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_folder_contents, request, response, operation, options
1478
+ yield response, operation if block_given?
1479
+ throw :response, response
191
1480
  end
1481
+ rescue ::GRPC::BadStatus => e
1482
+ raise ::Google::Cloud::Error.from_error(e)
192
1483
  end
193
1484
 
194
1485
  ##
195
- # Get the associated client for mix-in of the Locations.
1486
+ # Returns the contents of a caller's root folder in a given location.
1487
+ # The root folder contains all resources that are created by the user and not
1488
+ # contained in any other folder.
196
1489
  #
197
- # @return [Google::Cloud::Location::Locations::Client]
1490
+ # @overload query_user_root_contents(request, options = nil)
1491
+ # Pass arguments to `query_user_root_contents` via a request object, either of type
1492
+ # {::Google::Cloud::Dataform::V1::QueryUserRootContentsRequest} or an equivalent Hash.
198
1493
  #
199
- attr_reader :location_client
200
-
201
- ##
202
- # Get the associated client for mix-in of the IAMPolicy.
1494
+ # @param request [::Google::Cloud::Dataform::V1::QueryUserRootContentsRequest, ::Hash]
1495
+ # A request object representing the call parameters. Required. To specify no
1496
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1497
+ # @param options [::Gapic::CallOptions, ::Hash]
1498
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
203
1499
  #
204
- # @return [Google::Iam::V1::IAMPolicy::Client]
1500
+ # @overload query_user_root_contents(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
1501
+ # Pass arguments to `query_user_root_contents` via keyword arguments. Note that at
1502
+ # least one keyword argument is required. To specify no parameters, or to keep all
1503
+ # the default parameter values, pass an empty Hash as a request object (see above).
205
1504
  #
206
- attr_reader :iam_policy_client
1505
+ # @param location [::String]
1506
+ # Required. Location of the user root folder whose contents to list.
1507
+ # Format: projects/*/locations/*
1508
+ # @param page_size [::Integer]
1509
+ # Optional. Maximum number of paths to return. The server may return fewer
1510
+ # items than requested. If unspecified, the server will pick an appropriate
1511
+ # default.
1512
+ # @param page_token [::String]
1513
+ # Optional. Page token received from a previous `QueryUserRootContents` call.
1514
+ # Provide this to retrieve the subsequent page.
1515
+ #
1516
+ # When paginating, all other parameters provided to
1517
+ # `QueryUserRootFolderContents`, with the exception of `page_size`, must
1518
+ # match the call that provided the page token.
1519
+ # @param order_by [::String]
1520
+ # Optional. Field to additionally sort results by.
1521
+ # Will order Folders before Repositories, and then by `order_by` in ascending
1522
+ # order. Supported keywords: display_name (default), created_at,
1523
+ # last_modified_at. Examples:
1524
+ # - `orderBy="display_name"`
1525
+ # - `orderBy="display_name desc"`
1526
+ # @param filter [::String]
1527
+ # Optional. Optional filtering for the returned list. Filtering is currently
1528
+ # only supported on the `display_name` field.
1529
+ #
1530
+ # Example:
1531
+ # - `filter="display_name="MyFolder""`
1532
+ #
1533
+ # @yield [response, operation] Access the result along with the RPC operation
1534
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>]
1535
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1536
+ #
1537
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>]
1538
+ #
1539
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1540
+ #
1541
+ # @example Basic example
1542
+ # require "google/cloud/dataform/v1"
1543
+ #
1544
+ # # Create a client object. The client can be reused for multiple calls.
1545
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1546
+ #
1547
+ # # Create a request. To set request fields, pass in keyword arguments.
1548
+ # request = Google::Cloud::Dataform::V1::QueryUserRootContentsRequest.new
1549
+ #
1550
+ # # Call the query_user_root_contents method.
1551
+ # result = client.query_user_root_contents request
1552
+ #
1553
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1554
+ # # over elements, and API calls will be issued to fetch pages as needed.
1555
+ # result.each do |item|
1556
+ # # Each element is of type ::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry.
1557
+ # p item
1558
+ # end
1559
+ #
1560
+ def query_user_root_contents request, options = nil
1561
+ raise ::ArgumentError, "request must be provided" if request.nil?
1562
+
1563
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::QueryUserRootContentsRequest
1564
+
1565
+ # Converts hash and nil to an options object
1566
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1567
+
1568
+ # Customize the options with defaults
1569
+ metadata = @config.rpcs.query_user_root_contents.metadata.to_h
1570
+
1571
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1572
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1573
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1574
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1575
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1576
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1577
+
1578
+ header_params = {}
1579
+ if request.location
1580
+ header_params["location"] = request.location
1581
+ end
1582
+
1583
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1584
+ metadata[:"x-goog-request-params"] ||= request_params_header
1585
+
1586
+ options.apply_defaults timeout: @config.rpcs.query_user_root_contents.timeout,
1587
+ metadata: metadata,
1588
+ retry_policy: @config.rpcs.query_user_root_contents.retry_policy
1589
+
1590
+ options.apply_defaults timeout: @config.timeout,
1591
+ metadata: @config.metadata,
1592
+ retry_policy: @config.retry_policy
1593
+
1594
+ @dataform_stub.call_rpc :query_user_root_contents, request, options: options do |response, operation|
1595
+ response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_user_root_contents, request, response, operation, options
1596
+ yield response, operation if block_given?
1597
+ throw :response, response
1598
+ end
1599
+ rescue ::GRPC::BadStatus => e
1600
+ raise ::Google::Cloud::Error.from_error(e)
1601
+ end
207
1602
 
208
1603
  ##
209
- # The logger used for request/response debug logging.
1604
+ # Moves a Folder to a new Folder, TeamFolder, or the root location.
210
1605
  #
211
- # @return [Logger]
1606
+ # @overload move_folder(request, options = nil)
1607
+ # Pass arguments to `move_folder` via a request object, either of type
1608
+ # {::Google::Cloud::Dataform::V1::MoveFolderRequest} or an equivalent Hash.
212
1609
  #
213
- def logger
214
- @dataform_stub.logger
215
- end
1610
+ # @param request [::Google::Cloud::Dataform::V1::MoveFolderRequest, ::Hash]
1611
+ # A request object representing the call parameters. Required. To specify no
1612
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1613
+ # @param options [::Gapic::CallOptions, ::Hash]
1614
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1615
+ #
1616
+ # @overload move_folder(name: nil, destination_containing_folder: nil)
1617
+ # Pass arguments to `move_folder` via keyword arguments. Note that at
1618
+ # least one keyword argument is required. To specify no parameters, or to keep all
1619
+ # the default parameter values, pass an empty Hash as a request object (see above).
1620
+ #
1621
+ # @param name [::String]
1622
+ # Required. The full resource name of the Folder to move.
1623
+ # @param destination_containing_folder [::String]
1624
+ # Optional. The name of the Folder, TeamFolder, or root location to move the
1625
+ # Folder to. Can be in the format of: "" to move into the root User folder,
1626
+ # `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*`
1627
+ #
1628
+ # @yield [response, operation] Access the result along with the RPC operation
1629
+ # @yieldparam response [::Gapic::Operation]
1630
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1631
+ #
1632
+ # @return [::Gapic::Operation]
1633
+ #
1634
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1635
+ #
1636
+ # @example Basic example
1637
+ # require "google/cloud/dataform/v1"
1638
+ #
1639
+ # # Create a client object. The client can be reused for multiple calls.
1640
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
1641
+ #
1642
+ # # Create a request. To set request fields, pass in keyword arguments.
1643
+ # request = Google::Cloud::Dataform::V1::MoveFolderRequest.new
1644
+ #
1645
+ # # Call the move_folder method.
1646
+ # result = client.move_folder request
1647
+ #
1648
+ # # The returned object is of type Gapic::Operation. You can use it to
1649
+ # # check the status of an operation, cancel it, or wait for results.
1650
+ # # Here is how to wait for a response.
1651
+ # result.wait_until_done! timeout: 60
1652
+ # if result.response?
1653
+ # p result.response
1654
+ # else
1655
+ # puts "No response received."
1656
+ # end
1657
+ #
1658
+ def move_folder request, options = nil
1659
+ raise ::ArgumentError, "request must be provided" if request.nil?
216
1660
 
217
- # Service calls
1661
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::MoveFolderRequest
1662
+
1663
+ # Converts hash and nil to an options object
1664
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1665
+
1666
+ # Customize the options with defaults
1667
+ metadata = @config.rpcs.move_folder.metadata.to_h
1668
+
1669
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1670
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1671
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1672
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
1673
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1674
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1675
+
1676
+ header_params = {}
1677
+ if request.name
1678
+ header_params["name"] = request.name
1679
+ end
1680
+
1681
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1682
+ metadata[:"x-goog-request-params"] ||= request_params_header
1683
+
1684
+ options.apply_defaults timeout: @config.rpcs.move_folder.timeout,
1685
+ metadata: metadata,
1686
+ retry_policy: @config.rpcs.move_folder.retry_policy
1687
+
1688
+ options.apply_defaults timeout: @config.timeout,
1689
+ metadata: @config.metadata,
1690
+ retry_policy: @config.retry_policy
1691
+
1692
+ @dataform_stub.call_rpc :move_folder, request, options: options do |response, operation|
1693
+ response = ::Gapic::Operation.new response, @operations_client, options: options
1694
+ yield response, operation if block_given?
1695
+ throw :response, response
1696
+ end
1697
+ rescue ::GRPC::BadStatus => e
1698
+ raise ::Google::Cloud::Error.from_error(e)
1699
+ end
218
1700
 
219
1701
  ##
220
1702
  # Lists Repositories in a given project and location.
@@ -618,9 +2100,13 @@ module Google
618
2100
  # @param name [::String]
619
2101
  # Required. The repository's name.
620
2102
  # @param force [::Boolean]
621
- # Optional. If set to true, any child resources of this repository will also
622
- # be deleted. (Otherwise, the request will only succeed if the repository has
623
- # no child resources.)
2103
+ # Optional. If set to true, child resources of this repository (compilation
2104
+ # results and workflow invocations) will also be deleted. Otherwise, the
2105
+ # request will only succeed if the repository has no child resources.
2106
+ #
2107
+ # **Note:** *This flag doesn't support deletion of workspaces, release
2108
+ # configs or workflow configs. If any of such resources exists in the
2109
+ # repository, the request will fail.*.
624
2110
  #
625
2111
  # @yield [response, operation] Access the result along with the RPC operation
626
2112
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -645,16 +2131,113 @@ module Google
645
2131
  # # The returned object is of type Google::Protobuf::Empty.
646
2132
  # p result
647
2133
  #
648
- def delete_repository request, options = nil
2134
+ def delete_repository request, options = nil
2135
+ raise ::ArgumentError, "request must be provided" if request.nil?
2136
+
2137
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteRepositoryRequest
2138
+
2139
+ # Converts hash and nil to an options object
2140
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2141
+
2142
+ # Customize the options with defaults
2143
+ metadata = @config.rpcs.delete_repository.metadata.to_h
2144
+
2145
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2146
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2147
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2148
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
2149
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2150
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2151
+
2152
+ header_params = {}
2153
+ if request.name
2154
+ header_params["name"] = request.name
2155
+ end
2156
+
2157
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2158
+ metadata[:"x-goog-request-params"] ||= request_params_header
2159
+
2160
+ options.apply_defaults timeout: @config.rpcs.delete_repository.timeout,
2161
+ metadata: metadata,
2162
+ retry_policy: @config.rpcs.delete_repository.retry_policy
2163
+
2164
+ options.apply_defaults timeout: @config.timeout,
2165
+ metadata: @config.metadata,
2166
+ retry_policy: @config.retry_policy
2167
+
2168
+ @dataform_stub.call_rpc :delete_repository, request, options: options do |response, operation|
2169
+ yield response, operation if block_given?
2170
+ end
2171
+ rescue ::GRPC::BadStatus => e
2172
+ raise ::Google::Cloud::Error.from_error(e)
2173
+ end
2174
+
2175
+ ##
2176
+ # Moves a Repository to a new location.
2177
+ #
2178
+ # @overload move_repository(request, options = nil)
2179
+ # Pass arguments to `move_repository` via a request object, either of type
2180
+ # {::Google::Cloud::Dataform::V1::MoveRepositoryRequest} or an equivalent Hash.
2181
+ #
2182
+ # @param request [::Google::Cloud::Dataform::V1::MoveRepositoryRequest, ::Hash]
2183
+ # A request object representing the call parameters. Required. To specify no
2184
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2185
+ # @param options [::Gapic::CallOptions, ::Hash]
2186
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2187
+ #
2188
+ # @overload move_repository(name: nil, destination_containing_folder: nil)
2189
+ # Pass arguments to `move_repository` via keyword arguments. Note that at
2190
+ # least one keyword argument is required. To specify no parameters, or to keep all
2191
+ # the default parameter values, pass an empty Hash as a request object (see above).
2192
+ #
2193
+ # @param name [::String]
2194
+ # Required. The full resource name of the repository to move.
2195
+ # @param destination_containing_folder [::String]
2196
+ # Optional. The name of the Folder, TeamFolder, or root location to move the
2197
+ # repository to. Can be in the format of: "" to move into the root User
2198
+ # folder, `projects/*/locations/*/folders/*`,
2199
+ # `projects/*/locations/*/teamFolders/*`
2200
+ #
2201
+ # @yield [response, operation] Access the result along with the RPC operation
2202
+ # @yieldparam response [::Gapic::Operation]
2203
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2204
+ #
2205
+ # @return [::Gapic::Operation]
2206
+ #
2207
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2208
+ #
2209
+ # @example Basic example
2210
+ # require "google/cloud/dataform/v1"
2211
+ #
2212
+ # # Create a client object. The client can be reused for multiple calls.
2213
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
2214
+ #
2215
+ # # Create a request. To set request fields, pass in keyword arguments.
2216
+ # request = Google::Cloud::Dataform::V1::MoveRepositoryRequest.new
2217
+ #
2218
+ # # Call the move_repository method.
2219
+ # result = client.move_repository request
2220
+ #
2221
+ # # The returned object is of type Gapic::Operation. You can use it to
2222
+ # # check the status of an operation, cancel it, or wait for results.
2223
+ # # Here is how to wait for a response.
2224
+ # result.wait_until_done! timeout: 60
2225
+ # if result.response?
2226
+ # p result.response
2227
+ # else
2228
+ # puts "No response received."
2229
+ # end
2230
+ #
2231
+ def move_repository request, options = nil
649
2232
  raise ::ArgumentError, "request must be provided" if request.nil?
650
2233
 
651
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteRepositoryRequest
2234
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::MoveRepositoryRequest
652
2235
 
653
2236
  # Converts hash and nil to an options object
654
2237
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
655
2238
 
656
2239
  # Customize the options with defaults
657
- metadata = @config.rpcs.delete_repository.metadata.to_h
2240
+ metadata = @config.rpcs.move_repository.metadata.to_h
658
2241
 
659
2242
  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
660
2243
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
@@ -671,16 +2254,18 @@ module Google
671
2254
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
672
2255
  metadata[:"x-goog-request-params"] ||= request_params_header
673
2256
 
674
- options.apply_defaults timeout: @config.rpcs.delete_repository.timeout,
2257
+ options.apply_defaults timeout: @config.rpcs.move_repository.timeout,
675
2258
  metadata: metadata,
676
- retry_policy: @config.rpcs.delete_repository.retry_policy
2259
+ retry_policy: @config.rpcs.move_repository.retry_policy
677
2260
 
678
2261
  options.apply_defaults timeout: @config.timeout,
679
2262
  metadata: @config.metadata,
680
2263
  retry_policy: @config.retry_policy
681
2264
 
682
- @dataform_stub.call_rpc :delete_repository, request, options: options do |response, operation|
2265
+ @dataform_stub.call_rpc :move_repository, request, options: options do |response, operation|
2266
+ response = ::Gapic::Operation.new response, @operations_client, options: options
683
2267
  yield response, operation if block_given?
2268
+ throw :response, response
684
2269
  end
685
2270
  rescue ::GRPC::BadStatus => e
686
2271
  raise ::Google::Cloud::Error.from_error(e)
@@ -2347,7 +3932,7 @@ module Google
2347
3932
  # @param options [::Gapic::CallOptions, ::Hash]
2348
3933
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2349
3934
  #
2350
- # @overload query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil)
3935
+ # @overload query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil, view: nil)
2351
3936
  # Pass arguments to `query_directory_contents` via keyword arguments. Note that at
2352
3937
  # least one keyword argument is required. To specify no parameters, or to keep all
2353
3938
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2368,6 +3953,11 @@ module Google
2368
3953
  # When paginating, all other parameters provided to
2369
3954
  # `QueryDirectoryContents`, with the exception of `page_size`, must match the
2370
3955
  # call that provided the page token.
3956
+ # @param view [::Google::Cloud::Dataform::V1::DirectoryContentsView]
3957
+ # Optional. Specifies the metadata to return for each directory entry.
3958
+ # If unspecified, the default is `DIRECTORY_CONTENTS_VIEW_BASIC`.
3959
+ # Currently the `DIRECTORY_CONTENTS_VIEW_METADATA` view is not supported by
3960
+ # CMEK-protected workspaces.
2371
3961
  #
2372
3962
  # @yield [response, operation] Access the result along with the RPC operation
2373
3963
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>]
@@ -5206,6 +6796,294 @@ module Google
5206
6796
  raise ::Google::Cloud::Error.from_error(e)
5207
6797
  end
5208
6798
 
6799
+ ##
6800
+ # Gets the access control policy for a resource.
6801
+ # Returns an empty policy if the resource exists and does not have a policy
6802
+ # set.
6803
+ #
6804
+ # @overload get_iam_policy(request, options = nil)
6805
+ # Pass arguments to `get_iam_policy` via a request object, either of type
6806
+ # {::Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
6807
+ #
6808
+ # @param request [::Google::Iam::V1::GetIamPolicyRequest, ::Hash]
6809
+ # A request object representing the call parameters. Required. To specify no
6810
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6811
+ # @param options [::Gapic::CallOptions, ::Hash]
6812
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6813
+ #
6814
+ # @overload get_iam_policy(resource: nil, options: nil)
6815
+ # Pass arguments to `get_iam_policy` via keyword arguments. Note that at
6816
+ # least one keyword argument is required. To specify no parameters, or to keep all
6817
+ # the default parameter values, pass an empty Hash as a request object (see above).
6818
+ #
6819
+ # @param resource [::String]
6820
+ # REQUIRED: The resource for which the policy is being requested.
6821
+ # See the operation documentation for the appropriate value for this field.
6822
+ # @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
6823
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
6824
+ # `GetIamPolicy`.
6825
+ #
6826
+ # @yield [response, operation] Access the result along with the RPC operation
6827
+ # @yieldparam response [::Google::Iam::V1::Policy]
6828
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6829
+ #
6830
+ # @return [::Google::Iam::V1::Policy]
6831
+ #
6832
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6833
+ #
6834
+ # @example Basic example
6835
+ # require "google/cloud/dataform/v1"
6836
+ #
6837
+ # # Create a client object. The client can be reused for multiple calls.
6838
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
6839
+ #
6840
+ # # Create a request. To set request fields, pass in keyword arguments.
6841
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
6842
+ #
6843
+ # # Call the get_iam_policy method.
6844
+ # result = client.get_iam_policy request
6845
+ #
6846
+ # # The returned object is of type Google::Iam::V1::Policy.
6847
+ # p result
6848
+ #
6849
+ def get_iam_policy request, options = nil
6850
+ raise ::ArgumentError, "request must be provided" if request.nil?
6851
+
6852
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest
6853
+
6854
+ # Converts hash and nil to an options object
6855
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6856
+
6857
+ # Customize the options with defaults
6858
+ metadata = @config.rpcs.get_iam_policy.metadata.to_h
6859
+
6860
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6861
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6862
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6863
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
6864
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6865
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6866
+
6867
+ header_params = {}
6868
+ if request.resource
6869
+ header_params["resource"] = request.resource
6870
+ end
6871
+
6872
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6873
+ metadata[:"x-goog-request-params"] ||= request_params_header
6874
+
6875
+ options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
6876
+ metadata: metadata,
6877
+ retry_policy: @config.rpcs.get_iam_policy.retry_policy
6878
+
6879
+ options.apply_defaults timeout: @config.timeout,
6880
+ metadata: @config.metadata,
6881
+ retry_policy: @config.retry_policy
6882
+
6883
+ @dataform_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
6884
+ yield response, operation if block_given?
6885
+ end
6886
+ rescue ::GRPC::BadStatus => e
6887
+ raise ::Google::Cloud::Error.from_error(e)
6888
+ end
6889
+
6890
+ ##
6891
+ # Sets the access control policy on the specified resource. Replaces any
6892
+ # existing policy.
6893
+ #
6894
+ # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
6895
+ #
6896
+ # @overload set_iam_policy(request, options = nil)
6897
+ # Pass arguments to `set_iam_policy` via a request object, either of type
6898
+ # {::Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
6899
+ #
6900
+ # @param request [::Google::Iam::V1::SetIamPolicyRequest, ::Hash]
6901
+ # A request object representing the call parameters. Required. To specify no
6902
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6903
+ # @param options [::Gapic::CallOptions, ::Hash]
6904
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6905
+ #
6906
+ # @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
6907
+ # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
6908
+ # least one keyword argument is required. To specify no parameters, or to keep all
6909
+ # the default parameter values, pass an empty Hash as a request object (see above).
6910
+ #
6911
+ # @param resource [::String]
6912
+ # REQUIRED: The resource for which the policy is being specified.
6913
+ # See the operation documentation for the appropriate value for this field.
6914
+ # @param policy [::Google::Iam::V1::Policy, ::Hash]
6915
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
6916
+ # the policy is limited to a few 10s of KB. An empty policy is a
6917
+ # valid policy but certain Cloud Platform services (such as Projects)
6918
+ # might reject them.
6919
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
6920
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
6921
+ # the fields in the mask will be modified. If no mask is provided, the
6922
+ # following default mask is used:
6923
+ #
6924
+ # `paths: "bindings, etag"`
6925
+ #
6926
+ # @yield [response, operation] Access the result along with the RPC operation
6927
+ # @yieldparam response [::Google::Iam::V1::Policy]
6928
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6929
+ #
6930
+ # @return [::Google::Iam::V1::Policy]
6931
+ #
6932
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6933
+ #
6934
+ # @example Basic example
6935
+ # require "google/cloud/dataform/v1"
6936
+ #
6937
+ # # Create a client object. The client can be reused for multiple calls.
6938
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
6939
+ #
6940
+ # # Create a request. To set request fields, pass in keyword arguments.
6941
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
6942
+ #
6943
+ # # Call the set_iam_policy method.
6944
+ # result = client.set_iam_policy request
6945
+ #
6946
+ # # The returned object is of type Google::Iam::V1::Policy.
6947
+ # p result
6948
+ #
6949
+ def set_iam_policy request, options = nil
6950
+ raise ::ArgumentError, "request must be provided" if request.nil?
6951
+
6952
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest
6953
+
6954
+ # Converts hash and nil to an options object
6955
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6956
+
6957
+ # Customize the options with defaults
6958
+ metadata = @config.rpcs.set_iam_policy.metadata.to_h
6959
+
6960
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6961
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6962
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6963
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
6964
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6965
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6966
+
6967
+ header_params = {}
6968
+ if request.resource
6969
+ header_params["resource"] = request.resource
6970
+ end
6971
+
6972
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6973
+ metadata[:"x-goog-request-params"] ||= request_params_header
6974
+
6975
+ options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
6976
+ metadata: metadata,
6977
+ retry_policy: @config.rpcs.set_iam_policy.retry_policy
6978
+
6979
+ options.apply_defaults timeout: @config.timeout,
6980
+ metadata: @config.metadata,
6981
+ retry_policy: @config.retry_policy
6982
+
6983
+ @dataform_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
6984
+ yield response, operation if block_given?
6985
+ end
6986
+ rescue ::GRPC::BadStatus => e
6987
+ raise ::Google::Cloud::Error.from_error(e)
6988
+ end
6989
+
6990
+ ##
6991
+ # Returns permissions that a caller has on the specified resource.
6992
+ # If the resource does not exist, this will return an empty set of
6993
+ # permissions, not a `NOT_FOUND` error.
6994
+ #
6995
+ # Note: This operation is designed to be used for building permission-aware
6996
+ # UIs and command-line tools, not for authorization checking. This operation
6997
+ # may "fail open" without warning.
6998
+ #
6999
+ # @overload test_iam_permissions(request, options = nil)
7000
+ # Pass arguments to `test_iam_permissions` via a request object, either of type
7001
+ # {::Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash.
7002
+ #
7003
+ # @param request [::Google::Iam::V1::TestIamPermissionsRequest, ::Hash]
7004
+ # A request object representing the call parameters. Required. To specify no
7005
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
7006
+ # @param options [::Gapic::CallOptions, ::Hash]
7007
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
7008
+ #
7009
+ # @overload test_iam_permissions(resource: nil, permissions: nil)
7010
+ # Pass arguments to `test_iam_permissions` via keyword arguments. Note that at
7011
+ # least one keyword argument is required. To specify no parameters, or to keep all
7012
+ # the default parameter values, pass an empty Hash as a request object (see above).
7013
+ #
7014
+ # @param resource [::String]
7015
+ # REQUIRED: The resource for which the policy detail is being requested.
7016
+ # See the operation documentation for the appropriate value for this field.
7017
+ # @param permissions [::Array<::String>]
7018
+ # The set of permissions to check for the `resource`. Permissions with
7019
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
7020
+ # information see
7021
+ # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
7022
+ #
7023
+ # @yield [response, operation] Access the result along with the RPC operation
7024
+ # @yieldparam response [::Google::Iam::V1::TestIamPermissionsResponse]
7025
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
7026
+ #
7027
+ # @return [::Google::Iam::V1::TestIamPermissionsResponse]
7028
+ #
7029
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
7030
+ #
7031
+ # @example Basic example
7032
+ # require "google/cloud/dataform/v1"
7033
+ #
7034
+ # # Create a client object. The client can be reused for multiple calls.
7035
+ # client = Google::Cloud::Dataform::V1::Dataform::Client.new
7036
+ #
7037
+ # # Create a request. To set request fields, pass in keyword arguments.
7038
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
7039
+ #
7040
+ # # Call the test_iam_permissions method.
7041
+ # result = client.test_iam_permissions request
7042
+ #
7043
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
7044
+ # p result
7045
+ #
7046
+ def test_iam_permissions request, options = nil
7047
+ raise ::ArgumentError, "request must be provided" if request.nil?
7048
+
7049
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest
7050
+
7051
+ # Converts hash and nil to an options object
7052
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
7053
+
7054
+ # Customize the options with defaults
7055
+ metadata = @config.rpcs.test_iam_permissions.metadata.to_h
7056
+
7057
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
7058
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
7059
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
7060
+ gapic_version: ::Google::Cloud::Dataform::V1::VERSION
7061
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
7062
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
7063
+
7064
+ header_params = {}
7065
+ if request.resource
7066
+ header_params["resource"] = request.resource
7067
+ end
7068
+
7069
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
7070
+ metadata[:"x-goog-request-params"] ||= request_params_header
7071
+
7072
+ options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
7073
+ metadata: metadata,
7074
+ retry_policy: @config.rpcs.test_iam_permissions.retry_policy
7075
+
7076
+ options.apply_defaults timeout: @config.timeout,
7077
+ metadata: @config.metadata,
7078
+ retry_policy: @config.retry_policy
7079
+
7080
+ @dataform_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
7081
+ yield response, operation if block_given?
7082
+ end
7083
+ rescue ::GRPC::BadStatus => e
7084
+ raise ::Google::Cloud::Error.from_error(e)
7085
+ end
7086
+
5209
7087
  ##
5210
7088
  # Configuration class for the Dataform API.
5211
7089
  #
@@ -5222,17 +7100,17 @@ module Google
5222
7100
  # @example
5223
7101
  #
5224
7102
  # # Modify the global config, setting the timeout for
5225
- # # list_repositories to 20 seconds,
7103
+ # # get_team_folder to 20 seconds,
5226
7104
  # # and all remaining timeouts to 10 seconds.
5227
7105
  # ::Google::Cloud::Dataform::V1::Dataform::Client.configure do |config|
5228
7106
  # config.timeout = 10.0
5229
- # config.rpcs.list_repositories.timeout = 20.0
7107
+ # config.rpcs.get_team_folder.timeout = 20.0
5230
7108
  # end
5231
7109
  #
5232
7110
  # # Apply the above configuration only to a new client.
5233
7111
  # client = ::Google::Cloud::Dataform::V1::Dataform::Client.new do |config|
5234
7112
  # config.timeout = 10.0
5235
- # config.rpcs.list_repositories.timeout = 20.0
7113
+ # config.rpcs.get_team_folder.timeout = 20.0
5236
7114
  # end
5237
7115
  #
5238
7116
  # @!attribute [rw] endpoint
@@ -5302,6 +7180,7 @@ module Google
5302
7180
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
5303
7181
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
5304
7182
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
7183
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
5305
7184
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
5306
7185
  # trigger a retry.
5307
7186
  # @return [::Hash]
@@ -5385,10 +7264,86 @@ module Google
5385
7264
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
5386
7265
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
5387
7266
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
7267
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
5388
7268
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
5389
7269
  # trigger a retry.
5390
7270
  #
5391
7271
  class Rpcs
7272
+ ##
7273
+ # RPC-specific configuration for `get_team_folder`
7274
+ # @return [::Gapic::Config::Method]
7275
+ #
7276
+ attr_reader :get_team_folder
7277
+ ##
7278
+ # RPC-specific configuration for `create_team_folder`
7279
+ # @return [::Gapic::Config::Method]
7280
+ #
7281
+ attr_reader :create_team_folder
7282
+ ##
7283
+ # RPC-specific configuration for `update_team_folder`
7284
+ # @return [::Gapic::Config::Method]
7285
+ #
7286
+ attr_reader :update_team_folder
7287
+ ##
7288
+ # RPC-specific configuration for `delete_team_folder`
7289
+ # @return [::Gapic::Config::Method]
7290
+ #
7291
+ attr_reader :delete_team_folder
7292
+ ##
7293
+ # RPC-specific configuration for `delete_team_folder_tree`
7294
+ # @return [::Gapic::Config::Method]
7295
+ #
7296
+ attr_reader :delete_team_folder_tree
7297
+ ##
7298
+ # RPC-specific configuration for `query_team_folder_contents`
7299
+ # @return [::Gapic::Config::Method]
7300
+ #
7301
+ attr_reader :query_team_folder_contents
7302
+ ##
7303
+ # RPC-specific configuration for `search_team_folders`
7304
+ # @return [::Gapic::Config::Method]
7305
+ #
7306
+ attr_reader :search_team_folders
7307
+ ##
7308
+ # RPC-specific configuration for `get_folder`
7309
+ # @return [::Gapic::Config::Method]
7310
+ #
7311
+ attr_reader :get_folder
7312
+ ##
7313
+ # RPC-specific configuration for `create_folder`
7314
+ # @return [::Gapic::Config::Method]
7315
+ #
7316
+ attr_reader :create_folder
7317
+ ##
7318
+ # RPC-specific configuration for `update_folder`
7319
+ # @return [::Gapic::Config::Method]
7320
+ #
7321
+ attr_reader :update_folder
7322
+ ##
7323
+ # RPC-specific configuration for `delete_folder`
7324
+ # @return [::Gapic::Config::Method]
7325
+ #
7326
+ attr_reader :delete_folder
7327
+ ##
7328
+ # RPC-specific configuration for `delete_folder_tree`
7329
+ # @return [::Gapic::Config::Method]
7330
+ #
7331
+ attr_reader :delete_folder_tree
7332
+ ##
7333
+ # RPC-specific configuration for `query_folder_contents`
7334
+ # @return [::Gapic::Config::Method]
7335
+ #
7336
+ attr_reader :query_folder_contents
7337
+ ##
7338
+ # RPC-specific configuration for `query_user_root_contents`
7339
+ # @return [::Gapic::Config::Method]
7340
+ #
7341
+ attr_reader :query_user_root_contents
7342
+ ##
7343
+ # RPC-specific configuration for `move_folder`
7344
+ # @return [::Gapic::Config::Method]
7345
+ #
7346
+ attr_reader :move_folder
5392
7347
  ##
5393
7348
  # RPC-specific configuration for `list_repositories`
5394
7349
  # @return [::Gapic::Config::Method]
@@ -5415,6 +7370,11 @@ module Google
5415
7370
  #
5416
7371
  attr_reader :delete_repository
5417
7372
  ##
7373
+ # RPC-specific configuration for `move_repository`
7374
+ # @return [::Gapic::Config::Method]
7375
+ #
7376
+ attr_reader :move_repository
7377
+ ##
5418
7378
  # RPC-specific configuration for `commit_repository_changes`
5419
7379
  # @return [::Gapic::Config::Method]
5420
7380
  #
@@ -5659,9 +7619,54 @@ module Google
5659
7619
  # @return [::Gapic::Config::Method]
5660
7620
  #
5661
7621
  attr_reader :update_config
7622
+ ##
7623
+ # RPC-specific configuration for `get_iam_policy`
7624
+ # @return [::Gapic::Config::Method]
7625
+ #
7626
+ attr_reader :get_iam_policy
7627
+ ##
7628
+ # RPC-specific configuration for `set_iam_policy`
7629
+ # @return [::Gapic::Config::Method]
7630
+ #
7631
+ attr_reader :set_iam_policy
7632
+ ##
7633
+ # RPC-specific configuration for `test_iam_permissions`
7634
+ # @return [::Gapic::Config::Method]
7635
+ #
7636
+ attr_reader :test_iam_permissions
5662
7637
 
5663
7638
  # @private
5664
7639
  def initialize parent_rpcs = nil
7640
+ get_team_folder_config = parent_rpcs.get_team_folder if parent_rpcs.respond_to? :get_team_folder
7641
+ @get_team_folder = ::Gapic::Config::Method.new get_team_folder_config
7642
+ create_team_folder_config = parent_rpcs.create_team_folder if parent_rpcs.respond_to? :create_team_folder
7643
+ @create_team_folder = ::Gapic::Config::Method.new create_team_folder_config
7644
+ update_team_folder_config = parent_rpcs.update_team_folder if parent_rpcs.respond_to? :update_team_folder
7645
+ @update_team_folder = ::Gapic::Config::Method.new update_team_folder_config
7646
+ delete_team_folder_config = parent_rpcs.delete_team_folder if parent_rpcs.respond_to? :delete_team_folder
7647
+ @delete_team_folder = ::Gapic::Config::Method.new delete_team_folder_config
7648
+ delete_team_folder_tree_config = parent_rpcs.delete_team_folder_tree if parent_rpcs.respond_to? :delete_team_folder_tree
7649
+ @delete_team_folder_tree = ::Gapic::Config::Method.new delete_team_folder_tree_config
7650
+ query_team_folder_contents_config = parent_rpcs.query_team_folder_contents if parent_rpcs.respond_to? :query_team_folder_contents
7651
+ @query_team_folder_contents = ::Gapic::Config::Method.new query_team_folder_contents_config
7652
+ search_team_folders_config = parent_rpcs.search_team_folders if parent_rpcs.respond_to? :search_team_folders
7653
+ @search_team_folders = ::Gapic::Config::Method.new search_team_folders_config
7654
+ get_folder_config = parent_rpcs.get_folder if parent_rpcs.respond_to? :get_folder
7655
+ @get_folder = ::Gapic::Config::Method.new get_folder_config
7656
+ create_folder_config = parent_rpcs.create_folder if parent_rpcs.respond_to? :create_folder
7657
+ @create_folder = ::Gapic::Config::Method.new create_folder_config
7658
+ update_folder_config = parent_rpcs.update_folder if parent_rpcs.respond_to? :update_folder
7659
+ @update_folder = ::Gapic::Config::Method.new update_folder_config
7660
+ delete_folder_config = parent_rpcs.delete_folder if parent_rpcs.respond_to? :delete_folder
7661
+ @delete_folder = ::Gapic::Config::Method.new delete_folder_config
7662
+ delete_folder_tree_config = parent_rpcs.delete_folder_tree if parent_rpcs.respond_to? :delete_folder_tree
7663
+ @delete_folder_tree = ::Gapic::Config::Method.new delete_folder_tree_config
7664
+ query_folder_contents_config = parent_rpcs.query_folder_contents if parent_rpcs.respond_to? :query_folder_contents
7665
+ @query_folder_contents = ::Gapic::Config::Method.new query_folder_contents_config
7666
+ query_user_root_contents_config = parent_rpcs.query_user_root_contents if parent_rpcs.respond_to? :query_user_root_contents
7667
+ @query_user_root_contents = ::Gapic::Config::Method.new query_user_root_contents_config
7668
+ move_folder_config = parent_rpcs.move_folder if parent_rpcs.respond_to? :move_folder
7669
+ @move_folder = ::Gapic::Config::Method.new move_folder_config
5665
7670
  list_repositories_config = parent_rpcs.list_repositories if parent_rpcs.respond_to? :list_repositories
5666
7671
  @list_repositories = ::Gapic::Config::Method.new list_repositories_config
5667
7672
  get_repository_config = parent_rpcs.get_repository if parent_rpcs.respond_to? :get_repository
@@ -5672,6 +7677,8 @@ module Google
5672
7677
  @update_repository = ::Gapic::Config::Method.new update_repository_config
5673
7678
  delete_repository_config = parent_rpcs.delete_repository if parent_rpcs.respond_to? :delete_repository
5674
7679
  @delete_repository = ::Gapic::Config::Method.new delete_repository_config
7680
+ move_repository_config = parent_rpcs.move_repository if parent_rpcs.respond_to? :move_repository
7681
+ @move_repository = ::Gapic::Config::Method.new move_repository_config
5675
7682
  commit_repository_changes_config = parent_rpcs.commit_repository_changes if parent_rpcs.respond_to? :commit_repository_changes
5676
7683
  @commit_repository_changes = ::Gapic::Config::Method.new commit_repository_changes_config
5677
7684
  read_repository_file_config = parent_rpcs.read_repository_file if parent_rpcs.respond_to? :read_repository_file
@@ -5770,6 +7777,12 @@ module Google
5770
7777
  @get_config = ::Gapic::Config::Method.new get_config_config
5771
7778
  update_config_config = parent_rpcs.update_config if parent_rpcs.respond_to? :update_config
5772
7779
  @update_config = ::Gapic::Config::Method.new update_config_config
7780
+ get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
7781
+ @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
7782
+ set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
7783
+ @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
7784
+ test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
7785
+ @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
5773
7786
 
5774
7787
  yield self if block_given?
5775
7788
  end