// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/logging/v2/log_entry.proto
package com.google.logging.v2;
public interface LogEntryOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.logging.v2.LogEntry)
com.google.protobuf.MessageLiteOrBuilder {
/**
*
* Required. The resource name of the log to which this log entry belongs:
* "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]"
* A project number may be used in place of PROJECT_ID. The project number is
* translated to its corresponding PROJECT_ID internally and the `log_name`
* field will contain PROJECT_ID in queries and exports.
* `[LOG_ID]` must be URL-encoded within `log_name`. Example:
* `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
* `[LOG_ID]` must be less than 512 characters long and can only include the
* following characters: upper and lower case alphanumeric characters,
* forward-slash, underscore, hyphen, and period.
* For backward compatibility, if `log_name` begins with a forward-slash, such
* as `/projects/...`, then the log entry is ingested as usual but the
* forward-slash is removed. Listing the log entry will not show the leading
* slash and filtering for a log name with a leading slash will never return
* any results.
*
*
* string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
* @return The logName.
*/
java.lang.String getLogName();
/**
*
* Required. The resource name of the log to which this log entry belongs:
* "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]"
* A project number may be used in place of PROJECT_ID. The project number is
* translated to its corresponding PROJECT_ID internally and the `log_name`
* field will contain PROJECT_ID in queries and exports.
* `[LOG_ID]` must be URL-encoded within `log_name`. Example:
* `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
* `[LOG_ID]` must be less than 512 characters long and can only include the
* following characters: upper and lower case alphanumeric characters,
* forward-slash, underscore, hyphen, and period.
* For backward compatibility, if `log_name` begins with a forward-slash, such
* as `/projects/...`, then the log entry is ingested as usual but the
* forward-slash is removed. Listing the log entry will not show the leading
* slash and filtering for a log name with a leading slash will never return
* any results.
*
*
* string log_name = 12 [(.google.api.field_behavior) = REQUIRED];
* @return The bytes for logName.
*/
com.google.protobuf.ByteString
getLogNameBytes();
/**
*
* Required. The monitored resource that produced 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.
*
*
* .google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
* @return Whether the resource field is set.
*/
boolean hasResource();
/**
*
* Required. The monitored resource that produced 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.
*
*
* .google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];
* @return The resource.
*/
com.google.api.MonitoredResource getResource();
/**
*
* The log entry payload, represented as a protocol buffer. Some Google
* Cloud Platform services use this field for their log entry payloads.
* The following protocol buffer types are supported; user-defined types
* are not supported:
* "type.googleapis.com/google.cloud.audit.AuditLog"
* "type.googleapis.com/google.appengine.logging.v1.RequestLog"
*
*
* .google.protobuf.Any proto_payload = 2;
* @return Whether the protoPayload field is set.
*/
boolean hasProtoPayload();
/**
*
* The log entry payload, represented as a protocol buffer. Some Google
* Cloud Platform services use this field for their log entry payloads.
* The following protocol buffer types are supported; user-defined types
* are not supported:
* "type.googleapis.com/google.cloud.audit.AuditLog"
* "type.googleapis.com/google.appengine.logging.v1.RequestLog"
*
*
* .google.protobuf.Any proto_payload = 2;
* @return The protoPayload.
*/
com.google.protobuf.Any getProtoPayload();
/**
*
* The log entry payload, represented as a Unicode string (UTF-8).
*
*
* string text_payload = 3;
* @return The textPayload.
*/
java.lang.String getTextPayload();
/**
*
* The log entry payload, represented as a Unicode string (UTF-8).
*
*
* string text_payload = 3;
* @return The bytes for textPayload.
*/
com.google.protobuf.ByteString
getTextPayloadBytes();
/**
*
* The log entry payload, represented as a structure that is
* expressed as a JSON object.
*
*
* .google.protobuf.Struct json_payload = 6;
* @return Whether the jsonPayload field is set.
*/
boolean hasJsonPayload();
/**
*
* The log entry payload, represented as a structure that is
* expressed as a JSON object.
*
*
* .google.protobuf.Struct json_payload = 6;
* @return The jsonPayload.
*/
com.google.protobuf.Struct getJsonPayload();
/**
*
* Optional. The time the event described by the log entry occurred. This time is used
* to compute the log entry's age and to enforce the logs retention period.
* If this field is omitted in a new log entry, then Logging assigns it the
* current time. Timestamps have nanosecond accuracy, but trailing zeros in
* the fractional seconds might be omitted when the timestamp is displayed.
* Incoming log entries must have timestamps that don't exceed the
* [logs retention
* period](https://cloud.google.com/logging/quotas#logs_retention_periods) in
* the past, and that don't exceed 24 hours in the future. Log entries outside
* those time boundaries aren't ingested by Logging.
*
*
* .google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
* @return Whether the timestamp field is set.
*/
boolean hasTimestamp();
/**
*
* Optional. The time the event described by the log entry occurred. This time is used
* to compute the log entry's age and to enforce the logs retention period.
* If this field is omitted in a new log entry, then Logging assigns it the
* current time. Timestamps have nanosecond accuracy, but trailing zeros in
* the fractional seconds might be omitted when the timestamp is displayed.
* Incoming log entries must have timestamps that don't exceed the
* [logs retention
* period](https://cloud.google.com/logging/quotas#logs_retention_periods) in
* the past, and that don't exceed 24 hours in the future. Log entries outside
* those time boundaries aren't ingested by Logging.
*
*
* .google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];
* @return The timestamp.
*/
com.google.protobuf.Timestamp getTimestamp();
/**
*
* Output only. The time the log entry was received by Logging.
*
*
* .google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the receiveTimestamp field is set.
*/
boolean hasReceiveTimestamp();
/**
*
* Output only. The time the log entry was received by Logging.
*
*
* .google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The receiveTimestamp.
*/
com.google.protobuf.Timestamp getReceiveTimestamp();
/**
*
* Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
*
*
* .google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
* @return The enum numeric value on the wire for severity.
*/
int getSeverityValue();
/**
*
* Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
*
*
* .google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
* @return The severity.
*/
com.google.logging.type.LogSeverity getSeverity();
/**
*
* Optional. A unique identifier for the log entry. If you provide a value, then
* Logging considers other log entries in the same project, with the same
* `timestamp`, and with the same `insert_id` to be duplicates which are
* removed in a single query result. However, there are no guarantees of
* de-duplication in the export of logs.
* If the `insert_id` is omitted when writing a log entry, the Logging API
* assigns its own unique identifier in this field.
* In queries, the `insert_id` is also used to order log entries that have
* the same `log_name` and `timestamp` values.
*
*
* string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
* @return The insertId.
*/
java.lang.String getInsertId();
/**
*
* Optional. A unique identifier for the log entry. If you provide a value, then
* Logging considers other log entries in the same project, with the same
* `timestamp`, and with the same `insert_id` to be duplicates which are
* removed in a single query result. However, there are no guarantees of
* de-duplication in the export of logs.
* If the `insert_id` is omitted when writing a log entry, the Logging API
* assigns its own unique identifier in this field.
* In queries, the `insert_id` is also used to order log entries that have
* the same `log_name` and `timestamp` values.
*
*
* string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];
* @return The bytes for insertId.
*/
com.google.protobuf.ByteString
getInsertIdBytes();
/**
*
* Optional. Information about the HTTP request associated with this log entry, if
* applicable.
*
*
* .google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
* @return Whether the httpRequest field is set.
*/
boolean hasHttpRequest();
/**
*
* Optional. Information about the HTTP request associated with this log entry, if
* applicable.
*
*
* .google.logging.type.HttpRequest http_request = 7 [(.google.api.field_behavior) = OPTIONAL];
* @return The httpRequest.
*/
com.google.logging.type.HttpRequest getHttpRequest();
/**
*
* Optional. A set of user-defined (key, value) data that provides additional
* information about the log entry.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
* Optional. A set of user-defined (key, value) data that provides additional
* information about the log entry.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(
java.lang.String key);
/**
* Use {@link #getLabelsMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getLabels();
/**
*
* Optional. A set of user-defined (key, value) data that provides additional
* information about the log entry.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map
getLabelsMap();
/**
*
* Optional. A set of user-defined (key, value) data that provides additional
* information about the log entry.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrDefault(
java.lang.String key,
java.lang.String defaultValue);
/**
*
* Optional. A set of user-defined (key, value) data that provides additional
* information about the log entry.
*
*
* map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(
java.lang.String key);
/**
*
* Optional. Information about an operation associated with the log entry, if
* applicable.
*
*
* .google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
* @return Whether the operation field is set.
*/
boolean hasOperation();
/**
*
* Optional. Information about an operation associated with the log entry, if
* applicable.
*
*
* .google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
* @return The operation.
*/
com.google.logging.v2.LogEntryOperation getOperation();
/**
*
* Optional. Resource name of the trace associated with the log entry, if any. If it
* contains a relative resource name, the name is assumed to be relative to
* `//tracing.googleapis.com`. Example:
* `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
*
*
* string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
* @return The trace.
*/
java.lang.String getTrace();
/**
*
* Optional. Resource name of the trace associated with the log entry, if any. If it
* contains a relative resource name, the name is assumed to be relative to
* `//tracing.googleapis.com`. Example:
* `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
*
*
* string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
* @return The bytes for trace.
*/
com.google.protobuf.ByteString
getTraceBytes();
/**
*
* Optional. The span ID within the trace associated with the log entry.
* For Trace spans, this is the same format that the Trace API v2 uses: a
* 16-character hexadecimal encoding of an 8-byte array, such as
* `000000000000004a`.
*
*
* string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
* @return The spanId.
*/
java.lang.String getSpanId();
/**
*
* Optional. The span ID within the trace associated with the log entry.
* For Trace spans, this is the same format that the Trace API v2 uses: a
* 16-character hexadecimal encoding of an 8-byte array, such as
* `000000000000004a`.
*
*
* string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
* @return The bytes for spanId.
*/
com.google.protobuf.ByteString
getSpanIdBytes();
/**
*
* Optional. The sampling decision of the trace associated with the log entry.
* True means that the trace resource name in the `trace` field was sampled
* for storage in a trace backend. False means that the trace was not sampled
* for storage when this log entry was written, or the sampling decision was
* unknown at the time. A non-sampled `trace` value is still useful as a
* request correlation identifier. The default is False.
*
*
* bool trace_sampled = 30 [(.google.api.field_behavior) = OPTIONAL];
* @return The traceSampled.
*/
boolean getTraceSampled();
/**
*
* Optional. Source code location information associated with the log entry, if any.
*
*
* .google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
* @return Whether the sourceLocation field is set.
*/
boolean hasSourceLocation();
/**
*
* Optional. Source code location information associated with the log entry, if any.
*
*
* .google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
* @return The sourceLocation.
*/
com.google.logging.v2.LogEntrySourceLocation getSourceLocation();
public com.google.logging.v2.LogEntry.PayloadCase getPayloadCase();
}