Logging (GCloud Java Logging 0.2.7 API)

All Superinterfaces:: AutoCloseable, Service<LoggingOptions>

public interface Logging
extends AutoCloseable, Service<LoggingOptions>

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Logging.EntryListOption` Class for specifying options for listing log entries.
`static class`	`Logging.ListOption` Class for specifying options for listing sinks, monitored resources and monitored resource descriptors.
`static class`	`Logging.SortingField` Fields according to which log entries can be sorted.
`static class`	`Logging.SortingOrder` Sorting orders available when listing log entries.
`static class`	`Logging.WriteOption` Class for specifying options for writing log entries.

Method Summary

Methods
Modifier and Type	Method and Description
`Metric`	`create(MetricInfo metric)` Creates a new metric.
`Sink`	`create(SinkInfo sink)` Creates a new sink.
`Future<Metric>`	`createAsync(MetricInfo metric)` Sends a request for creating a metric.
`Future<Sink>`	`createAsync(SinkInfo sink)` Sends a request for creating a sink.
`boolean`	`deleteLog(String log)` Deletes a log and all its log entries.
`Future<Boolean>`	`deleteLogAsync(String log)` Sends a request for deleting a log and all its log entries.
`boolean`	`deleteMetric(String metric)` Deletes the requested metric.
`Future<Boolean>`	`deleteMetricAsync(String metric)` Sends a request for deleting a metric.
`boolean`	`deleteSink(String sink)` Deletes the requested sink.
`Future<Boolean>`	`deleteSinkAsync(String sink)` Sends a request for deleting a sink.
`Metric`	`getMetric(String metric)` Returns the requested metric or `null` if not found.
`Future<Metric>`	`getMetricAsync(String metric)` Sends a request for getting a metric.
`Sink`	`getSink(String sink)` Returns the requested sink or `null` if not found.
`Future<Sink>`	`getSinkAsync(String sink)` Sends a request for getting a sink.
`Page<LogEntry>`	`listLogEntries(Logging.EntryListOption... options)` Lists log entries.
`Future<AsyncPage<LogEntry>>`	`listLogEntriesAsync(Logging.EntryListOption... options)` Sends a request for listing log entries.
`Page<Metric>`	`listMetrics(Logging.ListOption... options)` Lists the metrics.
`Future<AsyncPage<Metric>>`	`listMetricsAsync(Logging.ListOption... options)` Sends a request for listing metrics.
`Page<MonitoredResourceDescriptor>`	`listMonitoredResourceDescriptors(Logging.ListOption... options)` Lists the monitored resource descriptors used by Stackdriver Logging.
`Future<AsyncPage<MonitoredResourceDescriptor>>`	`listMonitoredResourceDescriptorsAsync(Logging.ListOption... options)` Sends a request for listing monitored resource descriptors used by Stackdriver Logging.
`Page<Sink>`	`listSinks(Logging.ListOption... options)` Lists the sinks.
`Future<AsyncPage<Sink>>`	`listSinksAsync(Logging.ListOption... options)` Sends a request for listing sinks.
`Metric`	`update(MetricInfo metric)` Updates a metric or creates one if it does not exist.
`Sink`	`update(SinkInfo sink)` Updates a sink or creates one if it does not exist.
`Future<Metric>`	`updateAsync(MetricInfo metric)` Sends a request for updating a metric (or creating it, if it does not exist).
`Future<Sink>`	`updateAsync(SinkInfo sink)` Sends a request for updating a sink (or creating it, if it does not exist).
`void`	`write(Iterable<LogEntry> logEntries, Logging.WriteOption... options)` Writes log entries to Stackdriver Logging.
`Future<Void>`	`writeAsync(Iterable<LogEntry> logEntries, Logging.WriteOption... options)` Sends a request to log entries to Stackdriver Logging.

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.google.cloud.Service
options

- Method Detail
  - create
```
Sink create(SinkInfo sink)
```
    Creates a new sink.
    
    Returns:
    the created sink
    
    Throws:
    
    LoggingException - upon failure
  - createAsync
```
Future<Sink> createAsync(SinkInfo sink)
```
    Sends a request for creating a sink. This method returns a Future object to consume the result. Future.get() returns the created sink.
  - update
```
Sink update(SinkInfo sink)
```
    Updates a sink or creates one if it does not exist.
    
    Returns:
    the created sink
    
    Throws:
    
    LoggingException - upon failure
  - updateAsync
```
Future<Sink> updateAsync(SinkInfo sink)
```
    Sends a request for updating a sink (or creating it, if it does not exist). This method returns a Future object to consume the result. Future.get() returns the updated/created sink or null if not found.
  - getSink
```
Sink getSink(String sink)
```
    Returns the requested sink or null if not found.
    
    Throws:
    
    LoggingException - upon failure
  - getSinkAsync
```
Future<Sink> getSinkAsync(String sink)
```
    Sends a request for getting a sink. This method returns a Future object to consume the result. Future.get() returns the requested sink or null if not found.
    
    Throws:
    
    LoggingException - upon failure
  - listSinks
```
Page<Sink> listSinks(Logging.ListOption... options)
```
    Lists the sinks. This method returns a Page object that can be used to consume paginated results. Use Logging.ListOption to specify the page size or the page token from which to start listing sinks.
    
    Throws:
    
    LoggingException - upon failure
  - listSinksAsync
```
Future<AsyncPage<Sink>> listSinksAsync(Logging.ListOption... options)
```
    Sends a request for listing sinks. This method returns a Future object to consume the result. Future.get() returns an AsyncPage object that can be used to asynchronously handle paginated results. Use Logging.ListOption to specify the page size or the page token from which to start listing sinks.
  - deleteSink
```
boolean deleteSink(String sink)
```
    Deletes the requested sink.
    
    Returns:
    true if the sink was deleted, false if it was not found
  - deleteSinkAsync
```
Future<Boolean> deleteSinkAsync(String sink)
```
    Sends a request for deleting a sink. This method returns a Future object to consume the result. Future.get() returns true if the sink was deleted, false if it was not found.
  - deleteLog
```
boolean deleteLog(String log)
```
    Deletes a log and all its log entries. The log will reappear if new entries are written to it.
    
    Returns:
    true if the log was deleted, false if it was not found
  - deleteLogAsync
```
Future<Boolean> deleteLogAsync(String log)
```
    Sends a request for deleting a log and all its log entries. This method returns a Future object to consume the result. Future.get() returns true if the log was deleted, false if it was not found.
  - listMonitoredResourceDescriptors
```
Page<MonitoredResourceDescriptor> listMonitoredResourceDescriptors(Logging.ListOption... options)
```
    Lists the monitored resource descriptors used by Stackdriver Logging. This method returns a Page object that can be used to consume paginated results. Use Logging.ListOption to specify the page size or the page token from which to start listing resource descriptors.
    
    Throws:
    
    LoggingException - upon failure
  - listMonitoredResourceDescriptorsAsync
```
Future<AsyncPage<MonitoredResourceDescriptor>> listMonitoredResourceDescriptorsAsync(Logging.ListOption... options)
```
    Sends a request for listing monitored resource descriptors used by Stackdriver Logging. This method returns a Future object to consume the result. Future.get() returns an AsyncPage object that can be used to asynchronously handle paginated results. Use Logging.ListOption to specify the page size or the page token from which to start listing resource descriptors.
  - create
```
Metric create(MetricInfo metric)
```
    Creates a new metric.
    
    Returns:
    the created metric
    
    Throws:
    
    LoggingException - upon failure
  - createAsync
```
Future<Metric> createAsync(MetricInfo metric)
```
    Sends a request for creating a metric. This method returns a Future object to consume the result. Future.get() returns the created metric.
  - update
```
Metric update(MetricInfo metric)
```
    Updates a metric or creates one if it does not exist.
    
    Returns:
    the created metric
    
    Throws:
    
    LoggingException - upon failure
  - updateAsync
```
Future<Metric> updateAsync(MetricInfo metric)
```
    Sends a request for updating a metric (or creating it, if it does not exist). This method returns a Future object to consume the result. Future.get() returns the updated/created metric or null if not found.
  - getMetric
```
Metric getMetric(String metric)
```
    Returns the requested metric or null if not found.
    
    Throws:
    
    LoggingException - upon failure
  - getMetricAsync
```
Future<Metric> getMetricAsync(String metric)
```
    Sends a request for getting a metric. This method returns a Future object to consume the result. Future.get() returns the requested metric or null if not found.
    
    Throws:
    
    LoggingException - upon failure
  - listMetrics
```
Page<Metric> listMetrics(Logging.ListOption... options)
```
    Lists the metrics. This method returns a Page object that can be used to consume paginated results. Use Logging.ListOption to specify the page size or the page token from which to start listing metrics.
    
    Throws:
    
    LoggingException - upon failure
  - listMetricsAsync
```
Future<AsyncPage<Metric>> listMetricsAsync(Logging.ListOption... options)
```
    Sends a request for listing metrics. This method returns a Future object to consume the result. Future.get() returns an AsyncPage object that can be used to asynchronously handle paginated results. Use Logging.ListOption to specify the page size or the page token from which to start listing metrics.
  - deleteMetric
```
boolean deleteMetric(String metric)
```
    Deletes the requested metric.
    
    Returns:
    true if the metric was deleted, false if it was not found
  - deleteMetricAsync
```
Future<Boolean> deleteMetricAsync(String metric)
```
    Sends a request for deleting a metric. This method returns a Future object to consume the result. Future.get() returns true if the metric was deleted, false if it was not found.
  - write
```
void write(Iterable<LogEntry> logEntries,
         Logging.WriteOption... options)
```
    Writes log entries to Stackdriver Logging. Use Logging.WriteOption.logName(String) to provide a log name for those entries that do not specify one. Use Logging.WriteOption.resource(MonitoredResource) to provide a monitored resource for those entries that do not specify one. Use Logging.WriteOption.labels(Map) to provide some labels to be added to every entry in logEntries.
  - writeAsync
```
Future<Void> writeAsync(Iterable<LogEntry> logEntries,
                      Logging.WriteOption... options)
```
    Sends a request to log entries to Stackdriver Logging. Use Logging.WriteOption.logName(String) to provide a log name for those entries that do not specify one. Use Logging.WriteOption.resource(MonitoredResource) to provide a monitored resource for those entries that do not specify one. Use Logging.WriteOption.labels(Map) to provide some labels to be added to every entry in logEntries. The method returns a Future object that can be used to wait for the write operation to be completed.
  - listLogEntries
```
Page<LogEntry> listLogEntries(Logging.EntryListOption... options)
```
    Lists log entries. This method returns a Page object that can be used to consume paginated results. Use Logging.EntryListOption.pageSize(int) to specify the page size. Use Logging.EntryListOption.pageToken(String) to specify the page token from which to start listing entries. Use EntryListOption#sortOrder(SortingField, SortingOrder) to sort log entries according to your preferred order (default is most-recent last). Use Logging.EntryListOption.filter(String) to filter listed log entries.
    
    Throws:
    
    LoggingException - upon failure
  - listLogEntriesAsync
```
Future<AsyncPage<LogEntry>> listLogEntriesAsync(Logging.EntryListOption... options)
```
    Sends a request for listing log entries. This method returns a Future object to consume the result. Future.get() returns an AsyncPage object that can be used to asynchronously handle paginated results. Use Logging.EntryListOption.pageSize(int) to specify the page size. Use Logging.EntryListOption.pageToken(String) to specify the page token from which to start listing entries. Use EntryListOption#sortOrder(SortingField, SortingOrder) to sort log entries according to your preferred order (default is most-recent last). Use Logging.EntryListOption.filter(String) to filter listed log entries.
    
    Throws:
    
    LoggingException - upon failure

Interface Logging

Nested Class Summary

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.google.cloud.Service

Method Detail

create

createAsync

update

updateAsync

getSink

getSinkAsync

listSinks

listSinksAsync

deleteSink

deleteSinkAsync

deleteLog

deleteLogAsync

listMonitoredResourceDescriptors

listMonitoredResourceDescriptorsAsync

create

createAsync

update

updateAsync

getMetric

getMetricAsync

listMetrics

listMetricsAsync

deleteMetric

deleteMetricAsync

write

writeAsync

listLogEntries

listLogEntriesAsync