google-cloud-logging-v2 0.5.3 → 0.6.0

data/lib/google/cloud/logging/v2/config_service/paths.rb

@@ -485,6 +485,59 @@ module Google
               "projects/#{project}"
             end
 
+            ##
+            # Create a fully-qualified Settings resource string.
+            #
+            # @overload settings_path(project:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/settings`
+            #
+            #   @param project [String]
+            #
+            # @overload settings_path(organization:)
+            #   The resource will be in the following format:
+            #
+            #   `organizations/{organization}/settings`
+            #
+            #   @param organization [String]
+            #
+            # @overload settings_path(folder:)
+            #   The resource will be in the following format:
+            #
+            #   `folders/{folder}/settings`
+            #
+            #   @param folder [String]
+            #
+            # @overload settings_path(billing_account:)
+            #   The resource will be in the following format:
+            #
+            #   `billingAccounts/{billing_account}/settings`
+            #
+            #   @param billing_account [String]
+            #
+            # @return [::String]
+            def settings_path **args
+              resources = {
+                "project" => (proc do |project:|
+                  "projects/#{project}/settings"
+                end),
+                "organization" => (proc do |organization:|
+                  "organizations/#{organization}/settings"
+                end),
+                "folder" => (proc do |folder:|
+                  "folders/#{folder}/settings"
+                end),
+                "billing_account" => (proc do |billing_account:|
+                  "billingAccounts/#{billing_account}/settings"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
             extend self
           end
         end

data/lib/google/cloud/logging/v2/config_service.rb

@@ -24,6 +24,7 @@ require "google/cloud/logging/v2/version"
 
 require "google/cloud/logging/v2/config_service/credentials"
 require "google/cloud/logging/v2/config_service/paths"
+require "google/cloud/logging/v2/config_service/operations"
 require "google/cloud/logging/v2/config_service/client"
 
 module Google

data/lib/google/cloud/logging/v2/logging_service/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Logging::V2::LoggingService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all LoggingService clients:
-            #
-            #     ::Google::Cloud::Logging::V2::LoggingService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all LoggingService clients
+            #   ::Google::Cloud::Logging::V2::LoggingService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -124,19 +123,15 @@ module Google
             ##
             # Create a new LoggingService client object.
             #
-            # ## Examples
-            #
-            # To create a new LoggingService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Logging::V2::LoggingService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Logging::V2::LoggingService::Client.new
             #
-            # To create a new LoggingService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Logging::V2::LoggingService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Logging::V2::LoggingService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the LoggingService client.
             # @yieldparam config [Client::Configuration]
@@ -156,10 +151,9 @@ 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
@@ -181,10 +175,10 @@ module Google
             # Service calls
 
             ##
-            # Deletes all the log entries in a log. The log reappears if it receives new
-            # entries. Log entries written shortly before the delete operation might not
-            # be deleted. Entries received after the delete operation with a timestamp
-            # before the operation will be deleted.
+            # Deletes all the log entries in a log for the _Default Log Bucket. The log
+            # reappears if it receives new entries. Log entries written shortly before
+            # the delete operation might not be deleted. Entries received after the
+            # delete operation with a timestamp before the operation will be deleted.
             #
             # @overload delete_log(request, options = nil)
             #   Pass arguments to `delete_log` via a request object, either of type
@@ -204,14 +198,15 @@ module Google
             #   @param log_name [::String]
             #     Required. The resource name of the log to delete:
             #
-            #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
-            #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
-            #         "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
-            #         "folders/[FOLDER_ID]/logs/[LOG_ID]"
+            #     * `projects/[PROJECT_ID]/logs/[LOG_ID]`
+            #     * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
+            #     * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
+            #     * `folders/[FOLDER_ID]/logs/[LOG_ID]`
             #
             #     `[LOG_ID]` must be URL-encoded. For example,
             #     `"projects/my-project-id/logs/syslog"`,
-            #     `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
+            #     `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
+            #
             #     For more information about log names, see
             #     {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
             #
@@ -223,6 +218,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::LoggingService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::DeleteLogRequest.new
+            #
+            #   # Call the delete_log method.
+            #   result = client.delete_log request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_log request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -240,16 +250,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "log_name" => request.log_name
-              }
+              header_params = {}
+              if request.log_name
+                header_params["log_name"] = request.log_name
+              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.delete_log.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_log.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @logging_service_stub.call_rpc :delete_log, request, options: options do |response, operation|
@@ -288,15 +302,15 @@ module Google
             #     Optional. A default log resource name that is assigned to all log entries
             #     in `entries` that do not specify a value for `log_name`:
             #
-            #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
-            #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
-            #         "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
-            #         "folders/[FOLDER_ID]/logs/[LOG_ID]"
+            #     * `projects/[PROJECT_ID]/logs/[LOG_ID]`
+            #     * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
+            #     * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
+            #     * `folders/[FOLDER_ID]/logs/[LOG_ID]`
             #
             #     `[LOG_ID]` must be URL-encoded. For example:
             #
             #         "projects/my-project-id/logs/syslog"
-            #         "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
+            #         "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
             #
             #     The permission `logging.logEntries.create` is needed on each project,
             #     organization, billing account, or folder that is receiving new log
@@ -331,14 +345,14 @@ module Google
             #     the entries later in the list. See the `entries.list` method.
             #
             #     Log entries with timestamps that are more than the
-            #     [logs retention period](https://cloud.google.com/logging/quota-policy) in
+            #     [logs retention period](https://cloud.google.com/logging/quotas) in
             #     the past or more than 24 hours in the future will not be available when
             #     calling `entries.list`. However, those log entries can still be [exported
             #     with
             #     LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
             #
             #     To improve throughput and to avoid exceeding the
-            #     [quota limit](https://cloud.google.com/logging/quota-policy) for calls to
+            #     [quota limit](https://cloud.google.com/logging/quotas) for calls to
             #     `entries.write`, you should try to include several log entries in this
             #     list, rather than calling this method for each individual log entry.
             #   @param partial_success [::Boolean]
@@ -360,6 +374,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::LoggingService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::WriteLogEntriesRequest.new
+            #
+            #   # Call the write_log_entries method.
+            #   result = client.write_log_entries request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::WriteLogEntriesResponse.
+            #   p result
+            #
             def write_log_entries request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -380,7 +409,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.write_log_entries.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.write_log_entries.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @logging_service_stub.call_rpc :write_log_entries, request, options: options do |response, operation|
@@ -416,16 +447,17 @@ module Google
             #     Required. Names of one or more parent resources from which to
             #     retrieve log entries:
             #
-            #         "projects/[PROJECT_ID]"
-            #         "organizations/[ORGANIZATION_ID]"
-            #         "billingAccounts/[BILLING_ACCOUNT_ID]"
-            #         "folders/[FOLDER_ID]"
+            #     *  `projects/[PROJECT_ID]`
+            #     *  `organizations/[ORGANIZATION_ID]`
+            #     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
+            #     *  `folders/[FOLDER_ID]`
             #
-            #     May alternatively be one or more views
-            #       projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
-            #       organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
-            #       billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
-            #       folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #     May alternatively be one or more views:
+            #
+            #      * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+            #      * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+            #      * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+            #      * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
             #
             #     Projects listed in the `project_ids` field are added to this list.
             #   @param filter [::String]
@@ -444,10 +476,10 @@ module Google
             #     in order of decreasing timestamps (newest first).  Entries with equal
             #     timestamps are returned in order of their `insert_id` values.
             #   @param page_size [::Integer]
-            #     Optional. The maximum number of results to return from this request.
-            #     Default is 50. If the value is negative or exceeds 1000,
-            #     the request is rejected. The presence of `next_page_token` in the
-            #     response indicates that more results might be available.
+            #     Optional. The maximum number of results to return from this request. Default is 50.
+            #     If the value is negative or exceeds 1000, the request is rejected. The
+            #     presence of `next_page_token` in the response indicates that more results
+            #     might be available.
             #   @param page_token [::String]
             #     Optional. If present, then retrieve the next batch of results from the
             #     preceding call to this method.  `page_token` must be the value of
@@ -462,6 +494,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::LoggingService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListLogEntriesRequest.new
+            #
+            #   # Call the list_log_entries method.
+            #   result = client.list_log_entries request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Logging::V2::LogEntry.
+            #     p response
+            #   end
+            #
             def list_log_entries request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -482,7 +535,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_log_entries.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_log_entries.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @logging_service_stub.call_rpc :list_log_entries, request, options: options do |response, operation|
@@ -530,6 +585,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::LoggingService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListMonitoredResourceDescriptorsRequest.new
+            #
+            #   # Call the list_monitored_resource_descriptors method.
+            #   result = client.list_monitored_resource_descriptors request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Api::MonitoredResourceDescriptor.
+            #     p response
+            #   end
+            #
             def list_monitored_resource_descriptors request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -550,7 +626,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_monitored_resource_descriptors.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_monitored_resource_descriptors.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @logging_service_stub.call_rpc :list_monitored_resource_descriptors, request, options: options do |response, operation|
@@ -584,10 +662,10 @@ module Google
             #   @param parent [::String]
             #     Required. The resource name that owns the logs:
             #
-            #         "projects/[PROJECT_ID]"
-            #         "organizations/[ORGANIZATION_ID]"
-            #         "billingAccounts/[BILLING_ACCOUNT_ID]"
-            #         "folders/[FOLDER_ID]"
+            #     *  `projects/[PROJECT_ID]`
+            #     *  `organizations/[ORGANIZATION_ID]`
+            #     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
+            #     *  `folders/[FOLDER_ID]`
             #   @param page_size [::Integer]
             #     Optional. The maximum number of results to return from this request.
             #     Non-positive values are ignored.  The presence of `nextPageToken` in the
@@ -599,16 +677,18 @@ module Google
             #     parameters should be identical to those in the previous call.
             #   @param resource_names [::Array<::String>]
             #     Optional. The resource name that owns the logs:
-            #       projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
-            #       organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
-            #       billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
-            #       folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+            #
+            #      * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+            #      * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+            #      * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+            #      * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
             #
             #     To support legacy queries, it could also be:
-            #         "projects/[PROJECT_ID]"
-            #         "organizations/[ORGANIZATION_ID]"
-            #         "billingAccounts/[BILLING_ACCOUNT_ID]"
-            #         "folders/[FOLDER_ID]"
+            #
+            #     *  `projects/[PROJECT_ID]`
+            #     *  `organizations/[ORGANIZATION_ID]`
+            #     *  `billingAccounts/[BILLING_ACCOUNT_ID]`
+            #     *  `folders/[FOLDER_ID]`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Logging::V2::ListLogsResponse]
@@ -618,6 +698,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::LoggingService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListLogsRequest.new
+            #
+            #   # Call the list_logs method.
+            #   result = client.list_logs request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::ListLogsResponse.
+            #   p result
+            #
             def list_logs request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -635,16 +730,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              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.list_logs.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_logs.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @logging_service_stub.call_rpc :list_logs, request, options: options do |response, operation|
@@ -672,6 +771,30 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/logging/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Logging::V2::LoggingService::Client.new
+            #
+            #   # Create an input stream
+            #   input = Gapic::StreamInput.new
+            #
+            #   # Call the tail_log_entries method to start streaming.
+            #   output = client.tail_log_entries input
+            #
+            #   # Send requests on the stream. For each request, pass in keyword
+            #   # arguments to set fields. Be sure to close the stream when done.
+            #   input << Google::Cloud::Logging::V2::TailLogEntriesRequest.new
+            #   input << Google::Cloud::Logging::V2::TailLogEntriesRequest.new
+            #   input.close
+            #
+            #   # Handle streamed responses. These may be interleaved with inputs.
+            #   # Each response is of type ::Google::Cloud::Logging::V2::TailLogEntriesResponse.
+            #   output.each do |response|
+            #     p response
+            #   end
+            #
             def tail_log_entries request, options = nil
               unless request.is_a? ::Enumerable
                 raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
@@ -697,7 +820,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.tail_log_entries.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.tail_log_entries.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @logging_service_stub.call_rpc :tail_log_entries, request, options: options do |response, operation|
@@ -721,22 +846,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 delete_log
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Logging::V2::LoggingService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.delete_log.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Logging::V2::LoggingService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.delete_log.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # delete_log to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Logging::V2::LoggingService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.delete_log.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Logging::V2::LoggingService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.delete_log.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.