Interface LogEntryOrBuilder (3.14.6)

public interface LogEntryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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`

getHttpRequest()

public abstract 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 abstract 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 abstract 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 abstract ByteString getInsertIdBytes()

string insert_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for insertId.

getJsonPayload()

public abstract 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 abstract 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()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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 abstract String getLabelsOrThrow(String key)

map<string, string> labels = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getLogName()

public abstract 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 abstract ByteString getLogNameBytes()

string log_name = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for logName.

getOperation()

public abstract 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 abstract 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`

getPayloadCase()

public abstract LogEntry.PayloadCase getPayloadCase()

Returns
Type	Description
`LogEntry.PayloadCase`

getProtoPayload()

public abstract 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 abstract AnyOrBuilder getProtoPayloadOrBuilder()

.google.protobuf.Any proto_payload = 2;

Returns
Type	Description
`AnyOrBuilder`

getReceiveTimestamp()

public abstract 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 abstract 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 abstract 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 abstract MonitoredResourceOrBuilder getResourceOrBuilder()

.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`com.google.api.MonitoredResourceOrBuilder`

getSeverity()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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];

Returns
Type	Description
`String`	The spanId.

getSpanIdBytes()

public abstract ByteString getSpanIdBytes()

string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for spanId.

getSplit()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract TimestampOrBuilder getTimestampOrBuilder()

.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TimestampOrBuilder`

getTrace()

public abstract 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];

Returns
Type	Description
`String`	The trace.

getTraceBytes()

public abstract ByteString getTraceBytes()

string trace = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for trace.

getTraceSampled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasProtoPayload()

.google.protobuf.Any proto_payload = 2;

Returns
Type	Description
`boolean`	Whether the protoPayload field is set.

hasReceiveTimestamp()

public abstract 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 abstract boolean hasResource()

.google.api.MonitoredResource resource = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the resource field is set.

hasSourceLocation()

public abstract 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 abstract 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 abstract 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 abstract boolean hasTimestamp()

.google.protobuf.Timestamp timestamp = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the timestamp field is set.