com.google.logging.v2

Interface LogEntryOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

LogEntry, LogEntry.Builder

public interface LogEntryOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Optional.
HttpRequest	getHttpRequest() Optional.
HttpRequestOrBuilder	getHttpRequestOrBuilder() Optional.
java.lang.String	getInsertId() Optional.
ByteString	getInsertIdBytes() Optional.
Struct	getJsonPayload() The log entry payload, represented as a structure that is expressed as a JSON object.
StructOrBuilder	getJsonPayloadOrBuilder() The log entry payload, represented as a structure that is expressed as a JSON object.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Optional.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Optional.
java.lang.String	getLabelsOrThrow(java.lang.String key) Optional.
java.lang.String	getLogName() Required.
ByteString	getLogNameBytes() Required.
LogEntryOperation	getOperation() Optional.
LogEntryOperationOrBuilder	getOperationOrBuilder() Optional.
LogEntry.PayloadCase	getPayloadCase()
Any	getProtoPayload() The log entry payload, represented as a protocol buffer.
AnyOrBuilder	getProtoPayloadOrBuilder() The log entry payload, represented as a protocol buffer.
Timestamp	getReceiveTimestamp() Output only.
TimestampOrBuilder	getReceiveTimestampOrBuilder() Output only.
MonitoredResource	getResource() Required.
MonitoredResourceOrBuilder	getResourceOrBuilder() Required.
LogSeverity	getSeverity() Optional.
int	getSeverityValue() Optional.
LogEntrySourceLocation	getSourceLocation() Optional.
LogEntrySourceLocationOrBuilder	getSourceLocationOrBuilder() Optional.
java.lang.String	getSpanId() Optional.
ByteString	getSpanIdBytes() Optional.
java.lang.String	getTextPayload() The log entry payload, represented as a Unicode string (UTF-8).
ByteString	getTextPayloadBytes() The log entry payload, represented as a Unicode string (UTF-8).
Timestamp	getTimestamp() Optional.
TimestampOrBuilder	getTimestampOrBuilder() Optional.
java.lang.String	getTrace() Optional.
ByteString	getTraceBytes() 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	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

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

getLogNameBytes

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

hasResource

boolean hasResource()

 Required. The monitored resource associated with 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;

getResource

MonitoredResource getResource()

 Required. The monitored resource associated with 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;

getResourceOrBuilder

MonitoredResourceOrBuilder getResourceOrBuilder()

 Required. The monitored resource associated with 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;

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.
 

.google.protobuf.Any proto_payload = 2;

getProtoPayload

Any getProtoPayload()

 The log entry payload, represented as a protocol buffer.  Some
 Google Cloud Platform services use this field for their log
 entry payloads.
 

.google.protobuf.Any proto_payload = 2;

getProtoPayloadOrBuilder

AnyOrBuilder getProtoPayloadOrBuilder()

 The log entry payload, represented as a protocol buffer.  Some
 Google Cloud Platform services use this field for their log
 entry payloads.
 

.google.protobuf.Any proto_payload = 2;

getTextPayload

java.lang.String getTextPayload()

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

string text_payload = 3;

getTextPayloadBytes

ByteString getTextPayloadBytes()

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

string text_payload = 3;

hasJsonPayload

boolean hasJsonPayload()

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

.google.protobuf.Struct json_payload = 6;

getJsonPayload

Struct getJsonPayload()

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

.google.protobuf.Struct json_payload = 6;

getJsonPayloadOrBuilder

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 Stackdriver Logging assigns it the current time.
 Incoming log entries should have timestamps that are no more than
 the [logs retention period](/logging/quota-policy) in the past,
 and no more than 24 hours in the future.
 See the `entries.write` API method for more information.
 

.google.protobuf.Timestamp timestamp = 9;

getTimestamp

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 Stackdriver Logging assigns it the current time.
 Incoming log entries should have timestamps that are no more than
 the [logs retention period](/logging/quota-policy) in the past,
 and no more than 24 hours in the future.
 See the `entries.write` API method for more information.
 

.google.protobuf.Timestamp timestamp = 9;

getTimestampOrBuilder

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 Stackdriver Logging assigns it the current time.
 Incoming log entries should have timestamps that are no more than
 the [logs retention period](/logging/quota-policy) in the past,
 and no more than 24 hours in the future.
 See the `entries.write` API method for more information.
 

.google.protobuf.Timestamp timestamp = 9;

hasReceiveTimestamp

boolean hasReceiveTimestamp()

 Output only. The time the log entry was received by Stackdriver Logging.
 

.google.protobuf.Timestamp receive_timestamp = 24;

getReceiveTimestamp

Timestamp getReceiveTimestamp()

 Output only. The time the log entry was received by Stackdriver Logging.
 

.google.protobuf.Timestamp receive_timestamp = 24;

getReceiveTimestampOrBuilder

TimestampOrBuilder getReceiveTimestampOrBuilder()

 Output only. The time the log entry was received by Stackdriver Logging.
 

.google.protobuf.Timestamp receive_timestamp = 24;

getSeverityValue

int getSeverityValue()

 Optional. The severity of the log entry. The default value is
 `LogSeverity.DEFAULT`.
 

.google.logging.type.LogSeverity severity = 10;

getSeverity

LogSeverity getSeverity()

 Optional. The severity of the log entry. The default value is
 `LogSeverity.DEFAULT`.
 

.google.logging.type.LogSeverity severity = 10;

getInsertId

java.lang.String getInsertId()

 Optional. A unique identifier for the log entry. If you provide a value,
 then Stackdriver Logging considers other log entries in the same project,
 with the same `timestamp`, and with the same `insert_id` to be duplicates
 which can be removed.  If omitted in new log entries, then Stackdriver
 Logging assigns its own unique identifier. The `insert_id` is also used
 to order log entries that have the same `timestamp` value.
 

string insert_id = 4;

getInsertIdBytes

ByteString getInsertIdBytes()

 Optional. A unique identifier for the log entry. If you provide a value,
 then Stackdriver Logging considers other log entries in the same project,
 with the same `timestamp`, and with the same `insert_id` to be duplicates
 which can be removed.  If omitted in new log entries, then Stackdriver
 Logging assigns its own unique identifier. The `insert_id` is also used
 to order log entries that have the same `timestamp` value.
 

string insert_id = 4;

hasHttpRequest

boolean hasHttpRequest()

 Optional. Information about the HTTP request associated with this
 log entry, if applicable.
 

.google.logging.type.HttpRequest http_request = 7;

getHttpRequest

HttpRequest getHttpRequest()

 Optional. Information about the HTTP request associated with this
 log entry, if applicable.
 

.google.logging.type.HttpRequest http_request = 7;

getHttpRequestOrBuilder

HttpRequestOrBuilder getHttpRequestOrBuilder()

 Optional. Information about the HTTP request associated with this
 log entry, if applicable.
 

.google.logging.type.HttpRequest http_request = 7;

getLabelsCount

int getLabelsCount()

 Optional. A set of user-defined (key, value) data that provides additional
 information about the log entry.
 

map<string, string> labels = 11;

containsLabels

boolean containsLabels(java.lang.String key)

 Optional. A set of user-defined (key, value) data that provides additional
 information about the log entry.
 

map<string, string> labels = 11;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.String> getLabelsMap()

 Optional. A set of user-defined (key, value) data that provides additional
 information about the log entry.
 

map<string, string> labels = 11;

getLabelsOrDefault

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;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.String key)

 Optional. A set of user-defined (key, value) data that provides additional
 information about the log entry.
 

map<string, string> labels = 11;

hasOperation

boolean hasOperation()

 Optional. Information about an operation associated with the log entry, if
 applicable.
 

.google.logging.v2.LogEntryOperation operation = 15;

getOperation

LogEntryOperation getOperation()

 Optional. Information about an operation associated with the log entry, if
 applicable.
 

.google.logging.v2.LogEntryOperation operation = 15;

getOperationOrBuilder

LogEntryOperationOrBuilder getOperationOrBuilder()

 Optional. Information about an operation associated with the log entry, if
 applicable.
 

.google.logging.v2.LogEntryOperation operation = 15;

getTrace

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;

getTraceBytes

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;

getSpanId

java.lang.String getSpanId()

 Optional. Id of the span within the trace associated with the log entry.
 e.g. "0000000000000042"
 For Stackdriver trace spans, this is the same format that the Stackdriver
 trace API uses.
 The ID is a 16-character hexadecimal encoding of an 8-byte array.
 

string span_id = 27;

getSpanIdBytes

ByteString getSpanIdBytes()

 Optional. Id of the span within the trace associated with the log entry.
 e.g. "0000000000000042"
 For Stackdriver trace spans, this is the same format that the Stackdriver
 trace API uses.
 The ID is a 16-character hexadecimal encoding of an 8-byte array.
 

string span_id = 27;

hasSourceLocation

boolean hasSourceLocation()

 Optional. Source code location information associated with the log entry,
 if any.
 

.google.logging.v2.LogEntrySourceLocation source_location = 23;

getSourceLocation

LogEntrySourceLocation getSourceLocation()

 Optional. Source code location information associated with the log entry,
 if any.
 

.google.logging.v2.LogEntrySourceLocation source_location = 23;

getSourceLocationOrBuilder

LogEntrySourceLocationOrBuilder getSourceLocationOrBuilder()

 Optional. Source code location information associated with the log entry,
 if any.
 

.google.logging.v2.LogEntrySourceLocation source_location = 23;

getPayloadCase

LogEntry.PayloadCase getPayloadCase()