google-cloud-logging 0.21.2 → 0.23.0

data/lib/google/cloud/logging/sink/list.rb

@@ -62,7 +62,7 @@ module Google
           #
           #   logging = Google::Cloud::Logging.new
           #
-          #   sinks = dataset.sinks
+          #   sinks = logging.sinks
           #   if sinks.next?
           #     next_sinks = sinks.next
           #   end

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

@@ -12,6 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "google/cloud/logging/v2/config_service_v2_api"
-require "google/cloud/logging/v2/logging_service_v2_api"
-require "google/cloud/logging/v2/metrics_service_v2_api"
+require "google/cloud/logging/v2/config_service_v2_client"
+require "google/cloud/logging/v2/logging_service_v2_client"
+require "google/cloud/logging/v2/metrics_service_v2_client"

data/lib/google/cloud/logging/v2/{config_service_v2_api.rb → config_service_v2_client.rb}

@@ -32,12 +32,12 @@ module Google
   module Cloud
     module Logging
       module V2
-        # Service for configuring sinks used to export log entries outside Stackdriver
-        # Logging.
+        # Service for configuring sinks used to export log entries outside of
+        # Stackdriver Logging.
         #
         # @!attribute [r] config_service_v2_stub
         #   @return [Google::Logging::V2::ConfigServiceV2::Stub]
-        class ConfigServiceV2Api
+        class ConfigServiceV2Client
           attr_reader :config_service_v2_stub
 
           # The default address of the service.
@@ -69,11 +69,11 @@ module Google
             "https://www.googleapis.com/auth/logging.write"
           ].freeze
 
-          PARENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+          PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}"
           )
 
-          private_constant :PARENT_PATH_TEMPLATE
+          private_constant :PROJECT_PATH_TEMPLATE
 
           SINK_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/sinks/{sink}"
@@ -81,11 +81,11 @@ module Google
 
           private_constant :SINK_PATH_TEMPLATE
 
-          # Returns a fully-qualified parent resource name string.
+          # Returns a fully-qualified project resource name string.
           # @param project [String]
           # @return [String]
-          def self.parent_path project
-            PARENT_PATH_TEMPLATE.render(
+          def self.project_path project
+            PROJECT_PATH_TEMPLATE.render(
               :"project" => project
             )
           end
@@ -101,11 +101,11 @@ module Google
             )
           end
 
-          # Parses the project from a parent resource.
-          # @param parent_name [String]
+          # Parses the project from a project resource.
+          # @param project_name [String]
           # @return [String]
-          def self.match_project_from_parent_name parent_name
-            PARENT_PATH_TEMPLATE.match(parent_name)["project"]
+          def self.match_project_from_project_name project_name
+            PROJECT_PATH_TEMPLATE.match(project_name)["project"]
           end
 
           # Parses the project from a sink resource.
@@ -157,6 +157,7 @@ module Google
             require "google/gax/grpc"
             require "google/logging/v2/logging_config_services_pb"
 
+
             google_api_client = "#{app_name}/#{app_version} " \
               "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
               "ruby/#{RUBY_VERSION}".freeze
@@ -212,8 +213,10 @@ module Google
           # Lists sinks.
           #
           # @param parent [String]
-          #   Required. The cloud resource containing the sinks.
-          #   Example: +"projects/my-logging-project"+.
+          #   Required. The resource name where this sink was created:
+          #
+          #       "projects/[PROJECT_ID]"
+          #       "organizations/[ORGANIZATION_ID]"
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
           #   response. If page streaming is performed per-resource, this
@@ -230,20 +233,20 @@ module Google
           #   object.
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/logging/v2/config_service_v2_api"
+          #   require "google/cloud/logging/v2/config_service_v2_client"
           #
-          #   ConfigServiceV2Api = Google::Cloud::Logging::V2::ConfigServiceV2Api
+          #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
           #
-          #   config_service_v2_api = ConfigServiceV2Api.new
-          #   formatted_parent = ConfigServiceV2Api.parent_path("[PROJECT]")
+          #   config_service_v2_client = ConfigServiceV2Client.new
+          #   formatted_parent = ConfigServiceV2Client.project_path("[PROJECT]")
           #
           #   # Iterate over all results.
-          #   config_service_v2_api.list_sinks(formatted_parent).each do |element|
+          #   config_service_v2_client.list_sinks(formatted_parent).each do |element|
           #     # Process element.
           #   end
           #
           #   # Or iterate over results one page at a time.
-          #   config_service_v2_api.list_sinks(formatted_parent).each_page do |page|
+          #   config_service_v2_client.list_sinks(formatted_parent).each_page do |page|
           #     # Process each page at a time.
           #     page.each do |element|
           #       # Process element.
@@ -264,21 +267,23 @@ module Google
           # Gets a sink.
           #
           # @param sink_name [String]
-          #   Required. The resource name of the sink to return.
-          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          #   Required. The resource name of the sink to return:
+          #
+          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
+          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @return [Google::Logging::V2::LogSink]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/logging/v2/config_service_v2_api"
+          #   require "google/cloud/logging/v2/config_service_v2_client"
           #
-          #   ConfigServiceV2Api = Google::Cloud::Logging::V2::ConfigServiceV2Api
+          #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
           #
-          #   config_service_v2_api = ConfigServiceV2Api.new
-          #   formatted_sink_name = ConfigServiceV2Api.sink_path("[PROJECT]", "[SINK]")
-          #   response = config_service_v2_api.get_sink(formatted_sink_name)
+          #   config_service_v2_client = ConfigServiceV2Client.new
+          #   formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
+          #   response = config_service_v2_client.get_sink(formatted_sink_name)
 
           def get_sink \
               sink_name,
@@ -292,35 +297,44 @@ module Google
           # Creates a sink.
           #
           # @param parent [String]
-          #   Required. The resource in which to create the sink.
-          #   Example: +"projects/my-project-id"+.
-          #   The new sink must be provided in the request.
+          #   Required. The resource in which to create the sink:
+          #
+          #       "projects/[PROJECT_ID]"
+          #       "organizations/[ORGANIZATION_ID]"
           # @param sink [Google::Logging::V2::LogSink]
           #   Required. The new sink, whose +name+ parameter is a sink identifier that
           #   is not already in use.
+          # @param unique_writer_identity [true, false]
+          #   Optional. Whether the sink will have a dedicated service account returned
+          #   in the sink's writer_identity. Set this field to be true to export
+          #   logs from one project to a different project. This field is ignored for
+          #   non-project sinks (e.g. organization sinks) because those sinks are
+          #   required to have dedicated service accounts.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @return [Google::Logging::V2::LogSink]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/logging/v2/config_service_v2_api"
+          #   require "google/cloud/logging/v2/config_service_v2_client"
           #
-          #   ConfigServiceV2Api = Google::Cloud::Logging::V2::ConfigServiceV2Api
+          #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
           #   LogSink = Google::Logging::V2::LogSink
           #
-          #   config_service_v2_api = ConfigServiceV2Api.new
-          #   formatted_parent = ConfigServiceV2Api.parent_path("[PROJECT]")
+          #   config_service_v2_client = ConfigServiceV2Client.new
+          #   formatted_parent = ConfigServiceV2Client.project_path("[PROJECT]")
           #   sink = LogSink.new
-          #   response = config_service_v2_api.create_sink(formatted_parent, sink)
+          #   response = config_service_v2_client.create_sink(formatted_parent, sink)
 
           def create_sink \
               parent,
               sink,
+              unique_writer_identity: nil,
               options: nil
             req = Google::Logging::V2::CreateSinkRequest.new({
               parent: parent,
-              sink: sink
+              sink: sink,
+              unique_writer_identity: unique_writer_identity
             }.delete_if { |_, v| v.nil? })
             @create_sink.call(req, options)
           end
@@ -329,35 +343,47 @@ module Google
           #
           # @param sink_name [String]
           #   Required. The resource name of the sink to update, including the parent
-          #   resource and the sink identifier.  If the sink does not exist, this method
-          #   creates the sink.  Example: +"projects/my-project-id/sinks/my-sink-id"+.
+          #   resource and the sink identifier:
+          #
+          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
+          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
+          #
+          #   Example: +"projects/my-project-id/sinks/my-sink-id"+.
           # @param sink [Google::Logging::V2::LogSink]
           #   Required. The updated sink, whose name is the same identifier that appears
           #   as part of +sinkName+.  If +sinkName+ does not exist, then
           #   this method creates a new sink.
+          # @param unique_writer_identity [true, false]
+          #   Optional. Whether the sink will have a dedicated service account returned
+          #   in the sink's writer_identity. Set this field to be true to export
+          #   logs from one project to a different project. This field is ignored for
+          #   non-project sinks (e.g. organization sinks) because those sinks are
+          #   required to have dedicated service accounts.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @return [Google::Logging::V2::LogSink]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/logging/v2/config_service_v2_api"
+          #   require "google/cloud/logging/v2/config_service_v2_client"
           #
-          #   ConfigServiceV2Api = Google::Cloud::Logging::V2::ConfigServiceV2Api
+          #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
           #   LogSink = Google::Logging::V2::LogSink
           #
-          #   config_service_v2_api = ConfigServiceV2Api.new
-          #   formatted_sink_name = ConfigServiceV2Api.sink_path("[PROJECT]", "[SINK]")
+          #   config_service_v2_client = ConfigServiceV2Client.new
+          #   formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
           #   sink = LogSink.new
-          #   response = config_service_v2_api.update_sink(formatted_sink_name, sink)
+          #   response = config_service_v2_client.update_sink(formatted_sink_name, sink)
 
           def update_sink \
               sink_name,
               sink,
+              unique_writer_identity: nil,
               options: nil
             req = Google::Logging::V2::UpdateSinkRequest.new({
               sink_name: sink_name,
-              sink: sink
+              sink: sink,
+              unique_writer_identity: unique_writer_identity
             }.delete_if { |_, v| v.nil? })
             @update_sink.call(req, options)
           end
@@ -366,21 +392,24 @@ module Google
           #
           # @param sink_name [String]
           #   Required. The resource name of the sink to delete, including the parent
-          #   resource and the sink identifier.  Example:
-          #   +"projects/my-project-id/sinks/my-sink-id"+.  It is an error if the sink
-          #   does not exist.
+          #   resource and the sink identifier:
+          #
+          #       "projects/[PROJECT_ID]/sinks/[SINK_ID]"
+          #       "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
+          #
+          #   It is an error if the sink does not exist.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/logging/v2/config_service_v2_api"
+          #   require "google/cloud/logging/v2/config_service_v2_client"
           #
-          #   ConfigServiceV2Api = Google::Cloud::Logging::V2::ConfigServiceV2Api
+          #   ConfigServiceV2Client = Google::Cloud::Logging::V2::ConfigServiceV2Client
           #
-          #   config_service_v2_api = ConfigServiceV2Api.new
-          #   formatted_sink_name = ConfigServiceV2Api.sink_path("[PROJECT]", "[SINK]")
-          #   config_service_v2_api.delete_sink(formatted_sink_name)
+          #   config_service_v2_client = ConfigServiceV2Client.new
+          #   formatted_sink_name = ConfigServiceV2Client.sink_path("[PROJECT]", "[SINK]")
+          #   config_service_v2_client.delete_sink(formatted_sink_name)
 
           def delete_sink \
               sink_name,
@@ -389,6 +418,7 @@ module Google
               sink_name: sink_name
             }.delete_if { |_, v| v.nil? })
             @delete_sink.call(req, options)
+            nil
           end
         end
       end

data/lib/google/cloud/logging/v2/doc/google/api/label.rb

@@ -0,0 +1,41 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Api
+    # A description of a label.
+    # @!attribute [rw] key
+    #   @return [String]
+    #     The label key.
+    # @!attribute [rw] value_type
+    #   @return [Google::Api::LabelDescriptor::ValueType]
+    #     The type of data that can be assigned to the label.
+    # @!attribute [rw] description
+    #   @return [String]
+    #     A human-readable description for the label.
+    class LabelDescriptor
+      # Value types that can be used as label values.
+      module ValueType
+        # A variable-length string. This is the default.
+        STRING = 0
+
+        # Boolean; true or false.
+        BOOL = 1
+
+        # A 64-bit signed integer.
+        INT64 = 2
+      end
+    end
+  end
+end

data/lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb

@@ -18,17 +18,22 @@ module Google
       # An individual entry in a log.
       # @!attribute [rw] log_name
       #   @return [String]
-      #     Required. The resource name of the log to which this log entry
-      #     belongs. The format of the name is
-      #     +"projects/<project-id>/logs/<log-id>"+.  Examples:
-      #     +"projects/my-projectid/logs/syslog"+,
-      #     +"projects/my-projectid/logs/library.googleapis.com%2Fbook_log"+.
+      #     Required. The resource name of the log to which this log entry belongs:
       #
-      #     The log ID part of resource name must be less than 512 characters
-      #     long and can only include the following characters: upper and
-      #     lower case alphanumeric characters: [A-Za-z0-9]; and punctuation
-      #     characters: forward-slash, underscore, hyphen, and period.
-      #     Forward-slash (+/+) characters in the log ID must be URL-encoded.
+      #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
+      #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+      #
+      #     +[LOG_ID]+ must be URL-encoded within +log_name+. Example:
+      #     +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
+      #     +[LOG_ID]+ must be less than 512 characters long and can only include the
+      #     following characters: upper and lower case alphanumeric characters,
+      #     forward-slash, underscore, hyphen, and period.
+      #
+      #     For backward compatibility, if +log_name+ begins with a forward-slash, such
+      #     as +/projects/...+, then the log entry is ingested as usual but the
+      #     forward-slash is removed. Listing the log entry will not show the leading
+      #     slash and filtering for a log name with a leading slash will never return
+      #     any results.
       # @!attribute [rw] resource
       #   @return [Google::Api::MonitoredResource]
       #     Required. The monitored resource associated with this log entry.
@@ -45,8 +50,8 @@ module Google
       #     The log entry payload, represented as a Unicode string (UTF-8).
       # @!attribute [rw] json_payload
       #   @return [Google::Protobuf::Struct]
-      #     The log entry payload, represented as a structure that
-      #     is expressed as a JSON object.
+      #     The log entry payload, represented as a structure that is
+      #     expressed as a JSON object.
       # @!attribute [rw] timestamp
       #   @return [Google::Protobuf::Timestamp]
       #     Optional. The time the event described by the log entry occurred.  If

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

@@ -18,16 +18,31 @@ module Google
       # The parameters to DeleteLog.
       # @!attribute [rw] log_name
       #   @return [String]
-      #     Required. The resource name of the log to delete.  Example:
-      #     +"projects/my-project/logs/syslog"+.
+      #     Required. The resource name of the log to delete:
+      #
+      #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
+      #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+      #
+      #     +[LOG_ID]+ must be URL-encoded. For example,
+      #     +"projects/my-project-id/logs/syslog"+,
+      #     +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
+      #     For more information about log names, see
+      #     LogEntry.
       class DeleteLogRequest; end
 
       # The parameters to WriteLogEntries.
       # @!attribute [rw] log_name
       #   @return [String]
       #     Optional. A default log resource name that is assigned to all log entries
-      #     in +entries+ that do not specify a value for +log_name+.  Example:
-      #     +"projects/my-project/logs/syslog"+.  See
+      #     in +entries+ that do not specify a value for +log_name+:
+      #
+      #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
+      #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+      #
+      #     +[LOG_ID]+ must be URL-encoded. For example,
+      #     +"projects/my-project-id/logs/syslog"+ or
+      #     +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
+      #     For more information about log names, see
       #     LogEntry.
       # @!attribute [rw] resource
       #   @return [Google::Api::MonitoredResource]
@@ -73,20 +88,25 @@ module Google
       # @!attribute [rw] project_ids
       #   @return [Array<String>]
       #     Deprecated. One or more project identifiers or project numbers from which
-      #     to retrieve log entries.  Examples: +"my-project-1A"+, +"1234567890"+. If
+      #     to retrieve log entries.  Example: +"my-project-1A"+. If
       #     present, these project identifiers are converted to resource format and
       #     added to the list of resources in +resourceNames+. Callers should use
       #     +resourceNames+ rather than this parameter.
       # @!attribute [rw] resource_names
       #   @return [Array<String>]
-      #     Optional. One or more cloud resources from which to retrieve log entries.
-      #     Example: +"projects/my-project-1A"+, +"projects/1234567890"+.  Projects
-      #     listed in +projectIds+ are added to this list.
+      #     Required. One or more cloud resources from which to retrieve log
+      #     entries:
+      #
+      #         "projects/[PROJECT_ID]"
+      #         "organizations/[ORGANIZATION_ID]"
+      #
+      #     Projects listed in the +project_ids+ field are added to this list.
       # @!attribute [rw] filter
       #   @return [String]
       #     Optional. A filter that chooses which log entries to return.  See {Advanced
       #     Logs Filters}[https://cloud.google.com/logging/docs/view/advanced_filters].  Only log entries that
       #     match the filter are returned.  An empty filter matches all log entries.
+      #     The maximum length of the filter is 20000 characters.
       # @!attribute [rw] order_by
       #   @return [String]
       #     Optional. How the results should be sorted.  Presently, the only permitted