public final class LogEntry extends GeneratedMessageV3 implements LogEntryOrBuilderAn individual entry in a log.
Protobuf type google.logging.v2.LogEntry
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > LogEntryImplements
LogEntryOrBuilderStatic Fields
HTTP_REQUEST_FIELD_NUMBER
public static final int HTTP_REQUEST_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INSERT_ID_FIELD_NUMBER
public static final int INSERT_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
JSON_PAYLOAD_FIELD_NUMBER
public static final int JSON_PAYLOAD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LOG_NAME_FIELD_NUMBER
public static final int LOG_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
OPERATION_FIELD_NUMBER
public static final int OPERATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROTO_PAYLOAD_FIELD_NUMBER
public static final int PROTO_PAYLOAD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RECEIVE_TIMESTAMP_FIELD_NUMBER
public static final int RECEIVE_TIMESTAMP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RESOURCE_FIELD_NUMBER
public static final int RESOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SEVERITY_FIELD_NUMBER
public static final int SEVERITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SOURCE_LOCATION_FIELD_NUMBER
public static final int SOURCE_LOCATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SPAN_ID_FIELD_NUMBER
public static final int SPAN_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SPLIT_FIELD_NUMBER
public static final int SPLIT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TEXT_PAYLOAD_FIELD_NUMBER
public static final int TEXT_PAYLOAD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TIMESTAMP_FIELD_NUMBER
public static final int TIMESTAMP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRACE_FIELD_NUMBER
public static final int TRACE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRACE_SAMPLED_FIELD_NUMBER
public static final int TRACE_SAMPLED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static LogEntry getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static LogEntry.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder |
|
newBuilder(LogEntry prototype)
public static LogEntry.Builder newBuilder(LogEntry prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
LogEntry |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder |
|
parseDelimitedFrom(InputStream input)
public static LogEntry parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static LogEntry parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static LogEntry parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static LogEntry parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static LogEntry parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static LogEntry parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LogEntry parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<LogEntry> parser()| Returns | |
|---|---|
| Type | Description |
Parser<LogEntry> |
|
Methods
containsLabels(String key)
public boolean containsLabels(String key)Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.
User-defined labels are arbitrary key, value pairs that you can use to classify logs.
System-defined labels are defined by GCP services for platform logs.
They have two components - a service namespace component and the
attribute name. For example: compute.googleapis.com/resource_name.
Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public LogEntry getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LogEntry |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for insertId. |
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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.
User-defined labels are arbitrary key, value pairs that you can use to classify logs.
System-defined labels are defined by GCP services for platform logs.
They have two components - a service namespace component and the
attribute name. For example: compute.googleapis.com/resource_name.
Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.
User-defined labels are arbitrary key, value pairs that you can use to classify logs.
System-defined labels are defined by GCP services for platform logs.
They have two components - a service namespace component and the
attribute name. For example: compute.googleapis.com/resource_name.
Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.
User-defined labels are arbitrary key, value pairs that you can use to classify logs.
System-defined labels are defined by GCP services for platform logs.
They have two components - a service namespace component and the
attribute name. For example: compute.googleapis.com/resource_name.
Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.
User-defined labels are arbitrary key, value pairs that you can use to classify logs.
System-defined labels are defined by GCP services for platform logs.
They have two components - a service namespace component and the
attribute name. For example: compute.googleapis.com/resource_name.
Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.
map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for logName. |
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];
| Returns | |
|---|---|
| Type | Description |
LogEntryOperation |
The operation. |
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];
| Returns | |
|---|---|
| Type | Description |
LogEntryOperationOrBuilder |
|
getParserForType()
public Parser<LogEntry> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<LogEntry> |
|
getPayloadCase()
public LogEntry.PayloadCase getPayloadCase()| Returns | |
|---|---|
| Type | Description |
LogEntry.PayloadCase |
|
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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
AnyOrBuilder |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
com.google.api.MonitoredResourceOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
LogEntrySourceLocation |
The sourceLocation. |
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];
| Returns | |
|---|---|
| Type | Description |
LogEntrySourceLocationOrBuilder |
|
getSpanId()
public String getSpanId() Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A Span represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.
Applications that are instrumented for tracing will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The spanId. |
getSpanIdBytes()
public ByteString getSpanIdBytes() Optional. The ID of the Cloud Trace span
associated with the current operation in which the log is being written.
For example, if a span has the REST resource name of
"projects/some-project/traces/some-trace/spans/some-span-id", then the
span_id field is "some-span-id".
A Span represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.
Applications that are instrumented for tracing will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.
The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.
Example values:
000000000000004a7a2190356c3fc94b0000f00300090021d39223e101960076
string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for spanId. |
getSplit()
public LogSplit getSplit()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogSplit |
The split. |
getSplitOrBuilder()
public LogSplitOrBuilder getSplitOrBuilder()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LogSplitOrBuilder |
|
getTextPayload()
public String getTextPayload()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The textPayload. |
getTextPayloadBytes()
public ByteString getTextPayloadBytes()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The timestamp. |
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getTrace()
public String getTrace()Optional. The REST resource name of the trace being written to Cloud Trace in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The trace. |
getTraceBytes()
public ByteString getTraceBytes()Optional. The REST resource name of the trace being written to Cloud Trace in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".
The trace field provides the link between logs and traces. By using
this field, you can navigate from a log entry to a trace.
string trace = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for trace. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean |
The traceSampled. |
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];
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sourceLocation field is set. |
hasSplit()
public boolean hasSplit()Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.
.google.logging.v2.LogSplit split = 35 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the split field is set. |
hasTextPayload()
public boolean hasTextPayload()The log entry payload, represented as a Unicode string (UTF-8).
string text_payload = 3;
| Returns | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timestamp field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public LogEntry.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LogEntry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public LogEntry.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
LogEntry.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|