com.google.cloud.logging.spi.v2.LoggingServiceV2Api Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gcloud-java-logging Show documentation
Show all versions of gcloud-java-logging Show documentation
Java idiomatic client for Stackdriver Logging.
/*
* Copyright 2016 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* EDITING INSTRUCTIONS
* This file was generated from the file
* https://github.com/google/googleapis/blob/master/google/logging/v2/logging.proto
* and updates to that file get reflected here through a refresh process.
* For the short term, the refresh process will only be runnable by Google engineers.
* Manual additions are allowed because the refresh process performs
* a 3-way merge in order to preserve those manual additions. In order to not
* break the refresh process, only certain types of modifications are
* allowed.
*
* Allowed modifications - currently these are the only types allowed:
* 1. New methods (these should be added to the end of the class)
* 2. New imports
* 3. Additional documentation between "manual edit" demarcations
*
* Happy editing!
*/
package com.google.cloud.logging.spi.v2;
import com.google.api.MonitoredResource;
import com.google.api.MonitoredResourceDescriptor;
import com.google.api.gax.core.PageAccessor;
import com.google.api.gax.grpc.ApiCallable;
import com.google.api.gax.protobuf.PathTemplate;
import com.google.logging.v2.DeleteLogRequest;
import com.google.logging.v2.ListLogEntriesRequest;
import com.google.logging.v2.ListLogEntriesResponse;
import com.google.logging.v2.ListMonitoredResourceDescriptorsRequest;
import com.google.logging.v2.ListMonitoredResourceDescriptorsResponse;
import com.google.logging.v2.LogEntry;
import com.google.logging.v2.WriteLogEntriesRequest;
import com.google.logging.v2.WriteLogEntriesResponse;
import com.google.protobuf.Empty;
import io.grpc.ManagedChannel;
import java.io.Closeable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ScheduledExecutorService;
// Manually-added imports: add custom (non-generated) imports after this point.
// AUTO-GENERATED DOCUMENTATION AND SERVICE - see instructions at the top of the file for editing.
/**
* Service Description: Service for ingesting and querying logs.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* String formattedLogName = LoggingServiceV2Api.formatLogName("[PROJECT]", "[LOG]");
* loggingServiceV2Api.deleteLog(formattedLogName);
* }
*
*
*
* Note: close() needs to be called on the loggingServiceV2Api object to clean up resources such
* as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
*
The surface of this class includes several types of Java methods for each of the API's methods:
*
*
* - A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available
* as parameters, and not every API method will have a flattened method entry point.
*
- A "request object" method. This type of method only takes one parameter, a request
* object, which must be constructed before the call. Not every API method will have a request
* object method.
*
- A "callable" method. This type of method takes no parameters and returns an immutable
* ApiCallable object, which can be used to initiate calls to the service.
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist
* with these names, this class includes a format method for each type of name, and additionally
* a parse method to extract the individual identifiers contained within names that are
* returned.
*
*
This class can be customized by passing in a custom instance of LoggingServiceV2Settings to
* create(). For example:
*
*
*
* LoggingServiceV2Settings loggingServiceV2Settings = LoggingServiceV2Settings.defaultBuilder()
* .provideChannelWith(myCredentials)
* .build();
* LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.create(loggingServiceV2Settings);
*
*
*
*
*
*/
@javax.annotation.Generated("by GAPIC")
public class LoggingServiceV2Api implements AutoCloseable {
private final LoggingServiceV2Settings settings;
private final ManagedChannel channel;
private final ScheduledExecutorService executor;
private final List closeables = new ArrayList<>();
private final ApiCallable deleteLogCallable;
private final ApiCallable
writeLogEntriesCallable;
private final ApiCallable listLogEntriesCallable;
private final ApiCallable>
listLogEntriesPagedCallable;
private final ApiCallable<
ListMonitoredResourceDescriptorsRequest, ListMonitoredResourceDescriptorsResponse>
listMonitoredResourceDescriptorsCallable;
private final ApiCallable<
ListMonitoredResourceDescriptorsRequest, PageAccessor>
listMonitoredResourceDescriptorsPagedCallable;
public final LoggingServiceV2Settings getSettings() {
return settings;
}
private static final PathTemplate PROJECT_PATH_TEMPLATE =
PathTemplate.createWithoutUrlEncoding("projects/{project}");
private static final PathTemplate LOG_PATH_TEMPLATE =
PathTemplate.createWithoutUrlEncoding("projects/{project}/logs/{log}");
/**
* Formats a string containing the fully-qualified path to represent
* a project resource.
*
*
*
*/
public static final String formatProjectName(String project) {
return PROJECT_PATH_TEMPLATE.instantiate("project", project);
}
/**
* Formats a string containing the fully-qualified path to represent
* a log resource.
*
*
*
*/
public static final String formatLogName(String project, String log) {
return LOG_PATH_TEMPLATE.instantiate("project", project, "log", log);
}
/**
* Parses the project from the given fully-qualified path which
* represents a project resource.
*
*
*
*/
public static final String parseProjectFromProjectName(String projectName) {
return PROJECT_PATH_TEMPLATE.parse(projectName).get("project");
}
/**
* Parses the project from the given fully-qualified path which
* represents a log resource.
*
*
*
*/
public static final String parseProjectFromLogName(String logName) {
return LOG_PATH_TEMPLATE.parse(logName).get("project");
}
/**
* Parses the log from the given fully-qualified path which
* represents a log resource.
*
*
*
*/
public static final String parseLogFromLogName(String logName) {
return LOG_PATH_TEMPLATE.parse(logName).get("log");
}
/**
* Constructs an instance of LoggingServiceV2Api with default settings.
*
*
*
*/
public static final LoggingServiceV2Api createWithDefaults() throws IOException {
return create(LoggingServiceV2Settings.defaultBuilder().build());
}
/**
* Constructs an instance of LoggingServiceV2Api, using the given settings.
* The channels are created based on the settings passed in, or defaults for any
* settings that are not set.
*
*
*
*/
public static final LoggingServiceV2Api create(LoggingServiceV2Settings settings)
throws IOException {
return new LoggingServiceV2Api(settings);
}
/**
* Constructs an instance of LoggingServiceV2Api, using the given settings.
* This is protected so that it easy to make a subclass, but otherwise, the static
* factory methods should be preferred.
*
*
*
*/
protected LoggingServiceV2Api(LoggingServiceV2Settings settings) throws IOException {
this.settings = settings;
this.executor = settings.getExecutorProvider().getOrBuildExecutor();
this.channel = settings.getChannelProvider().getOrBuildChannel(this.executor);
this.deleteLogCallable =
ApiCallable.create(settings.deleteLogSettings(), this.channel, this.executor);
this.writeLogEntriesCallable =
ApiCallable.create(settings.writeLogEntriesSettings(), this.channel, this.executor);
this.listLogEntriesCallable =
ApiCallable.create(settings.listLogEntriesSettings(), this.channel, this.executor);
this.listLogEntriesPagedCallable =
ApiCallable.createPagedVariant(
settings.listLogEntriesSettings(), this.channel, this.executor);
this.listMonitoredResourceDescriptorsCallable =
ApiCallable.create(
settings.listMonitoredResourceDescriptorsSettings(), this.channel, this.executor);
this.listMonitoredResourceDescriptorsPagedCallable =
ApiCallable.createPagedVariant(
settings.listMonitoredResourceDescriptorsSettings(), this.channel, this.executor);
if (settings.getChannelProvider().shouldAutoClose()) {
closeables.add(
new Closeable() {
@Override
public void close() throws IOException {
channel.shutdown();
}
});
}
if (settings.getExecutorProvider().shouldAutoClose()) {
closeables.add(
new Closeable() {
@Override
public void close() throws IOException {
executor.shutdown();
}
});
}
}
// ----- deleteLog -----
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Deletes a log and all its log entries.
* The log will reappear if it receives new entries.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* String formattedLogName = LoggingServiceV2Api.formatLogName("[PROJECT]", "[LOG]");
* loggingServiceV2Api.deleteLog(formattedLogName);
* }
*
*
*
*
*
* @param logName Required. The resource name of the log to delete. Example:
* `"projects/my-project/logs/syslog"`.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final void deleteLog(String logName) {
LOG_PATH_TEMPLATE.validate(logName);
DeleteLogRequest request = DeleteLogRequest.newBuilder().setLogName(logName).build();
deleteLog(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Deletes a log and all its log entries.
* The log will reappear if it receives new entries.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* String formattedLogName = LoggingServiceV2Api.formatLogName("[PROJECT]", "[LOG]");
* DeleteLogRequest request = DeleteLogRequest.newBuilder()
* .setLogName(formattedLogName)
* .build();
* loggingServiceV2Api.deleteLog(request);
* }
*
*
*
*
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
private void deleteLog(DeleteLogRequest request) {
deleteLogCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Deletes a log and all its log entries.
* The log will reappear if it receives new entries.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* String formattedLogName = LoggingServiceV2Api.formatLogName("[PROJECT]", "[LOG]");
* DeleteLogRequest request = DeleteLogRequest.newBuilder()
* .setLogName(formattedLogName)
* .build();
* ListenableFuture<Void> future = loggingServiceV2Api.deleteLogCallable().futureCall(request);
* // Do something
* future.get();
* }
*
*
*
*
*/
public final ApiCallable deleteLogCallable() {
return deleteLogCallable;
}
// ----- writeLogEntries -----
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Writes log entries to Cloud Logging.
* All log entries in Cloud Logging are written by this method.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* String logName = "";
* MonitoredResource resource = MonitoredResource.newBuilder().build();
* Map<String, String> labels = new HashMap<>();
* List<LogEntry> entries = new ArrayList<>();
* WriteLogEntriesResponse response = loggingServiceV2Api.writeLogEntries(logName, resource, labels, entries);
* }
*
*
*
*
*
* @param logName Optional. A default log resource name for those log entries in `entries`
* that do not specify their own `logName`. Example:
* `"projects/my-project/logs/syslog"`. See
* [LogEntry][google.logging.v2.LogEntry].
* @param resource Optional. A default monitored resource for those log entries in `entries`
* that do not specify their own `resource`.
* @param labels Optional. User-defined `key:value` items that are added to
* the `labels` field of each log entry in `entries`, except when a log
* entry specifies its own `key:value` item with the same key.
* Example: `{ "size": "large", "color":"red" }`
* @param entries Required. The log entries to write. The log entries must have values for
* all required fields.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final WriteLogEntriesResponse writeLogEntries(
String logName,
MonitoredResource resource,
Map labels,
List entries) {
LOG_PATH_TEMPLATE.validate(logName);
WriteLogEntriesRequest request =
WriteLogEntriesRequest.newBuilder()
.setLogName(logName)
.setResource(resource)
.putAllLabels(labels)
.addAllEntries(entries)
.build();
return writeLogEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Writes log entries to Cloud Logging.
* All log entries in Cloud Logging are written by this method.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* List<LogEntry> entries = new ArrayList<>();
* WriteLogEntriesRequest request = WriteLogEntriesRequest.newBuilder()
* .addAllEntries(entries)
* .build();
* WriteLogEntriesResponse response = loggingServiceV2Api.writeLogEntries(request);
* }
*
*
*
*
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public WriteLogEntriesResponse writeLogEntries(WriteLogEntriesRequest request) {
return writeLogEntriesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Writes log entries to Cloud Logging.
* All log entries in Cloud Logging are written by this method.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* List<LogEntry> entries = new ArrayList<>();
* WriteLogEntriesRequest request = WriteLogEntriesRequest.newBuilder()
* .addAllEntries(entries)
* .build();
* ListenableFuture<WriteLogEntriesResponse> future = loggingServiceV2Api.writeLogEntriesCallable().futureCall(request);
* // Do something
* WriteLogEntriesResponse response = future.get();
* }
*
*
*
*
*/
public final ApiCallable
writeLogEntriesCallable() {
return writeLogEntriesCallable;
}
// ----- listLogEntries -----
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists log entries. Use this method to retrieve log entries from Cloud
* Logging. For ways to export log entries, see
* [Exporting Logs](/logging/docs/export).
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* List<String> projectIds = new ArrayList<>();
* String filter = "";
* String orderBy = "";
* for (LogEntry elements : loggingServiceV2Api.listLogEntries(projectIds, filter, orderBy)) {
* // doThingsWith(elements);
* }
* }
*
*
*
*
*
* @param projectIds Required. One or more project IDs or project numbers from which to retrieve
* log entries. Examples of a project ID: `"my-project-1A"`, `"1234567890"`.
* @param filter Optional. An [advanced logs filter](/logging/docs/view/advanced_filters).
* The filter is compared against all log entries in the projects specified by
* `projectIds`. Only entries that match the filter are retrieved. An empty
* filter matches all log entries.
* @param orderBy Optional. How the results should be sorted. Presently, the only permitted
* values are `"timestamp"` (default) and `"timestamp desc"`. The first
* option returns entries in order of increasing values of
* `LogEntry.timestamp` (oldest first), and the second option returns entries
* in order of decreasing timestamps (newest first). Entries with equal
* timestamps are returned in order of `LogEntry.insertId`.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final PageAccessor listLogEntries(
List projectIds, String filter, String orderBy) {
ListLogEntriesRequest request =
ListLogEntriesRequest.newBuilder()
.addAllProjectIds(projectIds)
.setFilter(filter)
.setOrderBy(orderBy)
.build();
return listLogEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists log entries. Use this method to retrieve log entries from Cloud
* Logging. For ways to export log entries, see
* [Exporting Logs](/logging/docs/export).
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* List<String> projectIds = new ArrayList<>();
* ListLogEntriesRequest request = ListLogEntriesRequest.newBuilder()
* .addAllProjectIds(projectIds)
* .build();
* for (LogEntry elements : loggingServiceV2Api.listLogEntries(request)) {
* // doThingsWith(elements);
* }
* }
*
*
*
*
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final PageAccessor listLogEntries(ListLogEntriesRequest request) {
return listLogEntriesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists log entries. Use this method to retrieve log entries from Cloud
* Logging. For ways to export log entries, see
* [Exporting Logs](/logging/docs/export).
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* List<String> projectIds = new ArrayList<>();
* ListLogEntriesRequest request = ListLogEntriesRequest.newBuilder()
* .addAllProjectIds(projectIds)
* .build();
* ListenableFuture<PageAccessor<LogEntry>> future = loggingServiceV2Api.listLogEntriesPagedCallable().futureCall(request);
* // Do something
* for (LogEntry elements : future.get()) {
* // doThingsWith(elements);
* }
* }
*
*
*
*
*/
public final ApiCallable>
listLogEntriesPagedCallable() {
return listLogEntriesPagedCallable;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists log entries. Use this method to retrieve log entries from Cloud
* Logging. For ways to export log entries, see
* [Exporting Logs](/logging/docs/export).
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* List<String> projectIds = new ArrayList<>();
* ListLogEntriesRequest request = ListLogEntriesRequest.newBuilder()
* .addAllProjectIds(projectIds)
* .build();
* while (true) {
* ListLogEntriesResponse response = loggingServiceV2Api.listLogEntriesCallable().call(request);
* for (LogEntry elements : response.getEntriesList()) {
* // doThingsWith(elements);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
*
*
*
*
*/
public final ApiCallable listLogEntriesCallable() {
return listLogEntriesCallable;
}
// ----- listMonitoredResourceDescriptors -----
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists monitored resource descriptors that are used by Cloud Logging.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest.newBuilder()
* .build();
* for (MonitoredResourceDescriptor elements : loggingServiceV2Api.listMonitoredResourceDescriptors(request)) {
* // doThingsWith(elements);
* }
* }
*
*
*
*
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final PageAccessor listMonitoredResourceDescriptors(
ListMonitoredResourceDescriptorsRequest request) {
return listMonitoredResourceDescriptorsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists monitored resource descriptors that are used by Cloud Logging.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest.newBuilder()
* .build();
* ListenableFuture<PageAccessor<MonitoredResourceDescriptor>> future = loggingServiceV2Api.listMonitoredResourceDescriptorsPagedCallable().futureCall(request);
* // Do something
* for (MonitoredResourceDescriptor elements : future.get()) {
* // doThingsWith(elements);
* }
* }
*
*
*
*
*/
public final ApiCallable<
ListMonitoredResourceDescriptorsRequest, PageAccessor>
listMonitoredResourceDescriptorsPagedCallable() {
return listMonitoredResourceDescriptorsPagedCallable;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD - see instructions at the top of the file for editing.
/**
* Lists monitored resource descriptors that are used by Cloud Logging.
*
* Sample code:
*
* try (LoggingServiceV2Api loggingServiceV2Api = LoggingServiceV2Api.createWithDefaults()) {
* ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest.newBuilder()
* .build();
* while (true) {
* ListMonitoredResourceDescriptorsResponse response = loggingServiceV2Api.listMonitoredResourceDescriptorsCallable().call(request);
* for (MonitoredResourceDescriptor elements : response.getResourceDescriptorsList()) {
* // doThingsWith(elements);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
*
*
*
*
*/
public final ApiCallable<
ListMonitoredResourceDescriptorsRequest, ListMonitoredResourceDescriptorsResponse>
listMonitoredResourceDescriptorsCallable() {
return listMonitoredResourceDescriptorsCallable;
}
/**
* Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately
* cancelled.
*
*
*
*/
@Override
public final void close() throws Exception {
for (AutoCloseable closeable : closeables) {
closeable.close();
}
}
// ========
// Manually-added methods: add custom (non-generated) methods after this point.
// ========
}