google-cloud-logging-v2 0.5.1 → 0.5.5

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]
@@ -67,50 +66,32 @@ module Google
 
                 default_config.rpcs.delete_log.timeout = 60.0
                 default_config.rpcs.delete_log.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.write_log_entries.timeout = 60.0
                 default_config.rpcs.write_log_entries.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.list_log_entries.timeout = 60.0
                 default_config.rpcs.list_log_entries.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.list_monitored_resource_descriptors.timeout = 60.0
                 default_config.rpcs.list_monitored_resource_descriptors.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.list_logs.timeout = 60.0
                 default_config.rpcs.list_logs.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.tail_log_entries.timeout = 3600.0
                 default_config.rpcs.tail_log_entries.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config
@@ -142,19 +123,15 @@ module Google
             ##
             # Create a new LoggingService client object.
             #
-            # ## Examples
-            #
-            # To create a new LoggingService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Logging::V2::LoggingService::Client.new
+            # @example
             #
-            # To create a new LoggingService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Logging::V2::LoggingService::Client.new
             #
-            #     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]
@@ -174,14 +151,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
@@ -241,6 +217,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?
 
@@ -258,16 +249,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|
@@ -378,6 +373,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?
 
@@ -398,7 +408,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|
@@ -480,6 +492,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?
 
@@ -500,7 +533,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|
@@ -548,6 +583,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?
 
@@ -568,7 +624,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|
@@ -636,6 +694,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?
 
@@ -653,16 +726,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|
@@ -690,6 +767,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
@@ -715,7 +816,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|
@@ -739,22 +842,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.