com.google.cloud.logging

Class LogEntry.Builder

java.lang.Object

com.google.cloud.logging.LogEntry.Builder

Enclosing class:

LogEntry

public static class LogEntry.Builder
extends Object

A builder for LogEntry objects.

Method Summary

Methods

Modifier and Type	Method and Description
LogEntry.Builder	addLabel(String key, String value) Adds a label to the log entry's labels.
LogEntry	build() Creates a LogEntry object for this builder.
LogEntry.Builder	clearLabels() Clears all the labels of the log entry.
LogEntry.Builder	setHttpRequest(HttpRequest httpRequest) Sets information about the HTTP request associated with this log entry, if applicable.
LogEntry.Builder	setInsertId(String insertId) Sets a unique ID for the log entry.
LogEntry.Builder	setLabels(Map<String,String> labels) Sets an optional set of user-defined (key, value) data that provides additional information about the log entry.
LogEntry.Builder	setLogName(String logName) Sets the name of the log to which this log entry belongs.
LogEntry.Builder	setOperation(Operation operation) Sets information about an operation associated with the log entry, if applicable.
LogEntry.Builder	setPayload(Payload payload) Sets the payload for this log entry.
LogEntry.Builder	setReceiveTimestamp(long receiveTimestamp) Sets the time the log entry was received by Stackdriver Logging.
LogEntry.Builder	setResource(MonitoredResource resource) Sets the monitored resource associated with this log entry.
LogEntry.Builder	setSeverity(Severity severity) Sets the severity of the log entry.
LogEntry.Builder	setSourceLocation(SourceLocation sourceLocation) Sets the source code location information associated with the log entry if any.
LogEntry.Builder	setTimestamp(long timestamp) Sets the time at which the event described by the log entry occurred, in milliseconds.
LogEntry.Builder	setTrace(String trace) Sets the resource name of the trace associated with the log entry, if any.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setLogName

public LogEntry.Builder setLogName(String logName)

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

setResource

public LogEntry.Builder setResource(MonitoredResource resource)

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

setTimestamp

public LogEntry.Builder setTimestamp(long timestamp)

Sets the time at which the event described by the log entry occurred, in milliseconds. If omitted, the Logging service will use the time at which the log entry is received.

setReceiveTimestamp

public LogEntry.Builder setReceiveTimestamp(long receiveTimestamp)

Sets the time the log entry was received by Stackdriver Logging.

setSeverity

public LogEntry.Builder setSeverity(Severity severity)

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

setInsertId

public LogEntry.Builder setInsertId(String insertId)

Sets a unique ID for the log entry. If you provide this field, the Logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, the Logging service will generate a unique ID for this log entry.

setHttpRequest

public LogEntry.Builder setHttpRequest(HttpRequest httpRequest)

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

setLabels

public LogEntry.Builder setLabels(Map<String,String> labels)

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

addLabel

public LogEntry.Builder addLabel(String key,
                        String value)

Adds a label to the log entry's labels. Labels are user-defined (key, value) data that provides additional information about the log entry.

clearLabels

public LogEntry.Builder clearLabels()

Clears all the labels of the log entry. Labels are user-defined (key, value) data that provides additional information about the log entry.

setOperation

public LogEntry.Builder setOperation(Operation operation)

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

setTrace

public LogEntry.Builder setTrace(String trace)

Sets 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`.

setSourceLocation

public LogEntry.Builder setSourceLocation(SourceLocation sourceLocation)

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

setPayload

public LogEntry.Builder setPayload(Payload payload)

Sets the payload for this log entry. The log entry payload can be provided as 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

build

public LogEntry build()

Creates a LogEntry object for this builder.