google.logging.v2.logging_pb2¶
Classes
DeleteLogRequest |
The parameters to DeleteLog. |
ListLogEntriesRequest |
The parameters to ListLogEntries . |
ListLogEntriesResponse |
Result returned from ListLogEntries . |
ListMonitoredResourceDescriptorsRequest |
The parameters to ListMonitoredResourceDescriptors |
ListMonitoredResourceDescriptorsResponse |
Result returned from ListMonitoredResourceDescriptors. |
WriteLogEntriesRequest |
The parameters to WriteLogEntries. |
WriteLogEntriesResponse |
Result returned from WriteLogEntries. |
-
class
google.logging.v2.logging_pb2.
DeleteLogRequest
[source]¶ The parameters to DeleteLog.
-
log_name
¶ string – Required. The resource name of the log to delete. Example:
"projects/my-project/logs/syslog"
.
-
-
class
google.logging.v2.logging_pb2.
ListLogEntriesRequest
[source]¶ The parameters to
ListLogEntries
.-
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. 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 ofLogEntry.timestamp
(oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order ofLogEntry.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 thenextPageToken
value as thepageToken
parameter in the next request.
-
page_token
¶ string – Optional. If the
pageToken
parameter is supplied, then the next page of results is retrieved. ThepageToken
parameter must be set to the value of thenextPageToken
from the previous response. The values ofprojectIds
,filter
, andorderBy
must be the same as in the previous request.
-
-
class
google.logging.v2.logging_pb2.
ListLogEntriesResponse
[source]¶ Result returned from
ListLogEntries
.-
entries
¶ list[
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 ofnextPageToken
aspageToken
.
-
-
class
google.logging.v2.logging_pb2.
ListMonitoredResourceDescriptorsRequest
[source]¶ The parameters to ListMonitoredResourceDescriptors
-
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 thenextPageToken
value as thepageToken
parameter in the next request.
-
page_token
¶ string – Optional. If the
pageToken
parameter is supplied, then the next page of results is retrieved. ThepageToken
parameter must be set to the value of thenextPageToken
from the previous response.
-
-
class
google.logging.v2.logging_pb2.
ListMonitoredResourceDescriptorsResponse
[source]¶ Result returned from ListMonitoredResourceDescriptors.
-
resource_descriptors
¶ list[
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 ofnextPageToken
aspageToken
.
-
-
class
google.logging.v2.logging_pb2.
WriteLogEntriesRequest
[source]¶ The parameters to WriteLogEntries.
-
log_name
¶ string – Optional. A default log resource name for those log entries in
entries
that do not specify their ownlogName
. Example:"projects/my-project/logs/syslog"
. SeeLogEntry
.
-
resource
¶ google.api.monitored_resource_pb2.MonitoredResource
– Optional. A default monitored resource for those log entries inentries
that do not specify their ownresource
.
-
labels
¶ dict[string ->
google.logging.v2.logging_pb2.WriteLogEntriesRequest.LabelsEntry
] – Optional. User-definedkey:value
items that are added to thelabels
field of each log entry inentries
, except when a log entry specifies its ownkey:value
item with the same key. Example:{ "size": "large", "color":"red" }
-
entries
¶ list[
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.
-