google-cloud-logging-v2 0.1.0

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

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Logging
+      module V2
+        # The parameters to DeleteLog.
+        # @!attribute [rw] log_name
+        #   @return [::String]
+        #     Required. The resource name of the log to delete:
+        #
+        #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
+        #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
+        #         "folders/[FOLDER_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
+        #     {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
+        class DeleteLogRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        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`:
+        #
+        #         "projects/[PROJECT_ID]/logs/[LOG_ID]"
+        #         "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
+        #         "folders/[FOLDER_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"
+        #
+        #     The permission `logging.logEntries.create` is needed on each project,
+        #     organization, billing account, or folder that is receiving new log
+        #     entries, whether the resource is specified in `logName` or in an
+        #     individual log entry.
+        # @!attribute [rw] resource
+        #   @return [::Google::Api::MonitoredResource]
+        #     Optional. A default monitored resource object that is assigned to all log
+        #     entries in `entries` that do not specify a value for `resource`. Example:
+        #
+        #         { "type": "gce_instance",
+        #           "labels": {
+        #             "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
+        #
+        #     See {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Default labels that are added to the `labels` field of all log
+        #     entries in `entries`. If a log entry already has a label with the same key
+        #     as a label in this parameter, then the log entry's label is not changed.
+        #     See {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
+        # @!attribute [rw] entries
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogEntry>]
+        #     Required. The log entries to send to Logging. The order of log
+        #     entries in this list does not matter. Values supplied in this method's
+        #     `log_name`, `resource`, and `labels` fields are copied into those log
+        #     entries in this list that do not include values for their corresponding
+        #     fields. For more information, see the
+        #     {::Google::Cloud::Logging::V2::LogEntry LogEntry} type.
+        #
+        #     If the `timestamp` or `insert_id` fields are missing in log entries, then
+        #     this method supplies the current time or a unique identifier, respectively.
+        #     The supplied values are chosen so that, among the log entries that did not
+        #     supply their own values, the entries earlier in the list will sort before
+        #     the entries later in the list. See the `entries.list` method.
+        #
+        #     Log entries with timestamps that are more than the
+        #     [logs retention period](https://cloud.google.com/logging/quota-policy) in the past or more than
+        #     24 hours in the future will not be available when calling `entries.list`.
+        #     However, those log entries can still be
+        #     [exported with LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
+        #
+        #     To improve throughput and to avoid exceeding the
+        #     [quota limit](https://cloud.google.com/logging/quota-policy) for calls to `entries.write`,
+        #     you should try to include several log entries in this list,
+        #     rather than calling this method for each individual log entry.
+        # @!attribute [rw] partial_success
+        #   @return [::Boolean]
+        #     Optional. Whether valid entries should be written even if some other
+        #     entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
+        #     entry is not written, then the response status is the error associated
+        #     with one of the failed entries and the response includes error details
+        #     keyed by the entries' zero-based index in the `entries.write` method.
+        # @!attribute [rw] dry_run
+        #   @return [::Boolean]
+        #     Optional. If true, the request should expect normal response, but the
+        #     entries won't be persisted nor exported. Useful for checking whether the
+        #     logging API endpoints are working properly before sending valuable data.
+        class WriteLogEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Result returned from WriteLogEntries.
+        class WriteLogEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Error details for WriteLogEntries with partial success.
+        # @!attribute [rw] log_entry_errors
+        #   @return [::Google::Protobuf::Map{::Integer => ::Google::Rpc::Status}]
+        #     When `WriteLogEntriesRequest.partial_success` is true, records the error
+        #     status for entries that were not written due to a permanent error, keyed
+        #     by the entry's zero-based index in `WriteLogEntriesRequest.entries`.
+        #
+        #     Failed requests for which no entries are written will not include
+        #     per-entry errors.
+        class WriteLogEntriesPartialErrors
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::Integer]
+          # @!attribute [rw] value
+          #   @return [::Google::Rpc::Status]
+          class LogEntryErrorsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The parameters to `ListLogEntries`.
+        # @!attribute [rw] resource_names
+        #   @return [::Array<::String>]
+        #     Required. Names of one or more parent resources from which to
+        #     retrieve log entries:
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_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 Queries](https://cloud.google.com/logging/docs/view/advanced-queries).  Only log entries that
+        #     match the filter are returned.  An empty filter matches all log entries in
+        #     the resources listed in `resource_names`. Referencing a parent resource
+        #     that is not listed in `resource_names` will cause the filter to return no
+        #     results.
+        #     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
+        #     values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
+        #     option returns entries in order of increasing values of
+        #     `LogEntry.timestamp` (oldest first), and the second option returns entries
+        #     in order of decreasing timestamps (newest first).  Entries with equal
+        #     timestamps are returned in order of their `insert_id` values.
+        # @!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 `next_page_token` in the
+        #     response indicates that more results might be available.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. If present, then retrieve the next batch of results from the
+        #     preceding call to this method.  `page_token` must be the value of
+        #     `next_page_token` from the previous response.  The values of other method
+        #     parameters should be identical to those in the previous call.
+        class ListLogEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Result returned from `ListLogEntries`.
+        # @!attribute [rw] entries
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogEntry>]
+        #     A list of log entries.  If `entries` is empty, `nextPageToken` may still be
+        #     returned, indicating that more entries may exist.  See `nextPageToken` for
+        #     more information.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If there might be more results than those appearing 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`.
+        #
+        #     If a value for `next_page_token` appears and the `entries` field is empty,
+        #     it means that the search found no log entries so far but it did not have
+        #     time to search all the possible log entries.  Retry the method with this
+        #     value for `page_token` to continue the search.  Alternatively, consider
+        #     speeding up the search by changing your filter to specify a single log name
+        #     or resource type, or to narrow the time range of the search.
+        class ListLogEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to ListMonitoredResourceDescriptors
+        # @!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.
+        # @!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.
+        class ListMonitoredResourceDescriptorsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Result returned from ListMonitoredResourceDescriptors.
+        # @!attribute [rw] resource_descriptors
+        #   @return [::Array<::Google::Api::MonitoredResourceDescriptor>]
+        #     A list of resource descriptors.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If there might be more results than those appearing 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 ListMonitoredResourceDescriptorsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to ListLogs.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name that owns the logs:
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_ID]"
+        # @!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.
+        # @!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.
+        class ListLogsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Result returned from ListLogs.
+        # @!attribute [rw] log_names
+        #   @return [::Array<::String>]
+        #     A list of log names. For example,
+        #     `"projects/my-project/logs/syslog"` or
+        #     `"organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If there might be more results than those appearing 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 ListLogsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,735 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Logging
+      module V2
+        # Describes a repository of logs (Beta).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the bucket.
+        #     For example:
+        #     "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.
+        #     Once a bucket has been created, the location can not be changed.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Describes this bucket.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The creation timestamp of the bucket. This is not set for any of the
+        #     default buckets.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last update timestamp of the bucket.
+        # @!attribute [rw] retention_days
+        #   @return [::Integer]
+        #     Logs will be retained by default for this amount of time, after which they
+        #     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 [r] lifecycle_state
+        #   @return [::Google::Cloud::Logging::V2::LifecycleState]
+        #     Output only. The bucket lifecycle state.
+        class LogBucket
+          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.
+        # The sink must be created within a project, organization, billing account, or
+        # folder.
+        # @!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 100
+        #     characters and can include only the following characters: upper and
+        #     lower-case alphanumeric characters, underscores, hyphens, and periods.
+        #     First character has to be alphanumeric.
+        # @!attribute [rw] destination
+        #   @return [::String]
+        #     Required. The export destination:
+        #
+        #         "storage.googleapis.com/[GCS_BUCKET]"
+        #         "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+        #         "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
+        #
+        #     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).
+        # @!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:
+        #
+        #         logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. A description of this sink.
+        #     The maximum length of the description is 8000 characters.
+        # @!attribute [rw] disabled
+        #   @return [::Boolean]
+        #     Optional. If set to True, then this sink is disabled and it does not
+        #     export any log entries.
+        # @!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.
+        # @!attribute [r] writer_identity
+        #   @return [::String]
+        #     Output only. An IAM identity–a service account or group—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
+        #     value of `unique_writer_identity` in those methods.
+        #
+        #     Until you grant this identity write-access to the destination, log entry
+        #     exports from this sink will fail. For more information,
+        #     see [Granting Access for a
+        #     Resource](https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
+        #     Consult the destination service's documentation to determine the
+        #     appropriate IAM roles to assign to the identity.
+        # @!attribute [rw] include_children
+        #   @return [::Boolean]
+        #     Optional. This field applies only to sinks owned by organizations and
+        #     folders. If the field is false, the default, only the logs owned by the
+        #     sink's parent resource are available for export. If the field is true, then
+        #     logs from all the projects, folders, and billing accounts contained in the
+        #     sink's parent resource are also available for export. Whether a particular
+        #     log entry from the children is exported depends on the sink's filter
+        #     expression. For example, if this field is true, then the filter
+        #     `resource.type=gce_instance` would export all Compute Engine VM instance
+        #     log entries from all projects in the sink's parent. To only export entries
+        #     from certain child projects, filter on the project part of the log name:
+        #
+        #         logName:("projects/test-project1/" OR "projects/test-project2/") AND
+        #         resource.type=gce_instance
+        # @!attribute [rw] bigquery_options
+        #   @return [::Google::Cloud::Logging::V2::BigQueryOptions]
+        #     Optional. Options that affect sinks exporting data to BigQuery.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The creation timestamp of the sink.
+        #
+        #     This field may not be present for older sinks.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last update timestamp of the sink.
+        #
+        #     This field may not be present for older sinks.
+        class LogSink
+          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.
+          module VersionFormat
+            # An unspecified format version that will default to V2.
+            VERSION_FORMAT_UNSPECIFIED = 0
+
+            # `LogEntry` version 2 format.
+            V2 = 1
+
+            # `LogEntry` version 1 format.
+            V1 = 2
+          end
+        end
+
+        # Options that change functionality of a sink exporting data to BigQuery.
+        # @!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
+        #     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.
+        # @!attribute [r] uses_timestamp_column_partitioning
+        #   @return [::Boolean]
+        #     Output only. True if new timestamp column based partitioning is in use,
+        #     false if legacy ingestion-time partitioning is in use.
+        #     All new sinks will have this field set true and will use timestamp column
+        #     based partitioning. If use_partitioned_tables is false, this value has no
+        #     meaning and will be false. Legacy sinks using partitioned tables will have
+        #     this field set to false.
+        class BigQueryOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `ListBuckets` (Beta).
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource whose buckets are to be listed:
+        #
+        #         "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
+        #         "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]"
+        #         "folders/[FOLDER_ID]/locations/[LOCATION_ID]"
+        #
+        #     Note: The locations portion of the resource must be specified, but
+        #     supplying the character `-` in place of [LOCATION_ID] will return all
+        #     buckets.
+        # @!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 ListBucketsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response from ListBuckets (Beta).
+        # @!attribute [rw] buckets
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogBucket>]
+        #     A list of buckets.
+        # @!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 ListBucketsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `UpdateBucket` (Beta).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The full resource name of the bucket to update.
+        #
+        #         "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"`. Also
+        #     requires permission "resourcemanager.projects.updateLiens" to set the
+        #     locked property
+        # @!attribute [rw] bucket
+        #   @return [::Google::Cloud::Logging::V2::LogBucket]
+        #     Required. The updated bucket.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. Field mask that specifies the fields in `bucket` that need an update. A
+        #     bucket 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=retention_days`.
+        class UpdateBucketRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `GetBucket` (Beta).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the bucket:
+        #
+        #         "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 GetBucketRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `ListSinks`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource whose sinks are to be listed:
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_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 ListSinksRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Result returned from `ListSinks`.
+        # @!attribute [rw] sinks
+        #   @return [::Array<::Google::Cloud::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
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `GetSink`.
+        # @!attribute [rw] sink_name
+        #   @return [::String]
+        #     Required. The resource name of the sink:
+        #
+        #         "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"`.
+        class GetSinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `CreateSink`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource in which to create the sink:
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_ID]"
+        #
+        #     Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.
+        # @!attribute [rw] sink
+        #   @return [::Google::Cloud::Logging::V2::LogSink]
+        #     Required. The new sink, whose `name` parameter is a sink identifier that
+        #     is not already in use.
+        # @!attribute [rw] unique_writer_identity
+        #   @return [::Boolean]
+        #     Optional. Determines the kind of IAM identity returned as `writer_identity`
+        #     in the new sink. If this value is omitted or set to false, and if the
+        #     sink's parent is a project, then the value returned as `writer_identity` is
+        #     the same group or service account used by Logging before the addition of
+        #     writer identities to this API. The sink's destination must be in the same
+        #     project as the sink itself.
+        #
+        #     If this field is set to true, or if the sink is owned by a non-project
+        #     resource such as an organization, then the value of `writer_identity` will
+        #     be a unique service account used only for exports from the new sink. For
+        #     more information, see `writer_identity` in {::Google::Cloud::Logging::V2::LogSink LogSink}.
+        class CreateSinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `UpdateSink`.
+        # @!attribute [rw] sink_name
+        #   @return [::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"`.
+        # @!attribute [rw] sink
+        #   @return [::Google::Cloud::Logging::V2::LogSink]
+        #     Required. The updated sink, whose name is the same identifier that appears as part
+        #     of `sink_name`.
+        # @!attribute [rw] unique_writer_identity
+        #   @return [::Boolean]
+        #     Optional. See {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#create_sink sinks.create}
+        #     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.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     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`.
+        class UpdateSinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `DeleteSink`.
+        # @!attribute [rw] sink_name
+        #   @return [::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"`.
+        class DeleteSinkRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies a set of log entries that are not to be stored in
+        # Logging. If your GCP resource receives a large volume of logs, you can
+        # use exclusions to reduce your chargeable logs. Exclusions are
+        # processed after log sinks, so you can export log entries before they are
+        # excluded. Note that organization-level and folder-level exclusions don't
+        # apply to child resources, and that you can't exclude audit log entries.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. A client-assigned identifier, such as `"load-balancer-exclusion"`.
+        #     Identifiers are limited to 100 characters and can include only letters,
+        #     digits, underscores, hyphens, and periods. First character has to be
+        #     alphanumeric.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     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),
+        #     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:
+        #
+        #     `"resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)"`
+        # @!attribute [rw] disabled
+        #   @return [::Boolean]
+        #     Optional. If set to True, then this exclusion is disabled and it does not
+        #     exclude any log entries. You can [update an
+        #     exclusion][google.logging.v2.ConfigServiceV2.UpdateExclusion] to change the
+        #     value of this field.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The creation timestamp of the exclusion.
+        #
+        #     This field may not be present for older exclusions.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last update timestamp of the exclusion.
+        #
+        #     This field may not be present for older exclusions.
+        class LogExclusion
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `ListExclusions`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource whose exclusions are to be listed.
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_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 ListExclusionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Result returned from `ListExclusions`.
+        # @!attribute [rw] exclusions
+        #   @return [::Array<::Google::Cloud::Logging::V2::LogExclusion>]
+        #     A list of exclusions.
+        # @!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 ListExclusionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `GetExclusion`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of an existing exclusion:
+        #
+        #         "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"`.
+        class GetExclusionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `CreateExclusion`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource in which to create the exclusion:
+        #
+        #         "projects/[PROJECT_ID]"
+        #         "organizations/[ORGANIZATION_ID]"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]"
+        #         "folders/[FOLDER_ID]"
+        #
+        #     Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.
+        # @!attribute [rw] exclusion
+        #   @return [::Google::Cloud::Logging::V2::LogExclusion]
+        #     Required. The new exclusion, whose `name` parameter is an exclusion name
+        #     that is not already used in the parent resource.
+        class CreateExclusionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `UpdateExclusion`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the exclusion to update:
+        #
+        #         "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"`.
+        # @!attribute [rw] exclusion
+        #   @return [::Google::Cloud::Logging::V2::LogExclusion]
+        #     Required. New values for the existing exclusion. Only the fields specified in
+        #     `update_mask` are relevant.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. A non-empty list of fields to change in the existing exclusion. New values
+        #     for the fields are taken from the corresponding fields in the
+        #     {::Google::Cloud::Logging::V2::LogExclusion LogExclusion} included in this request. Fields not mentioned in
+        #     `update_mask` are not changed and are ignored in the request.
+        #
+        #     For example, to change the filter and description of an exclusion,
+        #     specify an `update_mask` of `"filter,description"`.
+        class UpdateExclusionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The parameters to `DeleteExclusion`.
+        # @!attribute [rw] name
+        #   @return [::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"`.
+        class DeleteExclusionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource for which to retrieve CMEK settings.
+        #
+        #         "projects/[PROJECT_ID]/cmekSettings"
+        #         "organizations/[ORGANIZATION_ID]/cmekSettings"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
+        #         "folders/[FOLDER_ID]/cmekSettings"
+        #
+        #     Example: `"organizations/12345/cmekSettings"`.
+        #
+        #     Note: CMEK for the Logs Router can currently only be configured for GCP
+        #     organizations. Once configured, it applies to all projects and folders in
+        #     the GCP organization.
+        class GetCmekSettingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name for the CMEK settings to update.
+        #
+        #         "projects/[PROJECT_ID]/cmekSettings"
+        #         "organizations/[ORGANIZATION_ID]/cmekSettings"
+        #         "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
+        #         "folders/[FOLDER_ID]/cmekSettings"
+        #
+        #     Example: `"organizations/12345/cmekSettings"`.
+        #
+        #     Note: CMEK for the Logs Router can currently only be configured for GCP
+        #     organizations. Once configured, it applies to all projects and folders in
+        #     the GCP organization.
+        # @!attribute [rw] cmek_settings
+        #   @return [::Google::Cloud::Logging::V2::CmekSettings]
+        #     Required. The CMEK settings to update.
+        #
+        #     See [Enabling CMEK for Logs
+        #     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
+        #     be updated. A field will be overwritten if and only if it is in the update
+        #     mask. Output only fields cannot be updated.
+        #
+        #     See {::Google::Protobuf::FieldMask FieldMask} for more information.
+        #
+        #     Example: `"updateMask=kmsKeyName"`
+        class UpdateCmekSettingsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Describes the customer-managed encryption key (CMEK) settings associated with
+        # a project, folder, organization, billing account, or flexible resource.
+        #
+        # Note: CMEK for the Logs Router can currently only be configured for GCP
+        # 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.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the CMEK settings.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     The resource name for the configured Cloud KMS key.
+        #
+        #     KMS key name format:
+        #         "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
+        #
+        #     For example:
+        #         `"projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name"`
+        #
+        #
+        #
+        #     To enable CMEK for the Logs Router, set this field to a valid
+        #     `kms_key_name` for which the associated service account has the required
+        #     `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key.
+        #
+        #     The Cloud KMS key used by the Log Router can be updated by changing the
+        #     `kms_key_name` to a new valid key name. Encryption operations that are in
+        #     progress will be completed with the key that was in use when they started.
+        #     Decryption operations will be completed using the key that was used at the
+        #     time of encryption unless access to that key has been revoked.
+        #
+        #     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.
+        # @!attribute [r] service_account_id
+        #   @return [::String]
+        #     Output only. The service account that will be used by the Logs Router to access your
+        #     Cloud KMS key.
+        #
+        #     Before enabling CMEK for Logs Router, you must first assign the role
+        #     `roles/cloudkms.cryptoKeyEncrypterDecrypter` to the service account that
+        #     the Logs Router will use to access your Cloud KMS key. Use
+        #     {::Google::Cloud::Logging::V2::ConfigServiceV2::Client#get_cmek_settings GetCmekSettings} to
+        #     obtain the service account ID.
+        #
+        #     See [Enabling CMEK for Logs
+        #     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).
+        module LifecycleState
+          # Unspecified state.  This is only used/useful for distinguishing
+          # unset values.
+          LIFECYCLE_STATE_UNSPECIFIED = 0
+
+          # The normal and active state.
+          ACTIVE = 1
+
+          # The bucket has been marked for deletion by the user.
+          DELETE_REQUESTED = 2
+        end
+      end
+    end
+  end
+end