google-cloud-logging 1.10.4 → 1.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c44ea43caa6da57f944c25da29cb76c70b99805fbf517f36273e290f39e51a1
-  data.tar.gz: 9d4b2142b4713362151659a8af7b959be1950fe895254500a300052655e7c228
+  metadata.gz: 8e0a56b6f77ff53c3af5343211fc4066b3c0b020565300eac6ae2f5034f9f603
+  data.tar.gz: c6f7f6e4743bb5467877ecb6a50f9fa9f414c7db232b34d7ef74430d2be8a078
 SHA512:
-  metadata.gz: 6544f6f25befee91e60d009685797fab479c77d2d679584b35965bea7a44c536efe77a9bb8b68340719937371030129f018eb5fdff34221bff58752ceb98e240
-  data.tar.gz: c1219e8155a148df9874c5ddb6b0b03b9365b358f3bf3e855beebc9da6acc5307679a8c4c4c387350e8a9169b3a45eb67d0731e297c0c120033831018ff74fec
+  metadata.gz: 2ea063d11a971c2ce63315946c4610418d148f3a1f7f6bf10e29e8c232e1a5680b8f8ee2790a023f2c357f0c2a2e4cfece85cef49a778c56aa87e6e92c162b2c
+  data.tar.gz: 1439fbef427b0c6abe1f50707b1788426bf4163c0dff656ad6b2b005b093e96ca3a3b63eb8cfeac858834a956b1cd456fa678087776e397669ee0d519239b396

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Release History
 
+### 1.10.9 / 2020-06-17
+
+#### Documentation
+
+* Improved field descriptions in the low-level interface.
+
+### 1.10.8 / 2020-06-12
+
+#### Documentation
+
+* Provide more details on low-level monitored resource data types
+
+### 1.10.7 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
+### 1.10.6 / 2020-05-19
+
+#### Bug Fixes
+
+* Adjusted some default timeout and retry settings
+
+### 1.10.5 / 2020-05-05
+
+#### Bug Fixes
+
+* Prevent error when calling stop! on unused AsyncWriter
+
 ### 1.10.4 / 2020-04-20
 
 #### Documentation

data/TROUBLESHOOTING.md

@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
 
   - [New issue][gh-ruby]
 
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
 [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+logging
 
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+logging%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+[gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+logging%22
 
-[slack-ruby]: https://gcp-slack.appspot.com/
+[gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new

data/lib/google/cloud/logging/async_writer.rb

@@ -155,7 +155,7 @@ module Google
               max_threads: @threads, max_queue: @max_queue
             @thread ||= Thread.new { run_background }
 
-            publish_batch! if @batch.ready?
+            publish_batch! if @batch&.ready?
 
             @cond.broadcast
           end
@@ -222,6 +222,10 @@ module Google
         # writer. To stop the writer, first call {#stop} and then call {#wait!}
         # to block until the writer is stopped.
         #
+        # @param [Number, nil] timeout The maximum number of seconds to wait for
+        #   shutdown to complete. Will wait forever when the value is `nil`. The
+        #   default value is `nil`.
+        #
         # @return [AsyncWriter] returns self so calls can be chained.
         def wait! timeout = nil
           synchronize do
@@ -237,18 +241,22 @@ module Google
         ##
         # Stop this asynchronous writer and block until it has been stopped.
         #
-        # @param [Number] timeout Timeout in seconds.
+        # @param [Number, nil] timeout The maximum number of seconds to wait for
+        #   shutdown to complete. Will wait forever when the value is `nil`. The
+        #   default value is `nil`.
         # @param [Boolean] force If set to true, and the writer hasn't stopped
-        #     within the given timeout, kill it forcibly by terminating the
-        #     thread. This should be used with extreme caution, as it can
-        #     leave RPCs unfinished. Default is false.
+        #   within the given timeout, kill it forcibly by terminating the
+        #   thread. This should be used with extreme caution, as it can
+        #   leave RPCs unfinished. Default is false.
         #
-        # @return [Symbol] Returns `:stopped` if the AsyncWriter was already
-        #     stopped at the time of invocation, `:waited` if it stopped
-        #     during the timeout period, `:timeout` if it is still running
-        #     after the timeout, or `:forced` if it was forcibly killed.
+        # @return [Symbol] Returns `:new` if {#write_entries} has never been
+        #   called on the AsyncWriter, `:stopped` if it was already stopped
+        #   at the time of invocation, `:waited` if it stopped during the
+        #   timeout period, `:timeout` if it is still running after the
+        #   timeout, or `:forced` if it was forcibly killed.
         #
         def stop! timeout = nil, force: nil
+          return :new unless @thread_pool
           return :stopped if stopped?
 
           stop

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

@@ -388,6 +388,30 @@ module Google
               &Google::Logging::V2::ConfigServiceV2::Stub.method(:new)
             )
 
+            @delete_sink = Google::Gax.create_api_call(
+              @config_service_v2_stub.method(:delete_sink),
+              defaults["delete_sink"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'sink_name' => request.sink_name}
+              end
+            )
+            @update_sink = Google::Gax.create_api_call(
+              @config_service_v2_stub.method(:update_sink),
+              defaults["update_sink"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'sink_name' => request.sink_name}
+              end
+            )
+            @delete_exclusion = Google::Gax.create_api_call(
+              @config_service_v2_stub.method(:delete_exclusion),
+              defaults["delete_exclusion"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
+            )
             @list_buckets = Google::Gax.create_api_call(
               @config_service_v2_stub.method(:list_buckets),
               defaults["list_buckets"],
@@ -436,22 +460,6 @@ module Google
                 {'parent' => request.parent}
               end
             )
-            @update_sink = Google::Gax.create_api_call(
-              @config_service_v2_stub.method(:update_sink),
-              defaults["update_sink"],
-              exception_transformer: exception_transformer,
-              params_extractor: proc do |request|
-                {'sink_name' => request.sink_name}
-              end
-            )
-            @delete_sink = Google::Gax.create_api_call(
-              @config_service_v2_stub.method(:delete_sink),
-              defaults["delete_sink"],
-              exception_transformer: exception_transformer,
-              params_extractor: proc do |request|
-                {'sink_name' => request.sink_name}
-              end
-            )
             @list_exclusions = Google::Gax.create_api_call(
               @config_service_v2_stub.method(:list_exclusions),
               defaults["list_exclusions"],
@@ -484,14 +492,6 @@ module Google
                 {'name' => request.name}
               end
             )
-            @delete_exclusion = Google::Gax.create_api_call(
-              @config_service_v2_stub.method(:delete_exclusion),
-              defaults["delete_exclusion"],
-              exception_transformer: exception_transformer,
-              params_extractor: proc do |request|
-                {'name' => request.name}
-              end
-            )
             @get_cmek_settings = Google::Gax.create_api_call(
               @config_service_v2_stub.method(:get_cmek_settings),
               defaults["get_cmek_settings"],
@@ -512,6 +512,173 @@ module Google
 
           # Service calls
 
+          # Deletes a sink. If the sink has a unique `writer_identity`, then that
+          # service account is also deleted.
+          #
+          # @param sink_name [String]
+          #   Required. The full resource name of the sink to delete, including the parent
+          #   resource and the sink identifier:
+          #
+          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
+          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
+          #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
+          #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
+          #
+          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result []
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/logging/v2"
+          #
+          #   config_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
+          #
+          #   # TODO: Initialize `sink_name`:
+          #   sink_name = ''
+          #   config_client.delete_sink(sink_name)
+
+          def delete_sink \
+              sink_name,
+              options: nil,
+              &block
+            req = {
+              sink_name: sink_name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteSinkRequest)
+            @delete_sink.call(req, options, &block)
+            nil
+          end
+
+          # Updates a sink. This method replaces the following fields in the existing
+          # sink with values from the new sink: `destination`, and `filter`.
+          #
+          # The updated sink might also have a new `writer_identity`; see the
+          # `unique_writer_identity` field.
+          #
+          # @param sink_name [String]
+          #   Required. The full resource name of the sink to update, including the parent
+          #   resource and the sink identifier:
+          #
+          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
+          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
+          #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
+          #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
+          #
+          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
+          # @param sink [Google::Logging::V2::LogSink | Hash]
+          #   Required. The updated sink, whose name is the same identifier that appears as part
+          #   of `sink_name`.
+          #   A hash of the same form as `Google::Logging::V2::LogSink`
+          #   can also be provided.
+          # @param unique_writer_identity [true, false]
+          #   Optional. See {Google::Logging::V2::ConfigServiceV2#create_sink}
+          #   for a description of this field. When updating a sink, the effect of this
+          #   field on the value of `writer_identity` in the updated sink depends on both
+          #   the old and new values of this field:
+          #
+          #   * If the old and new values of this field are both false or both true,
+          #     then there is no change to the sink's `writer_identity`.
+          #   * If the old value is false and the new value is true, then
+          #     `writer_identity` is changed to a unique service account.
+          #   * It is an error if the old value is true and the new value is
+          #     set to false or defaulted to false.
+          # @param update_mask [Google::Protobuf::FieldMask | Hash]
+          #   Optional. Field mask that specifies the fields in `sink` that need
+          #   an update. A sink field will be overwritten if, and only if, it is
+          #   in the update mask. `name` and output only fields cannot be updated.
+          #
+          #   An empty updateMask is temporarily treated as using the following mask
+          #   for backwards compatibility purposes:
+          #     destination,filter,includeChildren
+          #   At some point in the future, behavior will be removed and specifying an
+          #   empty updateMask will be an error.
+          #
+          #   For a detailed `FieldMask` definition, see
+          #   https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
+          #
+          #   Example: `updateMask=filter`.
+          #   A hash of the same form as `Google::Protobuf::FieldMask`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Logging::V2::LogSink]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Logging::V2::LogSink]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/logging/v2"
+          #
+          #   config_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
+          #
+          #   # TODO: Initialize `sink_name`:
+          #   sink_name = ''
+          #
+          #   # TODO: Initialize `sink`:
+          #   sink = {}
+          #   response = config_client.update_sink(sink_name, sink)
+
+          def update_sink \
+              sink_name,
+              sink,
+              unique_writer_identity: nil,
+              update_mask: nil,
+              options: nil,
+              &block
+            req = {
+              sink_name: sink_name,
+              sink: sink,
+              unique_writer_identity: unique_writer_identity,
+              update_mask: update_mask
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateSinkRequest)
+            @update_sink.call(req, options, &block)
+          end
+
+          # Deletes an exclusion.
+          #
+          # @param name [String]
+          #   Required. The resource name of an existing exclusion to delete:
+          #
+          #       "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
+          #       "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
+          #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
+          #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
+          #
+          #   Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result []
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/logging/v2"
+          #
+          #   config_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
+          #
+          #   # TODO: Initialize `name`:
+          #   name = ''
+          #   config_client.delete_exclusion(name)
+
+          def delete_exclusion \
+              name,
+              options: nil,
+              &block
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteExclusionRequest)
+            @delete_exclusion.call(req, options, &block)
+            nil
+          end
+
           # Lists buckets (Beta).
           #
           # @param parent [String]
@@ -854,134 +1021,6 @@ module Google
             @create_sink.call(req, options, &block)
           end
 
-          # Updates a sink. This method replaces the following fields in the existing
-          # sink with values from the new sink: `destination`, and `filter`.
-          #
-          # The updated sink might also have a new `writer_identity`; see the
-          # `unique_writer_identity` field.
-          #
-          # @param sink_name [String]
-          #   Required. The full resource name of the sink to update, including the parent
-          #   resource and the sink identifier:
-          #
-          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
-          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
-          #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
-          #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
-          #
-          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
-          # @param sink [Google::Logging::V2::LogSink | Hash]
-          #   Required. The updated sink, whose name is the same identifier that appears as part
-          #   of `sink_name`.
-          #   A hash of the same form as `Google::Logging::V2::LogSink`
-          #   can also be provided.
-          # @param unique_writer_identity [true, false]
-          #   Optional. See {Google::Logging::V2::ConfigServiceV2#create_sink}
-          #   for a description of this field. When updating a sink, the effect of this
-          #   field on the value of `writer_identity` in the updated sink depends on both
-          #   the old and new values of this field:
-          #
-          #   * If the old and new values of this field are both false or both true,
-          #     then there is no change to the sink's `writer_identity`.
-          #   * If the old value is false and the new value is true, then
-          #     `writer_identity` is changed to a unique service account.
-          #   * It is an error if the old value is true and the new value is
-          #     set to false or defaulted to false.
-          # @param update_mask [Google::Protobuf::FieldMask | Hash]
-          #   Optional. Field mask that specifies the fields in `sink` that need
-          #   an update. A sink field will be overwritten if, and only if, it is
-          #   in the update mask. `name` and output only fields cannot be updated.
-          #
-          #   An empty updateMask is temporarily treated as using the following mask
-          #   for backwards compatibility purposes:
-          #     destination,filter,includeChildren
-          #   At some point in the future, behavior will be removed and specifying an
-          #   empty updateMask will be an error.
-          #
-          #   For a detailed `FieldMask` definition, see
-          #   https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
-          #
-          #   Example: `updateMask=filter`.
-          #   A hash of the same form as `Google::Protobuf::FieldMask`
-          #   can also be provided.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @yield [result, operation] Access the result along with the RPC operation
-          # @yieldparam result [Google::Logging::V2::LogSink]
-          # @yieldparam operation [GRPC::ActiveCall::Operation]
-          # @return [Google::Logging::V2::LogSink]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/logging/v2"
-          #
-          #   config_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
-          #
-          #   # TODO: Initialize `sink_name`:
-          #   sink_name = ''
-          #
-          #   # TODO: Initialize `sink`:
-          #   sink = {}
-          #   response = config_client.update_sink(sink_name, sink)
-
-          def update_sink \
-              sink_name,
-              sink,
-              unique_writer_identity: nil,
-              update_mask: nil,
-              options: nil,
-              &block
-            req = {
-              sink_name: sink_name,
-              sink: sink,
-              unique_writer_identity: unique_writer_identity,
-              update_mask: update_mask
-            }.delete_if { |_, v| v.nil? }
-            req = Google::Gax::to_proto(req, Google::Logging::V2::UpdateSinkRequest)
-            @update_sink.call(req, options, &block)
-          end
-
-          # Deletes a sink. If the sink has a unique `writer_identity`, then that
-          # service account is also deleted.
-          #
-          # @param sink_name [String]
-          #   Required. The full resource name of the sink to delete, including the parent
-          #   resource and the sink identifier:
-          #
-          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
-          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
-          #       "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
-          #       "folders/[FOLDER_ID]/sinks/[SINK_ID]"
-          #
-          #   Example: `"projects/my-project-id/sinks/my-sink-id"`.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @yield [result, operation] Access the result along with the RPC operation
-          # @yieldparam result []
-          # @yieldparam operation [GRPC::ActiveCall::Operation]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/logging/v2"
-          #
-          #   config_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
-          #
-          #   # TODO: Initialize `sink_name`:
-          #   sink_name = ''
-          #   config_client.delete_sink(sink_name)
-
-          def delete_sink \
-              sink_name,
-              options: nil,
-              &block
-            req = {
-              sink_name: sink_name
-            }.delete_if { |_, v| v.nil? }
-            req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteSinkRequest)
-            @delete_sink.call(req, options, &block)
-            nil
-          end
-
           # Lists all the exclusions in a parent resource.
           #
           # @param parent [String]
@@ -1193,45 +1232,6 @@ module Google
             @update_exclusion.call(req, options, &block)
           end
 
-          # Deletes an exclusion.
-          #
-          # @param name [String]
-          #   Required. The resource name of an existing exclusion to delete:
-          #
-          #       "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
-          #       "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
-          #       "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
-          #       "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
-          #
-          #   Example: `"projects/my-project-id/exclusions/my-exclusion-id"`.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @yield [result, operation] Access the result along with the RPC operation
-          # @yieldparam result []
-          # @yieldparam operation [GRPC::ActiveCall::Operation]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/logging/v2"
-          #
-          #   config_client = Google::Cloud::Logging::V2::ConfigServiceV2Client.new
-          #
-          #   # TODO: Initialize `name`:
-          #   name = ''
-          #   config_client.delete_exclusion(name)
-
-          def delete_exclusion \
-              name,
-              options: nil,
-              &block
-            req = {
-              name: name
-            }.delete_if { |_, v| v.nil? }
-            req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteExclusionRequest)
-            @delete_exclusion.call(req, options, &block)
-            nil
-          end
-
           # Gets the Logs Router CMEK settings for the given resource.
           #
           # Note: CMEK for the Logs Router can currently only be configured for GCP