Package com.google.logging.v2

Interface LogEntryOrBuilder

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 Details

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

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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

    • hasOperation

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

    • getOperation

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

    • getOperationOrBuilder

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

    • getTrace

      String getTrace()
       Optional. The REST resource name of the trace being written to
 [Cloud Trace](https://cloud.google.com/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:
      The trace.

    • getTraceBytes

      com.google.protobuf.ByteString getTraceBytes()
       Optional. The REST resource name of the trace being written to
 [Cloud Trace](https://cloud.google.com/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:
      The bytes for trace.

    • getSpanId

      String getSpanId()
       Optional. The ID of the [Cloud Trace](https://cloud.google.com/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](https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#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](https://cloud.google.com/trace/docs/setup) 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:

   - `000000000000004a`
   - `7a2190356c3fc94b`
   - `0000f00300090021`
   - `d39223e101960076`
      string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The spanId.

    • getSpanIdBytes

      com.google.protobuf.ByteString getSpanIdBytes()
       Optional. The ID of the [Cloud Trace](https://cloud.google.com/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](https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#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](https://cloud.google.com/trace/docs/setup) 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:

   - `000000000000004a`
   - `7a2190356c3fc94b`
   - `0000f00300090021`
   - `d39223e101960076`
      string span_id = 27 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for spanId.

    • getTraceSampled

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

    • hasSourceLocation

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

    • getSourceLocation

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

    • getSourceLocationOrBuilder

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

    • hasSplit

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

    • getSplit

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

    • getSplitOrBuilder

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

    • getPayloadCase

      LogEntry.PayloadCase getPayloadCase()