com.google.cloud.logging

Class Sink.Builder

java.lang.Object

com.google.cloud.logging.SinkInfo.Builder

com.google.cloud.logging.Sink.Builder

Enclosing class:

Sink

public static final class Sink.Builder
extends SinkInfo.Builder

A builder for Sink objects.

Method Summary

Modifier and Type	Method and Description
Sink	build() Creates a SinkInfo object for this builder.
Sink.Builder	setDestination(SinkInfo.Destination destination) Sets the export destination.
Sink.Builder	setFilter(String filter) Sets an advanced logs filter.
Sink.Builder	setName(String name) Sets the name of the sink.
Sink.Builder	setVersionFormat(SinkInfo.VersionFormat versionFormat) Sets the log entry version to use for this sink's exported log entries.

Methods inherited from class java.lang.Object

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

Method Detail

setName

@CanIgnoreReturnValue
public Sink.Builder setName(String name)

Description copied from class: SinkInfo.Builder

Sets the name of the sink. Example: my-severe-errors-to-pubsub. Sink identifiers are limited to 1000 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-..

Specified by:

setName in class SinkInfo.Builder

setDestination

@CanIgnoreReturnValue
public Sink.Builder setDestination(SinkInfo.Destination destination)

Description copied from class: SinkInfo.Builder

Sets the export destination. Use a SinkInfo.Destination.BucketDestination object to create a sink that exports logs to a Google Cloud Storage bucket. Use a SinkInfo.Destination.DatasetDestination object to create a sink that exports logs to a Google Cloud BigQuery dataset. Use a SinkInfo.Destination.TopicDestination object to create a sink that exports logs to a Google Cloud Pub/Sub topic.

Specified by:

setDestination in class SinkInfo.Builder

See Also:

Exporting Logs

setFilter

@CanIgnoreReturnValue
public Sink.Builder setFilter(String filter)

Description copied from class: SinkInfo.Builder

Sets an advanced logs filter. Only log entries matching that filter are exported. The filter must be consistent with the log entry format specified with #setVersionFormat(VersionFormat), regardless of the format of the log entry that was originally written to Cloud Logging. Example (V2 format): logName=projects/my-projectid/logs/syslog AND severity>=ERROR.

Specified by:

setFilter in class SinkInfo.Builder

See Also:

Advanced Log Filters

setVersionFormat

@CanIgnoreReturnValue
public Sink.Builder setVersionFormat(SinkInfo.VersionFormat versionFormat)

Description copied from class: SinkInfo.Builder

Sets the log entry version to use for this sink's exported log entries. This version does not have to correspond to the version of the log entry when it was written to Google Cloud Logging.

Specified by:

setVersionFormat in class SinkInfo.Builder

build

public Sink build()

Description copied from class: SinkInfo.Builder

Creates a SinkInfo object for this builder.

Specified by:

build in class SinkInfo.Builder