public final class LogEntry extends GeneratedMessageV3 implements LogEntryOrBuilder
An individual entry in a log.
Protobuf type google.logging.v2.LogEntry
Fields
HTTP_REQUEST_FIELD_NUMBER
public static final int HTTP_REQUEST_FIELD_NUMBER
Field Value
INSERT_ID_FIELD_NUMBER
public static final int INSERT_ID_FIELD_NUMBER
Field Value
JSON_PAYLOAD_FIELD_NUMBER
public static final int JSON_PAYLOAD_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
LOG_NAME_FIELD_NUMBER
public static final int LOG_NAME_FIELD_NUMBER
Field Value
OPERATION_FIELD_NUMBER
public static final int OPERATION_FIELD_NUMBER
Field Value
PROTO_PAYLOAD_FIELD_NUMBER
public static final int PROTO_PAYLOAD_FIELD_NUMBER
Field Value
RECEIVE_TIMESTAMP_FIELD_NUMBER
public static final int RECEIVE_TIMESTAMP_FIELD_NUMBER
Field Value
RESOURCE_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER
Field Value
SEVERITY_FIELD_NUMBER
public static final int SEVERITY_FIELD_NUMBER
Field Value
SOURCE_LOCATION_FIELD_NUMBER
public static final int SOURCE_LOCATION_FIELD_NUMBER
Field Value
SPAN_ID_FIELD_NUMBER
public static final int SPAN_ID_FIELD_NUMBER
Field Value
TEXT_PAYLOAD_FIELD_NUMBER
public static final int TEXT_PAYLOAD_FIELD_NUMBER
Field Value
TIMESTAMP_FIELD_NUMBER
public static final int TIMESTAMP_FIELD_NUMBER
Field Value
TRACE_FIELD_NUMBER
public static final int TRACE_FIELD_NUMBER
Field Value
TRACE_SAMPLED_FIELD_NUMBER
public static final int TRACE_SAMPLED_FIELD_NUMBER
Field Value
Methods
containsLabels(String key)
public boolean containsLabels(String key)
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static LogEntry getDefaultInstance()
Returns
getDefaultInstanceForType()
public LogEntry getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getHttpRequest()
public HttpRequest getHttpRequest()
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];
| Type | Description |
| com.google.logging.type.HttpRequest | The httpRequest.
|
getHttpRequestOrBuilder()
public HttpRequestOrBuilder getHttpRequestOrBuilder()
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];
| Type | Description |
| com.google.logging.type.HttpRequestOrBuilder | |
getInsertId()
public 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];
| Type | Description |
| String | The insertId.
|
getInsertIdBytes()
public ByteString getInsertIdBytes()
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];
getJsonPayload()
public Struct getJsonPayload()
The log entry payload, represented as a structure that is
expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Type | Description |
| Struct | The jsonPayload.
|
getJsonPayloadOrBuilder()
public StructOrBuilder getJsonPayloadOrBuilder()
The log entry payload, represented as a structure that is
expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public 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];
getLabelsMap()
public Map<String,String> 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];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, 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];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
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];
getLogName()
public 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];
| Type | Description |
| String | The logName.
|
getLogNameBytes()
public ByteString getLogNameBytes()
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];
getOperation()
public LogEntryOperation getOperation()
Optional. Information about an operation associated with the log entry, if
applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
getOperationOrBuilder()
public LogEntryOperationOrBuilder getOperationOrBuilder()
Optional. Information about an operation associated with the log entry, if
applicable.
.google.logging.v2.LogEntryOperation operation = 15 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<LogEntry> getParserForType()
Returns
Overrides
getPayloadCase()
public LogEntry.PayloadCase getPayloadCase()
Returns
getProtoPayload()
public Any getProtoPayload()
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;
| Type | Description |
| Any | The protoPayload.
|
getProtoPayloadOrBuilder()
public AnyOrBuilder getProtoPayloadOrBuilder()
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;
getReceiveTimestamp()
public Timestamp getReceiveTimestamp()
Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The receiveTimestamp.
|
getReceiveTimestampOrBuilder()
public TimestampOrBuilder getReceiveTimestampOrBuilder()
Output only. The time the log entry was received by Logging.
.google.protobuf.Timestamp receive_timestamp = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResource()
public MonitoredResource getResource()
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];
| Type | Description |
| com.google.api.MonitoredResource | The resource.
|
getResourceOrBuilder()
public MonitoredResourceOrBuilder getResourceOrBuilder()
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];
| Type | Description |
| com.google.api.MonitoredResourceOrBuilder | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSeverity()
public LogSeverity getSeverity()
Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
.google.logging.type.LogSeverity severity = 10 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.logging.type.LogSeverity | The severity.
|
getSeverityValue()
public 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];
| Type | Description |
| int | The enum numeric value on the wire for severity.
|
getSourceLocation()
public LogEntrySourceLocation getSourceLocation()
Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
getSourceLocationOrBuilder()
public LogEntrySourceLocationOrBuilder getSourceLocationOrBuilder()
Optional. Source code location information associated with the log entry, if any.
.google.logging.v2.LogEntrySourceLocation source_location = 23 [(.google.api.field_behavior) = OPTIONAL];
getSpanId()
public 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];
| Type | Description |
| String | The spanId.
|
getSpanIdBytes()
public ByteString getSpanIdBytes()
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];
getTextPayload()
public String getTextPayload()
The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Type | Description |
| String | The textPayload.
|
getTextPayloadBytes()
public ByteString getTextPayloadBytes()
The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Type | Description |
| ByteString | The bytes for textPayload.
|
getTimestamp()
public Timestamp getTimestamp()
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 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];
getTimestampOrBuilder()
public TimestampOrBuilder getTimestampOrBuilder()
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 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];
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];
| Type | Description |
| String | The trace.
|
getTraceBytes()
public ByteString getTraceBytes()
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];
getTraceSampled()
public boolean getTraceSampled()
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];
| Type | Description |
| boolean | The traceSampled.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasHttpRequest()
public 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];
| Type | Description |
| boolean | Whether the httpRequest field is set.
|
hasJsonPayload()
public boolean hasJsonPayload()
The log entry payload, represented as a structure that is
expressed as a JSON object.
.google.protobuf.Struct json_payload = 6;
| Type | Description |
| boolean | Whether the jsonPayload field is set.
|
hasOperation()
public 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];
| Type | Description |
| boolean | Whether the operation field is set.
|
hasProtoPayload()
public 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;
| Type | Description |
| boolean | Whether the protoPayload field is set.
|
hasReceiveTimestamp()
public 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];
| Type | Description |
| boolean | Whether the receiveTimestamp field is set.
|
hasResource()
public 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];
| Type | Description |
| boolean | Whether the resource field is set.
|
hasSourceLocation()
public 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];
| Type | Description |
| boolean | Whether the sourceLocation field is set.
|
hasTextPayload()
public boolean hasTextPayload()
The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Type | Description |
| boolean | Whether the textPayload field is set.
|
hasTimestamp()
public 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 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];
| Type | Description |
| boolean | Whether the timestamp field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static LogEntry.Builder newBuilder()
Returns
newBuilder(LogEntry prototype)
public static LogEntry.Builder newBuilder(LogEntry prototype)
Parameter
Returns
newBuilderForType()
public LogEntry.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LogEntry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
parseDelimitedFrom(InputStream input)
public static LogEntry parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static LogEntry parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static LogEntry parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static LogEntry parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static LogEntry parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static LogEntry parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<LogEntry> parser()
Returns
toBuilder()
public LogEntry.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
