public class Sink extends SinkInfoCloud 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 SinkInfo.Destination.BucketDestination, a Google Cloud BigQuery dataset (see SinkInfo.Destination.DatasetDestination) or a Google CloudPub/Sub topic (see SinkInfo.Destination.TopicDestination).
Sink adds a layer of service-related functionality over SinkInfo. Objects of
this class are immutable. To get a Sink object with the most recent information use
#reload or #reloadAsync.
See Also: About Sinks
Methods
delete()
public boolean delete()Deletes this sink.
Example of deleting the sink.
boolean deleted = sink.delete();
if (deleted) {
// the sink was deleted
} else {
// the sink was not found
}
| Type | Description |
| boolean |
|
deleteAsync()
public ApiFuture<Boolean> deleteAsync()Sends a request for deleting this sink. This method returns a ApiFuture object to
consume the result. ApiFuture#get() returns true if the sink was deleted,
false if it was not found.
Example of asynchronously deleting the sink.
ApiFuture<Boolean> future = sink.deleteAsync();
// ...
boolean deleted = future.get();
if (deleted) {
// the sink was deleted
} else {
// the sink was not found
}
| Type | Description |
| ApiFuture<Boolean> |
equals(Object obj)
public final boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getLogging()
public Logging getLogging()Returns the sinks's Logging object used to issue requests.
| Type | Description |
| Logging |
hashCode()
public final int hashCode()| Type | Description |
| int |
reload()
public Sink reload()Fetches current sink's latest information. Returns null if the sink does not exist.
Example of getting the sink's latest information.
Sink latestSink = sink.reload();
if (latestSink == null) {
// the sink was not found
}
| Type | Description |
| Sink | a |
reloadAsync()
public ApiFuture<Sink> reloadAsync()Sends a request to fetch current sink's latest information. This method returns a
ApiFuture object to consume the result. ApiFuture#get() returns a Sink object
with latest information or null if not found.
Example of asynchronously getting the sink's latest information.
ApiFuture<Sink> future = sink.reloadAsync();
// ...
Sink latestSink = future.get();
if (latestSink == null) {
// the sink was not found
}
| Type | Description |
| ApiFuture<Sink> |
toBuilder()
public Sink.Builder toBuilder()Returns a builder for this SinkInfo object.
| Type | Description |
| Sink.Builder |
update()
public Sink update()Updates current sink. If the sink does not exist, it is created.
Example of updating the sink's information.
Sink updatedSink = sink.toBuilder()
.setFilter("severity<=error") .build()="" .update();="">| Type | Description |
| Sink | a |
updateAsync()
public ApiFuture<Sink> updateAsync()Sends a request to update current sink. If the sink does not exist, it is created. This method
returns a ApiFuture object to consume the result. ApiFuture#get() returns a
Sink object with updated information.
Example of asynchronously updating the sink's information.
ApiFuture<Sink> future = sink.toBuilder()
.setFilter("severity<=error") .build()="" .updateasync();="" ...="" sink="" updatedsink="future.get();">| Type | Description |
| ApiFuture<Sink> |