google-cloud-logging-v2 0.1.0 → 0.3.0

data/proto_docs/google/logging/v2/logging_config.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Logging
       module V2
-        # Describes a repository of logs (Beta).
+        # Describes a repository of logs.
         # @!attribute [rw] name
         #   @return [::String]
         #     The resource name of the bucket.
@@ -29,7 +29,6 @@ module Google
         #     "projects/my-project-id/locations/my-location/buckets/my-bucket-id The
         #     supported locations are:
         #       "global"
-        #       "us-central1"
         #
         #     For the location of `global` it is unspecified where logs are actually
         #     stored.
@@ -50,6 +49,11 @@ module Google
         #     will automatically be deleted. The minimum retention period is 1 day.
         #     If this value is set to zero at bucket creation time, the default time of
         #     30 days will be used.
+        # @!attribute [rw] locked
+        #   @return [::Boolean]
+        #     Whether the bucket has been locked.
+        #     The retention period on a locked bucket may not be changed.
+        #     Locked buckets may only be deleted if they are empty.
         # @!attribute [r] lifecycle_state
         #   @return [::Google::Cloud::Logging::V2::LifecycleState]
         #     Output only. The bucket lifecycle state.
@@ -58,6 +62,36 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Describes a view over logs in a bucket.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the view.
+        #     For example
+        #     "projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Describes this view.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The creation timestamp of the view.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last update timestamp of the view.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Filter that restricts which log entries in a bucket are visible in this
+        #     view. Filters are restricted to be a logical AND of ==/!= of any of the
+        #     following:
+        #       originating project/folder/organization/billing account.
+        #       resource type
+        #       log id
+        #     Example: SOURCE("projects/myproject") AND resource.type = "gce_instance"
+        #                 AND LOG_ID("stdout")
+        class LogView
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Describes a sink used to export log entries to one of the following
         # destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a
         # Cloud Pub/Sub topic. A logs filter controls which log entries are exported.
@@ -81,12 +115,14 @@ module Google
         #     The sink's `writer_identity`, set when the sink is created, must
         #     have permission to write to the destination or else the log
         #     entries are not exported. For more information, see
-        #     [Exporting Logs with Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
+        #     [Exporting Logs with
+        #     Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Optional. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced-queries). The only
-        #     exported log entries are those that are in the resource owning the sink and
-        #     that match the filter. For example:
+        #     Optional. An [advanced logs
+        #     filter](https://cloud.google.com/logging/docs/view/advanced-queries). The
+        #     only exported log entries are those that are in the resource owning the
+        #     sink and that match the filter. For example:
         #
         #         logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
         # @!attribute [rw] description
@@ -97,13 +133,17 @@ module Google
         #   @return [::Boolean]
         #     Optional. If set to True, then this sink is disabled and it does not
         #     export any log entries.
+        # @!attribute [rw] exclusions
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogExclusion>]
+        #     Optional. Log entries that match any of the exclusion filters will not be exported.
+        #     If a log entry is matched by both `filter` and one of `exclusion_filters`
+        #     it will not be exported.
         # @!attribute [rw] output_version_format
         #   @return [::Google::Cloud::Logging::V2::LogSink::VersionFormat]
-        #     Deprecated. The log entry format to use for this sink's exported log
-        #     entries. The v2 format is used by default and cannot be changed.
+        #     Deprecated. This field is unused.
         # @!attribute [r] writer_identity
         #   @return [::String]
-        #     Output only. An IAM identity–a service account or group&mdash;under which Logging
+        #     Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging
         #     writes the exported log entries to the sink's destination. This field is
         #     set by {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#create_sink sinks.create} and
         #     {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#update_sink sinks.update} based on the
@@ -147,9 +187,7 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Available log entry formats. Log entries can be written to
-          # Logging in either format and can be exported in either format.
-          # Version 2 is the preferred format.
+          # Deprecated. This is unused.
           module VersionFormat
             # An unspecified format version that will default to V2.
             VERSION_FORMAT_UNSPECIFIED = 0
@@ -166,12 +204,13 @@ module Google
         # @!attribute [rw] use_partitioned_tables
         #   @return [::Boolean]
         #     Optional. Whether to use [BigQuery's partition
-        #     tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging
-        #     creates dated tables based on the log entries' timestamps, e.g.
-        #     syslog_20170523. With partitioned tables the date suffix is no longer
+        #     tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By
+        #     default, Logging creates dated tables based on the log entries' timestamps,
+        #     e.g. syslog_20170523. With partitioned tables the date suffix is no longer
         #     present and [special query
-        #     syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead.
-        #     In both cases, tables are sharded based on UTC timezone.
+        #     syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables)
+        #     has to be used instead. In both cases, tables are sharded based on UTC
+        #     timezone.
         # @!attribute [r] uses_timestamp_column_partitioning
         #   @return [::Boolean]
         #     Output only. True if new timestamp column based partitioning is in use,
@@ -185,7 +224,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The parameters to `ListBuckets` (Beta).
+        # The parameters to `ListBuckets`.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource whose buckets are to be listed:
@@ -214,7 +253,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response from ListBuckets (Beta).
+        # The response from ListBuckets.
         # @!attribute [rw] buckets
         #   @return [::Array<::Google::Cloud::Logging::V2::LogBucket>]
         #     A list of buckets.
@@ -228,7 +267,30 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The parameters to `UpdateBucket` (Beta).
+        # The parameters to `CreateBucket`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource in which to create the bucket:
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
+        #
+        #     Example: `"projects/my-logging-project/locations/global"`
+        # @!attribute [rw] bucket_id
+        #   @return [::String]
+        #     Required. A client-assigned identifier such as `"my-bucket"`. Identifiers are
+        #     limited to 100 characters and can include only letters, digits,
+        #     underscores, hyphens, and periods.
+        # @!attribute [rw] bucket
+        #   @return [::Google::Cloud::Logging::V2::LogBucket]
+        #     Required. The new bucket. The region specified in the new bucket must be compliant
+        #     with any Location Restriction Org Policy. The name field in the bucket is
+        #     ignored.
+        class CreateBucketRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `UpdateBucket`.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The full resource name of the bucket to update.
@@ -260,7 +322,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The parameters to `GetBucket` (Beta).
+        # The parameters to `GetBucket`.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the bucket:
@@ -277,6 +339,151 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The parameters to `DeleteBucket`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the bucket to delete.
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #         "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #         "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #
+        #     Example:
+        #     `"projects/my-project-id/locations/my-location/buckets/my-bucket-id"`.
+        class DeleteBucketRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `UndeleteBucket`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the bucket to undelete.
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #         "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #         "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #
+        #     Example:
+        #     `"projects/my-project-id/locations/my-location/buckets/my-bucket-id"`.
+        class UndeleteBucketRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `ListViews`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The bucket whose views are to be listed:
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_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 ListViewsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response from ListViews.
+        # @!attribute [rw] views
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogView>]
+        #     A list of views.
+        # @!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 ListViewsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `CreateView`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The bucket in which to create the view
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
+        #
+        #     Example:
+        #     `"projects/my-logging-project/locations/my-location/buckets/my-bucket"`
+        # @!attribute [rw] view_id
+        #   @return [::String]
+        #     Required. The id to use for this view.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Logging::V2::LogView]
+        #     Required. The new view.
+        class CreateViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `UpdateView`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the view to update
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        #
+        #     Example:
+        #       `"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id"`.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Logging::V2::LogView]
+        #     Required. The updated view.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Field mask that specifies the fields in `view` that need
+        #     an update. A field will be overwritten if, and only if, it is
+        #     in the update mask. `name` and output only fields cannot be updated.
+        #
+        #     For a detailed `FieldMask` definition, see
+        #     https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
+        #
+        #     Example: `updateMask=filter`.
+        class UpdateViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `GetView`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the policy:
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        #
+        #     Example:
+        #     `"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id"`.
+        class GetViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `DeleteView`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the view to delete:
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
+        #
+        #     Example:
+        #        `"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id"`.
+        class DeleteViewRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The parameters to `ListSinks`.
         # @!attribute [rw] parent
         #   @return [::String]
@@ -449,9 +656,10 @@ module Google
         #     Optional. A description of this exclusion.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Required. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced-queries)
-        #     that matches the log entries to be excluded. By using the
-        #     [sample function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
+        #     Required. An [advanced logs
+        #     filter](https://cloud.google.com/logging/docs/view/advanced-queries) that
+        #     matches the log entries to be excluded. By using the [sample
+        #     function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
         #     you can exclude less than 100% of the matching log entries.
         #     For example, the following query matches 99% of low-severity log
         #     entries from Google Cloud Storage buckets:
@@ -601,8 +809,9 @@ module Google
         # The parameters to
         # {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#get_cmek_settings GetCmekSettings}.
         #
-        # See [Enabling CMEK for Logs Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
-        # for more information.
+        # See [Enabling CMEK for Logs
+        # Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for
+        # more information.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource for which to retrieve CMEK settings.
@@ -625,8 +834,9 @@ module Google
         # The parameters to
         # {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#update_cmek_settings UpdateCmekSettings}.
         #
-        # See [Enabling CMEK for Logs Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
-        # for more information.
+        # See [Enabling CMEK for Logs
+        # Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for
+        # more information.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name for the CMEK settings to update.
@@ -646,7 +856,8 @@ module Google
         #     Required. The CMEK settings to update.
         #
         #     See [Enabling CMEK for Logs
-        #     Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+        #     Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
+        #     for more information.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Optional. Field mask identifying which fields from `cmek_settings` should
@@ -668,8 +879,9 @@ module Google
         # organizations. Once configured, it applies to all projects and folders in the
         # GCP organization.
         #
-        # See [Enabling CMEK for Logs Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
-        # for more information.
+        # See [Enabling CMEK for Logs
+        # Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for
+        # more information.
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The resource name of the CMEK settings.
@@ -698,7 +910,8 @@ module Google
         #     To disable CMEK for the Logs Router, set this field to an empty string.
         #
         #     See [Enabling CMEK for Logs
-        #     Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+        #     Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
+        #     for more information.
         # @!attribute [r] service_account_id
         #   @return [::String]
         #     Output only. The service account that will be used by the Logs Router to access your
@@ -711,13 +924,14 @@ module Google
         #     obtain the service account ID.
         #
         #     See [Enabling CMEK for Logs
-        #     Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
+        #     Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
+        #     for more information.
         class CmekSettings
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # LogBucket lifecycle states (Beta).
+        # LogBucket lifecycle states.
         module LifecycleState
           # Unspecified state.  This is only used/useful for distinguishing
           # unset values.

data/proto_docs/google/logging/v2/logging_metrics.rb

@@ -24,8 +24,8 @@ module Google
         # Describes a logs-based metric. The value of the metric is the number of log
         # entries that match a logs filter in a given time interval.
         #
-        # Logs-based metric can also be used to extract values from logs and create a
-        # a distribution of the values. The distribution records the statistics of the
+        # Logs-based metrics can also be used to extract values from logs and create a
+        # distribution of the values. The distribution records the statistics of the
         # extracted values along with an optional histogram of the values as specified
         # by the bucket options.
         # @!attribute [rw] name
@@ -49,9 +49,9 @@ module Google
         #     The maximum length of the description is 8000 characters.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Required. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced_filters) which is
-        #     used to match log entries.
-        #     Example:
+        #     Required. An [advanced logs
+        #     filter](https://cloud.google.com/logging/docs/view/advanced_filters) which
+        #     is used to match log entries. Example:
         #
         #         "resource.type=gae_app AND severity>=ERROR"
         #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-logging-v2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Logging V2 API