google-cloud-logging 0.21.0 → 0.21.1

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

@@ -0,0 +1,150 @@
+# 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 Logging
+    module V2
+      # Describes a sink used to export log entries outside Stackdriver Logging.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     Required. The client-assigned sink identifier, unique within the
+      #     project. Example: +"my-syslog-errors-to-pubsub"+.  Sink identifiers are
+      #     limited to 1000 characters and can include only the following characters:
+      #     +A-Z+, +a-z+, +0-9+, and the special characters +_-.+.  The maximum length
+      #     of the name is 100 characters.
+      # @!attribute [rw] destination
+      #   @return [String]
+      #     Required. The export destination. See
+      #     {Exporting Logs With Sinks}[https://cloud.google.com/logging/docs/api/tasks/exporting-logs].
+      #     Examples:
+      #
+      #         "storage.googleapis.com/my-gcs-bucket"
+      #         "bigquery.googleapis.com/projects/my-project-id/datasets/my-dataset"
+      #         "pubsub.googleapis.com/projects/my-project/topics/my-topic"
+      # @!attribute [rw] filter
+      #   @return [String]
+      #     Optional. An {advanced logs filter}[https://cloud.google.com/logging/docs/view/advanced_filters].
+      #     Only log entries matching the filter are exported. The filter
+      #     must be consistent with the log entry format specified by the
+      #     +outputVersionFormat+ parameter, regardless of the format of the
+      #     log entry that was originally written to Stackdriver Logging.
+      #     Example filter (V2 format):
+      #
+      #         logName=projects/my-projectid/logs/syslog AND severity>=ERROR
+      # @!attribute [rw] output_version_format
+      #   @return [Google::Logging::V2::LogSink::VersionFormat]
+      #     Optional. The log entry version to use for this sink's exported log
+      #     entries.  This version does not have to correspond to the version of the
+      #     log entry that was written to Stackdriver Logging. If omitted, the
+      #     v2 format is used.
+      # @!attribute [rw] writer_identity
+      #   @return [String]
+      #     Output only. The iam identity to which the destination needs to grant write
+      #     access.  This may be a service account or a group.
+      #     Examples (Do not assume these specific values):
+      #        "serviceAccount:cloud-logs@system.gserviceaccount.com"
+      #        "group:cloud-logs@google.com"
+      #
+      #       For GCS destinations, the role "roles/owner" is required on the bucket
+      #       For Cloud Pubsub destinations, the role "roles/pubsub.publisher" is
+      #         required on the topic
+      #       For BigQuery, the role "roles/editor" is required on the dataset
+      class LogSink
+        # Available log entry formats. Log entries can be written to Cloud
+        # Logging in either format and can be exported in either format.
+        # Version 2 is the preferred format.
+        module VersionFormat
+          # An unspecified version format will default to V2.
+          VERSION_FORMAT_UNSPECIFIED = 0
+
+          # +LogEntry+ version 2 format.
+          V2 = 1
+
+          # +LogEntry+ version 1 format.
+          V1 = 2
+        end
+      end
+
+      # The parameters to +ListSinks+.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     Required. The cloud resource containing the sinks.
+      #     Example: +"projects/my-logging-project"+.
+      # @!attribute [rw] page_token
+      #   @return [String]
+      #     Optional. If present, then retrieve the next batch of results from the
+      #     preceding call to this method.  +pageToken+ must be the value of
+      #     +nextPageToken+ from the previous response.  The values of other method
+      #     parameters should be identical to those in the previous call.
+      # @!attribute [rw] page_size
+      #   @return [Integer]
+      #     Optional. The maximum number of results to return from this request.
+      #     Non-positive values are ignored.  The presence of +nextPageToken+ in the
+      #     response indicates that more results might be available.
+      class ListSinksRequest; end
+
+      # Result returned from +ListSinks+.
+      # @!attribute [rw] sinks
+      #   @return [Array<Google::Logging::V2::LogSink>]
+      #     A list of sinks.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     If there might be more results than appear in this response, then
+      #     +nextPageToken+ is included.  To get the next set of results, call the same
+      #     method again using the value of +nextPageToken+ as +pageToken+.
+      class ListSinksResponse; end
+
+      # The parameters to +GetSink+.
+      # @!attribute [rw] sink_name
+      #   @return [String]
+      #     Required. The resource name of the sink to return.
+      #     Example: +"projects/my-project-id/sinks/my-sink-id"+.
+      class GetSinkRequest; end
+
+      # The parameters to +CreateSink+.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     Required. The resource in which to create the sink.
+      #     Example: +"projects/my-project-id"+.
+      #     The new sink must be provided in the request.
+      # @!attribute [rw] sink
+      #   @return [Google::Logging::V2::LogSink]
+      #     Required. The new sink, whose +name+ parameter is a sink identifier that
+      #     is not already in use.
+      class CreateSinkRequest; end
+
+      # The parameters to +UpdateSink+.
+      # @!attribute [rw] sink_name
+      #   @return [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"+.
+      # @!attribute [rw] sink
+      #   @return [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.
+      class UpdateSinkRequest; end
+
+      # The parameters to +DeleteSink+.
+      # @!attribute [rw] sink_name
+      #   @return [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.
+      class DeleteSinkRequest; end
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# 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 Logging
+    module V2
+      # Describes a logs-based metric.  The value of the metric is the
+      # number of log entries that match a logs filter.
+      # @!attribute [rw] name
+      #   @return [String]
+      #     Required. The client-assigned metric identifier. Example:
+      #     +"severe_errors"+.  Metric identifiers are limited to 100
+      #     characters and can include only the following characters: +A-Z+,
+      #     +a-z+, +0-9+, and the special characters +_-.,+!*',()%/+.  The
+      #     forward-slash character (+/+) denotes a hierarchy of name pieces,
+      #     and it cannot be the first character of the name.  The '%' character
+      #     is used to URL encode unsafe and reserved characters and must be
+      #     followed by two hexadecimal digits according to RFC 1738.
+      # @!attribute [rw] description
+      #   @return [String]
+      #     Optional. A description of this metric, which is used in documentation.
+      # @!attribute [rw] filter
+      #   @return [String]
+      #     Required. An {advanced logs filter}[https://cloud.google.com/logging/docs/view/advanced_filters].
+      #     Example: +"resource.type=gae_app AND severity>=ERROR"+.
+      # @!attribute [rw] version
+      #   @return [Google::Logging::V2::LogMetric::ApiVersion]
+      #     Output only. The API version that created or updated this metric.
+      #     The version also dictates the syntax of the filter expression. When a value
+      #     for this field is missing, the default value of V2 should be assumed.
+      class LogMetric
+        # Stackdriver Logging API version.
+        module ApiVersion
+          # Stackdriver Logging API v2.
+          V2 = 0
+
+          # Stackdriver Logging API v1.
+          V1 = 1
+        end
+      end
+
+      # The parameters to ListLogMetrics.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     Required. The resource name containing the metrics.
+      #     Example: +"projects/my-project-id"+.
+      # @!attribute [rw] page_token
+      #   @return [String]
+      #     Optional. If present, then retrieve the next batch of results from the
+      #     preceding call to this method.  +pageToken+ must be the value of
+      #     +nextPageToken+ from the previous response.  The values of other method
+      #     parameters should be identical to those in the previous call.
+      # @!attribute [rw] page_size
+      #   @return [Integer]
+      #     Optional. The maximum number of results to return from this request.
+      #     Non-positive values are ignored.  The presence of +nextPageToken+ in the
+      #     response indicates that more results might be available.
+      class ListLogMetricsRequest; end
+
+      # Result returned from ListLogMetrics.
+      # @!attribute [rw] metrics
+      #   @return [Array<Google::Logging::V2::LogMetric>]
+      #     A list of logs-based metrics.
+      # @!attribute [rw] next_page_token
+      #   @return [String]
+      #     If there might be more results than appear in this response, then
+      #     +nextPageToken+ is included.  To get the next set of results, call this
+      #     method again using the value of +nextPageToken+ as +pageToken+.
+      class ListLogMetricsResponse; end
+
+      # The parameters to GetLogMetric.
+      # @!attribute [rw] metric_name
+      #   @return [String]
+      #     The resource name of the desired metric.
+      #     Example: +"projects/my-project-id/metrics/my-metric-id"+.
+      class GetLogMetricRequest; end
+
+      # The parameters to CreateLogMetric.
+      # @!attribute [rw] parent
+      #   @return [String]
+      #     The resource name of the project in which to create the metric.
+      #     Example: +"projects/my-project-id"+.
+      #
+      #     The new metric must be provided in the request.
+      # @!attribute [rw] metric
+      #   @return [Google::Logging::V2::LogMetric]
+      #     The new logs-based metric, which must not have an identifier that
+      #     already exists.
+      class CreateLogMetricRequest; end
+
+      # The parameters to UpdateLogMetric.
+      # @!attribute [rw] metric_name
+      #   @return [String]
+      #     The resource name of the metric to update.
+      #     Example: +"projects/my-project-id/metrics/my-metric-id"+.
+      #
+      #     The updated metric must be provided in the request and have the
+      #     same identifier that is specified in +metricName+.
+      #     If the metric does not exist, it is created.
+      # @!attribute [rw] metric
+      #   @return [Google::Logging::V2::LogMetric]
+      #     The updated metric, whose name must be the same as the
+      #     metric identifier in +metricName+. If +metricName+ does not
+      #     exist, then a new metric is created.
+      class UpdateLogMetricRequest; end
+
+      # The parameters to DeleteLogMetric.
+      # @!attribute [rw] metric_name
+      #   @return [String]
+      #     The resource name of the metric to delete.
+      #     Example: +"projects/my-project-id/metrics/my-metric-id"+.
+      class DeleteLogMetricRequest; end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# 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 Protobuf
+    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an +Any+ value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field +@type+ which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # +value+ which holds the custom JSON in addition to the +@type+
+    # field. Example (for message Google::Protobuf::Duration):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the schema +http+, +https+, or no schema, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no schema is provided, +https+ is assumed.
+    #     * The last segment of the URL's path must represent the fully
+    #       qualified name of the type (as in +path/google.protobuf.Duration+).
+    #       The name should be in a canonical form (e.g., leading "." is
+    #       not accepted).
+    #     * An HTTP GET on the URL must yield a Google::Protobuf::Type
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemas other than +http+, +https+ (or the empty schema) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive.
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     +seconds+ field and a positive or negative +nanos+ field. For durations
+    #     of one second or more, a non-zero value for the +nanos+ field must be
+    #     of the same sign as the +seconds+ field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration; end
+  end
+end