Class LogEntry (3.14.6)

public class LogEntry implements Serializable

A Cloud Logging log entry. All log entries are represented via objects of this class. Log entries can have different type of payloads: an UTF-8 string (see Payload.StringPayload), a JSON object (see Payload.JsonPayload, or a protobuf object (see Payload.ProtoPayload). Entries can also store additional information about the operation or the HTTP request that generated the log (see LogEntry#getOperation() and LogEntry#getHttpRequest(), respectively). See Also: Log Entries and Logs

Inheritance

Object > LogEntry

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder(Payload<?> payload)

public static LogEntry.Builder newBuilder(Payload<?> payload)

Returns a builder for LogEntry objects given the entry payload.

Parameter
Name	Description
`payload`	`Payload<?>`

Returns
Type	Description
`LogEntry.Builder`

of(Payload<?> payload)

public static LogEntry of(Payload<?> payload)

Creates a LogEntry object given the entry payload.

Parameter
Name	Description
`payload`	`Payload<?>`

Returns
Type	Description
`LogEntry`

of(String logName, MonitoredResource resource, Payload<?> payload)

public static LogEntry of(String logName, MonitoredResource resource, Payload<?> payload)

Creates a LogEntry object given the log name, the monitored resource and the entry payload.

Parameters
Name	Description
`logName`	`String`
`resource`	`com.google.cloud.MonitoredResource`
`payload`	`Payload<?>`

Returns
Type	Description
`LogEntry`

Methods

<T>getPayload()

public T <T>getPayload()

Returns the payload for this log entry. The log entry payload can be an UTF-8 string (see Payload.StringPayload), a JSON object (see Payload.JsonPayload, or a protobuf object (see Payload.ProtoPayload). See Also: Log Entries and Logs

Returns
Type	Description
`T`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

getDestination()

public LogDestinationName getDestination()

Returns the log path destination name type associated with log entry. By default, project name based destination is used. See Also: logName

Returns
Type	Description
`LogDestinationName`

getHttpRequest()

public HttpRequest getHttpRequest()

Returns information about the HTTP request associated with this log entry, if applicable.

Returns
Type	Description
`HttpRequest`

getInsertId()

public String getInsertId()

Returns a unique ID for the log entry. The Logging service considers other log entries in the same log with the same ID as duplicates which can be removed.

Returns
Type	Description
`String`

getInstantReceiveTimestamp()

public Instant getInstantReceiveTimestamp()

Returns the time the log entry was received by Cloud Logging, in milliseconds.

Returns
Type	Description
`Instant`	timestamp as Instant

getInstantTimestamp()

public Instant getInstantTimestamp()

Returns the time at which the event described by the log entry occurred.

Returns
Type	Description
`Instant`	timestamp as Instant

getLabels()

public Map<String,String> getLabels()

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

Returns
Type	Description
`Map<String,String>`

getLogName()

public String getLogName()

Returns the name of the log to which this log entry belongs. The log name must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters: [A-Za-z0-9]; and punctuation characters: _-./. The forward-slash (/) characters in the log name must be URL-encoded. Examples: syslog, library.googleapis.com%2Fbook_log.

Returns
Type	Description
`String`

getOperation()

public Operation getOperation()

Returns information about an operation associated with the log entry, if applicable.

Returns
Type	Description
`Operation`

getReceiveTimestamp() (deprecated)

public @Nullable Long getReceiveTimestamp()

Deprecated. This method is no longer recommended to get the received time timestamp.

Use getInstantReceiveTimestamp() instead.

Returns the time the log entry was received by Cloud Logging, in milliseconds.

Returns
Type	Description
`@org.jspecify.annotations.Nullable java.lang.Long`	timestamp in milliseconds

getResource()

public MonitoredResource getResource()

Returns 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.

Returns
Type	Description
`com.google.cloud.MonitoredResource`

getSeverity()

public Severity getSeverity()

Returns the severity of the log entry. If not set, Severity#DEFAULT is used.

Returns
Type	Description
`Severity`

getSourceLocation()

public SourceLocation getSourceLocation()

Returns the source code location information associated with the log entry, if any.

Returns
Type	Description
`SourceLocation`

getSpanId()

public @Nullable String getSpanId()

Returns the ID of the trace span associated with the log entry, if any.

Returns
Type	Description
`@org.jspecify.annotations.Nullable java.lang.String`

getTimestamp() (deprecated)

public @Nullable Long getTimestamp()

Deprecated. This method is no longer recommended to get the entry timestamp.

Use getInstantTimestamp() instead.

Returns the time at which the event described by the log entry occurred, in milliseconds.

Returns
Type	Description
`@org.jspecify.annotations.Nullable java.lang.Long`	timestamp in milliseconds

getTrace()

public @Nullable String getTrace()

Returns the 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.

Returns
Type	Description
`@org.jspecify.annotations.Nullable java.lang.String`

getTraceSampled()

public boolean getTraceSampled()

Returns the sampling decision of the trace span associated with the log entry, or false if there is no trace span.

Returns
Type	Description
`boolean`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

toBuilder()

public LogEntry.Builder toBuilder()

Returns a Builder for this log entry.

Returns
Type	Description
`LogEntry.Builder`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()

toStructuredJsonString()

public String toStructuredJsonString()

Serializes the object to a one line JSON string in the simplified format that can be parsed by the logging agents that run on Google Cloud resources.

Returns
Type	Description
`String`