# 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.
from google.api import monitored_resource_pb2
from google.logging.v2 import log_entry_pb2
[docs]class DeleteLogRequest(object):
"""
The parameters to DeleteLog.
Attributes:
log_name (string): Required. The resource name of the log to delete. Example:
``"projects/my-project/logs/syslog"``.
"""
pass
[docs]class WriteLogEntriesRequest(object):
"""
The parameters to WriteLogEntries.
Attributes:
log_name (string): Optional. A default log resource name for those log entries in ``entries``
that do not specify their own ``logName``. Example:
``"projects/my-project/logs/syslog"``. See
``LogEntry``.
resource (:class:`google.api.monitored_resource_pb2.MonitoredResource`): Optional. A default monitored resource for those log entries in ``entries``
that do not specify their own ``resource``.
labels (dict[string -> :class:`google.logging.v2.logging_pb2.WriteLogEntriesRequest.LabelsEntry`]): Optional. User-defined ``key:value`` items that are added to
the ``labels`` field of each log entry in ``entries``, except when a log
entry specifies its own ``key:value`` item with the same key.
Example: ``{ "size": "large", "color":"red" }``
entries (list[:class:`google.logging.v2.log_entry_pb2.LogEntry`]): Required. The log entries to write. The log entries must have values for
all required fields.
To improve throughput and to avoid exceeding the quota limit for calls
to ``entries.write``, use this field to write multiple log entries at once
rather than // calling this method for each log entry.
partial_success (bool): 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, the response status will be the error associated
with one of the failed entries and include error details in the form of
WriteLogEntriesPartialErrors.
"""
pass
[docs]class WriteLogEntriesResponse(object):
"""
Result returned from WriteLogEntries.
empty
Attributes:
"""
pass
[docs]class ListLogEntriesRequest(object):
"""
The parameters to ``ListLogEntries``.
Attributes:
project_ids (list[string]): Required. One or more project IDs or project numbers from which to retrieve
log entries. Examples of a project ID: ``"my-project-1A"``, ``"1234567890"``.
filter (string): Optional. An `advanced logs filter <https://cloud.google.com/logging/docs/view/advanced_filters>`_.
The filter is compared against all log entries in the projects specified by
``projectIds``. Only entries that match the filter are retrieved. An empty
filter matches all log entries.
order_by (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 ``LogEntry.insertId``.
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.
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 values of ``projectIds``, ``filter``, and ``orderBy`` must be the same
as in the previous request.
"""
pass
[docs]class ListLogEntriesResponse(object):
"""
Result returned from ``ListLogEntries``.
Attributes:
entries (list[:class:`google.logging.v2.log_entry_pb2.LogEntry`]): A list of log entries.
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 ListMonitoredResourceDescriptorsRequest(object):
"""
The parameters to ListMonitoredResourceDescriptors
Attributes:
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.
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.
"""
pass
[docs]class ListMonitoredResourceDescriptorsResponse(object):
"""
Result returned from ListMonitoredResourceDescriptors.
Attributes:
resource_descriptors (list[:class:`google.api.monitored_resource_pb2.MonitoredResourceDescriptor`]): A list of resource descriptors.
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