lib/google/cloud/logging/v2/logging_service/client.rb in google-cloud-logging-v2-0.5.6 vs lib/google/cloud/logging/v2/logging_service/client.rb in google-cloud-logging-v2-0.6.0
- old
+ new
@@ -173,14 +173,14 @@
end
# Service calls
##
- # Deletes all the log entries in a log. The log reappears if it receives new
- # entries. Log entries written shortly before the delete operation might not
- # be deleted. Entries received after the delete operation with a timestamp
- # before the operation will be deleted.
+ # Deletes all the log entries in a log for the _Default Log Bucket. The log
+ # reappears if it receives new entries. Log entries written shortly before
+ # the delete operation might not be deleted. Entries received after the
+ # delete operation with a timestamp before the operation will be deleted.
#
# @overload delete_log(request, options = nil)
# Pass arguments to `delete_log` via a request object, either of type
# {::Google::Cloud::Logging::V2::DeleteLogRequest} or an equivalent Hash.
#
@@ -196,18 +196,19 @@
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param log_name [::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]"
+ # * `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"`.
+ # `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
+ #
# For more information about log names, see
# {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Protobuf::Empty]
@@ -299,19 +300,19 @@
#
# @param log_name [::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]"
+ # * `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"
+ # "organizations/123/logs/cloudaudit.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.
@@ -342,18 +343,18 @@
# 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
+ # [logs retention period](https://cloud.google.com/logging/quotas) 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
+ # [quota limit](https://cloud.google.com/logging/quotas) 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.
# @param partial_success [::Boolean]
# Optional. Whether valid entries should be written even if some other
# entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
@@ -444,21 +445,22 @@
#
# @param resource_names [::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/[PROJECT_ID]`
+ # * `organizations/[ORGANIZATION_ID]`
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
+ # * `folders/[FOLDER_ID]`
#
- # May alternatively be one or more views
- # projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
- # organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
- # billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
- # folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
+ # May alternatively be one or more views:
#
+ # * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ # * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ # * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ #
# Projects listed in the `project_ids` field are added to this list.
# @param filter [::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
@@ -472,14 +474,14 @@
# 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.
# @param page_size [::Integer]
- # Optional. The maximum number of results to return from this request.
- # Default is 50. If the value is negative or exceeds 1000,
- # the request is rejected. The presence of `next_page_token` in the
- # response indicates that more results might be available.
+ # Optional. The maximum number of results to return from this request. Default is 50.
+ # If the value is negative or exceeds 1000, the request is rejected. The
+ # presence of `next_page_token` in the response indicates that more results
+ # might be available.
# @param page_token [::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.
@@ -658,14 +660,14 @@
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param parent [::String]
# Required. The resource name that owns the logs:
#
- # "projects/[PROJECT_ID]"
- # "organizations/[ORGANIZATION_ID]"
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
- # "folders/[FOLDER_ID]"
+ # * `projects/[PROJECT_ID]`
+ # * `organizations/[ORGANIZATION_ID]`
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
+ # * `folders/[FOLDER_ID]`
# @param page_size [::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.
# @param page_token [::String]
@@ -673,19 +675,21 @@
# 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.
# @param resource_names [::Array<::String>]
# Optional. The resource name that owns the logs:
- # projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
- # organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
- # billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
- # folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
#
+ # * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ # * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ # * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
+ #
# To support legacy queries, it could also be:
- # "projects/[PROJECT_ID]"
- # "organizations/[ORGANIZATION_ID]"
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
- # "folders/[FOLDER_ID]"
+ #
+ # * `projects/[PROJECT_ID]`
+ # * `organizations/[ORGANIZATION_ID]`
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
+ # * `folders/[FOLDER_ID]`
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Logging::V2::ListLogsResponse]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#