google-cloud-data_catalog-v1 0.7.1 → 0.8.1

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
@@ -46,13 +46,12 @@ module Google
             # See {::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all PolicyTagManager clients:
-            #
-            #     ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all PolicyTagManager clients
+            #   ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -101,19 +100,15 @@ module Google
             ##
             # Create a new PolicyTagManager client object.
             #
-            # ## Examples
-            #
-            # To create a new PolicyTagManager client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.new
             #
-            # To create a new PolicyTagManager client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the PolicyTagManager client.
             # @yieldparam config [Client::Configuration]
@@ -133,14 +128,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -158,8 +152,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 +174,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]
@@ -215,7 +210,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_taxonomy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_taxonomy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :create_taxonomy, request, options: options do |response, operation|
@@ -227,7 +224,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 +244,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]
@@ -284,7 +282,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_taxonomy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_taxonomy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :delete_taxonomy, request, options: options do |response, operation|
@@ -296,7 +296,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 +315,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]
@@ -357,7 +358,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.update_taxonomy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_taxonomy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :update_taxonomy, request, options: options do |response, operation|
@@ -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>]
@@ -430,7 +435,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_taxonomies.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_taxonomies.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :list_taxonomies, request, options: options do |response, operation|
@@ -461,7 +468,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]
@@ -497,7 +504,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_taxonomy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_taxonomy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :get_taxonomy, request, options: options do |response, operation|
@@ -527,9 +536,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]
@@ -565,7 +575,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_policy_tag.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_policy_tag.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :create_policy_tag, request, options: options do |response, operation|
@@ -577,12 +589,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 +612,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]
@@ -637,7 +650,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_policy_tag.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_policy_tag.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :delete_policy_tag, request, options: options do |response, operation|
@@ -649,7 +664,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 +683,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]
@@ -713,7 +727,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.update_policy_tag.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_policy_tag.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :update_policy_tag, request, options: options do |response, operation|
@@ -745,11 +761,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>]
@@ -785,7 +804,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_policy_tags.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_policy_tags.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :list_policy_tags, request, options: options do |response, operation|
@@ -816,7 +837,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]
@@ -852,7 +873,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_policy_tag.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_policy_tag.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :get_policy_tag, request, options: options do |response, operation|
@@ -922,7 +945,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_iam_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
@@ -994,7 +1019,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.set_iam_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
@@ -1006,7 +1033,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)
@@ -1067,7 +1094,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.test_iam_permissions.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @policy_tag_manager_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
@@ -1091,22 +1120,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for create_taxonomy
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_taxonomy.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_taxonomy.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # create_taxonomy to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_taxonomy.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::DataCatalog::V1::PolicyTagManager::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_taxonomy.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.