google-cloud-data_catalog-v1 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +702 -147
  3. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +341 -90
  4. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +98 -48
  5. data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
  6. data/lib/google/cloud/datacatalog/v1/bigquery_pb.rb +1 -1
  7. data/lib/google/cloud/datacatalog/v1/common_pb.rb +1 -0
  8. data/lib/google/cloud/datacatalog/v1/data_source_pb.rb +1 -1
  9. data/lib/google/cloud/datacatalog/v1/datacatalog_pb.rb +2 -2
  10. data/lib/google/cloud/datacatalog/v1/datacatalog_services_pb.rb +7 -3
  11. data/lib/google/cloud/datacatalog/v1/gcs_fileset_spec_pb.rb +2 -2
  12. data/lib/google/cloud/datacatalog/v1/policytagmanager_pb.rb +2 -2
  13. data/lib/google/cloud/datacatalog/v1/policytagmanager_services_pb.rb +1 -1
  14. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_pb.rb +2 -2
  15. data/lib/google/cloud/datacatalog/v1/policytagmanagerserialization_services_pb.rb +1 -1
  16. data/lib/google/cloud/datacatalog/v1/schema_pb.rb +1 -1
  17. data/lib/google/cloud/datacatalog/v1/search_pb.rb +4 -2
  18. data/lib/google/cloud/datacatalog/v1/table_spec_pb.rb +3 -2
  19. data/lib/google/cloud/datacatalog/v1/tags_pb.rb +2 -2
  20. data/lib/google/cloud/datacatalog/v1/timestamps_pb.rb +2 -2
  21. data/lib/google/cloud/datacatalog/v1/usage_pb.rb +1 -1
  22. data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +11 -4
  23. data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +2 -4
  24. data/proto_docs/google/cloud/datacatalog/v1/search.rb +7 -0
  25. data/proto_docs/google/cloud/datacatalog/v1/table_spec.rb +3 -0
  26. metadata +4 -4
@@ -42,13 +42,12 @@ module Google
42
42
  # See {::Google::Cloud::DataCatalog::V1::DataCatalog::Client::Configuration}
43
43
  # for a description of the configuration fields.
44
44
  #
45
- # ## Example
45
+ # @example
46
46
  #
47
- # To modify the configuration for all DataCatalog clients:
48
- #
49
- # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
50
- # config.timeout = 10.0
51
- # end
47
+ # # Modify the configuration for all DataCatalog clients
48
+ # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
49
+ # config.timeout = 10.0
50
+ # end
52
51
  #
53
52
  # @yield [config] Configure the Client client.
54
53
  # @yieldparam config [Client::Configuration]
@@ -137,19 +136,15 @@ module Google
137
136
  ##
138
137
  # Create a new DataCatalog client object.
139
138
  #
140
- # ## Examples
141
- #
142
- # To create a new DataCatalog client with the default
143
- # configuration:
139
+ # @example
144
140
  #
145
- # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
141
+ # # Create a client using the default configuration
142
+ # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
146
143
  #
147
- # To create a new DataCatalog client with a custom
148
- # configuration:
149
- #
150
- # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
151
- # config.timeout = 10.0
152
- # end
144
+ # # Create a client using a custom configuration
145
+ # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
146
+ # config.timeout = 10.0
147
+ # end
153
148
  #
154
149
  # @yield [config] Configure the DataCatalog client.
155
150
  # @yieldparam config [Client::Configuration]
@@ -169,10 +164,9 @@ module Google
169
164
 
170
165
  # Create credentials
171
166
  credentials = @config.credentials
172
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
167
+ # Use self-signed JWT if the endpoint is unchanged from default,
173
168
  # but only if the default endpoint does not have a region prefix.
174
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
175
- @config.endpoint == Client.configure.endpoint &&
169
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
176
170
  !@config.endpoint.split(".").first.include?("-")
177
171
  credentials ||= Credentials.default scope: @config.scope,
178
172
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -234,7 +228,8 @@ module Google
234
228
  # @param query [::String]
235
229
  # Optional. The query string with a minimum of 3 characters and specific syntax.
236
230
  # For more information, see
237
- # [Data Catalog search syntax](/data-catalog/docs/how-to/search-reference).
231
+ # [Data Catalog search
232
+ # syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
238
233
  #
239
234
  # An empty query string returns all data assets (in the specified scope)
240
235
  # that you have access to.
@@ -276,6 +271,27 @@ module Google
276
271
  #
277
272
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
278
273
  #
274
+ # @example Basic example
275
+ # require "google/cloud/data_catalog/v1"
276
+ #
277
+ # # Create a client object. The client can be reused for multiple calls.
278
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
279
+ #
280
+ # # Create a request. To set request fields, pass in keyword arguments.
281
+ # request = Google::Cloud::DataCatalog::V1::SearchCatalogRequest.new
282
+ #
283
+ # # Call the search_catalog method.
284
+ # result = client.search_catalog request
285
+ #
286
+ # # The returned object is of type Gapic::PagedEnumerable. You can
287
+ # # iterate over all elements by calling #each, and the enumerable
288
+ # # will lazily make API calls to fetch subsequent pages. Other
289
+ # # methods are also available for managing paging directly.
290
+ # result.each do |response|
291
+ # # Each element is of type ::Google::Cloud::DataCatalog::V1::SearchCatalogResult.
292
+ # p response
293
+ # end
294
+ #
279
295
  def search_catalog request, options = nil
280
296
  raise ::ArgumentError, "request must be provided" if request.nil?
281
297
 
@@ -296,7 +312,9 @@ module Google
296
312
  options.apply_defaults timeout: @config.rpcs.search_catalog.timeout,
297
313
  metadata: metadata,
298
314
  retry_policy: @config.rpcs.search_catalog.retry_policy
299
- options.apply_defaults metadata: @config.metadata,
315
+
316
+ options.apply_defaults timeout: @config.timeout,
317
+ metadata: @config.metadata,
300
318
  retry_policy: @config.retry_policy
301
319
 
302
320
  @data_catalog_stub.call_rpc :search_catalog, request, options: options do |response, operation|
@@ -374,6 +392,21 @@ module Google
374
392
  #
375
393
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
376
394
  #
395
+ # @example Basic example
396
+ # require "google/cloud/data_catalog/v1"
397
+ #
398
+ # # Create a client object. The client can be reused for multiple calls.
399
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
400
+ #
401
+ # # Create a request. To set request fields, pass in keyword arguments.
402
+ # request = Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest.new
403
+ #
404
+ # # Call the create_entry_group method.
405
+ # result = client.create_entry_group request
406
+ #
407
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
408
+ # p result
409
+ #
377
410
  def create_entry_group request, options = nil
378
411
  raise ::ArgumentError, "request must be provided" if request.nil?
379
412
 
@@ -391,16 +424,20 @@ module Google
391
424
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
392
425
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
393
426
 
394
- header_params = {
395
- "parent" => request.parent
396
- }
427
+ header_params = {}
428
+ if request.parent
429
+ header_params["parent"] = request.parent
430
+ end
431
+
397
432
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
398
433
  metadata[:"x-goog-request-params"] ||= request_params_header
399
434
 
400
435
  options.apply_defaults timeout: @config.rpcs.create_entry_group.timeout,
401
436
  metadata: metadata,
402
437
  retry_policy: @config.rpcs.create_entry_group.retry_policy
403
- options.apply_defaults metadata: @config.metadata,
438
+
439
+ options.apply_defaults timeout: @config.timeout,
440
+ metadata: @config.metadata,
404
441
  retry_policy: @config.retry_policy
405
442
 
406
443
  @data_catalog_stub.call_rpc :create_entry_group, request, options: options do |response, operation|
@@ -442,6 +479,21 @@ module Google
442
479
  #
443
480
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
444
481
  #
482
+ # @example Basic example
483
+ # require "google/cloud/data_catalog/v1"
484
+ #
485
+ # # Create a client object. The client can be reused for multiple calls.
486
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
487
+ #
488
+ # # Create a request. To set request fields, pass in keyword arguments.
489
+ # request = Google::Cloud::DataCatalog::V1::GetEntryGroupRequest.new
490
+ #
491
+ # # Call the get_entry_group method.
492
+ # result = client.get_entry_group request
493
+ #
494
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
495
+ # p result
496
+ #
445
497
  def get_entry_group request, options = nil
446
498
  raise ::ArgumentError, "request must be provided" if request.nil?
447
499
 
@@ -459,16 +511,20 @@ module Google
459
511
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
460
512
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
461
513
 
462
- header_params = {
463
- "name" => request.name
464
- }
514
+ header_params = {}
515
+ if request.name
516
+ header_params["name"] = request.name
517
+ end
518
+
465
519
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
466
520
  metadata[:"x-goog-request-params"] ||= request_params_header
467
521
 
468
522
  options.apply_defaults timeout: @config.rpcs.get_entry_group.timeout,
469
523
  metadata: metadata,
470
524
  retry_policy: @config.rpcs.get_entry_group.retry_policy
471
- options.apply_defaults metadata: @config.metadata,
525
+
526
+ options.apply_defaults timeout: @config.timeout,
527
+ metadata: @config.metadata,
472
528
  retry_policy: @config.retry_policy
473
529
 
474
530
  @data_catalog_stub.call_rpc :get_entry_group, request, options: options do |response, operation|
@@ -519,6 +575,21 @@ module Google
519
575
  #
520
576
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
521
577
  #
578
+ # @example Basic example
579
+ # require "google/cloud/data_catalog/v1"
580
+ #
581
+ # # Create a client object. The client can be reused for multiple calls.
582
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
583
+ #
584
+ # # Create a request. To set request fields, pass in keyword arguments.
585
+ # request = Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest.new
586
+ #
587
+ # # Call the update_entry_group method.
588
+ # result = client.update_entry_group request
589
+ #
590
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::EntryGroup.
591
+ # p result
592
+ #
522
593
  def update_entry_group request, options = nil
523
594
  raise ::ArgumentError, "request must be provided" if request.nil?
524
595
 
@@ -536,16 +607,20 @@ module Google
536
607
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
537
608
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
538
609
 
539
- header_params = {
540
- "entry_group.name" => request.entry_group.name
541
- }
610
+ header_params = {}
611
+ if request.entry_group&.name
612
+ header_params["entry_group.name"] = request.entry_group.name
613
+ end
614
+
542
615
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
543
616
  metadata[:"x-goog-request-params"] ||= request_params_header
544
617
 
545
618
  options.apply_defaults timeout: @config.rpcs.update_entry_group.timeout,
546
619
  metadata: metadata,
547
620
  retry_policy: @config.rpcs.update_entry_group.retry_policy
548
- options.apply_defaults metadata: @config.metadata,
621
+
622
+ options.apply_defaults timeout: @config.timeout,
623
+ metadata: @config.metadata,
549
624
  retry_policy: @config.retry_policy
550
625
 
551
626
  @data_catalog_stub.call_rpc :update_entry_group, request, options: options do |response, operation|
@@ -592,6 +667,21 @@ module Google
592
667
  #
593
668
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
594
669
  #
670
+ # @example Basic example
671
+ # require "google/cloud/data_catalog/v1"
672
+ #
673
+ # # Create a client object. The client can be reused for multiple calls.
674
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
675
+ #
676
+ # # Create a request. To set request fields, pass in keyword arguments.
677
+ # request = Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest.new
678
+ #
679
+ # # Call the delete_entry_group method.
680
+ # result = client.delete_entry_group request
681
+ #
682
+ # # The returned object is of type Google::Protobuf::Empty.
683
+ # p result
684
+ #
595
685
  def delete_entry_group request, options = nil
596
686
  raise ::ArgumentError, "request must be provided" if request.nil?
597
687
 
@@ -609,16 +699,20 @@ module Google
609
699
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
610
700
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
611
701
 
612
- header_params = {
613
- "name" => request.name
614
- }
702
+ header_params = {}
703
+ if request.name
704
+ header_params["name"] = request.name
705
+ end
706
+
615
707
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
616
708
  metadata[:"x-goog-request-params"] ||= request_params_header
617
709
 
618
710
  options.apply_defaults timeout: @config.rpcs.delete_entry_group.timeout,
619
711
  metadata: metadata,
620
712
  retry_policy: @config.rpcs.delete_entry_group.retry_policy
621
- options.apply_defaults metadata: @config.metadata,
713
+
714
+ options.apply_defaults timeout: @config.timeout,
715
+ metadata: @config.metadata,
622
716
  retry_policy: @config.retry_policy
623
717
 
624
718
  @data_catalog_stub.call_rpc :delete_entry_group, request, options: options do |response, operation|
@@ -668,6 +762,27 @@ module Google
668
762
  #
669
763
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
670
764
  #
765
+ # @example Basic example
766
+ # require "google/cloud/data_catalog/v1"
767
+ #
768
+ # # Create a client object. The client can be reused for multiple calls.
769
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
770
+ #
771
+ # # Create a request. To set request fields, pass in keyword arguments.
772
+ # request = Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest.new
773
+ #
774
+ # # Call the list_entry_groups method.
775
+ # result = client.list_entry_groups request
776
+ #
777
+ # # The returned object is of type Gapic::PagedEnumerable. You can
778
+ # # iterate over all elements by calling #each, and the enumerable
779
+ # # will lazily make API calls to fetch subsequent pages. Other
780
+ # # methods are also available for managing paging directly.
781
+ # result.each do |response|
782
+ # # Each element is of type ::Google::Cloud::DataCatalog::V1::EntryGroup.
783
+ # p response
784
+ # end
785
+ #
671
786
  def list_entry_groups request, options = nil
672
787
  raise ::ArgumentError, "request must be provided" if request.nil?
673
788
 
@@ -685,16 +800,20 @@ module Google
685
800
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
686
801
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
687
802
 
688
- header_params = {
689
- "parent" => request.parent
690
- }
803
+ header_params = {}
804
+ if request.parent
805
+ header_params["parent"] = request.parent
806
+ end
807
+
691
808
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
692
809
  metadata[:"x-goog-request-params"] ||= request_params_header
693
810
 
694
811
  options.apply_defaults timeout: @config.rpcs.list_entry_groups.timeout,
695
812
  metadata: metadata,
696
813
  retry_policy: @config.rpcs.list_entry_groups.retry_policy
697
- options.apply_defaults metadata: @config.metadata,
814
+
815
+ options.apply_defaults timeout: @config.timeout,
816
+ metadata: @config.metadata,
698
817
  retry_policy: @config.retry_policy
699
818
 
700
819
  @data_catalog_stub.call_rpc :list_entry_groups, request, options: options do |response, operation|
@@ -756,6 +875,21 @@ module Google
756
875
  #
757
876
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
758
877
  #
878
+ # @example Basic example
879
+ # require "google/cloud/data_catalog/v1"
880
+ #
881
+ # # Create a client object. The client can be reused for multiple calls.
882
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
883
+ #
884
+ # # Create a request. To set request fields, pass in keyword arguments.
885
+ # request = Google::Cloud::DataCatalog::V1::CreateEntryRequest.new
886
+ #
887
+ # # Call the create_entry method.
888
+ # result = client.create_entry request
889
+ #
890
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
891
+ # p result
892
+ #
759
893
  def create_entry request, options = nil
760
894
  raise ::ArgumentError, "request must be provided" if request.nil?
761
895
 
@@ -773,16 +907,20 @@ module Google
773
907
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
774
908
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
775
909
 
776
- header_params = {
777
- "parent" => request.parent
778
- }
910
+ header_params = {}
911
+ if request.parent
912
+ header_params["parent"] = request.parent
913
+ end
914
+
779
915
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
780
916
  metadata[:"x-goog-request-params"] ||= request_params_header
781
917
 
782
918
  options.apply_defaults timeout: @config.rpcs.create_entry.timeout,
783
919
  metadata: metadata,
784
920
  retry_policy: @config.rpcs.create_entry.retry_policy
785
- options.apply_defaults metadata: @config.metadata,
921
+
922
+ options.apply_defaults timeout: @config.timeout,
923
+ metadata: @config.metadata,
786
924
  retry_policy: @config.retry_policy
787
925
 
788
926
  @data_catalog_stub.call_rpc :create_entry, request, options: options do |response, operation|
@@ -857,6 +995,21 @@ module Google
857
995
  #
858
996
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
859
997
  #
998
+ # @example Basic example
999
+ # require "google/cloud/data_catalog/v1"
1000
+ #
1001
+ # # Create a client object. The client can be reused for multiple calls.
1002
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1003
+ #
1004
+ # # Create a request. To set request fields, pass in keyword arguments.
1005
+ # request = Google::Cloud::DataCatalog::V1::UpdateEntryRequest.new
1006
+ #
1007
+ # # Call the update_entry method.
1008
+ # result = client.update_entry request
1009
+ #
1010
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
1011
+ # p result
1012
+ #
860
1013
  def update_entry request, options = nil
861
1014
  raise ::ArgumentError, "request must be provided" if request.nil?
862
1015
 
@@ -874,16 +1027,20 @@ module Google
874
1027
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
875
1028
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
876
1029
 
877
- header_params = {
878
- "entry.name" => request.entry.name
879
- }
1030
+ header_params = {}
1031
+ if request.entry&.name
1032
+ header_params["entry.name"] = request.entry.name
1033
+ end
1034
+
880
1035
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
881
1036
  metadata[:"x-goog-request-params"] ||= request_params_header
882
1037
 
883
1038
  options.apply_defaults timeout: @config.rpcs.update_entry.timeout,
884
1039
  metadata: metadata,
885
1040
  retry_policy: @config.rpcs.update_entry.retry_policy
886
- options.apply_defaults metadata: @config.metadata,
1041
+
1042
+ options.apply_defaults timeout: @config.timeout,
1043
+ metadata: @config.metadata,
887
1044
  retry_policy: @config.retry_policy
888
1045
 
889
1046
  @data_catalog_stub.call_rpc :update_entry, request, options: options do |response, operation|
@@ -932,6 +1089,21 @@ module Google
932
1089
  #
933
1090
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
934
1091
  #
1092
+ # @example Basic example
1093
+ # require "google/cloud/data_catalog/v1"
1094
+ #
1095
+ # # Create a client object. The client can be reused for multiple calls.
1096
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1097
+ #
1098
+ # # Create a request. To set request fields, pass in keyword arguments.
1099
+ # request = Google::Cloud::DataCatalog::V1::DeleteEntryRequest.new
1100
+ #
1101
+ # # Call the delete_entry method.
1102
+ # result = client.delete_entry request
1103
+ #
1104
+ # # The returned object is of type Google::Protobuf::Empty.
1105
+ # p result
1106
+ #
935
1107
  def delete_entry request, options = nil
936
1108
  raise ::ArgumentError, "request must be provided" if request.nil?
937
1109
 
@@ -949,16 +1121,20 @@ module Google
949
1121
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
950
1122
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
951
1123
 
952
- header_params = {
953
- "name" => request.name
954
- }
1124
+ header_params = {}
1125
+ if request.name
1126
+ header_params["name"] = request.name
1127
+ end
1128
+
955
1129
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
956
1130
  metadata[:"x-goog-request-params"] ||= request_params_header
957
1131
 
958
1132
  options.apply_defaults timeout: @config.rpcs.delete_entry.timeout,
959
1133
  metadata: metadata,
960
1134
  retry_policy: @config.rpcs.delete_entry.retry_policy
961
- options.apply_defaults metadata: @config.metadata,
1135
+
1136
+ options.apply_defaults timeout: @config.timeout,
1137
+ metadata: @config.metadata,
962
1138
  retry_policy: @config.retry_policy
963
1139
 
964
1140
  @data_catalog_stub.call_rpc :delete_entry, request, options: options do |response, operation|
@@ -998,6 +1174,21 @@ module Google
998
1174
  #
999
1175
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1000
1176
  #
1177
+ # @example Basic example
1178
+ # require "google/cloud/data_catalog/v1"
1179
+ #
1180
+ # # Create a client object. The client can be reused for multiple calls.
1181
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1182
+ #
1183
+ # # Create a request. To set request fields, pass in keyword arguments.
1184
+ # request = Google::Cloud::DataCatalog::V1::GetEntryRequest.new
1185
+ #
1186
+ # # Call the get_entry method.
1187
+ # result = client.get_entry request
1188
+ #
1189
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
1190
+ # p result
1191
+ #
1001
1192
  def get_entry request, options = nil
1002
1193
  raise ::ArgumentError, "request must be provided" if request.nil?
1003
1194
 
@@ -1015,16 +1206,20 @@ module Google
1015
1206
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1016
1207
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1017
1208
 
1018
- header_params = {
1019
- "name" => request.name
1020
- }
1209
+ header_params = {}
1210
+ if request.name
1211
+ header_params["name"] = request.name
1212
+ end
1213
+
1021
1214
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1022
1215
  metadata[:"x-goog-request-params"] ||= request_params_header
1023
1216
 
1024
1217
  options.apply_defaults timeout: @config.rpcs.get_entry.timeout,
1025
1218
  metadata: metadata,
1026
1219
  retry_policy: @config.rpcs.get_entry.retry_policy
1027
- options.apply_defaults metadata: @config.metadata,
1220
+
1221
+ options.apply_defaults timeout: @config.timeout,
1222
+ metadata: @config.metadata,
1028
1223
  retry_policy: @config.retry_policy
1029
1224
 
1030
1225
  @data_catalog_stub.call_rpc :get_entry, request, options: options do |response, operation|
@@ -1103,6 +1298,21 @@ module Google
1103
1298
  #
1104
1299
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1105
1300
  #
1301
+ # @example Basic example
1302
+ # require "google/cloud/data_catalog/v1"
1303
+ #
1304
+ # # Create a client object. The client can be reused for multiple calls.
1305
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1306
+ #
1307
+ # # Create a request. To set request fields, pass in keyword arguments.
1308
+ # request = Google::Cloud::DataCatalog::V1::LookupEntryRequest.new
1309
+ #
1310
+ # # Call the lookup_entry method.
1311
+ # result = client.lookup_entry request
1312
+ #
1313
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::Entry.
1314
+ # p result
1315
+ #
1106
1316
  def lookup_entry request, options = nil
1107
1317
  raise ::ArgumentError, "request must be provided" if request.nil?
1108
1318
 
@@ -1123,7 +1333,9 @@ module Google
1123
1333
  options.apply_defaults timeout: @config.rpcs.lookup_entry.timeout,
1124
1334
  metadata: metadata,
1125
1335
  retry_policy: @config.rpcs.lookup_entry.retry_policy
1126
- options.apply_defaults metadata: @config.metadata,
1336
+
1337
+ options.apply_defaults timeout: @config.timeout,
1338
+ metadata: @config.metadata,
1127
1339
  retry_policy: @config.retry_policy
1128
1340
 
1129
1341
  @data_catalog_stub.call_rpc :lookup_entry, request, options: options do |response, operation|
@@ -1137,6 +1349,10 @@ module Google
1137
1349
  ##
1138
1350
  # Lists entries.
1139
1351
  #
1352
+ # Note: Currently, this method can list only custom entries.
1353
+ # To get a list of both custom and automatically created entries, use
1354
+ # {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalog}.
1355
+ #
1140
1356
  # @overload list_entries(request, options = nil)
1141
1357
  # Pass arguments to `list_entries` via a request object, either of type
1142
1358
  # {::Google::Cloud::DataCatalog::V1::ListEntriesRequest} or an equivalent Hash.
@@ -1177,6 +1393,27 @@ module Google
1177
1393
  #
1178
1394
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1179
1395
  #
1396
+ # @example Basic example
1397
+ # require "google/cloud/data_catalog/v1"
1398
+ #
1399
+ # # Create a client object. The client can be reused for multiple calls.
1400
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1401
+ #
1402
+ # # Create a request. To set request fields, pass in keyword arguments.
1403
+ # request = Google::Cloud::DataCatalog::V1::ListEntriesRequest.new
1404
+ #
1405
+ # # Call the list_entries method.
1406
+ # result = client.list_entries request
1407
+ #
1408
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1409
+ # # iterate over all elements by calling #each, and the enumerable
1410
+ # # will lazily make API calls to fetch subsequent pages. Other
1411
+ # # methods are also available for managing paging directly.
1412
+ # result.each do |response|
1413
+ # # Each element is of type ::Google::Cloud::DataCatalog::V1::Entry.
1414
+ # p response
1415
+ # end
1416
+ #
1180
1417
  def list_entries request, options = nil
1181
1418
  raise ::ArgumentError, "request must be provided" if request.nil?
1182
1419
 
@@ -1194,16 +1431,20 @@ module Google
1194
1431
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1195
1432
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1196
1433
 
1197
- header_params = {
1198
- "parent" => request.parent
1199
- }
1434
+ header_params = {}
1435
+ if request.parent
1436
+ header_params["parent"] = request.parent
1437
+ end
1438
+
1200
1439
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1201
1440
  metadata[:"x-goog-request-params"] ||= request_params_header
1202
1441
 
1203
1442
  options.apply_defaults timeout: @config.rpcs.list_entries.timeout,
1204
1443
  metadata: metadata,
1205
1444
  retry_policy: @config.rpcs.list_entries.retry_policy
1206
- options.apply_defaults metadata: @config.metadata,
1445
+
1446
+ options.apply_defaults timeout: @config.timeout,
1447
+ metadata: @config.metadata,
1207
1448
  retry_policy: @config.retry_policy
1208
1449
 
1209
1450
  @data_catalog_stub.call_rpc :list_entries, request, options: options do |response, operation|
@@ -1258,6 +1499,21 @@ module Google
1258
1499
  #
1259
1500
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1260
1501
  #
1502
+ # @example Basic example
1503
+ # require "google/cloud/data_catalog/v1"
1504
+ #
1505
+ # # Create a client object. The client can be reused for multiple calls.
1506
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1507
+ #
1508
+ # # Create a request. To set request fields, pass in keyword arguments.
1509
+ # request = Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest.new
1510
+ #
1511
+ # # Call the create_tag_template method.
1512
+ # result = client.create_tag_template request
1513
+ #
1514
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
1515
+ # p result
1516
+ #
1261
1517
  def create_tag_template request, options = nil
1262
1518
  raise ::ArgumentError, "request must be provided" if request.nil?
1263
1519
 
@@ -1275,16 +1531,20 @@ module Google
1275
1531
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1276
1532
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1277
1533
 
1278
- header_params = {
1279
- "parent" => request.parent
1280
- }
1534
+ header_params = {}
1535
+ if request.parent
1536
+ header_params["parent"] = request.parent
1537
+ end
1538
+
1281
1539
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1282
1540
  metadata[:"x-goog-request-params"] ||= request_params_header
1283
1541
 
1284
1542
  options.apply_defaults timeout: @config.rpcs.create_tag_template.timeout,
1285
1543
  metadata: metadata,
1286
1544
  retry_policy: @config.rpcs.create_tag_template.retry_policy
1287
- options.apply_defaults metadata: @config.metadata,
1545
+
1546
+ options.apply_defaults timeout: @config.timeout,
1547
+ metadata: @config.metadata,
1288
1548
  retry_policy: @config.retry_policy
1289
1549
 
1290
1550
  @data_catalog_stub.call_rpc :create_tag_template, request, options: options do |response, operation|
@@ -1324,6 +1584,21 @@ module Google
1324
1584
  #
1325
1585
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1326
1586
  #
1587
+ # @example Basic example
1588
+ # require "google/cloud/data_catalog/v1"
1589
+ #
1590
+ # # Create a client object. The client can be reused for multiple calls.
1591
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1592
+ #
1593
+ # # Create a request. To set request fields, pass in keyword arguments.
1594
+ # request = Google::Cloud::DataCatalog::V1::GetTagTemplateRequest.new
1595
+ #
1596
+ # # Call the get_tag_template method.
1597
+ # result = client.get_tag_template request
1598
+ #
1599
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
1600
+ # p result
1601
+ #
1327
1602
  def get_tag_template request, options = nil
1328
1603
  raise ::ArgumentError, "request must be provided" if request.nil?
1329
1604
 
@@ -1341,16 +1616,20 @@ module Google
1341
1616
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1342
1617
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1343
1618
 
1344
- header_params = {
1345
- "name" => request.name
1346
- }
1619
+ header_params = {}
1620
+ if request.name
1621
+ header_params["name"] = request.name
1622
+ end
1623
+
1347
1624
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1348
1625
  metadata[:"x-goog-request-params"] ||= request_params_header
1349
1626
 
1350
1627
  options.apply_defaults timeout: @config.rpcs.get_tag_template.timeout,
1351
1628
  metadata: metadata,
1352
1629
  retry_policy: @config.rpcs.get_tag_template.retry_policy
1353
- options.apply_defaults metadata: @config.metadata,
1630
+
1631
+ options.apply_defaults timeout: @config.timeout,
1632
+ metadata: @config.metadata,
1354
1633
  retry_policy: @config.retry_policy
1355
1634
 
1356
1635
  @data_catalog_stub.call_rpc :get_tag_template, request, options: options do |response, operation|
@@ -1391,12 +1670,17 @@ module Google
1391
1670
  # Required. The template to update. The `name` field must be set.
1392
1671
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1393
1672
  # Names of fields whose values to overwrite on a tag template. Currently,
1394
- # only `display_name` can be overwritten.
1673
+ # only `display_name` and `is_publicly_readable` can be overwritten.
1395
1674
  #
1396
1675
  # If this parameter is absent or empty, all modifiable fields
1397
1676
  # are overwritten. If such fields are non-required and omitted in the
1398
1677
  # request body, their values are emptied.
1399
1678
  #
1679
+ # Note: Updating the `is_publicly_readable` field may require up to 12
1680
+ # hours to take effect in search results. Additionally, it also requires
1681
+ # the `tagTemplates.getIamPolicy` and `tagTemplates.setIamPolicy`
1682
+ # permissions.
1683
+ #
1400
1684
  # @yield [response, operation] Access the result along with the RPC operation
1401
1685
  # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplate]
1402
1686
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -1405,6 +1689,21 @@ module Google
1405
1689
  #
1406
1690
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1407
1691
  #
1692
+ # @example Basic example
1693
+ # require "google/cloud/data_catalog/v1"
1694
+ #
1695
+ # # Create a client object. The client can be reused for multiple calls.
1696
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1697
+ #
1698
+ # # Create a request. To set request fields, pass in keyword arguments.
1699
+ # request = Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest.new
1700
+ #
1701
+ # # Call the update_tag_template method.
1702
+ # result = client.update_tag_template request
1703
+ #
1704
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplate.
1705
+ # p result
1706
+ #
1408
1707
  def update_tag_template request, options = nil
1409
1708
  raise ::ArgumentError, "request must be provided" if request.nil?
1410
1709
 
@@ -1422,16 +1721,20 @@ module Google
1422
1721
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1423
1722
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1424
1723
 
1425
- header_params = {
1426
- "tag_template.name" => request.tag_template.name
1427
- }
1724
+ header_params = {}
1725
+ if request.tag_template&.name
1726
+ header_params["tag_template.name"] = request.tag_template.name
1727
+ end
1728
+
1428
1729
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1429
1730
  metadata[:"x-goog-request-params"] ||= request_params_header
1430
1731
 
1431
1732
  options.apply_defaults timeout: @config.rpcs.update_tag_template.timeout,
1432
1733
  metadata: metadata,
1433
1734
  retry_policy: @config.rpcs.update_tag_template.retry_policy
1434
- options.apply_defaults metadata: @config.metadata,
1735
+
1736
+ options.apply_defaults timeout: @config.timeout,
1737
+ metadata: @config.metadata,
1435
1738
  retry_policy: @config.retry_policy
1436
1739
 
1437
1740
  @data_catalog_stub.call_rpc :update_tag_template, request, options: options do |response, operation|
@@ -1479,6 +1782,21 @@ module Google
1479
1782
  #
1480
1783
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1481
1784
  #
1785
+ # @example Basic example
1786
+ # require "google/cloud/data_catalog/v1"
1787
+ #
1788
+ # # Create a client object. The client can be reused for multiple calls.
1789
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1790
+ #
1791
+ # # Create a request. To set request fields, pass in keyword arguments.
1792
+ # request = Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest.new
1793
+ #
1794
+ # # Call the delete_tag_template method.
1795
+ # result = client.delete_tag_template request
1796
+ #
1797
+ # # The returned object is of type Google::Protobuf::Empty.
1798
+ # p result
1799
+ #
1482
1800
  def delete_tag_template request, options = nil
1483
1801
  raise ::ArgumentError, "request must be provided" if request.nil?
1484
1802
 
@@ -1496,16 +1814,20 @@ module Google
1496
1814
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1497
1815
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1498
1816
 
1499
- header_params = {
1500
- "name" => request.name
1501
- }
1817
+ header_params = {}
1818
+ if request.name
1819
+ header_params["name"] = request.name
1820
+ end
1821
+
1502
1822
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1503
1823
  metadata[:"x-goog-request-params"] ||= request_params_header
1504
1824
 
1505
1825
  options.apply_defaults timeout: @config.rpcs.delete_tag_template.timeout,
1506
1826
  metadata: metadata,
1507
1827
  retry_policy: @config.rpcs.delete_tag_template.retry_policy
1508
- options.apply_defaults metadata: @config.metadata,
1828
+
1829
+ options.apply_defaults timeout: @config.timeout,
1830
+ metadata: @config.metadata,
1509
1831
  retry_policy: @config.retry_policy
1510
1832
 
1511
1833
  @data_catalog_stub.call_rpc :delete_tag_template, request, options: options do |response, operation|
@@ -1561,6 +1883,21 @@ module Google
1561
1883
  #
1562
1884
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1563
1885
  #
1886
+ # @example Basic example
1887
+ # require "google/cloud/data_catalog/v1"
1888
+ #
1889
+ # # Create a client object. The client can be reused for multiple calls.
1890
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
1891
+ #
1892
+ # # Create a request. To set request fields, pass in keyword arguments.
1893
+ # request = Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest.new
1894
+ #
1895
+ # # Call the create_tag_template_field method.
1896
+ # result = client.create_tag_template_field request
1897
+ #
1898
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
1899
+ # p result
1900
+ #
1564
1901
  def create_tag_template_field request, options = nil
1565
1902
  raise ::ArgumentError, "request must be provided" if request.nil?
1566
1903
 
@@ -1578,16 +1915,20 @@ module Google
1578
1915
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1579
1916
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1580
1917
 
1581
- header_params = {
1582
- "parent" => request.parent
1583
- }
1918
+ header_params = {}
1919
+ if request.parent
1920
+ header_params["parent"] = request.parent
1921
+ end
1922
+
1584
1923
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1585
1924
  metadata[:"x-goog-request-params"] ||= request_params_header
1586
1925
 
1587
1926
  options.apply_defaults timeout: @config.rpcs.create_tag_template_field.timeout,
1588
1927
  metadata: metadata,
1589
1928
  retry_policy: @config.rpcs.create_tag_template_field.retry_policy
1590
- options.apply_defaults metadata: @config.metadata,
1929
+
1930
+ options.apply_defaults timeout: @config.timeout,
1931
+ metadata: @config.metadata,
1591
1932
  retry_policy: @config.retry_policy
1592
1933
 
1593
1934
  @data_catalog_stub.call_rpc :create_tag_template_field, request, options: options do |response, operation|
@@ -1653,6 +1994,21 @@ module Google
1653
1994
  #
1654
1995
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1655
1996
  #
1997
+ # @example Basic example
1998
+ # require "google/cloud/data_catalog/v1"
1999
+ #
2000
+ # # Create a client object. The client can be reused for multiple calls.
2001
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2002
+ #
2003
+ # # Create a request. To set request fields, pass in keyword arguments.
2004
+ # request = Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest.new
2005
+ #
2006
+ # # Call the update_tag_template_field method.
2007
+ # result = client.update_tag_template_field request
2008
+ #
2009
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
2010
+ # p result
2011
+ #
1656
2012
  def update_tag_template_field request, options = nil
1657
2013
  raise ::ArgumentError, "request must be provided" if request.nil?
1658
2014
 
@@ -1670,16 +2026,20 @@ module Google
1670
2026
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1671
2027
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1672
2028
 
1673
- header_params = {
1674
- "name" => request.name
1675
- }
2029
+ header_params = {}
2030
+ if request.name
2031
+ header_params["name"] = request.name
2032
+ end
2033
+
1676
2034
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1677
2035
  metadata[:"x-goog-request-params"] ||= request_params_header
1678
2036
 
1679
2037
  options.apply_defaults timeout: @config.rpcs.update_tag_template_field.timeout,
1680
2038
  metadata: metadata,
1681
2039
  retry_policy: @config.rpcs.update_tag_template_field.retry_policy
1682
- options.apply_defaults metadata: @config.metadata,
2040
+
2041
+ options.apply_defaults timeout: @config.timeout,
2042
+ metadata: @config.metadata,
1683
2043
  retry_policy: @config.retry_policy
1684
2044
 
1685
2045
  @data_catalog_stub.call_rpc :update_tag_template_field, request, options: options do |response, operation|
@@ -1713,7 +2073,7 @@ module Google
1713
2073
  # the default parameter values, pass an empty Hash as a request object (see above).
1714
2074
  #
1715
2075
  # @param name [::String]
1716
- # Required. The name of the tag template.
2076
+ # Required. The name of the tag template field.
1717
2077
  # @param new_tag_template_field_id [::String]
1718
2078
  # Required. The new ID of this tag template field. For example, `my_new_field`.
1719
2079
  #
@@ -1725,6 +2085,21 @@ module Google
1725
2085
  #
1726
2086
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1727
2087
  #
2088
+ # @example Basic example
2089
+ # require "google/cloud/data_catalog/v1"
2090
+ #
2091
+ # # Create a client object. The client can be reused for multiple calls.
2092
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2093
+ #
2094
+ # # Create a request. To set request fields, pass in keyword arguments.
2095
+ # request = Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest.new
2096
+ #
2097
+ # # Call the rename_tag_template_field method.
2098
+ # result = client.rename_tag_template_field request
2099
+ #
2100
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
2101
+ # p result
2102
+ #
1728
2103
  def rename_tag_template_field request, options = nil
1729
2104
  raise ::ArgumentError, "request must be provided" if request.nil?
1730
2105
 
@@ -1742,16 +2117,20 @@ module Google
1742
2117
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1743
2118
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1744
2119
 
1745
- header_params = {
1746
- "name" => request.name
1747
- }
2120
+ header_params = {}
2121
+ if request.name
2122
+ header_params["name"] = request.name
2123
+ end
2124
+
1748
2125
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1749
2126
  metadata[:"x-goog-request-params"] ||= request_params_header
1750
2127
 
1751
2128
  options.apply_defaults timeout: @config.rpcs.rename_tag_template_field.timeout,
1752
2129
  metadata: metadata,
1753
2130
  retry_policy: @config.rpcs.rename_tag_template_field.retry_policy
1754
- options.apply_defaults metadata: @config.metadata,
2131
+
2132
+ options.apply_defaults timeout: @config.timeout,
2133
+ metadata: @config.metadata,
1755
2134
  retry_policy: @config.retry_policy
1756
2135
 
1757
2136
  @data_catalog_stub.call_rpc :rename_tag_template_field, request, options: options do |response, operation|
@@ -1795,6 +2174,21 @@ module Google
1795
2174
  #
1796
2175
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1797
2176
  #
2177
+ # @example Basic example
2178
+ # require "google/cloud/data_catalog/v1"
2179
+ #
2180
+ # # Create a client object. The client can be reused for multiple calls.
2181
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2182
+ #
2183
+ # # Create a request. To set request fields, pass in keyword arguments.
2184
+ # request = Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldEnumValueRequest.new
2185
+ #
2186
+ # # Call the rename_tag_template_field_enum_value method.
2187
+ # result = client.rename_tag_template_field_enum_value request
2188
+ #
2189
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::TagTemplateField.
2190
+ # p result
2191
+ #
1798
2192
  def rename_tag_template_field_enum_value request, options = nil
1799
2193
  raise ::ArgumentError, "request must be provided" if request.nil?
1800
2194
 
@@ -1812,16 +2206,20 @@ module Google
1812
2206
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1813
2207
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1814
2208
 
1815
- header_params = {
1816
- "name" => request.name
1817
- }
2209
+ header_params = {}
2210
+ if request.name
2211
+ header_params["name"] = request.name
2212
+ end
2213
+
1818
2214
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1819
2215
  metadata[:"x-goog-request-params"] ||= request_params_header
1820
2216
 
1821
2217
  options.apply_defaults timeout: @config.rpcs.rename_tag_template_field_enum_value.timeout,
1822
2218
  metadata: metadata,
1823
2219
  retry_policy: @config.rpcs.rename_tag_template_field_enum_value.retry_policy
1824
- options.apply_defaults metadata: @config.metadata,
2220
+
2221
+ options.apply_defaults timeout: @config.timeout,
2222
+ metadata: @config.metadata,
1825
2223
  retry_policy: @config.retry_policy
1826
2224
 
1827
2225
  @data_catalog_stub.call_rpc :rename_tag_template_field_enum_value, request, options: options do |response, operation|
@@ -1870,6 +2268,21 @@ module Google
1870
2268
  #
1871
2269
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1872
2270
  #
2271
+ # @example Basic example
2272
+ # require "google/cloud/data_catalog/v1"
2273
+ #
2274
+ # # Create a client object. The client can be reused for multiple calls.
2275
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2276
+ #
2277
+ # # Create a request. To set request fields, pass in keyword arguments.
2278
+ # request = Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest.new
2279
+ #
2280
+ # # Call the delete_tag_template_field method.
2281
+ # result = client.delete_tag_template_field request
2282
+ #
2283
+ # # The returned object is of type Google::Protobuf::Empty.
2284
+ # p result
2285
+ #
1873
2286
  def delete_tag_template_field request, options = nil
1874
2287
  raise ::ArgumentError, "request must be provided" if request.nil?
1875
2288
 
@@ -1887,16 +2300,20 @@ module Google
1887
2300
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1888
2301
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1889
2302
 
1890
- header_params = {
1891
- "name" => request.name
1892
- }
2303
+ header_params = {}
2304
+ if request.name
2305
+ header_params["name"] = request.name
2306
+ end
2307
+
1893
2308
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1894
2309
  metadata[:"x-goog-request-params"] ||= request_params_header
1895
2310
 
1896
2311
  options.apply_defaults timeout: @config.rpcs.delete_tag_template_field.timeout,
1897
2312
  metadata: metadata,
1898
2313
  retry_policy: @config.rpcs.delete_tag_template_field.retry_policy
1899
- options.apply_defaults metadata: @config.metadata,
2314
+
2315
+ options.apply_defaults timeout: @config.timeout,
2316
+ metadata: @config.metadata,
1900
2317
  retry_policy: @config.retry_policy
1901
2318
 
1902
2319
  @data_catalog_stub.call_rpc :delete_tag_template_field, request, options: options do |response, operation|
@@ -1911,9 +2328,9 @@ module Google
1911
2328
  # Creates a tag and assigns it to:
1912
2329
  #
1913
2330
  # * An {::Google::Cloud::DataCatalog::V1::Entry Entry} if the method name is
1914
- # ``projects.locations.entryGroups.entries.tags.create``.
2331
+ # `projects.locations.entryGroups.entries.tags.create`.
1915
2332
  # * Or {::Google::Cloud::DataCatalog::V1::EntryGroup EntryGroup}if the method
1916
- # name is ``projects.locations.entryGroups.tags.create``.
2333
+ # name is `projects.locations.entryGroups.tags.create`.
1917
2334
  #
1918
2335
  # Note: The project identified by the `parent` parameter for the [tag]
1919
2336
  # (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
@@ -1955,6 +2372,21 @@ module Google
1955
2372
  #
1956
2373
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1957
2374
  #
2375
+ # @example Basic example
2376
+ # require "google/cloud/data_catalog/v1"
2377
+ #
2378
+ # # Create a client object. The client can be reused for multiple calls.
2379
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2380
+ #
2381
+ # # Create a request. To set request fields, pass in keyword arguments.
2382
+ # request = Google::Cloud::DataCatalog::V1::CreateTagRequest.new
2383
+ #
2384
+ # # Call the create_tag method.
2385
+ # result = client.create_tag request
2386
+ #
2387
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::Tag.
2388
+ # p result
2389
+ #
1958
2390
  def create_tag request, options = nil
1959
2391
  raise ::ArgumentError, "request must be provided" if request.nil?
1960
2392
 
@@ -1972,16 +2404,20 @@ module Google
1972
2404
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
1973
2405
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1974
2406
 
1975
- header_params = {
1976
- "parent" => request.parent
1977
- }
2407
+ header_params = {}
2408
+ if request.parent
2409
+ header_params["parent"] = request.parent
2410
+ end
2411
+
1978
2412
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1979
2413
  metadata[:"x-goog-request-params"] ||= request_params_header
1980
2414
 
1981
2415
  options.apply_defaults timeout: @config.rpcs.create_tag.timeout,
1982
2416
  metadata: metadata,
1983
2417
  retry_policy: @config.rpcs.create_tag.retry_policy
1984
- options.apply_defaults metadata: @config.metadata,
2418
+
2419
+ options.apply_defaults timeout: @config.timeout,
2420
+ metadata: @config.metadata,
1985
2421
  retry_policy: @config.retry_policy
1986
2422
 
1987
2423
  @data_catalog_stub.call_rpc :create_tag, request, options: options do |response, operation|
@@ -2028,6 +2464,21 @@ module Google
2028
2464
  #
2029
2465
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2030
2466
  #
2467
+ # @example Basic example
2468
+ # require "google/cloud/data_catalog/v1"
2469
+ #
2470
+ # # Create a client object. The client can be reused for multiple calls.
2471
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2472
+ #
2473
+ # # Create a request. To set request fields, pass in keyword arguments.
2474
+ # request = Google::Cloud::DataCatalog::V1::UpdateTagRequest.new
2475
+ #
2476
+ # # Call the update_tag method.
2477
+ # result = client.update_tag request
2478
+ #
2479
+ # # The returned object is of type Google::Cloud::DataCatalog::V1::Tag.
2480
+ # p result
2481
+ #
2031
2482
  def update_tag request, options = nil
2032
2483
  raise ::ArgumentError, "request must be provided" if request.nil?
2033
2484
 
@@ -2045,16 +2496,20 @@ module Google
2045
2496
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
2046
2497
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2047
2498
 
2048
- header_params = {
2049
- "tag.name" => request.tag.name
2050
- }
2499
+ header_params = {}
2500
+ if request.tag&.name
2501
+ header_params["tag.name"] = request.tag.name
2502
+ end
2503
+
2051
2504
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2052
2505
  metadata[:"x-goog-request-params"] ||= request_params_header
2053
2506
 
2054
2507
  options.apply_defaults timeout: @config.rpcs.update_tag.timeout,
2055
2508
  metadata: metadata,
2056
2509
  retry_policy: @config.rpcs.update_tag.retry_policy
2057
- options.apply_defaults metadata: @config.metadata,
2510
+
2511
+ options.apply_defaults timeout: @config.timeout,
2512
+ metadata: @config.metadata,
2058
2513
  retry_policy: @config.retry_policy
2059
2514
 
2060
2515
  @data_catalog_stub.call_rpc :update_tag, request, options: options do |response, operation|
@@ -2094,6 +2549,21 @@ module Google
2094
2549
  #
2095
2550
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2096
2551
  #
2552
+ # @example Basic example
2553
+ # require "google/cloud/data_catalog/v1"
2554
+ #
2555
+ # # Create a client object. The client can be reused for multiple calls.
2556
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2557
+ #
2558
+ # # Create a request. To set request fields, pass in keyword arguments.
2559
+ # request = Google::Cloud::DataCatalog::V1::DeleteTagRequest.new
2560
+ #
2561
+ # # Call the delete_tag method.
2562
+ # result = client.delete_tag request
2563
+ #
2564
+ # # The returned object is of type Google::Protobuf::Empty.
2565
+ # p result
2566
+ #
2097
2567
  def delete_tag request, options = nil
2098
2568
  raise ::ArgumentError, "request must be provided" if request.nil?
2099
2569
 
@@ -2111,16 +2581,20 @@ module Google
2111
2581
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
2112
2582
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2113
2583
 
2114
- header_params = {
2115
- "name" => request.name
2116
- }
2584
+ header_params = {}
2585
+ if request.name
2586
+ header_params["name"] = request.name
2587
+ end
2588
+
2117
2589
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2118
2590
  metadata[:"x-goog-request-params"] ||= request_params_header
2119
2591
 
2120
2592
  options.apply_defaults timeout: @config.rpcs.delete_tag.timeout,
2121
2593
  metadata: metadata,
2122
2594
  retry_policy: @config.rpcs.delete_tag.retry_policy
2123
- options.apply_defaults metadata: @config.metadata,
2595
+
2596
+ options.apply_defaults timeout: @config.timeout,
2597
+ metadata: @config.metadata,
2124
2598
  retry_policy: @config.retry_policy
2125
2599
 
2126
2600
  @data_catalog_stub.call_rpc :delete_tag, request, options: options do |response, operation|
@@ -2169,6 +2643,27 @@ module Google
2169
2643
  #
2170
2644
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2171
2645
  #
2646
+ # @example Basic example
2647
+ # require "google/cloud/data_catalog/v1"
2648
+ #
2649
+ # # Create a client object. The client can be reused for multiple calls.
2650
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2651
+ #
2652
+ # # Create a request. To set request fields, pass in keyword arguments.
2653
+ # request = Google::Cloud::DataCatalog::V1::ListTagsRequest.new
2654
+ #
2655
+ # # Call the list_tags method.
2656
+ # result = client.list_tags request
2657
+ #
2658
+ # # The returned object is of type Gapic::PagedEnumerable. You can
2659
+ # # iterate over all elements by calling #each, and the enumerable
2660
+ # # will lazily make API calls to fetch subsequent pages. Other
2661
+ # # methods are also available for managing paging directly.
2662
+ # result.each do |response|
2663
+ # # Each element is of type ::Google::Cloud::DataCatalog::V1::Tag.
2664
+ # p response
2665
+ # end
2666
+ #
2172
2667
  def list_tags request, options = nil
2173
2668
  raise ::ArgumentError, "request must be provided" if request.nil?
2174
2669
 
@@ -2186,16 +2681,20 @@ module Google
2186
2681
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
2187
2682
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2188
2683
 
2189
- header_params = {
2190
- "parent" => request.parent
2191
- }
2684
+ header_params = {}
2685
+ if request.parent
2686
+ header_params["parent"] = request.parent
2687
+ end
2688
+
2192
2689
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2193
2690
  metadata[:"x-goog-request-params"] ||= request_params_header
2194
2691
 
2195
2692
  options.apply_defaults timeout: @config.rpcs.list_tags.timeout,
2196
2693
  metadata: metadata,
2197
2694
  retry_policy: @config.rpcs.list_tags.retry_policy
2198
- options.apply_defaults metadata: @config.metadata,
2695
+
2696
+ options.apply_defaults timeout: @config.timeout,
2697
+ metadata: @config.metadata,
2199
2698
  retry_policy: @config.retry_policy
2200
2699
 
2201
2700
  @data_catalog_stub.call_rpc :list_tags, request, options: options do |response, operation|
@@ -2258,6 +2757,21 @@ module Google
2258
2757
  #
2259
2758
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2260
2759
  #
2760
+ # @example Basic example
2761
+ # require "google/cloud/data_catalog/v1"
2762
+ #
2763
+ # # Create a client object. The client can be reused for multiple calls.
2764
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2765
+ #
2766
+ # # Create a request. To set request fields, pass in keyword arguments.
2767
+ # request = Google::Iam::V1::SetIamPolicyRequest.new
2768
+ #
2769
+ # # Call the set_iam_policy method.
2770
+ # result = client.set_iam_policy request
2771
+ #
2772
+ # # The returned object is of type Google::Iam::V1::Policy.
2773
+ # p result
2774
+ #
2261
2775
  def set_iam_policy request, options = nil
2262
2776
  raise ::ArgumentError, "request must be provided" if request.nil?
2263
2777
 
@@ -2275,16 +2789,20 @@ module Google
2275
2789
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
2276
2790
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2277
2791
 
2278
- header_params = {
2279
- "resource" => request.resource
2280
- }
2792
+ header_params = {}
2793
+ if request.resource
2794
+ header_params["resource"] = request.resource
2795
+ end
2796
+
2281
2797
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2282
2798
  metadata[:"x-goog-request-params"] ||= request_params_header
2283
2799
 
2284
2800
  options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout,
2285
2801
  metadata: metadata,
2286
2802
  retry_policy: @config.rpcs.set_iam_policy.retry_policy
2287
- options.apply_defaults metadata: @config.metadata,
2803
+
2804
+ options.apply_defaults timeout: @config.timeout,
2805
+ metadata: @config.metadata,
2288
2806
  retry_policy: @config.retry_policy
2289
2807
 
2290
2808
  @data_catalog_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
@@ -2348,6 +2866,21 @@ module Google
2348
2866
  #
2349
2867
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2350
2868
  #
2869
+ # @example Basic example
2870
+ # require "google/cloud/data_catalog/v1"
2871
+ #
2872
+ # # Create a client object. The client can be reused for multiple calls.
2873
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2874
+ #
2875
+ # # Create a request. To set request fields, pass in keyword arguments.
2876
+ # request = Google::Iam::V1::GetIamPolicyRequest.new
2877
+ #
2878
+ # # Call the get_iam_policy method.
2879
+ # result = client.get_iam_policy request
2880
+ #
2881
+ # # The returned object is of type Google::Iam::V1::Policy.
2882
+ # p result
2883
+ #
2351
2884
  def get_iam_policy request, options = nil
2352
2885
  raise ::ArgumentError, "request must be provided" if request.nil?
2353
2886
 
@@ -2365,16 +2898,20 @@ module Google
2365
2898
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
2366
2899
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2367
2900
 
2368
- header_params = {
2369
- "resource" => request.resource
2370
- }
2901
+ header_params = {}
2902
+ if request.resource
2903
+ header_params["resource"] = request.resource
2904
+ end
2905
+
2371
2906
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2372
2907
  metadata[:"x-goog-request-params"] ||= request_params_header
2373
2908
 
2374
2909
  options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout,
2375
2910
  metadata: metadata,
2376
2911
  retry_policy: @config.rpcs.get_iam_policy.retry_policy
2377
- options.apply_defaults metadata: @config.metadata,
2912
+
2913
+ options.apply_defaults timeout: @config.timeout,
2914
+ metadata: @config.metadata,
2378
2915
  retry_policy: @config.retry_policy
2379
2916
 
2380
2917
  @data_catalog_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
@@ -2433,6 +2970,21 @@ module Google
2433
2970
  #
2434
2971
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2435
2972
  #
2973
+ # @example Basic example
2974
+ # require "google/cloud/data_catalog/v1"
2975
+ #
2976
+ # # Create a client object. The client can be reused for multiple calls.
2977
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2978
+ #
2979
+ # # Create a request. To set request fields, pass in keyword arguments.
2980
+ # request = Google::Iam::V1::TestIamPermissionsRequest.new
2981
+ #
2982
+ # # Call the test_iam_permissions method.
2983
+ # result = client.test_iam_permissions request
2984
+ #
2985
+ # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
2986
+ # p result
2987
+ #
2436
2988
  def test_iam_permissions request, options = nil
2437
2989
  raise ::ArgumentError, "request must be provided" if request.nil?
2438
2990
 
@@ -2450,16 +3002,20 @@ module Google
2450
3002
  gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
2451
3003
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2452
3004
 
2453
- header_params = {
2454
- "resource" => request.resource
2455
- }
3005
+ header_params = {}
3006
+ if request.resource
3007
+ header_params["resource"] = request.resource
3008
+ end
3009
+
2456
3010
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2457
3011
  metadata[:"x-goog-request-params"] ||= request_params_header
2458
3012
 
2459
3013
  options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout,
2460
3014
  metadata: metadata,
2461
3015
  retry_policy: @config.rpcs.test_iam_permissions.retry_policy
2462
- options.apply_defaults metadata: @config.metadata,
3016
+
3017
+ options.apply_defaults timeout: @config.timeout,
3018
+ metadata: @config.metadata,
2463
3019
  retry_policy: @config.retry_policy
2464
3020
 
2465
3021
  @data_catalog_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
@@ -2483,22 +3039,21 @@ module Google
2483
3039
  # Configuration can be applied globally to all clients, or to a single client
2484
3040
  # on construction.
2485
3041
  #
2486
- # # Examples
2487
- #
2488
- # To modify the global config, setting the timeout for search_catalog
2489
- # to 20 seconds, and all remaining timeouts to 10 seconds:
2490
- #
2491
- # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
2492
- # config.timeout = 10.0
2493
- # config.rpcs.search_catalog.timeout = 20.0
2494
- # end
2495
- #
2496
- # To apply the above configuration only to a new client:
2497
- #
2498
- # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
2499
- # config.timeout = 10.0
2500
- # config.rpcs.search_catalog.timeout = 20.0
2501
- # end
3042
+ # @example
3043
+ #
3044
+ # # Modify the global config, setting the timeout for
3045
+ # # search_catalog to 20 seconds,
3046
+ # # and all remaining timeouts to 10 seconds.
3047
+ # ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
3048
+ # config.timeout = 10.0
3049
+ # config.rpcs.search_catalog.timeout = 20.0
3050
+ # end
3051
+ #
3052
+ # # Apply the above configuration only to a new client.
3053
+ # client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
3054
+ # config.timeout = 10.0
3055
+ # config.rpcs.search_catalog.timeout = 20.0
3056
+ # end
2502
3057
  #
2503
3058
  # @!attribute [rw] endpoint
2504
3059
  # The hostname or hostname:port of the service endpoint.