package google.logging.v2
Get desktop application:
View/edit binary Protocol Buffers messages
rpc ListSinks (, )
logging_config.proto:30Lists sinks.
message
logging_config.proto:99The parameters to `ListSinks`.
string project_name = 1
Required. The resource name of the project containing the sinks. Example: `"projects/my-logging-project"`, `"projects/01234567890"`.
string page_token = 2
Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The value of `projectName` must be the same as in the previous request.
int32 page_size = 3
Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.
message
logging_config.proto:120Result returned from `ListSinks`.
repeated sinks = 1
A list of sinks.
string next_page_token = 2
If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`.
rpc GetSink (, )
logging_config.proto:35Gets a sink.
message
logging_config.proto:131The parameters to `GetSink`.
string sink_name = 1
The resource name of the sink to return. Example: `"projects/my-project-id/sinks/my-sink-id"`.
rpc CreateSink (, )
logging_config.proto:40Creates a sink.
message
logging_config.proto:138The parameters to `CreateSink`.
string project_name = 1
The resource name of the project in which to create the sink. Example: `"projects/my-project-id"`. The new sink must be provided in the request.
optional sink = 2
The new sink, which must not have an identifier that already exists.
rpc UpdateSink (, )
logging_config.proto:45Creates or updates a sink.
message
logging_config.proto:151The parameters to `UpdateSink`.
string sink_name = 1
The resource name of the sink to update. Example: `"projects/my-project-id/sinks/my-sink-id"`. The updated sink must be provided in the request and have the same name that is specified in `sinkName`. If the sink does not exist, it is created.
optional sink = 2
The updated sink, whose name must be the same as the sink identifier in `sinkName`. If `sinkName` does not exist, then this method creates a new sink.
rpc DeleteSink (, )
logging_config.proto:50Deletes a sink.
message
logging_config.proto:167The parameters to `DeleteSink`.
string sink_name = 1
The resource name of the sink to delete. Example: `"projects/my-project-id/sinks/my-sink-id"`.
service LoggingServiceV2
logging.proto:32Service for ingesting and querying logs.
rpc DeleteLog (, )
logging.proto:36Deletes a log and all its log entries. The log will reappear if it receives new entries.
message
logging.proto:62The parameters to DeleteLog.
string log_name = 1
Required. The resource name of the log to delete. Example: `"projects/my-project/logs/syslog"`.
rpc WriteLogEntries (, )
logging.proto:43Writes log entries to Cloud Logging. All log entries in Cloud Logging are written by this method.
message
logging.proto:69The parameters to WriteLogEntries.
string log_name = 1
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][google.logging.v2.LogEntry].
optional resource = 2
Optional. A default monitored resource for those log entries in `entries` that do not specify their own `resource`.
map<string, string> labels = 3
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" }`
repeated entries = 4
Required. The log entries to write. The log entries must have values for all required fields.
message
logging.proto:92Result returned from WriteLogEntries.
(message has no fields)
rpc ListLogEntries (, )
logging.proto:51Lists log entries. Use this method to retrieve log entries from Cloud Logging. For ways to export log entries, see [Exporting Logs](/logging/docs/export).
message
logging.proto:97The parameters to `ListLogEntries`.
repeated string project_ids = 1
Required. One or more project IDs or project numbers from which to retrieve log entries. Examples of a project ID: `"my-project-1A"`, `"1234567890"`.
string filter = 2
Optional. An [advanced logs filter](/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.
string order_by = 3
Optional. How the results should be sorted. Presently, the only permitted values are `"timestamp"` (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`.
int32 page_size = 4
Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.
string page_token = 5
Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The values of `projectIds`, `filter`, and `orderBy` must be the same as in the previous request.
message
logging.proto:132Result returned from `ListLogEntries`.
repeated entries = 1
A list of log entries.
string next_page_token = 2
If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`.
Lists monitored resource descriptors that are used by Cloud Logging.
message
logging.proto:143The parameters to ListMonitoredResourceDescriptors
int32 page_size = 1
Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.
string page_token = 2
Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request.
message
logging.proto:159Result returned from ListMonitoredResourceDescriptors.
repeated resource_descriptors = 1
A list of resource descriptors.
string next_page_token = 2
If there are more results than were returned, then `nextPageToken` is returned in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`.
Lists logs-based metrics.
message
logging_metrics.proto:73The parameters to ListLogMetrics.
string project_name = 1
Required. The resource name of the project containing the metrics. Example: `"projects/my-project-id"`.
string page_token = 2
Optional. If the `pageToken` request parameter is supplied, then the next page of results in the set are retrieved. The `pageToken` parameter must be set with the value of the `nextPageToken` result parameter from the previous request. The value of `projectName` must be the same as in the previous request.
int32 page_size = 3
Optional. The maximum number of results to return from this request. Fewer results might be returned. You must check for the `nextPageToken` result to determine if additional results are available, which you can retrieve by passing the `nextPageToken` value in the `pageToken` parameter to the next request.
message
logging_metrics.proto:94Result returned from ListLogMetrics.
repeated metrics = 1
A list of logs-based metrics.
string next_page_token = 2
If there are more results than were returned, then `nextPageToken` is given a value in the response. To get the next batch of results, call this method again using the value of `nextPageToken` as `pageToken`.
rpc GetLogMetric (, )
logging_metrics.proto:33Gets a logs-based metric.
message
logging_metrics.proto:105The parameters to GetLogMetric.
string metric_name = 1
The resource name of the desired metric. Example: `"projects/my-project-id/metrics/my-metric-id"`.
Creates a logs-based metric.
message
logging_metrics.proto:112The parameters to CreateLogMetric.
string project_name = 1
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.
optional metric = 2
The new logs-based metric, which must not have an identifier that already exists.
Creates or updates a logs-based metric.
message
logging_metrics.proto:126The parameters to UpdateLogMetric.
string metric_name = 1
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.
optional metric = 2
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.
Deletes a logs-based metric.
message
logging_metrics.proto:142The parameters to DeleteLogMetric.
string metric_name = 1
The resource name of the metric to delete. Example: `"projects/my-project-id/metrics/my-metric-id"`.
message
log_entry.proto:33An individual entry in a log.
Used in: ,
string log_name = 12
Required. The resource name of the log to which this log entry belongs. The format of the name is `projects/<project-id>/logs/<log-id%gt;`. Examples: `"projects/my-projectid/logs/syslog"`, `"projects/1234567890/logs/library.googleapis.com%2Fbook_log"`. The log ID part of resource name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: forward-slash, underscore, hyphen, and period. Forward-slash (`/`) characters in the log ID must be URL-encoded.
optional resource = 8
Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
oneof payload
Required. The log entry payload, which can be one of multiple types.
proto_payload = 2
The log entry payload, represented as a protocol buffer. You can only use `protoPayload` values that belong to a set of approved types.
string text_payload = 3
The log entry payload, represented as a Unicode string (UTF-8).
json_payload = 6
The log entry payload, represented as a structure that is expressed as a JSON object.
optional timestamp = 9
Optional. The time the event described by the log entry occurred. If omitted, Cloud Logging will use the time the log entry is written.
type.LogSeverity severity = 10
Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
string insert_id = 4
Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Cloud Logging will generate a unique ID for this log entry.
optional http_request = 7
Optional. Information about the HTTP request associated with this log entry, if applicable.
map<string, string> labels = 11
Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
optional operation = 15
Optional. Information about an operation associated with the log entry, if applicable.
message
log_entry.proto:97Additional information about a potentially long-running operation with which a log entry is associated.
Used in:
string id = 1
Required. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
string producer = 2
Required. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, "github.com/MyProject/MyApplication"`.
bool first = 3
Optional. Set this to True if this is the first log entry in the operation.
bool last = 4
Optional. Set this to True if this is the last log entry in the operation.
message
logging_metrics.proto:55Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
Used as response type in: MetricsServiceV2.CreateLogMetric, MetricsServiceV2.GetLogMetric, MetricsServiceV2.UpdateLogMetric
Used as field type in: , ,
string name = 1
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.
string description = 2
A description of this metric, which is used in documentation.
string filter = 3
An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
message
logging_config.proto:56Describes a sink used to export log entries outside Cloud Logging.
Used as response type in: ConfigServiceV2.CreateSink, ConfigServiceV2.GetSink, ConfigServiceV2.UpdateSink
Used as field type in: , ,
string name = 1
Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
string destination = 3
The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
string filter = 5
An [advanced logs filter](/logging/docs/view/advanced_filters) that defines the log entries to be exported. The filter must be consistent with the log entry format designed by the `outputVersionFormat` parameter, regardless of the format of the log entry that was originally written to Cloud Logging. Example: `"logName:syslog AND severity>=ERROR"`.
LogSink.VersionFormat output_version_format = 6
The log entry version used when exporting log entries from this sink. This version does not have to correspond to the version of the log entry when it was written to Cloud Logging.
Available log entry formats. Log entries can be written to Cloud Logging in either format and can be exported in either format. Version 2 is the preferred format.
Used in:
VERSION_FORMAT_UNSPECIFIED = 0
An unspecified version format will default to V2.
V2 = 1
`LogEntry` version 2 format.
V1 = 2
`LogEntry` version 1 format.