LogEntry (Cloud Logging API v2 (Rev. 656) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.logging.v2.model.LogEntry

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class LogEntry
extends com.google.api.client.json.GenericJson
```
An individual entry in a log.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Logging API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

LogEntry()

Constructors
Constructor and Description
`LogEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogEntry`	`clone()`
`HttpRequest`	`getHttpRequest()` Optional.
`java.lang.String`	`getInsertId()` Optional.
`java.util.Map<java.lang.String,java.lang.Object>`	`getJsonPayload()` 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()` Optional.
`java.lang.String`	`getLogName()` Required.
`MonitoredResourceMetadata`	`getMetadata()` Output only.
`LogEntryOperation`	`getOperation()` Optional.
`java.util.Map<java.lang.String,java.lang.Object>`	`getProtoPayload()` The log entry payload, represented as a protocol buffer.
`java.lang.String`	`getReceiveTimestamp()` Output only.
`MonitoredResource`	`getResource()` Required.
`java.lang.String`	`getSeverity()` Optional.
`LogEntrySourceLocation`	`getSourceLocation()` Optional.
`java.lang.String`	`getSpanId()` Optional.
`java.lang.String`	`getTextPayload()` The log entry payload, represented as a Unicode string (UTF-8).
`java.lang.String`	`getTimestamp()` Optional.
`java.lang.String`	`getTrace()` Optional.
`java.lang.Boolean`	`getTraceSampled()` Optional.
`LogEntry`	`set(java.lang.String fieldName, java.lang.Object value)`
`LogEntry`	`setHttpRequest(HttpRequest httpRequest)` Optional.
`LogEntry`	`setInsertId(java.lang.String insertId)` Optional.
`LogEntry`	`setJsonPayload(java.util.Map<java.lang.String,java.lang.Object> jsonPayload)` The log entry payload, represented as a structure that is expressed as a JSON object.
`LogEntry`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Optional.
`LogEntry`	`setLogName(java.lang.String logName)` Required.
`LogEntry`	`setMetadata(MonitoredResourceMetadata metadata)` Output only.
`LogEntry`	`setOperation(LogEntryOperation operation)` Optional.
`LogEntry`	`setProtoPayload(java.util.Map<java.lang.String,java.lang.Object> protoPayload)` The log entry payload, represented as a protocol buffer.
`LogEntry`	`setReceiveTimestamp(java.lang.String receiveTimestamp)` Output only.
`LogEntry`	`setResource(MonitoredResource resource)` Required.
`LogEntry`	`setSeverity(java.lang.String severity)` Optional.
`LogEntry`	`setSourceLocation(LogEntrySourceLocation sourceLocation)` Optional.
`LogEntry`	`setSpanId(java.lang.String spanId)` Optional.
`LogEntry`	`setTextPayload(java.lang.String textPayload)` The log entry payload, represented as a Unicode string (UTF-8).
`LogEntry`	`setTimestamp(java.lang.String timestamp)` Optional.
`LogEntry`	`setTrace(java.lang.String trace)` Optional.
`LogEntry`	`setTraceSampled(java.lang.Boolean traceSampled)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - LogEntry
```
public LogEntry()
```
- Method Detail
  - getHttpRequest
```
public HttpRequest getHttpRequest()
```
    Optional. Information about the HTTP request associated with this log entry, if applicable.
    
    Returns:
    
    value or null for none
  - setHttpRequest
```
public LogEntry setHttpRequest(HttpRequest httpRequest)
```
    Optional. Information about the HTTP request associated with this log entry, if applicable.
    
    Parameters:
    
    httpRequest - httpRequest or null for none
  - getInsertId
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setInsertId
```
public LogEntry setInsertId(java.lang.String insertId)
```
    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.
    
    Parameters:
    
    insertId - insertId or null for none
  - getJsonPayload
```
public java.util.Map<java.lang.String,java.lang.Object> getJsonPayload()
```
    The log entry payload, represented as a structure that is expressed as a JSON object.
    
    Returns:
    
    value or null for none
  - setJsonPayload
```
public LogEntry setJsonPayload(java.util.Map<java.lang.String,java.lang.Object> jsonPayload)
```
    The log entry payload, represented as a structure that is expressed as a JSON object.
    
    Parameters:
    
    jsonPayload - jsonPayload or null for none
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
    Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
    
    Returns:
    
    value or null for none
  - setLabels
```
public LogEntry setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
    Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
    
    Parameters:
    
    labels - labels or null for none
  - getLogName
```
public 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 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.
    
    Returns:
    
    value or null for none
  - setLogName
```
public LogEntry setLogName(java.lang.String logName)
```
    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.
    
    Parameters:
    
    logName - logName or null for none
  - getMetadata
```
public MonitoredResourceMetadata getMetadata()
```
    Output only. Deprecated. Additional metadata about the monitored resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources have this field populated for GKE versions older than 1.12.6. For GKE versions 1.12.6 and above, the metadata field has been deprecated. The Kubernetes pod labels that used to be in metadata.userLabels will now be present in the labels field with a key prefix of k8s-pod/. The Stackdriver system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public LogEntry setMetadata(MonitoredResourceMetadata metadata)
```
    Output only. Deprecated. Additional metadata about the monitored resource.Only k8s_container, k8s_pod, and k8s_node MonitoredResources have this field populated for GKE versions older than 1.12.6. For GKE versions 1.12.6 and above, the metadata field has been deprecated. The Kubernetes pod labels that used to be in metadata.userLabels will now be present in the labels field with a key prefix of k8s-pod/. The Stackdriver system labels that were present in the metadata.systemLabels field will no longer be available in the LogEntry.
    
    Parameters:
    
    metadata - metadata or null for none
  - getOperation
```
public LogEntryOperation getOperation()
```
    Optional. Information about an operation associated with the log entry, if applicable.
    
    Returns:
    
    value or null for none
  - setOperation
```
public LogEntry setOperation(LogEntryOperation operation)
```
    Optional. Information about an operation associated with the log entry, if applicable.
    
    Parameters:
    
    operation - operation or null for none
  - getProtoPayload
```
public java.util.Map<java.lang.String,java.lang.Object> 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"
    
    Returns:
    
    value or null for none
  - setProtoPayload
```
public LogEntry setProtoPayload(java.util.Map<java.lang.String,java.lang.Object> protoPayload)
```
    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"
    
    Parameters:
    
    protoPayload - protoPayload or null for none
  - getReceiveTimestamp
```
public java.lang.String getReceiveTimestamp()
```
    Output only. The time the log entry was received by Logging.
    
    Returns:
    
    value or null for none
  - setReceiveTimestamp
```
public LogEntry setReceiveTimestamp(java.lang.String receiveTimestamp)
```
    Output only. The time the log entry was received by Logging.
    
    Parameters:
    
    receiveTimestamp - receiveTimestamp or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setResource
```
public LogEntry setResource(MonitoredResource resource)
```
    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.
    
    Parameters:
    
    resource - resource or null for none
  - getSeverity
```
public java.lang.String getSeverity()
```
    Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
    
    Returns:
    
    value or null for none
  - setSeverity
```
public LogEntry setSeverity(java.lang.String severity)
```
    Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
    
    Parameters:
    
    severity - severity or null for none
  - getSourceLocation
```
public LogEntrySourceLocation getSourceLocation()
```
    Optional. Source code location information associated with the log entry, if any.
    
    Returns:
    
    value or null for none
  - setSourceLocation
```
public LogEntry setSourceLocation(LogEntrySourceLocation sourceLocation)
```
    Optional. Source code location information associated with the log entry, if any.
    
    Parameters:
    
    sourceLocation - sourceLocation or null for none
  - getSpanId
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setSpanId
```
public LogEntry setSpanId(java.lang.String spanId)
```
    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.
    
    Parameters:
    
    spanId - spanId or null for none
  - getTextPayload
```
public java.lang.String getTextPayload()
```
    The log entry payload, represented as a Unicode string (UTF-8).
    
    Returns:
    
    value or null for none
  - setTextPayload
```
public LogEntry setTextPayload(java.lang.String textPayload)
```
    The log entry payload, represented as a Unicode string (UTF-8).
    
    Parameters:
    
    textPayload - textPayload or null for none
  - getTimestamp
```
public java.lang.String 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 should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.
    
    Returns:
    
    value or null for none
  - setTimestamp
```
public LogEntry setTimestamp(java.lang.String timestamp)
```
    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 should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.
    
    Parameters:
    
    timestamp - timestamp or null for none
  - getTrace
```
public 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
    
    Returns:
    
    value or null for none
  - setTrace
```
public LogEntry setTrace(java.lang.String trace)
```
    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
    
    Parameters:
    
    trace - trace or null for none
  - getTraceSampled
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setTraceSampled
```
public LogEntry setTraceSampled(java.lang.Boolean traceSampled)
```
    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.
    
    Parameters:
    
    traceSampled - traceSampled or null for none
  - set
```
public LogEntry set(java.lang.String fieldName,
                    java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public LogEntry clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Logging API v2 (revision 656)

Class LogEntry

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

LogEntry

Method Detail

getHttpRequest

setHttpRequest

getInsertId

setInsertId

getJsonPayload

setJsonPayload

getLabels

setLabels

getLogName

setLogName

getMetadata

setMetadata

getOperation

setOperation

getProtoPayload

setProtoPayload

getReceiveTimestamp

setReceiveTimestamp

getResource

setResource

getSeverity

setSeverity

getSourceLocation

setSourceLocation

getSpanId

setSpanId

getTextPayload

setTextPayload

getTimestamp

setTimestamp

getTrace

setTrace

getTraceSampled

setTraceSampled

set

clone