google-cloud-data_catalog-v1 0.7.3 → 0.8.0

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

@@ -31,7 +31,7 @@ module Google
     module DataCatalog
       module V1
         ##
-        # Policy Tag Manager API service allows clients to manage their policy tags and
+        # Policy Tag Manager API service allows you to manage your policy tags and
         # taxonomies.
         #
         # Policy tags are used to tag BigQuery columns and apply additional access

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

@@ -27,7 +27,7 @@ module Google
           ##
           # Client for the PolicyTagManager service.
           #
-          # Policy Tag Manager API service allows clients to manage their policy tags and
+          # Policy Tag Manager API service allows you to manage your policy tags and
           # taxonomies.
           #
           # Policy tags are used to tag BigQuery columns and apply additional access
@@ -158,8 +158,9 @@ module Google
             # Service calls
 
             ##
-            # Creates a taxonomy in a specified project. The taxonomy is initially empty,
-            # i.e., does not contain policy tags.
+            # Creates a taxonomy in a specified project.
+            #
+            # The taxonomy is initially empty, that is, it doesn't contain policy tags.
             #
             # @overload create_taxonomy(request, options = nil)
             #   Pass arguments to `create_taxonomy` via a request object, either of type
@@ -179,7 +180,7 @@ module Google
             #   @param parent [::String]
             #     Required. Resource name of the project that the taxonomy will belong to.
             #   @param taxonomy [::Google::Cloud::DataCatalog::V1::Taxonomy, ::Hash]
-            #     The taxonomy to be created.
+            #     The taxonomy to create.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::Taxonomy]
@@ -227,7 +228,7 @@ module Google
             end
 
             ##
-            # Deletes a taxonomy. This method will also delete all policy tags in this
+            # Deletes a taxonomy, including all policy tags in this
             # taxonomy, their associated policies, and the policy tags references from
             # BigQuery columns.
             #
@@ -247,8 +248,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. Resource name of the taxonomy to be deleted. All policy tags in
-            #     this taxonomy will also be deleted.
+            #     Required. Resource name of the taxonomy to delete.
+            #
+            #     Note: All policy tags in this taxonomy are also deleted.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -296,7 +298,7 @@ module Google
             end
 
             ##
-            # Updates a taxonomy. This method can update the taxonomy's display name,
+            # Updates a taxonomy, including its display name,
             # description, and activated policy types.
             #
             # @overload update_taxonomy(request, options = nil)
@@ -315,13 +317,14 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param taxonomy [::Google::Cloud::DataCatalog::V1::Taxonomy, ::Hash]
-            #     The taxonomy to update. Only description, display_name, and activated
-            #     policy types can be updated.
+            #     The taxonomy to update. You can update only its description, display name,
+            #     and activated policy types.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-            #     The update mask applies to the resource. For the `FieldMask` definition,
-            #     see
-            #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
-            #     If not set, defaults to all of the fields that are allowed to update.
+            #     Specifies fields to update. If not set, defaults to all fields you can
+            #     update.
+            #
+            #     For more information, see [FieldMask]
+            #     (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::Taxonomy]
@@ -369,8 +372,8 @@ module Google
             end
 
             ##
-            # Lists all taxonomies in a project in a particular location that the caller
-            # has permission to view.
+            # Lists all taxonomies in a project in a particular location that you
+            # have a permission to view.
             #
             # @overload list_taxonomies(request, options = nil)
             #   Pass arguments to `list_taxonomies` via a request object, either of type
@@ -390,11 +393,13 @@ module Google
             #   @param parent [::String]
             #     Required. Resource name of the project to list the taxonomies of.
             #   @param page_size [::Integer]
-            #     The maximum number of items to return. Must be a value between 1 and 1000.
-            #     If not set, defaults to 50.
+            #     The maximum number of items to return. Must be a value between 1 and 1000
+            #     inclusively. If not set, defaults to 50.
             #   @param page_token [::String]
-            #     The next_page_token value returned from a previous list request, if any. If
-            #     not set, defaults to an empty string.
+            #     The pagination token of the next results page. If not set,
+            #     the first page is returned.
+            #
+            #     The token is returned in the response to a previous list request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::Taxonomy>]
@@ -461,7 +466,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. Resource name of the requested taxonomy.
+            #     Required. Resource name of the taxonomy to get.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::Taxonomy]
@@ -527,9 +532,10 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. Resource name of the taxonomy that the policy tag will belong to.
+            #     Required. Resource name of the taxonomy that the policy tag will belong to.<br /><br
+            #     />
             #   @param policy_tag [::Google::Cloud::DataCatalog::V1::PolicyTag, ::Hash]
-            #     The policy tag to be created.
+            #     The policy tag to create.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::PolicyTag]
@@ -577,12 +583,12 @@ module Google
             end
 
             ##
-            # Deletes a policy tag. This method also deletes:
+            # Deletes a policy tag together with the following:
             #
-            # * all of its descendant policy tags, if any
-            # * the policies associated with the policy tag and its descendants
-            # * references from BigQuery table schema of the policy tag and its
-            #   descendants.
+            # * All of its descendant policy tags, if any
+            # * Policies associated with the policy tag and its descendants
+            # * References from BigQuery table schema of the policy tag and its
+            #   descendants
             #
             # @overload delete_policy_tag(request, options = nil)
             #   Pass arguments to `delete_policy_tag` via a request object, either of type
@@ -600,8 +606,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. Resource name of the policy tag to be deleted. All of its descendant
-            #     policy tags will also be deleted.
+            #     Required. Resource name of the policy tag to delete.
+            #
+            #     Note: All of its descendant policy tags are also deleted.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -649,7 +656,7 @@ module Google
             end
 
             ##
-            # Updates a policy tag. This method can update the policy tag's display
+            # Updates a policy tag, including its display
             # name, description, and parent policy tag.
             #
             # @overload update_policy_tag(request, options = nil)
@@ -668,16 +675,15 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param policy_tag [::Google::Cloud::DataCatalog::V1::PolicyTag, ::Hash]
-            #     The policy tag to update. Only the description, display_name, and
-            #     parent_policy_tag fields can be updated.
+            #     The policy tag to update. You can update only its description, display
+            #     name, and parent policy tag fields.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-            #     The update mask applies to the resource. Only display_name, description and
-            #     parent_policy_tag can be updated and thus can be listed in the mask. If
-            #     update_mask is not provided, all allowed fields (i.e. display_name,
-            #     description and parent) will be updated. For more information including the
-            #     `FieldMask` definition, see
-            #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
-            #     If not set, defaults to all of the fields that are allowed to update.
+            #     Specifies the fields to update.
+            #
+            #     You can update only display name, description, and parent policy tag.
+            #     If not set, defaults to all updatable fields.
+            #     For more information, see [FieldMask]
+            #     (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::PolicyTag]
@@ -745,11 +751,14 @@ module Google
             #   @param parent [::String]
             #     Required. Resource name of the taxonomy to list the policy tags of.
             #   @param page_size [::Integer]
-            #     The maximum number of items to return. Must be a value between 1 and 1000.
+            #     The maximum number of items to return. Must be a value between 1 and 1000
+            #     inclusively.
             #     If not set, defaults to 50.
             #   @param page_token [::String]
-            #     The next_page_token value returned from a previous List request, if any. If
-            #     not set, defaults to an empty string.
+            #     The pagination token of the next results page. If not set, returns the
+            #     first page.
+            #
+            #     The token is returned in the response to a previous list request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::V1::PolicyTag>]
@@ -816,7 +825,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. Resource name of the requested policy tag.
+            #     Required. Resource name of the policy tag.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::PolicyTag]
@@ -1006,7 +1015,7 @@ module Google
             end
 
             ##
-            # Returns the permissions that a caller has on a specified policy tag or
+            # Returns your permissions on a specified policy tag or
             # taxonomy.
             #
             # @overload test_iam_permissions(request, options = nil)

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

@@ -31,9 +31,10 @@ module Google
     module DataCatalog
       module V1
         ##
-        # Policy Tag Manager serialization API service allows clients to manipulate
-        # their policy tags and taxonomies in serialized format, where taxonomy is a
-        # hierarchical group of policy tags.
+        # Policy Tag Manager Serialization API service allows you to manipulate
+        # your policy tags and taxonomies in a serialized format.
+        #
+        # Taxonomy is a hierarchical group of policy tags.
         #
         # To load this service and instantiate a client:
         #

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

@@ -27,9 +27,10 @@ module Google
           ##
           # Client for the PolicyTagManagerSerialization service.
           #
-          # Policy Tag Manager serialization API service allows clients to manipulate
-          # their policy tags and taxonomies in serialized format, where taxonomy is a
-          # hierarchical group of policy tags.
+          # Policy Tag Manager Serialization API service allows you to manipulate
+          # your policy tags and taxonomies in a serialized format.
+          #
+          # Taxonomy is a hierarchical group of policy tags.
           #
           class Client
             include Paths
@@ -155,15 +156,94 @@ module Google
             # Service calls
 
             ##
-            # Creates new taxonomies (including their policy tags) by importing from
-            # inlined source or cross-regional source. New taxonomies will be created in
-            # a given parent project.
+            # Replaces (updates) a taxonomy and all its policy tags.
+            #
+            # The taxonomy and its entire hierarchy of policy tags must be
+            # represented literally by `SerializedTaxonomy` and the nested
+            # `SerializedPolicyTag` messages.
+            #
+            # This operation automatically does the following:
+            #
+            # - Deletes the existing policy tags that are missing from the
+            #   `SerializedPolicyTag`.
+            # - Creates policy tags that don't have resource names. They are considered
+            #   new.
+            # - Updates policy tags with valid resources names accordingly.
+            #
+            # @overload replace_taxonomy(request, options = nil)
+            #   Pass arguments to `replace_taxonomy` via a request object, either of type
+            #   {::Google::Cloud::DataCatalog::V1::ReplaceTaxonomyRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DataCatalog::V1::ReplaceTaxonomyRequest, ::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 replace_taxonomy(name: nil, serialized_taxonomy: nil)
+            #   Pass arguments to `replace_taxonomy` 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 name [::String]
+            #     Required. Resource name of the taxonomy to update.
+            #   @param serialized_taxonomy [::Google::Cloud::DataCatalog::V1::SerializedTaxonomy, ::Hash]
+            #     Required. Taxonomy to update along with its child policy tags.
             #
-            # If using the cross-regional source, a new taxonomy is created by copying
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::DataCatalog::V1::Taxonomy]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::DataCatalog::V1::Taxonomy]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def replace_taxonomy request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::V1::ReplaceTaxonomyRequest
+
+              # 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.replace_taxonomy.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 = {
+                "name" => request.name
+              }
+              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.replace_taxonomy.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.replace_taxonomy.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @policy_tag_manager_serialization_stub.call_rpc :replace_taxonomy, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Creates new taxonomies (including their policy tags) in a given project
+            # by importing from inlined or cross-regional sources.
+            #
+            # For a cross-regional source, new taxonomies are created by copying
             # from a source in another region.
             #
-            # If using the inlined source, this method provides a way to bulk create
-            # taxonomies and policy tags using nested proto structure.
+            # For an inlined source, taxonomies and policy tags are created in bulk using
+            # nested protocol buffer structures.
             #
             # @overload import_taxonomies(request, options = nil)
             #   Pass arguments to `import_taxonomies` via a request object, either of type
@@ -183,9 +263,9 @@ module Google
             #   @param parent [::String]
             #     Required. Resource name of project that the imported taxonomies will belong to.
             #   @param inline_source [::Google::Cloud::DataCatalog::V1::InlineSource, ::Hash]
-            #     Inline source used for taxonomies import.
+            #     Inline source taxonomy to import.
             #   @param cross_regional_source [::Google::Cloud::DataCatalog::V1::CrossRegionalSource, ::Hash]
-            #     Cross-regional source taxonomy to be imported.
+            #     Cross-regional source taxonomy to import.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::ImportTaxonomiesResponse]
@@ -233,12 +313,12 @@ module Google
             end
 
             ##
-            # Exports taxonomies as the requested type and returns the taxonomies
-            # including their policy tags. The requested taxonomies must belong to one
-            # project.
+            # Exports taxonomies in the requested type and returns them,
+            # including their policy tags. The requested taxonomies must belong to the
+            # same project.
             #
-            # SerializedTaxonomy protos with nested policy tags that are generated by
-            # this method can be used as input for future ImportTaxonomies calls.
+            # This method generates `SerializedTaxonomy` protocol buffers with nested
+            # policy tags that can be used as input for `ImportTaxonomies` calls.
             #
             # @overload export_taxonomies(request, options = nil)
             #   Pass arguments to `export_taxonomies` via a request object, either of type
@@ -258,10 +338,10 @@ module Google
             #   @param parent [::String]
             #     Required. Resource name of the project that the exported taxonomies belong to.
             #   @param taxonomies [::Array<::String>]
-            #     Required. Resource names of the taxonomies to be exported.
+            #     Required. Resource names of the taxonomies to export.
             #   @param serialized_taxonomies [::Boolean]
-            #     Export taxonomies as serialized taxonomies, which contain all the policy
-            #     tags as nested protos.
+            #     Serialized export taxonomies that contain all the policy
+            #     tags as nested protocol buffers.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DataCatalog::V1::ExportTaxonomiesResponse]
@@ -323,19 +403,19 @@ module Google
             #
             # # Examples
             #
-            # To modify the global config, setting the timeout for import_taxonomies
+            # To modify the global config, setting the timeout for replace_taxonomy
             # to 20 seconds, and all remaining timeouts to 10 seconds:
             #
             #     ::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client.configure do |config|
             #       config.timeout = 10.0
-            #       config.rpcs.import_taxonomies.timeout = 20.0
+            #       config.rpcs.replace_taxonomy.timeout = 20.0
             #     end
             #
             # To apply the above configuration only to a new client:
             #
             #     client = ::Google::Cloud::DataCatalog::V1::PolicyTagManagerSerialization::Client.new do |config|
             #       config.timeout = 10.0
-            #       config.rpcs.import_taxonomies.timeout = 20.0
+            #       config.rpcs.replace_taxonomy.timeout = 20.0
             #     end
             #
             # @!attribute [rw] endpoint
@@ -444,6 +524,11 @@ module Google
               #         trigger a retry.
               #
               class Rpcs
+                ##
+                # RPC-specific configuration for `replace_taxonomy`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :replace_taxonomy
                 ##
                 # RPC-specific configuration for `import_taxonomies`
                 # @return [::Gapic::Config::Method]
@@ -457,6 +542,8 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
+                  replace_taxonomy_config = parent_rpcs.replace_taxonomy if parent_rpcs.respond_to? :replace_taxonomy
+                  @replace_taxonomy = ::Gapic::Config::Method.new replace_taxonomy_config
                   import_taxonomies_config = parent_rpcs.import_taxonomies if parent_rpcs.respond_to? :import_taxonomies
                   @import_taxonomies = ::Gapic::Config::Method.new import_taxonomies_config
                   export_taxonomies_config = parent_rpcs.export_taxonomies if parent_rpcs.respond_to? :export_taxonomies

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DataCatalog
       module V1
-        VERSION = "0.7.3"
+        VERSION = "0.8.0"
       end
     end
   end