LogEntryOrBuilder (Google Cloud Logging Parent 3.15.6 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LogEntry, LogEntry.Builder
```
public interface LogEntryOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Optional.
`com.google.logging.type.HttpRequest`	`getHttpRequest()` Optional.
`com.google.logging.type.HttpRequestOrBuilder`	`getHttpRequestOrBuilder()` Optional.
`String`	`getInsertId()` Optional.
`com.google.protobuf.ByteString`	`getInsertIdBytes()` Optional.
`com.google.protobuf.Struct`	`getJsonPayload()` The log entry payload, represented as a structure that is expressed as a JSON object.
`com.google.protobuf.StructOrBuilder`	`getJsonPayloadOrBuilder()` The log entry payload, represented as a structure that is expressed as a JSON object.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Optional.
`Map<String,String>`	`getLabelsMap()` Optional.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Optional.
`String`	`getLabelsOrThrow(String key)` Optional.
`String`	`getLogName()` Required.
`com.google.protobuf.ByteString`	`getLogNameBytes()` Required.
`LogEntryOperation`	`getOperation()` Optional.
`LogEntryOperationOrBuilder`	`getOperationOrBuilder()` Optional.
`LogEntry.PayloadCase`	`getPayloadCase()`
`com.google.protobuf.Any`	`getProtoPayload()` The log entry payload, represented as a protocol buffer.
`com.google.protobuf.AnyOrBuilder`	`getProtoPayloadOrBuilder()` The log entry payload, represented as a protocol buffer.
`com.google.protobuf.Timestamp`	`getReceiveTimestamp()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getReceiveTimestampOrBuilder()` Output only.
`com.google.api.MonitoredResource`	`getResource()` Required.
`com.google.api.MonitoredResourceOrBuilder`	`getResourceOrBuilder()` Required.
`com.google.logging.type.LogSeverity`	`getSeverity()` Optional.
`int`	`getSeverityValue()` Optional.
`LogEntrySourceLocation`	`getSourceLocation()` Optional.
`LogEntrySourceLocationOrBuilder`	`getSourceLocationOrBuilder()` Optional.
`String`	`getSpanId()` Optional.
`com.google.protobuf.ByteString`	`getSpanIdBytes()` Optional.
`LogSplit`	`getSplit()` Optional.
`LogSplitOrBuilder`	`getSplitOrBuilder()` Optional.
`String`	`getTextPayload()` The log entry payload, represented as a Unicode string (UTF-8).
`com.google.protobuf.ByteString`	`getTextPayloadBytes()` The log entry payload, represented as a Unicode string (UTF-8).
`com.google.protobuf.Timestamp`	`getTimestamp()` Optional.
`com.google.protobuf.TimestampOrBuilder`	`getTimestampOrBuilder()` Optional.
`String`	`getTrace()` Optional.
`com.google.protobuf.ByteString`	`getTraceBytes()` Optional.
`boolean`	`getTraceSampled()` Optional.
`boolean`	`hasHttpRequest()` Optional.
`boolean`	`hasJsonPayload()` The log entry payload, represented as a structure that is expressed as a JSON object.
`boolean`	`hasOperation()` Optional.
`boolean`	`hasProtoPayload()` The log entry payload, represented as a protocol buffer.
`boolean`	`hasReceiveTimestamp()` Output only.
`boolean`	`hasResource()` Required.
`boolean`	`hasSourceLocation()` Optional.
`boolean`	`hasSplit()` Optional.
`boolean`	`hasTextPayload()` The log entry payload, represented as a Unicode string (UTF-8).
`boolean`	`hasTimestamp()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getLogName

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:: The logName.

getLogNameBytes

com.google.protobuf.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:: The bytes for logName.

hasResource

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:: Whether the resource field is set.

getResource

com.google.api.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:: The resource.

getResourceOrBuilder

com.google.api.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];

hasProtoPayload

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:: Whether the protoPayload field is set.

getProtoPayload

com.google.protobuf.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:: The protoPayload.

getProtoPayloadOrBuilder

com.google.protobuf.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;

hasTextPayload

boolean hasTextPayload()

 The log entry payload, represented as a Unicode string (UTF-8).

string text_payload = 3;

Returns:: Whether the textPayload field is set.

getTextPayload

String getTextPayload()

 The log entry payload, represented as a Unicode string (UTF-8).

string text_payload = 3;

Returns:: The textPayload.

getTextPayloadBytes

com.google.protobuf.ByteString getTextPayloadBytes()

 The log entry payload, represented as a Unicode string (UTF-8).

string text_payload = 3;

Returns:: The bytes for textPayload.

hasJsonPayload

boolean hasJsonPayload()

 The log entry payload, represented as a structure that is
 expressed as a JSON object.

.google.protobuf.Struct json_payload = 6;

Returns:: Whether the jsonPayload field is set.

getJsonPayload

com.google.protobuf.Struct getJsonPayload()

 The log entry payload, represented as a structure that is
 expressed as a JSON object.

.google.protobuf.Struct json_payload = 6;

Returns:: The jsonPayload.

getJsonPayloadOrBuilder

com.google.protobuf.StructOrBuilder getJsonPayloadOrBuilder()

 The log entry payload, represented as a structure that is
 expressed as a JSON object.

.google.protobuf.Struct json_payload = 6;

hasTimestamp

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

Returns:: Whether the timestamp field is set.

getTimestamp

com.google.protobuf.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](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];

Returns:: The timestamp.

getTimestampOrBuilder

com.google.protobuf.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](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];

hasReceiveTimestamp
```
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:

Whether the receiveTimestamp field is set.

getReceiveTimestamp
```
com.google.protobuf.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:

The receiveTimestamp.

getReceiveTimestampOrBuilder

com.google.protobuf.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];

getSeverityValue
```
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:

The enum numeric value on the wire for severity.

getSeverity

com.google.logging.type.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:: The severity.

getInsertId

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:: The insertId.

getInsertIdBytes

com.google.protobuf.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:: The bytes for insertId.

hasHttpRequest
```
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:

Whether the httpRequest field is set.

getHttpRequest

com.google.logging.type.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:: The httpRequest.

getHttpRequestOrBuilder

com.google.logging.type.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];