Class Sink.Builder (3.16.2)

public static final class Sink.Builder extends SinkInfo.Builder

A builder for Sink objects.

Inheritance

java.lang.Object > SinkInfo.Builder > Sink.Builder

Inherited Members

SinkInfo.Builder.build()

SinkInfo.Builder.setDestination(SinkInfo.Destination)

SinkInfo.Builder.setFilter(String)

SinkInfo.Builder.setName(String)

SinkInfo.Builder.setVersionFormat(SinkInfo.VersionFormat)

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)

Methods

build()

public Sink build()

Creates a SinkInfo object for this builder.

Returns
Type	Description
`Sink`

Overrides

SinkInfo.Builder.build()

setDestination(SinkInfo.Destination destination)

public Sink.Builder setDestination(SinkInfo.Destination destination)

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

Parameter
Name	Description
`destination`	`SinkInfo.Destination`

Returns
Type	Description
`Sink.Builder`

Overrides

SinkInfo.Builder.setDestination(SinkInfo.Destination destination)

setFilter(String filter)

public Sink.Builder setFilter(String filter)

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.

Parameter
Name	Description
`filter`	`String`

Returns
Type	Description
`Sink.Builder`

Overrides

SinkInfo.Builder.setFilter(String filter)

setName(String name)

public Sink.Builder setName(String name)

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

Parameter
Name	Description
`name`	`String`

Returns
Type	Description
`Sink.Builder`

Overrides

SinkInfo.Builder.setName(String name)

setVersionFormat(SinkInfo.VersionFormat versionFormat)

public Sink.Builder setVersionFormat(SinkInfo.VersionFormat versionFormat)

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.

Parameter
Name	Description
`versionFormat`	`SinkInfo.VersionFormat`

Returns
Type	Description
`Sink.Builder`

Overrides

SinkInfo.Builder.setVersionFormat(SinkInfo.VersionFormat versionFormat)