Class SinkInfo.Builder (3.20.7)

public abstract static class SinkInfo.Builder

A builder for SinkInfo objects.

Inheritance

java.lang.Object > SinkInfo.Builder

Inherited Members

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)

Constructors

Builder()

public Builder()

Methods

build()

public abstract SinkInfo build()

Creates a SinkInfo object for this builder.

Returns
Type	Description
`SinkInfo`

setDestination(SinkInfo.Destination destination)

public abstract SinkInfo.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. See Also: Exporting Logs

Parameter
Name	Description
`destination`	`SinkInfo.Destination`

Returns
Type	Description
`SinkInfo.Builder`

setFilter(String filter)

public abstract SinkInfo.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. See Also: Advanced Log Filters

Parameter
Name	Description
`filter`	`String`

Returns
Type	Description
`SinkInfo.Builder`

setName(String name)

public abstract SinkInfo.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
`SinkInfo.Builder`

setVersionFormat(SinkInfo.VersionFormat versionFormat)

public abstract SinkInfo.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
`SinkInfo.Builder`