google-cloud-logging-v2 0.5.2 → 0.5.6

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Logging::V2::ConfigService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all ConfigService clients:
-            #
-            #     ::Google::Cloud::Logging::V2::ConfigService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all ConfigService clients
+            #   ::Google::Cloud::Logging::V2::ConfigService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -135,19 +134,15 @@ module Google
             ##
             # Create a new ConfigService client object.
             #
-            # ## Examples
-            #
-            # To create a new ConfigService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Logging::V2::ConfigService::Client.new
+            # @example
             #
-            # To create a new ConfigService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Logging::V2::ConfigService::Client.new
             #
-            #     client = ::Google::Cloud::Logging::V2::ConfigService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Logging::V2::ConfigService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the ConfigService client.
             # @yieldparam config [Client::Configuration]
@@ -167,10 +162,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
@@ -238,6 +232,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListBucketsRequest.new
+            #
+            #   # Call the list_buckets method.
+            #   result = client.list_buckets 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::LogBucket.
+            #     p response
+            #   end
+            #
             def list_buckets request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -255,16 +270,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_buckets.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_buckets.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :list_buckets, request, options: options do |response, operation|
@@ -313,6 +332,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::GetBucketRequest.new
+            #
+            #   # Call the get_bucket method.
+            #   result = client.get_bucket request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogBucket.
+            #   p result
+            #
             def get_bucket request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -330,16 +364,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.get_bucket.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_bucket.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :get_bucket, request, options: options do |response, operation|
@@ -392,6 +430,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::CreateBucketRequest.new
+            #
+            #   # Call the create_bucket method.
+            #   result = client.create_bucket request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogBucket.
+            #   p result
+            #
             def create_bucket request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -409,16 +462,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.create_bucket.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_bucket.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :create_bucket, request, options: options do |response, operation|
@@ -488,6 +545,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UpdateBucketRequest.new
+            #
+            #   # Call the update_bucket method.
+            #   result = client.update_bucket request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogBucket.
+            #   p result
+            #
             def update_bucket request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -505,16 +577,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.update_bucket.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_bucket.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :update_bucket, request, options: options do |response, operation|
@@ -565,6 +641,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::DeleteBucketRequest.new
+            #
+            #   # Call the delete_bucket method.
+            #   result = client.delete_bucket request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_bucket request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -582,16 +673,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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_bucket.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_bucket.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :delete_bucket, request, options: options do |response, operation|
@@ -640,6 +735,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UndeleteBucketRequest.new
+            #
+            #   # Call the undelete_bucket method.
+            #   result = client.undelete_bucket request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def undelete_bucket request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -657,16 +767,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.undelete_bucket.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.undelete_bucket.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :undelete_bucket, request, options: options do |response, operation|
@@ -717,6 +831,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListViewsRequest.new
+            #
+            #   # Call the list_views method.
+            #   result = client.list_views 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::LogView.
+            #     p response
+            #   end
+            #
             def list_views request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -734,16 +869,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_views.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_views.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :list_views, request, options: options do |response, operation|
@@ -789,6 +928,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::GetViewRequest.new
+            #
+            #   # Call the get_view method.
+            #   result = client.get_view request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogView.
+            #   p result
+            #
             def get_view request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -806,16 +960,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.get_view.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_view.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :get_view, request, options: options do |response, operation|
@@ -865,6 +1023,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::CreateViewRequest.new
+            #
+            #   # Call the create_view method.
+            #   result = client.create_view request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogView.
+            #   p result
+            #
             def create_view request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -882,16 +1055,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.create_view.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_view.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :create_view, request, options: options do |response, operation|
@@ -948,6 +1125,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UpdateViewRequest.new
+            #
+            #   # Call the update_view method.
+            #   result = client.update_view request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogView.
+            #   p result
+            #
             def update_view request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -965,16 +1157,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.update_view.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_view.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :update_view, request, options: options do |response, operation|
@@ -1019,6 +1215,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::DeleteViewRequest.new
+            #
+            #   # Call the delete_view method.
+            #   result = client.delete_view request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_view request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1036,16 +1247,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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_view.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_view.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :delete_view, request, options: options do |response, operation|
@@ -1099,6 +1314,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListSinksRequest.new
+            #
+            #   # Call the list_sinks method.
+            #   result = client.list_sinks 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::LogSink.
+            #     p response
+            #   end
+            #
             def list_sinks request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1116,16 +1352,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_sinks.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_sinks.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :list_sinks, request, options: options do |response, operation|
@@ -1173,6 +1413,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::GetSinkRequest.new
+            #
+            #   # Call the get_sink method.
+            #   result = client.get_sink request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogSink.
+            #   p result
+            #
             def get_sink request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1190,16 +1445,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "sink_name" => request.sink_name
-              }
+              header_params = {}
+              if request.sink_name
+                header_params["sink_name"] = request.sink_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.get_sink.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_sink.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :get_sink, request, options: options do |response, operation|
@@ -1264,6 +1523,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::CreateSinkRequest.new
+            #
+            #   # Call the create_sink method.
+            #   result = client.create_sink request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogSink.
+            #   p result
+            #
             def create_sink request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1281,16 +1555,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.create_sink.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_sink.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :create_sink, request, options: options do |response, operation|
@@ -1372,6 +1650,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UpdateSinkRequest.new
+            #
+            #   # Call the update_sink method.
+            #   result = client.update_sink request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogSink.
+            #   p result
+            #
             def update_sink request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1389,16 +1682,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "sink_name" => request.sink_name
-              }
+              header_params = {}
+              if request.sink_name
+                header_params["sink_name"] = request.sink_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.update_sink.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_sink.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :update_sink, request, options: options do |response, operation|
@@ -1447,6 +1744,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::DeleteSinkRequest.new
+            #
+            #   # Call the delete_sink method.
+            #   result = client.delete_sink request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_sink request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1464,16 +1776,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "sink_name" => request.sink_name
-              }
+              header_params = {}
+              if request.sink_name
+                header_params["sink_name"] = request.sink_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_sink.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_sink.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :delete_sink, request, options: options do |response, operation|
@@ -1527,6 +1843,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::ListExclusionsRequest.new
+            #
+            #   # Call the list_exclusions method.
+            #   result = client.list_exclusions 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::LogExclusion.
+            #     p response
+            #   end
+            #
             def list_exclusions request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1544,16 +1881,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_exclusions.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_exclusions.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :list_exclusions, request, options: options do |response, operation|
@@ -1601,6 +1942,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::GetExclusionRequest.new
+            #
+            #   # Call the get_exclusion method.
+            #   result = client.get_exclusion request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogExclusion.
+            #   p result
+            #
             def get_exclusion request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1618,16 +1974,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.get_exclusion.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_exclusion.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :get_exclusion, request, options: options do |response, operation|
@@ -1679,6 +2039,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::CreateExclusionRequest.new
+            #
+            #   # Call the create_exclusion method.
+            #   result = client.create_exclusion request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogExclusion.
+            #   p result
+            #
             def create_exclusion request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1696,16 +2071,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.create_exclusion.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_exclusion.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :create_exclusion, request, options: options do |response, operation|
@@ -1763,6 +2142,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UpdateExclusionRequest.new
+            #
+            #   # Call the update_exclusion method.
+            #   result = client.update_exclusion request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::LogExclusion.
+            #   p result
+            #
             def update_exclusion request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1780,16 +2174,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.update_exclusion.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_exclusion.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :update_exclusion, request, options: options do |response, operation|
@@ -1836,6 +2234,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::DeleteExclusionRequest.new
+            #
+            #   # Call the delete_exclusion method.
+            #   result = client.delete_exclusion request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_exclusion request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1853,16 +2266,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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_exclusion.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_exclusion.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :delete_exclusion, request, options: options do |response, operation|
@@ -1921,6 +2338,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::GetCmekSettingsRequest.new
+            #
+            #   # Call the get_cmek_settings method.
+            #   result = client.get_cmek_settings request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::CmekSettings.
+            #   p result
+            #
             def get_cmek_settings request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1938,16 +2370,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.get_cmek_settings.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_cmek_settings.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :get_cmek_settings, request, options: options do |response, operation|
@@ -2026,6 +2462,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::ConfigService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Logging::V2::UpdateCmekSettingsRequest.new
+            #
+            #   # Call the update_cmek_settings method.
+            #   result = client.update_cmek_settings request
+            #
+            #   # The returned object is of type Google::Cloud::Logging::V2::CmekSettings.
+            #   p result
+            #
             def update_cmek_settings request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -2043,16 +2494,20 @@ module Google
                 gapic_version: ::Google::Cloud::Logging::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.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.update_cmek_settings.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_cmek_settings.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @config_service_stub.call_rpc :update_cmek_settings, request, options: options do |response, operation|
@@ -2076,22 +2531,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 list_buckets
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Logging::V2::ConfigService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_buckets.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Logging::V2::ConfigService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_buckets.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_buckets to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Logging::V2::ConfigService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_buckets.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Logging::V2::ConfigService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_buckets.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.