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	httpRequest(HttpRequest httpRequest) Sets information about the HTTP request associated with this log entry, if applicable.
LogEntry.Builder	insertId(String insertId) Sets a unique ID for the log entry.
LogEntry.Builder	labels(Map<String,String> labels) Sets an optional set of user-defined (key, value) data that provides additional information about the log entry.
LogEntry.Builder	logName(String logName) Sets the name of the log to which this log entry belongs.
LogEntry.Builder	operation(Operation operation) Sets information about an operation associated with the log entry, if applicable.
LogEntry.Builder	payload(Payload payload) Sets the payload for this log entry.
LogEntry.Builder	resource(MonitoredResource resource) Sets the monitored resource associated with this log entry.
LogEntry.Builder	severity(Severity severity) Sets the severity of the log entry.
LogEntry.Builder	timestamp(long timestamp) Sets the time at which the event described by the log entry occurred, in milliseconds.

Methods inherited from class java.lang.Object

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

Method Detail

logName

public LogEntry.Builder logName(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.

resource

public LogEntry.Builder resource(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.

timestamp

public LogEntry.Builder timestamp(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.

severity

public LogEntry.Builder severity(Severity severity)

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

insertId

public LogEntry.Builder insertId(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.

httpRequest

public LogEntry.Builder httpRequest(HttpRequest httpRequest)

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

labels

public LogEntry.Builder labels(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.

operation

public LogEntry.Builder operation(Operation operation)

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

payload

public LogEntry.Builder payload(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.