# 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.
[docs]class LogMetric(object):
"""
Describes a logs-based metric. The value of the metric is the
number of log entries that match a logs filter.
Attributes:
name (string): Required. The client-assigned metric identifier. Example:
``"severe_errors"``. Metric identifiers are limited to 1000
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.
description (string): A description of this metric, which is used in documentation.
filter (string): An `advanced logs filter <https://cloud.google.com/logging/docs/view/advanced_filters>`_.
Example: ``"logName:syslog AND severity>=ERROR"``.
"""
pass
[docs]class ListLogMetricsRequest(object):
"""
The parameters to ListLogMetrics.
Attributes:
parent (string): Required. The resource name containing the metrics.
Example: ``"projects/my-project-id"``.
page_token (string): Optional. If the ``pageToken`` parameter is supplied, then the next page of
results is retrieved. The ``pageToken`` parameter must be set to the value
of the ``nextPageToken`` from the previous response.
The value of ``parent`` must be the same as in the previous request.
page_size (int): Optional. The maximum number of results to return from this request.
You must check for presence of ``nextPageToken`` to determine if additional
results are available, which you can retrieve by passing the
``nextPageToken`` value as the ``pageToken`` parameter in the next request.
"""
pass
[docs]class ListLogMetricsResponse(object):
"""
Result returned from ListLogMetrics.
Attributes:
metrics (list[:class:`google.logging.v2.logging_metrics_pb2.LogMetric`]): A list of logs-based metrics.
next_page_token (string): If there are more results than were returned, then ``nextPageToken`` is
included in the response. To get the next set of results, call this
method again using the value of ``nextPageToken`` as ``pageToken``.
"""
pass
[docs]class GetLogMetricRequest(object):
"""
The parameters to GetLogMetric.
Attributes:
metric_name (string): The resource name of the desired metric.
Example: ``"projects/my-project-id/metrics/my-metric-id"``.
"""
pass
[docs]class CreateLogMetricRequest(object):
"""
The parameters to CreateLogMetric.
Attributes:
parent (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.
metric (:class:`google.logging.v2.logging_metrics_pb2.LogMetric`): The new logs-based metric, which must not have an identifier that
already exists.
"""
pass
[docs]class UpdateLogMetricRequest(object):
"""
The parameters to UpdateLogMetric.
Attributes:
metric_name (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.
metric (:class:`google.logging.v2.logging_metrics_pb2.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.
"""
pass
[docs]class DeleteLogMetricRequest(object):
"""
The parameters to DeleteLogMetric.
Attributes:
metric_name (string): The resource name of the metric to delete.
Example: ``"projects/my-project-id/metrics/my-metric-id"``.
"""
pass