google-cloud-data_catalog-v1 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 411fd1764f657bce89c9ed3d1b28753d8119afc7f0c460cc7b8df8aeb640a48e
-  data.tar.gz: df455550c1154e9f84e7034129ae917e2eef020f74b6d996e772414fd9025c78
+  metadata.gz: 2d083c21d6aefccc6e2dc26d4f1adbc2776d3b8795bdc128e76bde149b408f6b
+  data.tar.gz: 0a345f881b23995d3fddc3e8ce6cf090982ca65ffd7453fe37209b55f2810e0e
 SHA512:
-  metadata.gz: 6ac6b7d57c7868b779b4c9de2d71ddcd783731e6d6d3b92e8ce8e90230ccb1cd064c837295b03f22d76fb5d49416e545cb10855587b96855f55d46142c310d7f
-  data.tar.gz: 2af89f682588cafeafd8f196e1356f73709b440079dcd154d0d4b77c82d26d41ebe0f3ad6beb109ae167cb49528a71766d808e98cdedf582ba4a1302db3f29b0
+  metadata.gz: e89e88507e4861c6f3c19b018a251bc0ed451a2fd4b6276609298a17682535f524c39eb6167ed63c8240e0c99fa0eaef031423a4cd0ea34927c0a88a460cc898
+  data.tar.gz: bf2397e6fe505768b3c4b0f2f0ef12a5f951ee911e2e0c0cc50ccd3ca61eb330e1f68bc9725da5969c8c28815fa7f35b214fcb2b5701c316e4473b837e9e8696

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Data Catalog V1 API
 
-API Client library for the Data Catalog V1 API
+A fully managed and highly scalable data discovery and metadata management service.
 
 DataCatalog is a centralized and unified data catalog service for all your Cloud resources, where users and systems can discover data, explore and curate its semantics, understand how to act on it, and help govern its usage.
 
@@ -47,7 +47,7 @@ for general usage information.
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
 The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 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)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb

@@ -108,6 +108,11 @@ module Google
                   initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
+                default_config.rpcs.import_entries.timeout = 60.0
+                default_config.rpcs.import_entries.retry_policy = {
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
+                }
+
                 default_config
               end
               yield @configure if block_given?
@@ -177,6 +182,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @operations_client = Operations.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
                 config.credentials = credentials
                 config.quota_project = @quota_project_id
@@ -192,6 +203,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for long-running operations.
+            #
+            # @return [::Google::Cloud::DataCatalog::V1::DataCatalog::Operations]
+            #
+            attr_reader :operations_client
+
             ##
             # Get the associated client for mix-in of the IAMPolicy.
             #
@@ -240,9 +258,8 @@ module Google
             #     empty AND `include_gcp_public_datasets` is set to `false`. In this case,
             #     the request returns an error.
             #   @param query [::String]
-            #     Optional. The query string with a minimum of 3 characters and specific syntax.
-            #     For more information, see
-            #     [Data Catalog search
+            #     Optional. The query string with a minimum of 3 characters and specific
+            #     syntax. For more information, see [Data Catalog search
             #     syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
             #
             #     An empty query string returns all data assets (in the specified scope)
@@ -260,10 +277,11 @@ module Google
             #     The maximum number is 1000. If exceeded, throws an "invalid argument"
             #     exception.
             #   @param page_token [::String]
-            #     Optional. Pagination token that, if specified, returns the next page of search
-            #     results. If empty, returns the first page.
+            #     Optional. Pagination token that, if specified, returns the next page of
+            #     search results. If empty, returns the first page.
             #
-            #     This token is returned in the {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}
+            #     This token is returned in the
+            #     {::Google::Cloud::DataCatalog::V1::SearchCatalogResponse#next_page_token SearchCatalogResponse.next_page_token}
             #     field of the response to a previous
             #     {::Google::Cloud::DataCatalog::V1::DataCatalog::Client#search_catalog SearchCatalogRequest}
             #     call.
@@ -384,7 +402,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The names of the project and location that the new entry group belongs to.
+            #     Required. The names of the project and location that the new entry group
+            #     belongs to.
             #
             #     Note: The entry group itself and its child resources might not be
             #     stored in the location specified in its name.
@@ -2158,8 +2177,8 @@ module Google
             #   @param tag_template_field [::Google::Cloud::DataCatalog::V1::TagTemplateField, ::Hash]
             #     Required. The template to update.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-            #     Optional. Names of fields whose values to overwrite on an individual field of a tag
-            #     template. The following fields are modifiable:
+            #     Optional. Names of fields whose values to overwrite on an individual field
+            #     of a tag template. The following fields are modifiable:
             #
             #     * `display_name`
             #     * `type.enum_type`
@@ -2264,7 +2283,8 @@ module Google
             #   @param name [::String]
             #     Required. The name of the tag template field.
             #   @param new_tag_template_field_id [::String]
-            #     Required. The new ID of this tag template field. For example, `my_new_field`.
+            #     Required. The new ID of this tag template field. For example,
+            #     `my_new_field`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplateField]
@@ -2353,7 +2373,8 @@ module Google
             #   @param name [::String]
             #     Required. The name of the enum field value.
             #   @param new_enum_value_display_name [::String]
-            #     Required. The new display name of the enum value. For example, `my_new_enum_value`.
+            #     Required. The new display name of the enum value. For example,
+            #     `my_new_enum_value`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::TagTemplateField]
@@ -2895,6 +2916,122 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # `ReconcileTags` creates or updates a list of tags on the entry.
+            # If the
+            # {::Google::Cloud::DataCatalog::V1::ReconcileTagsRequest#force_delete_missing ReconcileTagsRequest.force_delete_missing}
+            # parameter is set, the operation deletes tags not included in the input tag
+            # list.
+            #
+            # `ReconcileTags` returns a [long-running operation]
+            # [google.longrunning.Operation] resource that can be queried with
+            # Operations.GetOperation
+            # to return [ReconcileTagsMetadata]
+            # [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and
+            # a [ReconcileTagsResponse]
+            # [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
+            #
+            # @overload reconcile_tags(request, options = nil)
+            #   Pass arguments to `reconcile_tags` via a request object, either of type
+            #   {::Google::Cloud::DataCatalog::V1::ReconcileTagsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DataCatalog::V1::ReconcileTagsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload reconcile_tags(parent: nil, tag_template: nil, force_delete_missing: nil, tags: nil)
+            #   Pass arguments to `reconcile_tags` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. Name of {::Google::Cloud::DataCatalog::V1::Entry Entry} to be tagged.
+            #   @param tag_template [::String]
+            #     Required. The name of the tag template, which is used for reconciliation.
+            #   @param force_delete_missing [::Boolean]
+            #     If set to `true`, deletes entry tags related to a tag template
+            #     not listed in the tags source from an entry. If set to `false`,
+            #     unlisted tags are retained.
+            #   @param tags [::Array<::Google::Cloud::DataCatalog::V1::Tag, ::Hash>]
+            #     A list of tags to apply to an entry. A tag can specify a
+            #     tag template, which must be the template specified in the
+            #     `ReconcileTagsRequest`.
+            #     The sole entry and each of its columns must be mentioned at most once.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/data_catalog/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DataCatalog::V1::ReconcileTagsRequest.new
+            #
+            #   # Call the reconcile_tags method.
+            #   result = client.reconcile_tags request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "No response received."
+            #   end
+            #
+            def reconcile_tags request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ReconcileTagsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.reconcile_tags.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.reconcile_tags.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.reconcile_tags.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @data_catalog_stub.call_rpc :reconcile_tags, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Marks an {::Google::Cloud::DataCatalog::V1::Entry Entry} as starred by
             # the current user. Starring information is private to each user.
@@ -3393,6 +3530,118 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Imports entries from a source, such as data previously dumped into a
+            # Cloud Storage bucket, into Data Catalog. Import of entries
+            # is a sync operation that reconciles the state of the third-party system
+            # with the Data Catalog.
+            #
+            # `ImportEntries` accepts source data snapshots of a third-party system.
+            # Snapshot should be delivered as a .wire or base65-encoded .txt file
+            # containing a sequence of Protocol Buffer messages of
+            # {::Google::Cloud::DataCatalog::V1::DumpItem DumpItem} type.
+            #
+            # `ImportEntries` returns a [long-running operation]
+            # [google.longrunning.Operation] resource that can be queried with
+            # Operations.GetOperation
+            # to return
+            # {::Google::Cloud::DataCatalog::V1::ImportEntriesMetadata ImportEntriesMetadata}
+            # and an
+            # {::Google::Cloud::DataCatalog::V1::ImportEntriesResponse ImportEntriesResponse}
+            # message.
+            #
+            # @overload import_entries(request, options = nil)
+            #   Pass arguments to `import_entries` via a request object, either of type
+            #   {::Google::Cloud::DataCatalog::V1::ImportEntriesRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DataCatalog::V1::ImportEntriesRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload import_entries(parent: nil, gcs_bucket_path: nil)
+            #   Pass arguments to `import_entries` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. Target entry group for ingested entries.
+            #   @param gcs_bucket_path [::String]
+            #     Path to a Cloud Storage bucket that contains a dump ready for ingestion.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/data_catalog/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DataCatalog::V1::ImportEntriesRequest.new
+            #
+            #   # Call the import_entries method.
+            #   result = client.import_entries request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "No response received."
+            #   end
+            #
+            def import_entries request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ImportEntriesRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.import_entries.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DataCatalog::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.import_entries.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.import_entries.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @data_catalog_stub.call_rpc :import_entries, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the DataCatalog API.
             #
@@ -3431,9 +3680,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
@@ -3664,6 +3913,11 @@ module Google
                 #
                 attr_reader :list_tags
                 ##
+                # RPC-specific configuration for `reconcile_tags`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :reconcile_tags
+                ##
                 # RPC-specific configuration for `star_entry`
                 # @return [::Gapic::Config::Method]
                 #
@@ -3688,6 +3942,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :test_iam_permissions
+                ##
+                # RPC-specific configuration for `import_entries`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :import_entries
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -3745,6 +4004,8 @@ module Google
                   @delete_tag = ::Gapic::Config::Method.new delete_tag_config
                   list_tags_config = parent_rpcs.list_tags if parent_rpcs.respond_to? :list_tags
                   @list_tags = ::Gapic::Config::Method.new list_tags_config
+                  reconcile_tags_config = parent_rpcs.reconcile_tags if parent_rpcs.respond_to? :reconcile_tags
+                  @reconcile_tags = ::Gapic::Config::Method.new reconcile_tags_config
                   star_entry_config = parent_rpcs.star_entry if parent_rpcs.respond_to? :star_entry
                   @star_entry = ::Gapic::Config::Method.new star_entry_config
                   unstar_entry_config = parent_rpcs.unstar_entry if parent_rpcs.respond_to? :unstar_entry
@@ -3755,6 +4016,8 @@ module Google
                   @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
                   test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
                   @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
+                  import_entries_config = parent_rpcs.import_entries if parent_rpcs.respond_to? :import_entries
+                  @import_entries = ::Gapic::Config::Method.new import_entries_config
 
                   yield self if block_given?
                 end