public class SinkInfo implements Serializable
Cloud Logging sinks can be used to control the export of your logs. Each sink specifies the
export of a set of log entries to a certain destination. A sink consists of a name, unique to the
project, a filter for choosing the log entries to export and a destination for the log entries.
Sink destination can either be a Google Cloud Storage bucket (see Destination.BucketDestination, a Google Cloud BigQuery dataset (see Destination.DatasetDestination) or a Google Cloud Pub/Sub topic (see Destination.TopicDestination).
See Also: About Sinks
Static Methods
newBuilder(String name, SinkInfo.Destination destination)
public static SinkInfo.Builder newBuilder(String name, SinkInfo.Destination destination)
Returns a builder for SinkInfo
objects given the name of the sink and its destination.
of(String name, SinkInfo.Destination destination)
public static SinkInfo of(String name, SinkInfo.Destination destination)
Creates a SinkInfo
object given the name of the sink and its destination.
Methods
<T>getDestination()
public T <T>getDestination()
Returns the export destination. This method returns a Destination.BucketDestination for
sinks that export logs to Google Cloud Storage buckets. Returns Destination.DatasetDestination for sinks that export logs to Google Cloud BigQuery datasets.
Returns Destination.TopicDestination for sinks that export logs to Google Cloud Pub/Sub
topics.
See Also: Exporting Logs
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
getFilter()
public String getFilter()
Returns an advanced logs filter. Only log entries matching that filter are exported. The filter
must be consistent with the log entry format specified in #getVersionFormat(),
regardless of the format of the log entry that wa originally written to Cloud Logging. Example
(V2 format): logName=projects/my-projectid/logs/syslog AND severity>=ERROR
.
See Also: Advanced Log Filters
getName()
Returns 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 _-.
.
public SinkInfo.VersionFormat getVersionFormat()
Returns 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.
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
toBuilder()
public SinkInfo.Builder toBuilder()
Returns a builder for this SinkInfo
object.
toString()
Overrides