google-cloud-data_catalog-v1 0.1.0 → 0.2.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8f0b9786e0ffc2237b2d359aabcb1f3957bf37e2f6615b1202e4dcb7754de45b
4
- data.tar.gz: 6398cd2868879dd7d79b3ed3b5bc684b7c28d17fca6f23aa50a2070d0acbde47
3
+ metadata.gz: 7f7f13c7d4dc8d8313bff38c4627394fbb91ab6892c2295cf817e1383a3c2d07
4
+ data.tar.gz: f946c788416bf43a30818918f779897c20c7861cb31e4ab8f48a5b6268845381
5
5
  SHA512:
6
- metadata.gz: ec08e2681f0faa34220c2c682e76278e48a04f514615a3122911b1c59c85a3e2ce1f3e8f0cddd65478df83a7f84df1ff51ad1fdc5ffc2d78d32fc35e8a8a1631
7
- data.tar.gz: 4b237c72130547949392ee9ea0d5b3fbf87faf2e93098e73017370f4e0695889a696debee1c83c4f8982523d2741cbd5bfd3d257a0fc6ad060895c8783874f35
6
+ metadata.gz: 5c0cb46651f54e9468964bdb07e24692e2955cb6b18405397d48fa6287160d97db57b2b07da0552527eb36ea9cf3bdda31669bbe0ed5ee83e1df4dd47c0ec892
7
+ data.tar.gz: c31640694c5d29e6e0f2a398e40683d2ffbbe6d134e2a0dc3f927cc955c92607037406c5b0c67f0bfb6170f061ac169c16e3d7bdbd51414ddde634eafa4a948a
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Data Catalog V1
1
+ # Ruby Client for the Data Catalog V1 API
2
2
 
3
3
  API Client library for the Data Catalog V1 API
4
4
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
12
12
  $ gem install google-cloud-data_catalog-v1
13
13
  ```
14
14
 
15
+ ## Before You Begin
16
+
17
+ In order to use this library, you first need to go through the following steps:
18
+
19
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
20
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
21
+ 1. {file:AUTHENTICATION.md Set up authentication.}
22
+
23
+ ## Quick Start
24
+
25
+ ```ruby
26
+ require "google/cloud/data_catalog/v1"
27
+
28
+ client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
29
+ request = my_create_request
30
+ response = client.search_catalog request
31
+ ```
32
+
33
+ View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-data_catalog-v1/latest)
34
+ for class and method documentation.
35
+
36
+ ## Enabling Logging
37
+
38
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
39
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
40
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
41
+ that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
42
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
43
+
44
+ Configuring a Ruby stdlib logger:
45
+
46
+ ```ruby
47
+ require "logger"
48
+
49
+ module MyLogger
50
+ LOGGER = Logger.new $stderr, level: Logger::WARN
51
+ def logger
52
+ LOGGER
53
+ end
54
+ end
55
+
56
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
57
+ module GRPC
58
+ extend MyLogger
59
+ end
60
+ ```
61
+
15
62
  ## Supported Ruby Versions
16
63
 
17
64
  This library is supported on Ruby 2.4+.
@@ -1 +1,21 @@
1
- require "google/cloud/data_catalog/v1/version"
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/data_catalog/v1"
@@ -17,3 +17,19 @@
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
19
  require "google/cloud/data_catalog/v1/data_catalog"
20
+ require "google/cloud/data_catalog/v1/version"
21
+
22
+ module Google
23
+ module Cloud
24
+ module DataCatalog
25
+ ##
26
+ # To load this package, including all its services, and instantiate a client:
27
+ #
28
+ # require "google/cloud/data_catalog/v1"
29
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
30
+ #
31
+ module V1
32
+ end
33
+ end
34
+ end
35
+ end
@@ -16,5 +16,35 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/data_catalog/v1/data_catalog/client"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/data_catalog/v1/version"
24
+
20
25
  require "google/cloud/data_catalog/v1/data_catalog/credentials"
26
+ require "google/cloud/data_catalog/v1/data_catalog/paths"
27
+ require "google/cloud/data_catalog/v1/data_catalog/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module DataCatalog
32
+ module V1
33
+ ##
34
+ # Data Catalog API service allows clients to discover, understand, and manage
35
+ # their data.
36
+ #
37
+ # To load this service and instantiate a client:
38
+ #
39
+ # require "google/cloud/data_catalog/v1/data_catalog"
40
+ # client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
41
+ #
42
+ module DataCatalog
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+
49
+ helper_path = ::File.join __dir__, "data_catalog", "helpers.rb"
50
+ require "google/cloud/data_catalog/v1/data_catalog/helpers" if ::File.file? helper_path
@@ -16,15 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/data_catalog/v1/version"
25
20
  require "google/cloud/datacatalog/v1/datacatalog_pb"
26
- require "google/cloud/data_catalog/v1/data_catalog/credentials"
27
- require "google/cloud/data_catalog/v1/data_catalog/paths"
28
21
 
29
22
  module Google
30
23
  module Cloud
@@ -235,27 +228,21 @@ module Google
235
228
  # Syntax](/data-catalog/docs/how-to/search-reference) for more information.
236
229
  #
237
230
  # @overload search_catalog(request, options = nil)
238
- # @param request [Google::Cloud::DataCatalog::V1::SearchCatalogRequest | Hash]
239
- # Searches Data Catalog for multiple resources like entries, tags that
240
- # match a query.
241
- #
242
- # This is a custom method
243
- # (https://cloud.google.com/apis/design/custom_methods) and does not return
244
- # the complete resource, only the resource identifier and high level
245
- # fields. Clients can subsequentally call `Get` methods.
246
- #
247
- # Note that Data Catalog search queries do not guarantee full recall. Query
248
- # results that match your query may not be returned, even in subsequent
249
- # result pages. Also note that results returned (and not returned) can vary
250
- # across repeated search queries.
231
+ # Pass arguments to `search_catalog` via a request object, either of type
232
+ # {Google::Cloud::DataCatalog::V1::SearchCatalogRequest} or an equivalent Hash.
251
233
  #
252
- # See [Data Catalog Search
253
- # Syntax](/data-catalog/docs/how-to/search-reference) for more information.
234
+ # @param request [Google::Cloud::DataCatalog::V1::SearchCatalogRequest, Hash]
235
+ # A request object representing the call parameters. Required. To specify no
236
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
254
237
  # @param options [Gapic::CallOptions, Hash]
255
238
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
256
239
  #
257
240
  # @overload search_catalog(scope: nil, query: nil, page_size: nil, page_token: nil, order_by: nil)
258
- # @param scope [Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope | Hash]
241
+ # Pass arguments to `search_catalog` via keyword arguments. Note that at
242
+ # least one keyword argument is required. To specify no parameters, or to keep all
243
+ # the default parameter values, pass an empty Hash as a request object (see above).
244
+ #
245
+ # @param scope [Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope, Hash]
259
246
  # Required. The scope of this search request. A `scope` that has empty
260
247
  # `include_org_ids`, `include_project_ids` AND false
261
248
  # `include_gcp_public_datasets` is considered invalid. Data Catalog will
@@ -292,7 +279,6 @@ module Google
292
279
  #
293
280
  # If not specified, defaults to `relevance` descending.
294
281
  #
295
- #
296
282
  # @yield [response, operation] Access the result along with the RPC operation
297
283
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::DataCatalog::V1::SearchCatalogResult>]
298
284
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -354,29 +340,20 @@ module Google
354
340
  # (/data-catalog/docs/concepts/resource-project) for more information).
355
341
  #
356
342
  # @overload create_entry_group(request, options = nil)
357
- # @param request [Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest | Hash]
358
- # Creates an EntryGroup.
343
+ # Pass arguments to `create_entry_group` via a request object, either of type
344
+ # {Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest} or an equivalent Hash.
359
345
  #
360
- # An entry group contains logically related entries together with Cloud
361
- # Identity and Access Management policies that specify the users who can
362
- # create, edit, and view entries within the entry group.
363
- #
364
- # Data Catalog automatically creates an entry group for BigQuery entries
365
- # ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry
366
- # group to contain Cloud Storage fileset entries or custom type entries,
367
- # and the IAM policies associated with those entries. Entry groups, like
368
- # entries, can be searched.
369
- #
370
- # A maximum of 10,000 entry groups may be created per organization across all
371
- # locations.
372
- #
373
- # Users should enable the Data Catalog API in the project identified by
374
- # the `parent` parameter (see [Data Catalog Resource Project]
375
- # (/data-catalog/docs/concepts/resource-project) for more information).
346
+ # @param request [Google::Cloud::DataCatalog::V1::CreateEntryGroupRequest, Hash]
347
+ # A request object representing the call parameters. Required. To specify no
348
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
376
349
  # @param options [Gapic::CallOptions, Hash]
377
350
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
378
351
  #
379
352
  # @overload create_entry_group(parent: nil, entry_group_id: nil, entry_group: nil)
353
+ # Pass arguments to `create_entry_group` via keyword arguments. Note that at
354
+ # least one keyword argument is required. To specify no parameters, or to keep all
355
+ # the default parameter values, pass an empty Hash as a request object (see above).
356
+ #
380
357
  # @param parent [String]
381
358
  # Required. The name of the project this entry group is in. Example:
382
359
  #
@@ -388,10 +365,9 @@ module Google
388
365
  # Required. The id of the entry group to create.
389
366
  # The id must begin with a letter or underscore, contain only English
390
367
  # letters, numbers and underscores, and be at most 64 characters.
391
- # @param entry_group [Google::Cloud::DataCatalog::V1::EntryGroup | Hash]
368
+ # @param entry_group [Google::Cloud::DataCatalog::V1::EntryGroup, Hash]
392
369
  # The entry group to create. Defaults to an empty entry group.
393
370
  #
394
- #
395
371
  # @yield [response, operation] Access the result along with the RPC operation
396
372
  # @yieldparam response [Google::Cloud::DataCatalog::V1::EntryGroup]
397
373
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -441,19 +417,26 @@ module Google
441
417
  # Gets an EntryGroup.
442
418
  #
443
419
  # @overload get_entry_group(request, options = nil)
444
- # @param request [Google::Cloud::DataCatalog::V1::GetEntryGroupRequest | Hash]
445
- # Gets an EntryGroup.
420
+ # Pass arguments to `get_entry_group` via a request object, either of type
421
+ # {Google::Cloud::DataCatalog::V1::GetEntryGroupRequest} or an equivalent Hash.
422
+ #
423
+ # @param request [Google::Cloud::DataCatalog::V1::GetEntryGroupRequest, Hash]
424
+ # A request object representing the call parameters. Required. To specify no
425
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
446
426
  # @param options [Gapic::CallOptions, Hash]
447
427
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
448
428
  #
449
429
  # @overload get_entry_group(name: nil, read_mask: nil)
430
+ # Pass arguments to `get_entry_group` via keyword arguments. Note that at
431
+ # least one keyword argument is required. To specify no parameters, or to keep all
432
+ # the default parameter values, pass an empty Hash as a request object (see above).
433
+ #
450
434
  # @param name [String]
451
435
  # Required. The name of the entry group. For example,
452
436
  # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
453
- # @param read_mask [Google::Protobuf::FieldMask | Hash]
437
+ # @param read_mask [Google::Protobuf::FieldMask, Hash]
454
438
  # The fields to return. If not set or empty, all fields are returned.
455
439
  #
456
- #
457
440
  # @yield [response, operation] Access the result along with the RPC operation
458
441
  # @yieldparam response [Google::Cloud::DataCatalog::V1::EntryGroup]
459
442
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -506,22 +489,26 @@ module Google
506
489
  # information).
507
490
  #
508
491
  # @overload update_entry_group(request, options = nil)
509
- # @param request [Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest | Hash]
510
- # Updates an EntryGroup. The user should enable the Data Catalog API in the
511
- # project identified by the `entry_group.name` parameter (see [Data Catalog
512
- # Resource Project] (/data-catalog/docs/concepts/resource-project) for more
513
- # information).
492
+ # Pass arguments to `update_entry_group` via a request object, either of type
493
+ # {Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest} or an equivalent Hash.
494
+ #
495
+ # @param request [Google::Cloud::DataCatalog::V1::UpdateEntryGroupRequest, Hash]
496
+ # A request object representing the call parameters. Required. To specify no
497
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
514
498
  # @param options [Gapic::CallOptions, Hash]
515
499
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
516
500
  #
517
501
  # @overload update_entry_group(entry_group: nil, update_mask: nil)
518
- # @param entry_group [Google::Cloud::DataCatalog::V1::EntryGroup | Hash]
502
+ # Pass arguments to `update_entry_group` via keyword arguments. Note that at
503
+ # least one keyword argument is required. To specify no parameters, or to keep all
504
+ # the default parameter values, pass an empty Hash as a request object (see above).
505
+ #
506
+ # @param entry_group [Google::Cloud::DataCatalog::V1::EntryGroup, Hash]
519
507
  # Required. The updated entry group. "name" field must be set.
520
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
508
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
521
509
  # The fields to update on the entry group. If absent or empty, all modifiable
522
510
  # fields are updated.
523
511
  #
524
- #
525
512
  # @yield [response, operation] Access the result along with the RPC operation
526
513
  # @yieldparam response [Google::Cloud::DataCatalog::V1::EntryGroup]
527
514
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -574,22 +561,26 @@ module Google
574
561
  # (/data-catalog/docs/concepts/resource-project) for more information).
575
562
  #
576
563
  # @overload delete_entry_group(request, options = nil)
577
- # @param request [Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest | Hash]
578
- # Deletes an EntryGroup. Only entry groups that do not contain entries can be
579
- # deleted. Users should enable the Data Catalog API in the project
580
- # identified by the `name` parameter (see [Data Catalog Resource Project]
581
- # (/data-catalog/docs/concepts/resource-project) for more information).
564
+ # Pass arguments to `delete_entry_group` via a request object, either of type
565
+ # {Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest} or an equivalent Hash.
566
+ #
567
+ # @param request [Google::Cloud::DataCatalog::V1::DeleteEntryGroupRequest, Hash]
568
+ # A request object representing the call parameters. Required. To specify no
569
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
582
570
  # @param options [Gapic::CallOptions, Hash]
583
571
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
584
572
  #
585
573
  # @overload delete_entry_group(name: nil, force: nil)
574
+ # Pass arguments to `delete_entry_group` via keyword arguments. Note that at
575
+ # least one keyword argument is required. To specify no parameters, or to keep all
576
+ # the default parameter values, pass an empty Hash as a request object (see above).
577
+ #
586
578
  # @param name [String]
587
579
  # Required. The name of the entry group. For example,
588
580
  # `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
589
581
  # @param force [Boolean]
590
582
  # Optional. If true, deletes all entries in the entry group.
591
583
  #
592
- #
593
584
  # @yield [response, operation] Access the result along with the RPC operation
594
585
  # @yieldparam response [Google::Protobuf::Empty]
595
586
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -639,12 +630,20 @@ module Google
639
630
  # Lists entry groups.
640
631
  #
641
632
  # @overload list_entry_groups(request, options = nil)
642
- # @param request [Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest | Hash]
643
- # Lists entry groups.
633
+ # Pass arguments to `list_entry_groups` via a request object, either of type
634
+ # {Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest} or an equivalent Hash.
635
+ #
636
+ # @param request [Google::Cloud::DataCatalog::V1::ListEntryGroupsRequest, Hash]
637
+ # A request object representing the call parameters. Required. To specify no
638
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
644
639
  # @param options [Gapic::CallOptions, Hash]
645
640
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
646
641
  #
647
642
  # @overload list_entry_groups(parent: nil, page_size: nil, page_token: nil)
643
+ # Pass arguments to `list_entry_groups` via keyword arguments. Note that at
644
+ # least one keyword argument is required. To specify no parameters, or to keep all
645
+ # the default parameter values, pass an empty Hash as a request object (see above).
646
+ #
648
647
  # @param parent [String]
649
648
  # Required. The name of the location that contains the entry groups, which can be
650
649
  # provided in URL format. Example:
@@ -657,7 +656,6 @@ module Google
657
656
  # Optional. Token that specifies which page is requested. If empty, the first page is
658
657
  # returned.
659
658
  #
660
- #
661
659
  # @yield [response, operation] Access the result along with the RPC operation
662
660
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::DataCatalog::V1::EntryGroup>]
663
661
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -715,19 +713,20 @@ module Google
715
713
  # A maximum of 100,000 entries may be created per entry group.
716
714
  #
717
715
  # @overload create_entry(request, options = nil)
718
- # @param request [Google::Cloud::DataCatalog::V1::CreateEntryRequest | Hash]
719
- # Creates an entry. Only entries of 'FILESET' type or user-specified type can
720
- # be created.
716
+ # Pass arguments to `create_entry` via a request object, either of type
717
+ # {Google::Cloud::DataCatalog::V1::CreateEntryRequest} or an equivalent Hash.
721
718
  #
722
- # Users should enable the Data Catalog API in the project identified by
723
- # the `parent` parameter (see [Data Catalog Resource Project]
724
- # (/data-catalog/docs/concepts/resource-project) for more information).
725
- #
726
- # A maximum of 100,000 entries may be created per entry group.
719
+ # @param request [Google::Cloud::DataCatalog::V1::CreateEntryRequest, Hash]
720
+ # A request object representing the call parameters. Required. To specify no
721
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
727
722
  # @param options [Gapic::CallOptions, Hash]
728
723
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
729
724
  #
730
725
  # @overload create_entry(parent: nil, entry_id: nil, entry: nil)
726
+ # Pass arguments to `create_entry` via keyword arguments. Note that at
727
+ # least one keyword argument is required. To specify no parameters, or to keep all
728
+ # the default parameter values, pass an empty Hash as a request object (see above).
729
+ #
731
730
  # @param parent [String]
732
731
  # Required. The name of the entry group this entry is in. Example:
733
732
  #
@@ -737,10 +736,9 @@ module Google
737
736
  # the location in this name.
738
737
  # @param entry_id [String]
739
738
  # Required. The id of the entry to create.
740
- # @param entry [Google::Cloud::DataCatalog::V1::Entry | Hash]
739
+ # @param entry [Google::Cloud::DataCatalog::V1::Entry, Hash]
741
740
  # Required. The entry to create.
742
741
  #
743
- #
744
742
  # @yield [response, operation] Access the result along with the RPC operation
745
743
  # @yieldparam response [Google::Cloud::DataCatalog::V1::Entry]
746
744
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -793,18 +791,23 @@ module Google
793
791
  # (/data-catalog/docs/concepts/resource-project) for more information).
794
792
  #
795
793
  # @overload update_entry(request, options = nil)
796
- # @param request [Google::Cloud::DataCatalog::V1::UpdateEntryRequest | Hash]
797
- # Updates an existing entry.
798
- # Users should enable the Data Catalog API in the project identified by
799
- # the `entry.name` parameter (see [Data Catalog Resource Project]
800
- # (/data-catalog/docs/concepts/resource-project) for more information).
794
+ # Pass arguments to `update_entry` via a request object, either of type
795
+ # {Google::Cloud::DataCatalog::V1::UpdateEntryRequest} or an equivalent Hash.
796
+ #
797
+ # @param request [Google::Cloud::DataCatalog::V1::UpdateEntryRequest, Hash]
798
+ # A request object representing the call parameters. Required. To specify no
799
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
801
800
  # @param options [Gapic::CallOptions, Hash]
802
801
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
803
802
  #
804
803
  # @overload update_entry(entry: nil, update_mask: nil)
805
- # @param entry [Google::Cloud::DataCatalog::V1::Entry | Hash]
804
+ # Pass arguments to `update_entry` via keyword arguments. Note that at
805
+ # least one keyword argument is required. To specify no parameters, or to keep all
806
+ # the default parameter values, pass an empty Hash as a request object (see above).
807
+ #
808
+ # @param entry [Google::Cloud::DataCatalog::V1::Entry, Hash]
806
809
  # Required. The updated entry. The "name" field must be set.
807
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
810
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
808
811
  # The fields to update on the entry. If absent or empty, all modifiable
809
812
  # fields are updated.
810
813
  #
@@ -826,7 +829,6 @@ module Google
826
829
  # * linked_resource
827
830
  # * source_system_timestamps
828
831
  #
829
- #
830
832
  # @yield [response, operation] Access the result along with the RPC operation
831
833
  # @yieldparam response [Google::Cloud::DataCatalog::V1::Entry]
832
834
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -881,23 +883,25 @@ module Google
881
883
  # (/data-catalog/docs/concepts/resource-project) for more information).
882
884
  #
883
885
  # @overload delete_entry(request, options = nil)
884
- # @param request [Google::Cloud::DataCatalog::V1::DeleteEntryRequest | Hash]
885
- # Deletes an existing entry. Only entries created through
886
- # {Google::Cloud::DataCatalog::V1::DataCatalog::Client#create_entry CreateEntry}
887
- # method can be deleted.
888
- # Users should enable the Data Catalog API in the project identified by
889
- # the `name` parameter (see [Data Catalog Resource Project]
890
- # (/data-catalog/docs/concepts/resource-project) for more information).
886
+ # Pass arguments to `delete_entry` via a request object, either of type
887
+ # {Google::Cloud::DataCatalog::V1::DeleteEntryRequest} or an equivalent Hash.
888
+ #
889
+ # @param request [Google::Cloud::DataCatalog::V1::DeleteEntryRequest, Hash]
890
+ # A request object representing the call parameters. Required. To specify no
891
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
891
892
  # @param options [Gapic::CallOptions, Hash]
892
893
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
893
894
  #
894
895
  # @overload delete_entry(name: nil)
896
+ # Pass arguments to `delete_entry` via keyword arguments. Note that at
897
+ # least one keyword argument is required. To specify no parameters, or to keep all
898
+ # the default parameter values, pass an empty Hash as a request object (see above).
899
+ #
895
900
  # @param name [String]
896
901
  # Required. The name of the entry. Example:
897
902
  #
898
903
  # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
899
904
  #
900
- #
901
905
  # @yield [response, operation] Access the result along with the RPC operation
902
906
  # @yieldparam response [Google::Protobuf::Empty]
903
907
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -947,18 +951,25 @@ module Google
947
951
  # Gets an entry.
948
952
  #
949
953
  # @overload get_entry(request, options = nil)
950
- # @param request [Google::Cloud::DataCatalog::V1::GetEntryRequest | Hash]
951
- # Gets an entry.
954
+ # Pass arguments to `get_entry` via a request object, either of type
955
+ # {Google::Cloud::DataCatalog::V1::GetEntryRequest} or an equivalent Hash.
956
+ #
957
+ # @param request [Google::Cloud::DataCatalog::V1::GetEntryRequest, Hash]
958
+ # A request object representing the call parameters. Required. To specify no
959
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
952
960
  # @param options [Gapic::CallOptions, Hash]
953
961
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
954
962
  #
955
963
  # @overload get_entry(name: nil)
964
+ # Pass arguments to `get_entry` via keyword arguments. Note that at
965
+ # least one keyword argument is required. To specify no parameters, or to keep all
966
+ # the default parameter values, pass an empty Hash as a request object (see above).
967
+ #
956
968
  # @param name [String]
957
969
  # Required. The name of the entry. Example:
958
970
  #
959
971
  # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}
960
972
  #
961
- #
962
973
  # @yield [response, operation] Access the result along with the RPC operation
963
974
  # @yieldparam response [Google::Cloud::DataCatalog::V1::Entry]
964
975
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1010,14 +1021,20 @@ module Google
1010
1021
  # Data Catalog Entry.
1011
1022
  #
1012
1023
  # @overload lookup_entry(request, options = nil)
1013
- # @param request [Google::Cloud::DataCatalog::V1::LookupEntryRequest | Hash]
1014
- # Get an entry by target resource name. This method allows clients to use
1015
- # the resource name from the source Google Cloud Platform service to get the
1016
- # Data Catalog Entry.
1024
+ # Pass arguments to `lookup_entry` via a request object, either of type
1025
+ # {Google::Cloud::DataCatalog::V1::LookupEntryRequest} or an equivalent Hash.
1026
+ #
1027
+ # @param request [Google::Cloud::DataCatalog::V1::LookupEntryRequest, Hash]
1028
+ # A request object representing the call parameters. Required. To specify no
1029
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1017
1030
  # @param options [Gapic::CallOptions, Hash]
1018
1031
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1019
1032
  #
1020
1033
  # @overload lookup_entry(linked_resource: nil, sql_resource: nil)
1034
+ # Pass arguments to `lookup_entry` via keyword arguments. Note that at
1035
+ # least one keyword argument is required. To specify no parameters, or to keep all
1036
+ # the default parameter values, pass an empty Hash as a request object (see above).
1037
+ #
1021
1038
  # @param linked_resource [String]
1022
1039
  # The full name of the Google Cloud Platform resource the Data Catalog
1023
1040
  # entry represents. See:
@@ -1042,7 +1059,6 @@ module Google
1042
1059
  # `*_id`s shoud satisfy the standard SQL rules for identifiers.
1043
1060
  # https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.
1044
1061
  #
1045
- #
1046
1062
  # @yield [response, operation] Access the result along with the RPC operation
1047
1063
  # @yieldparam response [Google::Cloud::DataCatalog::V1::Entry]
1048
1064
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1086,12 +1102,20 @@ module Google
1086
1102
  # Lists entries.
1087
1103
  #
1088
1104
  # @overload list_entries(request, options = nil)
1089
- # @param request [Google::Cloud::DataCatalog::V1::ListEntriesRequest | Hash]
1090
- # Lists entries.
1105
+ # Pass arguments to `list_entries` via a request object, either of type
1106
+ # {Google::Cloud::DataCatalog::V1::ListEntriesRequest} or an equivalent Hash.
1107
+ #
1108
+ # @param request [Google::Cloud::DataCatalog::V1::ListEntriesRequest, Hash]
1109
+ # A request object representing the call parameters. Required. To specify no
1110
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1091
1111
  # @param options [Gapic::CallOptions, Hash]
1092
1112
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1093
1113
  #
1094
1114
  # @overload list_entries(parent: nil, page_size: nil, page_token: nil, read_mask: nil)
1115
+ # Pass arguments to `list_entries` via keyword arguments. Note that at
1116
+ # least one keyword argument is required. To specify no parameters, or to keep all
1117
+ # the default parameter values, pass an empty Hash as a request object (see above).
1118
+ #
1095
1119
  # @param parent [String]
1096
1120
  # Required. The name of the entry group that contains the entries, which can
1097
1121
  # be provided in URL format. Example:
@@ -1103,13 +1127,12 @@ module Google
1103
1127
  # @param page_token [String]
1104
1128
  # Token that specifies which page is requested. If empty, the first page is
1105
1129
  # returned.
1106
- # @param read_mask [Google::Protobuf::FieldMask | Hash]
1130
+ # @param read_mask [Google::Protobuf::FieldMask, Hash]
1107
1131
  # The fields to return for each Entry. If not set or empty, all
1108
1132
  # fields are returned.
1109
1133
  # For example, setting read_mask to contain only one path "name" will cause
1110
1134
  # ListEntries to return a list of Entries with only "name" field.
1111
1135
  #
1112
- #
1113
1136
  # @yield [response, operation] Access the result along with the RPC operation
1114
1137
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::DataCatalog::V1::Entry>]
1115
1138
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1163,15 +1186,20 @@ module Google
1163
1186
  # information).
1164
1187
  #
1165
1188
  # @overload create_tag_template(request, options = nil)
1166
- # @param request [Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest | Hash]
1167
- # Creates a tag template. The user should enable the Data Catalog API in
1168
- # the project identified by the `parent` parameter (see [Data Catalog
1169
- # Resource Project](/data-catalog/docs/concepts/resource-project) for more
1170
- # information).
1189
+ # Pass arguments to `create_tag_template` via a request object, either of type
1190
+ # {Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest} or an equivalent Hash.
1191
+ #
1192
+ # @param request [Google::Cloud::DataCatalog::V1::CreateTagTemplateRequest, Hash]
1193
+ # A request object representing the call parameters. Required. To specify no
1194
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1171
1195
  # @param options [Gapic::CallOptions, Hash]
1172
1196
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1173
1197
  #
1174
1198
  # @overload create_tag_template(parent: nil, tag_template_id: nil, tag_template: nil)
1199
+ # Pass arguments to `create_tag_template` via keyword arguments. Note that at
1200
+ # least one keyword argument is required. To specify no parameters, or to keep all
1201
+ # the default parameter values, pass an empty Hash as a request object (see above).
1202
+ #
1175
1203
  # @param parent [String]
1176
1204
  # Required. The name of the project and the template location
1177
1205
  # [region](/compute/docs/regions-zones/#available).
@@ -1182,10 +1210,9 @@ module Google
1182
1210
  # * projects/\\{project_id}/locations/us-central1
1183
1211
  # @param tag_template_id [String]
1184
1212
  # Required. The id of the tag template to create.
1185
- # @param tag_template [Google::Cloud::DataCatalog::V1::TagTemplate | Hash]
1213
+ # @param tag_template [Google::Cloud::DataCatalog::V1::TagTemplate, Hash]
1186
1214
  # Required. The tag template to create.
1187
1215
  #
1188
- #
1189
1216
  # @yield [response, operation] Access the result along with the RPC operation
1190
1217
  # @yieldparam response [Google::Cloud::DataCatalog::V1::TagTemplate]
1191
1218
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1235,18 +1262,25 @@ module Google
1235
1262
  # Gets a tag template.
1236
1263
  #
1237
1264
  # @overload get_tag_template(request, options = nil)
1238
- # @param request [Google::Cloud::DataCatalog::V1::GetTagTemplateRequest | Hash]
1239
- # Gets a tag template.
1265
+ # Pass arguments to `get_tag_template` via a request object, either of type
1266
+ # {Google::Cloud::DataCatalog::V1::GetTagTemplateRequest} or an equivalent Hash.
1267
+ #
1268
+ # @param request [Google::Cloud::DataCatalog::V1::GetTagTemplateRequest, Hash]
1269
+ # A request object representing the call parameters. Required. To specify no
1270
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1240
1271
  # @param options [Gapic::CallOptions, Hash]
1241
1272
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1242
1273
  #
1243
1274
  # @overload get_tag_template(name: nil)
1275
+ # Pass arguments to `get_tag_template` via keyword arguments. Note that at
1276
+ # least one keyword argument is required. To specify no parameters, or to keep all
1277
+ # the default parameter values, pass an empty Hash as a request object (see above).
1278
+ #
1244
1279
  # @param name [String]
1245
1280
  # Required. The name of the tag template. Example:
1246
1281
  #
1247
1282
  # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
1248
1283
  #
1249
- #
1250
1284
  # @yield [response, operation] Access the result along with the RPC operation
1251
1285
  # @yieldparam response [Google::Cloud::DataCatalog::V1::TagTemplate]
1252
1286
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1301,20 +1335,23 @@ module Google
1301
1335
  # (/data-catalog/docs/concepts/resource-project) for more information).
1302
1336
  #
1303
1337
  # @overload update_tag_template(request, options = nil)
1304
- # @param request [Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest | Hash]
1305
- # Updates a tag template. This method cannot be used to update the fields of
1306
- # a template. The tag template fields are represented as separate resources
1307
- # and should be updated using their own create/update/delete methods.
1308
- # Users should enable the Data Catalog API in the project identified by
1309
- # the `tag_template.name` parameter (see [Data Catalog Resource Project]
1310
- # (/data-catalog/docs/concepts/resource-project) for more information).
1338
+ # Pass arguments to `update_tag_template` via a request object, either of type
1339
+ # {Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest} or an equivalent Hash.
1340
+ #
1341
+ # @param request [Google::Cloud::DataCatalog::V1::UpdateTagTemplateRequest, Hash]
1342
+ # A request object representing the call parameters. Required. To specify no
1343
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1311
1344
  # @param options [Gapic::CallOptions, Hash]
1312
1345
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1313
1346
  #
1314
1347
  # @overload update_tag_template(tag_template: nil, update_mask: nil)
1315
- # @param tag_template [Google::Cloud::DataCatalog::V1::TagTemplate | Hash]
1348
+ # Pass arguments to `update_tag_template` via keyword arguments. Note that at
1349
+ # least one keyword argument is required. To specify no parameters, or to keep all
1350
+ # the default parameter values, pass an empty Hash as a request object (see above).
1351
+ #
1352
+ # @param tag_template [Google::Cloud::DataCatalog::V1::TagTemplate, Hash]
1316
1353
  # Required. The template to update. The "name" field must be set.
1317
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
1354
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
1318
1355
  # The field mask specifies the parts of the template to overwrite.
1319
1356
  #
1320
1357
  # Allowed fields:
@@ -1323,7 +1360,6 @@ module Google
1323
1360
  #
1324
1361
  # If absent or empty, all of the allowed fields above will be updated.
1325
1362
  #
1326
- #
1327
1363
  # @yield [response, operation] Access the result along with the RPC operation
1328
1364
  # @yieldparam response [Google::Cloud::DataCatalog::V1::TagTemplate]
1329
1365
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1376,15 +1412,20 @@ module Google
1376
1412
  # (/data-catalog/docs/concepts/resource-project) for more information).
1377
1413
  #
1378
1414
  # @overload delete_tag_template(request, options = nil)
1379
- # @param request [Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest | Hash]
1380
- # Deletes a tag template and all tags using the template.
1381
- # Users should enable the Data Catalog API in the project identified by
1382
- # the `name` parameter (see [Data Catalog Resource Project]
1383
- # (/data-catalog/docs/concepts/resource-project) for more information).
1415
+ # Pass arguments to `delete_tag_template` via a request object, either of type
1416
+ # {Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest} or an equivalent Hash.
1417
+ #
1418
+ # @param request [Google::Cloud::DataCatalog::V1::DeleteTagTemplateRequest, Hash]
1419
+ # A request object representing the call parameters. Required. To specify no
1420
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1384
1421
  # @param options [Gapic::CallOptions, Hash]
1385
1422
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1386
1423
  #
1387
1424
  # @overload delete_tag_template(name: nil, force: nil)
1425
+ # Pass arguments to `delete_tag_template` via keyword arguments. Note that at
1426
+ # least one keyword argument is required. To specify no parameters, or to keep all
1427
+ # the default parameter values, pass an empty Hash as a request object (see above).
1428
+ #
1388
1429
  # @param name [String]
1389
1430
  # Required. The name of the tag template to delete. Example:
1390
1431
  #
@@ -1394,7 +1435,6 @@ module Google
1394
1435
  # This confirms the deletion of any possible tags using this template.
1395
1436
  # `force = false` will be supported in the future.
1396
1437
  #
1397
- #
1398
1438
  # @yield [response, operation] Access the result along with the RPC operation
1399
1439
  # @yieldparam response [Google::Protobuf::Empty]
1400
1440
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1448,16 +1488,20 @@ module Google
1448
1488
  # information).
1449
1489
  #
1450
1490
  # @overload create_tag_template_field(request, options = nil)
1451
- # @param request [Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest | Hash]
1452
- # Creates a field in a tag template. The user should enable the Data Catalog
1453
- # API in the project identified by the `parent` parameter (see
1454
- # [Data Catalog Resource
1455
- # Project](/data-catalog/docs/concepts/resource-project) for more
1456
- # information).
1491
+ # Pass arguments to `create_tag_template_field` via a request object, either of type
1492
+ # {Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest} or an equivalent Hash.
1493
+ #
1494
+ # @param request [Google::Cloud::DataCatalog::V1::CreateTagTemplateFieldRequest, 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.
1457
1497
  # @param options [Gapic::CallOptions, Hash]
1458
1498
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1459
1499
  #
1460
1500
  # @overload create_tag_template_field(parent: nil, tag_template_field_id: nil, tag_template_field: nil)
1501
+ # Pass arguments to `create_tag_template_field` 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).
1504
+ #
1461
1505
  # @param parent [String]
1462
1506
  # Required. The name of the project and the template location
1463
1507
  # [region](/compute/docs/regions-zones/#available).
@@ -1472,10 +1516,9 @@ module Google
1472
1516
  # (0-9), underscores (_) and dashes (-). Field IDs must be at least 1
1473
1517
  # character long and at most 128 characters long. Field IDs must also be
1474
1518
  # unique within their template.
1475
- # @param tag_template_field [Google::Cloud::DataCatalog::V1::TagTemplateField | Hash]
1519
+ # @param tag_template_field [Google::Cloud::DataCatalog::V1::TagTemplateField, Hash]
1476
1520
  # Required. The tag template field to create.
1477
1521
  #
1478
- #
1479
1522
  # @yield [response, operation] Access the result along with the RPC operation
1480
1523
  # @yieldparam response [Google::Cloud::DataCatalog::V1::TagTemplateField]
1481
1524
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1528,22 +1571,27 @@ module Google
1528
1571
  # (/data-catalog/docs/concepts/resource-project) for more information).
1529
1572
  #
1530
1573
  # @overload update_tag_template_field(request, options = nil)
1531
- # @param request [Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest | Hash]
1532
- # Updates a field in a tag template. This method cannot be used to update the
1533
- # field type. Users should enable the Data Catalog API in the project
1534
- # identified by the `name` parameter (see [Data Catalog Resource Project]
1535
- # (/data-catalog/docs/concepts/resource-project) for more information).
1574
+ # Pass arguments to `update_tag_template_field` via a request object, either of type
1575
+ # {Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest} or an equivalent Hash.
1576
+ #
1577
+ # @param request [Google::Cloud::DataCatalog::V1::UpdateTagTemplateFieldRequest, Hash]
1578
+ # A request object representing the call parameters. Required. To specify no
1579
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1536
1580
  # @param options [Gapic::CallOptions, Hash]
1537
1581
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1538
1582
  #
1539
1583
  # @overload update_tag_template_field(name: nil, tag_template_field: nil, update_mask: nil)
1584
+ # Pass arguments to `update_tag_template_field` via keyword arguments. Note that at
1585
+ # least one keyword argument is required. To specify no parameters, or to keep all
1586
+ # the default parameter values, pass an empty Hash as a request object (see above).
1587
+ #
1540
1588
  # @param name [String]
1541
1589
  # Required. The name of the tag template field. Example:
1542
1590
  #
1543
1591
  # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}/fields/\\{tag_template_field_id}
1544
- # @param tag_template_field [Google::Cloud::DataCatalog::V1::TagTemplateField | Hash]
1592
+ # @param tag_template_field [Google::Cloud::DataCatalog::V1::TagTemplateField, Hash]
1545
1593
  # Required. The template to update.
1546
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
1594
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
1547
1595
  # Optional. The field mask specifies the parts of the template to be updated.
1548
1596
  # Allowed fields:
1549
1597
  #
@@ -1559,7 +1607,6 @@ module Google
1559
1607
  # values cannot be deleted nor renamed. Updating a template field from
1560
1608
  # optional to required is NOT allowed.
1561
1609
  #
1562
- #
1563
1610
  # @yield [response, operation] Access the result along with the RPC operation
1564
1611
  # @yieldparam response [Google::Cloud::DataCatalog::V1::TagTemplateField]
1565
1612
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1612,15 +1659,20 @@ module Google
1612
1659
  # information).
1613
1660
  #
1614
1661
  # @overload rename_tag_template_field(request, options = nil)
1615
- # @param request [Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest | Hash]
1616
- # Renames a field in a tag template. The user should enable the Data Catalog
1617
- # API in the project identified by the `name` parameter (see [Data Catalog
1618
- # Resource Project](/data-catalog/docs/concepts/resource-project) for more
1619
- # information).
1662
+ # Pass arguments to `rename_tag_template_field` via a request object, either of type
1663
+ # {Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest} or an equivalent Hash.
1664
+ #
1665
+ # @param request [Google::Cloud::DataCatalog::V1::RenameTagTemplateFieldRequest, Hash]
1666
+ # A request object representing the call parameters. Required. To specify no
1667
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1620
1668
  # @param options [Gapic::CallOptions, Hash]
1621
1669
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1622
1670
  #
1623
1671
  # @overload rename_tag_template_field(name: nil, new_tag_template_field_id: nil)
1672
+ # Pass arguments to `rename_tag_template_field` via keyword arguments. Note that at
1673
+ # least one keyword argument is required. To specify no parameters, or to keep all
1674
+ # the default parameter values, pass an empty Hash as a request object (see above).
1675
+ #
1624
1676
  # @param name [String]
1625
1677
  # Required. The name of the tag template. Example:
1626
1678
  #
@@ -1628,7 +1680,6 @@ module Google
1628
1680
  # @param new_tag_template_field_id [String]
1629
1681
  # Required. The new ID of this tag template field. For example, `my_new_field`.
1630
1682
  #
1631
- #
1632
1683
  # @yield [response, operation] Access the result along with the RPC operation
1633
1684
  # @yieldparam response [Google::Cloud::DataCatalog::V1::TagTemplateField]
1634
1685
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1681,15 +1732,20 @@ module Google
1681
1732
  # (/data-catalog/docs/concepts/resource-project) for more information).
1682
1733
  #
1683
1734
  # @overload delete_tag_template_field(request, options = nil)
1684
- # @param request [Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest | Hash]
1685
- # Deletes a field in a tag template and all uses of that field.
1686
- # Users should enable the Data Catalog API in the project identified by
1687
- # the `name` parameter (see [Data Catalog Resource Project]
1688
- # (/data-catalog/docs/concepts/resource-project) for more information).
1735
+ # Pass arguments to `delete_tag_template_field` via a request object, either of type
1736
+ # {Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest} or an equivalent Hash.
1737
+ #
1738
+ # @param request [Google::Cloud::DataCatalog::V1::DeleteTagTemplateFieldRequest, Hash]
1739
+ # A request object representing the call parameters. Required. To specify no
1740
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1689
1741
  # @param options [Gapic::CallOptions, Hash]
1690
1742
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1691
1743
  #
1692
1744
  # @overload delete_tag_template_field(name: nil, force: nil)
1745
+ # Pass arguments to `delete_tag_template_field` via keyword arguments. Note that at
1746
+ # least one keyword argument is required. To specify no parameters, or to keep all
1747
+ # the default parameter values, pass an empty Hash as a request object (see above).
1748
+ #
1693
1749
  # @param name [String]
1694
1750
  # Required. The name of the tag template field to delete. Example:
1695
1751
  #
@@ -1699,7 +1755,6 @@ module Google
1699
1755
  # This confirms the deletion of this field from any tags using this field.
1700
1756
  # `force = false` will be supported in the future.
1701
1757
  #
1702
- #
1703
1758
  # @yield [response, operation] Access the result along with the RPC operation
1704
1759
  # @yieldparam response [Google::Protobuf::Empty]
1705
1760
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1755,18 +1810,20 @@ module Google
1755
1810
  # used to create the tag must be from the same organization.
1756
1811
  #
1757
1812
  # @overload create_tag(request, options = nil)
1758
- # @param request [Google::Cloud::DataCatalog::V1::CreateTagRequest | Hash]
1759
- # Creates a tag on an {Google::Cloud::DataCatalog::V1::Entry Entry}.
1760
- # Note: The project identified by the `parent` parameter for the
1761
- # [tag](/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
1762
- # and the
1763
- # [tag
1764
- # template](/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
1765
- # used to create the tag must be from the same organization.
1813
+ # Pass arguments to `create_tag` via a request object, either of type
1814
+ # {Google::Cloud::DataCatalog::V1::CreateTagRequest} or an equivalent Hash.
1815
+ #
1816
+ # @param request [Google::Cloud::DataCatalog::V1::CreateTagRequest, Hash]
1817
+ # A request object representing the call parameters. Required. To specify no
1818
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1766
1819
  # @param options [Gapic::CallOptions, Hash]
1767
1820
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1768
1821
  #
1769
1822
  # @overload create_tag(parent: nil, tag: nil)
1823
+ # Pass arguments to `create_tag` via keyword arguments. Note that at
1824
+ # least one keyword argument is required. To specify no parameters, or to keep all
1825
+ # the default parameter values, pass an empty Hash as a request object (see above).
1826
+ #
1770
1827
  # @param parent [String]
1771
1828
  # Required. The name of the resource to attach this tag to. Tags can be attached to
1772
1829
  # Entries. Example:
@@ -1775,10 +1832,9 @@ module Google
1775
1832
  #
1776
1833
  # Note that this Tag and its child resources may not actually be stored in
1777
1834
  # the location in this name.
1778
- # @param tag [Google::Cloud::DataCatalog::V1::Tag | Hash]
1835
+ # @param tag [Google::Cloud::DataCatalog::V1::Tag, Hash]
1779
1836
  # Required. The tag to create.
1780
1837
  #
1781
- #
1782
1838
  # @yield [response, operation] Access the result along with the RPC operation
1783
1839
  # @yieldparam response [Google::Cloud::DataCatalog::V1::Tag]
1784
1840
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1828,19 +1884,26 @@ module Google
1828
1884
  # Updates an existing tag.
1829
1885
  #
1830
1886
  # @overload update_tag(request, options = nil)
1831
- # @param request [Google::Cloud::DataCatalog::V1::UpdateTagRequest | Hash]
1832
- # Updates an existing tag.
1887
+ # Pass arguments to `update_tag` via a request object, either of type
1888
+ # {Google::Cloud::DataCatalog::V1::UpdateTagRequest} or an equivalent Hash.
1889
+ #
1890
+ # @param request [Google::Cloud::DataCatalog::V1::UpdateTagRequest, Hash]
1891
+ # A request object representing the call parameters. Required. To specify no
1892
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1833
1893
  # @param options [Gapic::CallOptions, Hash]
1834
1894
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1835
1895
  #
1836
1896
  # @overload update_tag(tag: nil, update_mask: nil)
1837
- # @param tag [Google::Cloud::DataCatalog::V1::Tag | Hash]
1897
+ # Pass arguments to `update_tag` via keyword arguments. Note that at
1898
+ # least one keyword argument is required. To specify no parameters, or to keep all
1899
+ # the default parameter values, pass an empty Hash as a request object (see above).
1900
+ #
1901
+ # @param tag [Google::Cloud::DataCatalog::V1::Tag, Hash]
1838
1902
  # Required. The updated tag. The "name" field must be set.
1839
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
1903
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
1840
1904
  # The fields to update on the Tag. If absent or empty, all modifiable fields
1841
1905
  # are updated. Currently the only modifiable field is the field `fields`.
1842
1906
  #
1843
- #
1844
1907
  # @yield [response, operation] Access the result along with the RPC operation
1845
1908
  # @yieldparam response [Google::Cloud::DataCatalog::V1::Tag]
1846
1909
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1890,18 +1953,25 @@ module Google
1890
1953
  # Deletes a tag.
1891
1954
  #
1892
1955
  # @overload delete_tag(request, options = nil)
1893
- # @param request [Google::Cloud::DataCatalog::V1::DeleteTagRequest | Hash]
1894
- # Deletes a tag.
1956
+ # Pass arguments to `delete_tag` via a request object, either of type
1957
+ # {Google::Cloud::DataCatalog::V1::DeleteTagRequest} or an equivalent Hash.
1958
+ #
1959
+ # @param request [Google::Cloud::DataCatalog::V1::DeleteTagRequest, Hash]
1960
+ # A request object representing the call parameters. Required. To specify no
1961
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1895
1962
  # @param options [Gapic::CallOptions, Hash]
1896
1963
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1897
1964
  #
1898
1965
  # @overload delete_tag(name: nil)
1966
+ # Pass arguments to `delete_tag` via keyword arguments. Note that at
1967
+ # least one keyword argument is required. To specify no parameters, or to keep all
1968
+ # the default parameter values, pass an empty Hash as a request object (see above).
1969
+ #
1899
1970
  # @param name [String]
1900
1971
  # Required. The name of the tag to delete. Example:
1901
1972
  #
1902
1973
  # * projects/\\{project_id}/locations/\\{location}/entryGroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
1903
1974
  #
1904
- #
1905
1975
  # @yield [response, operation] Access the result along with the RPC operation
1906
1976
  # @yieldparam response [Google::Protobuf::Empty]
1907
1977
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1951,12 +2021,20 @@ module Google
1951
2021
  # Lists the tags on an {Google::Cloud::DataCatalog::V1::Entry Entry}.
1952
2022
  #
1953
2023
  # @overload list_tags(request, options = nil)
1954
- # @param request [Google::Cloud::DataCatalog::V1::ListTagsRequest | Hash]
1955
- # Lists the tags on an {Google::Cloud::DataCatalog::V1::Entry Entry}.
2024
+ # Pass arguments to `list_tags` via a request object, either of type
2025
+ # {Google::Cloud::DataCatalog::V1::ListTagsRequest} or an equivalent Hash.
2026
+ #
2027
+ # @param request [Google::Cloud::DataCatalog::V1::ListTagsRequest, Hash]
2028
+ # A request object representing the call parameters. Required. To specify no
2029
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1956
2030
  # @param options [Gapic::CallOptions, Hash]
1957
2031
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1958
2032
  #
1959
2033
  # @overload list_tags(parent: nil, page_size: nil, page_token: nil)
2034
+ # Pass arguments to `list_tags` via keyword arguments. Note that at
2035
+ # least one keyword argument is required. To specify no parameters, or to keep all
2036
+ # the default parameter values, pass an empty Hash as a request object (see above).
2037
+ #
1960
2038
  # @param parent [String]
1961
2039
  # Required. The name of the Data Catalog resource to list the tags of. The resource
1962
2040
  # could be an {Google::Cloud::DataCatalog::V1::Entry Entry} or an
@@ -1972,7 +2050,6 @@ module Google
1972
2050
  # Token that specifies which page is requested. If empty, the first page is
1973
2051
  # returned.
1974
2052
  #
1975
- #
1976
2053
  # @yield [response, operation] Access the result along with the RPC operation
1977
2054
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::DataCatalog::V1::Tag>]
1978
2055
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -2036,36 +2113,29 @@ module Google
2036
2113
  # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
2037
2114
  #
2038
2115
  # @overload set_iam_policy(request, options = nil)
2039
- # @param request [Google::Iam::V1::SetIamPolicyRequest | Hash]
2040
- # Sets the access control policy for a resource. Replaces any existing
2041
- # policy.
2042
- # Supported resources are:
2043
- # - Tag templates.
2044
- # - Entries.
2045
- # - Entry groups.
2046
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2047
- # and any external Google Cloud Platform resources synced to Data Catalog.
2048
- #
2049
- # Callers must have following Google IAM permission
2050
- # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
2051
- # templates.
2052
- # - `datacatalog.entries.setIamPolicy` to set policies on entries.
2053
- # - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
2116
+ # Pass arguments to `set_iam_policy` via a request object, either of type
2117
+ # {Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
2118
+ #
2119
+ # @param request [Google::Iam::V1::SetIamPolicyRequest, Hash]
2120
+ # A request object representing the call parameters. Required. To specify no
2121
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2054
2122
  # @param options [Gapic::CallOptions, Hash]
2055
2123
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2056
2124
  #
2057
2125
  # @overload set_iam_policy(resource: nil, policy: nil)
2126
+ # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
2127
+ # least one keyword argument is required. To specify no parameters, or to keep all
2128
+ # the default parameter values, pass an empty Hash as a request object (see above).
2129
+ #
2058
2130
  # @param resource [String]
2059
2131
  # REQUIRED: The resource for which the policy is being specified.
2060
- # `resource` is usually specified as a path. For example, a Project
2061
- # resource is specified as `projects/{project}`.
2062
- # @param policy [Google::Iam::V1::Policy | Hash]
2132
+ # See the operation documentation for the appropriate value for this field.
2133
+ # @param policy [Google::Iam::V1::Policy, Hash]
2063
2134
  # REQUIRED: The complete policy to be applied to the `resource`. The size of
2064
2135
  # the policy is limited to a few 10s of KB. An empty policy is a
2065
2136
  # valid policy but certain Cloud Platform services (such as Projects)
2066
2137
  # might reject them.
2067
2138
  #
2068
- #
2069
2139
  # @yield [response, operation] Access the result along with the RPC operation
2070
2140
  # @yieldparam response [Google::Iam::V1::Policy]
2071
2141
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -2130,32 +2200,26 @@ module Google
2130
2200
  # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
2131
2201
  #
2132
2202
  # @overload get_iam_policy(request, options = nil)
2133
- # @param request [Google::Iam::V1::GetIamPolicyRequest | Hash]
2134
- # Gets the access control policy for a resource. A `NOT_FOUND` error
2135
- # is returned if the resource does not exist. An empty policy is returned
2136
- # if the resource exists but does not have a policy set on it.
2137
- #
2138
- # Supported resources are:
2139
- # - Tag templates.
2140
- # - Entries.
2141
- # - Entry groups.
2142
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2143
- # and any external Google Cloud Platform resources synced to Data Catalog.
2144
- #
2145
- # Callers must have following Google IAM permission
2146
- # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
2147
- # templates.
2148
- # - `datacatalog.entries.getIamPolicy` to get policies on entries.
2149
- # - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
2203
+ # Pass arguments to `get_iam_policy` via a request object, either of type
2204
+ # {Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
2205
+ #
2206
+ # @param request [Google::Iam::V1::GetIamPolicyRequest, Hash]
2207
+ # A request object representing the call parameters. Required. To specify no
2208
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2150
2209
  # @param options [Gapic::CallOptions, Hash]
2151
2210
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2152
2211
  #
2153
- # @overload get_iam_policy(resource: nil)
2212
+ # @overload get_iam_policy(resource: nil, options: nil)
2213
+ # Pass arguments to `get_iam_policy` via keyword arguments. Note that at
2214
+ # least one keyword argument is required. To specify no parameters, or to keep all
2215
+ # the default parameter values, pass an empty Hash as a request object (see above).
2216
+ #
2154
2217
  # @param resource [String]
2155
2218
  # REQUIRED: The resource for which the policy is being requested.
2156
- # `resource` is usually specified as a path. For example, a Project
2157
- # resource is specified as `projects/{project}`.
2158
- #
2219
+ # See the operation documentation for the appropriate value for this field.
2220
+ # @param options [Google::Iam::V1::GetPolicyOptions, Hash]
2221
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
2222
+ # `GetIamPolicy`. This field is only used by Cloud IAM.
2159
2223
  #
2160
2224
  # @yield [response, operation] Access the result along with the RPC operation
2161
2225
  # @yieldparam response [Google::Iam::V1::Policy]
@@ -2218,35 +2282,29 @@ module Google
2218
2282
  # request.
2219
2283
  #
2220
2284
  # @overload test_iam_permissions(request, options = nil)
2221
- # @param request [Google::Iam::V1::TestIamPermissionsRequest | Hash]
2222
- # Returns the caller's permissions on a resource.
2223
- # If the resource does not exist, an empty set of permissions is returned
2224
- # (We don't return a `NOT_FOUND` error).
2225
- #
2226
- # Supported resources are:
2227
- # - Tag templates.
2228
- # - Entries.
2229
- # - Entry groups.
2230
- # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
2231
- # and any external Google Cloud Platform resources synced to Data Catalog.
2232
- #
2233
- # A caller is not required to have Google IAM permission to make this
2234
- # request.
2285
+ # Pass arguments to `test_iam_permissions` via a request object, either of type
2286
+ # {Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash.
2287
+ #
2288
+ # @param request [Google::Iam::V1::TestIamPermissionsRequest, Hash]
2289
+ # A request object representing the call parameters. Required. To specify no
2290
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2235
2291
  # @param options [Gapic::CallOptions, Hash]
2236
2292
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2237
2293
  #
2238
2294
  # @overload test_iam_permissions(resource: nil, permissions: nil)
2295
+ # Pass arguments to `test_iam_permissions` via keyword arguments. Note that at
2296
+ # least one keyword argument is required. To specify no parameters, or to keep all
2297
+ # the default parameter values, pass an empty Hash as a request object (see above).
2298
+ #
2239
2299
  # @param resource [String]
2240
2300
  # REQUIRED: The resource for which the policy detail is being requested.
2241
- # `resource` is usually specified as a path. For example, a Project
2242
- # resource is specified as `projects/{project}`.
2301
+ # See the operation documentation for the appropriate value for this field.
2243
2302
  # @param permissions [Array<String>]
2244
2303
  # The set of permissions to check for the `resource`. Permissions with
2245
2304
  # wildcards (such as '*' or 'storage.*') are not allowed. For more
2246
2305
  # information see
2247
2306
  # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
2248
2307
  #
2249
- #
2250
2308
  # @yield [response, operation] Access the result along with the RPC operation
2251
2309
  # @yieldparam response [Google::Iam::V1::TestIamPermissionsResponse]
2252
2310
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -2627,13 +2685,3 @@ module Google
2627
2685
  end
2628
2686
  end
2629
2687
  end
2630
-
2631
- # rubocop:disable Lint/HandleExceptions
2632
-
2633
- # Once client is loaded, load helpers.rb if it exists.
2634
- begin
2635
- require "google/cloud/data_catalog/v1/data_catalog/helpers"
2636
- rescue LoadError
2637
- end
2638
-
2639
- # rubocop:enable Lint/HandleExceptions