Class Logging.WriteOption (3.18.0)

public static final class Logging.WriteOption extends Option

Class for specifying options for writing log entries.

Inheritance

Object > com.google.cloud.logging.Option > Logging.WriteOption

Static Methods

autoPopulateMetadata(boolean autoPopulateMetadata)

public static Logging.WriteOption autoPopulateMetadata(boolean autoPopulateMetadata)

Returns an option to opt-out automatic population of log entries metadata fields that are not set.

Parameter
Name Description
autoPopulateMetadata boolean
Returns
Type Description
Logging.WriteOption

destination(LogDestinationName destination)

public static Logging.WriteOption destination(LogDestinationName destination)

Returns an option to specify a log destination resource path (see LogDestinationName for details)

Parameter
Name Description
destination LogDestinationName
Returns
Type Description
Logging.WriteOption

labels(Map<String,String> labels)

public static Logging.WriteOption labels(Map<String,String> labels)

Sets an option to specify (key, value) pairs that are added to the LogEntry#getLabels() of each log entry written, except when a log entry already has a value associated to the same key.

Parameter
Name Description
labels Map<String,String>
Returns
Type Description
Logging.WriteOption

logName(String logName)

public static Logging.WriteOption logName(String logName)

Returns an option to specify a default log name (see LogEntry#getLogName()) for those log entries that do not specify their own log name. Example: syslog.

Parameter
Name Description
logName String
Returns
Type Description
Logging.WriteOption

partialSuccess(boolean partialSuccess)

public static Logging.WriteOption partialSuccess(boolean partialSuccess)

Returns an option to set partialSuccess flag. See the API documentation for more details.

Parameter
Name Description
partialSuccess boolean
Returns
Type Description
Logging.WriteOption

resource(MonitoredResource resource)

public static Logging.WriteOption resource(MonitoredResource resource)

Returns an option to specify a default monitored resource (see LogEntry#getResource()) for those log entries that do not specify their own resource.

Parameter
Name Description
resource com.google.cloud.MonitoredResource
Returns
Type Description
Logging.WriteOption