com.google.cloud.logging.spi.v2

Class MetricsServiceV2Api

java.lang.Object

com.google.cloud.logging.spi.v2.MetricsServiceV2Api

All Implemented Interfaces:

AutoCloseable

@Generated(value="by GAPIC")
public class MetricsServiceV2Api
extends Object
implements AutoCloseable

Service Description: Service for configuring logs-based metrics.

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 (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   LogMetric response = metricsServiceV2Api.getLogMetric(formattedMetricName);
 }
 
 

Note: close() needs to be called on the metricsServiceV2Api 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:

1. 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.
2. 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.
3. 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 MetricsServiceV2Settings to create(). For example:

 
 MetricsServiceV2Settings metricsServiceV2Settings = MetricsServiceV2Settings.defaultBuilder()
     .provideChannelWith(myCredentials)
     .build();
 MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create(metricsServiceV2Settings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetricsServiceV2Api(MetricsServiceV2Settings settings) Constructs an instance of MetricsServiceV2Api, using the given settings.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
static MetricsServiceV2Api	create() Constructs an instance of MetricsServiceV2Api with default settings.
static MetricsServiceV2Api	create(MetricsServiceV2Settings settings) Constructs an instance of MetricsServiceV2Api, using the given settings.
com.google.logging.v2.LogMetric	createLogMetric(com.google.logging.v2.CreateLogMetricRequest request) Creates a logs-based metric.
com.google.logging.v2.LogMetric	createLogMetric(String parent, com.google.logging.v2.LogMetric metric) Creates a logs-based metric.
com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.CreateLogMetricRequest,com.google.logging.v2.LogMetric>	createLogMetricCallable() Creates a logs-based metric.
void	deleteLogMetric(String metricName) Deletes a logs-based metric.
com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.DeleteLogMetricRequest,com.google.protobuf.Empty>	deleteLogMetricCallable() Deletes a logs-based metric.
static String	formatMetricName(String project, String metric) Formats a string containing the fully-qualified path to represent a metric resource.
static String	formatParentName(String project) Formats a string containing the fully-qualified path to represent a parent resource.
com.google.logging.v2.LogMetric	getLogMetric(String metricName) Gets a logs-based metric.
com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.GetLogMetricRequest,com.google.logging.v2.LogMetric>	getLogMetricCallable() Gets a logs-based metric.
MetricsServiceV2Settings	getSettings()
com.google.api.gax.core.PageAccessor<com.google.logging.v2.LogMetric>	listLogMetrics(com.google.logging.v2.ListLogMetricsRequest request) Lists logs-based metrics.
com.google.api.gax.core.PageAccessor<com.google.logging.v2.LogMetric>	listLogMetrics(String parent) Lists logs-based metrics.
com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.ListLogMetricsRequest,com.google.logging.v2.ListLogMetricsResponse>	listLogMetricsCallable() Lists logs-based metrics.
com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.ListLogMetricsRequest,com.google.api.gax.core.PageAccessor<com.google.logging.v2.LogMetric>>	listLogMetricsPagedCallable() Lists logs-based metrics.
static String	parseMetricFromMetricName(String metricName) Parses the metric from the given fully-qualified path which represents a metric resource.
static String	parseProjectFromMetricName(String metricName) Parses the project from the given fully-qualified path which represents a metric resource.
static String	parseProjectFromParentName(String parentName) Parses the project from the given fully-qualified path which represents a parent resource.
com.google.logging.v2.LogMetric	updateLogMetric(String metricName, com.google.logging.v2.LogMetric metric) Creates or updates a logs-based metric.
com.google.logging.v2.LogMetric	updateLogMetric(com.google.logging.v2.UpdateLogMetricRequest request) Creates or updates a logs-based metric.
com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.UpdateLogMetricRequest,com.google.logging.v2.LogMetric>	updateLogMetricCallable() Creates or updates a logs-based metric.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsServiceV2Api

protected MetricsServiceV2Api(MetricsServiceV2Settings settings)
                       throws IOException

Constructs an instance of MetricsServiceV2Api, using the given settings. This is protected so that it easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

Method Detail

getSettings

public final MetricsServiceV2Settings getSettings()

formatParentName

public static final String formatParentName(String project)

Formats a string containing the fully-qualified path to represent a parent resource.

formatMetricName

public static final String formatMetricName(String project,
                      String metric)

Formats a string containing the fully-qualified path to represent a metric resource.

parseProjectFromParentName

public static final String parseProjectFromParentName(String parentName)

Parses the project from the given fully-qualified path which represents a parent resource.

parseProjectFromMetricName

public static final String parseProjectFromMetricName(String metricName)

Parses the project from the given fully-qualified path which represents a metric resource.

parseMetricFromMetricName

public static final String parseMetricFromMetricName(String metricName)

Parses the metric from the given fully-qualified path which represents a metric resource.

create

public static final MetricsServiceV2Api create()
                                        throws IOException

Constructs an instance of MetricsServiceV2Api with default settings.

Throws:

IOException

create

public static final MetricsServiceV2Api create(MetricsServiceV2Settings settings)
                                        throws IOException

Constructs an instance of MetricsServiceV2Api, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

listLogMetrics

public final com.google.api.gax.core.PageAccessor<com.google.logging.v2.LogMetric> listLogMetrics(String parent)

Lists logs-based metrics. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   for (LogMetric element : metricsServiceV2Api.listLogMetrics(formattedParent)) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name containing the metrics. Example: `"projects/my-project-id"`.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

listLogMetrics

public final com.google.api.gax.core.PageAccessor<com.google.logging.v2.LogMetric> listLogMetrics(com.google.logging.v2.ListLogMetricsRequest request)

Lists logs-based metrics. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   ListLogMetricsRequest request = ListLogMetricsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (LogMetric element : metricsServiceV2Api.listLogMetrics(request)) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

listLogMetricsPagedCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.ListLogMetricsRequest,com.google.api.gax.core.PageAccessor<com.google.logging.v2.LogMetric>> listLogMetricsPagedCallable()

Lists logs-based metrics. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   ListLogMetricsRequest request = ListLogMetricsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ListenableFuture<PageAccessor<LogMetric>> future = metricsServiceV2Api.listLogMetricsPagedCallable().futureCall(request);
   // Do something
   for (LogMetric element : future.get()) {
     // doThingsWith(element);
   }
 }
 

listLogMetricsCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.ListLogMetricsRequest,com.google.logging.v2.ListLogMetricsResponse> listLogMetricsCallable()

Lists logs-based metrics. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   ListLogMetricsRequest request = ListLogMetricsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListLogMetricsResponse response = metricsServiceV2Api.listLogMetricsCallable().call(request);
     for (LogMetric element : response.getMetricsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getLogMetric

public final com.google.logging.v2.LogMetric getLogMetric(String metricName)

Gets a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   LogMetric response = metricsServiceV2Api.getLogMetric(formattedMetricName);
 }
 

Parameters:

metricName - The resource name of the desired metric. Example: `"projects/my-project-id/metrics/my-metric-id"`.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

getLogMetricCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.GetLogMetricRequest,com.google.logging.v2.LogMetric> getLogMetricCallable()

Gets a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   GetLogMetricRequest request = GetLogMetricRequest.newBuilder()
     .setMetricName(formattedMetricName)
     .build();
   ListenableFuture<LogMetric> future = metricsServiceV2Api.getLogMetricCallable().futureCall(request);
   // Do something
   LogMetric response = future.get();
 }
 

createLogMetric

public final com.google.logging.v2.LogMetric createLogMetric(String parent,
                                              com.google.logging.v2.LogMetric metric)

Creates a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   LogMetric metric = LogMetric.newBuilder().build();
   LogMetric response = metricsServiceV2Api.createLogMetric(formattedParent, metric);
 }
 

Parameters:

parent - The resource name of the project in which to create the metric. Example: `"projects/my-project-id"`. The new metric must be provided in the request.

metric - The new logs-based metric, which must not have an identifier that already exists.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

createLogMetric

public final com.google.logging.v2.LogMetric createLogMetric(com.google.logging.v2.CreateLogMetricRequest request)

Creates a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   LogMetric metric = LogMetric.newBuilder().build();
   CreateLogMetricRequest request = CreateLogMetricRequest.newBuilder()
     .setParent(formattedParent)
     .setMetric(metric)
     .build();
   LogMetric response = metricsServiceV2Api.createLogMetric(request);
 }
 

Parameters:

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

createLogMetricCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.CreateLogMetricRequest,com.google.logging.v2.LogMetric> createLogMetricCallable()

Creates a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedParent = MetricsServiceV2Api.formatParentName("[PROJECT]");
   LogMetric metric = LogMetric.newBuilder().build();
   CreateLogMetricRequest request = CreateLogMetricRequest.newBuilder()
     .setParent(formattedParent)
     .setMetric(metric)
     .build();
   ListenableFuture<LogMetric> future = metricsServiceV2Api.createLogMetricCallable().futureCall(request);
   // Do something
   LogMetric response = future.get();
 }
 

updateLogMetric

public final com.google.logging.v2.LogMetric updateLogMetric(String metricName,
                                              com.google.logging.v2.LogMetric metric)

Creates or updates a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   LogMetric metric = LogMetric.newBuilder().build();
   LogMetric response = metricsServiceV2Api.updateLogMetric(formattedMetricName, metric);
 }
 

Parameters:

metricName - The resource name of the metric to update. Example: `"projects/my-project-id/metrics/my-metric-id"`. The updated metric must be provided in the request and have the same identifier that is specified in `metricName`. If the metric does not exist, it is created.

metric - The updated metric, whose name must be the same as the metric identifier in `metricName`. If `metricName` does not exist, then a new metric is created.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

updateLogMetric

public final com.google.logging.v2.LogMetric updateLogMetric(com.google.logging.v2.UpdateLogMetricRequest request)

Creates or updates a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   LogMetric metric = LogMetric.newBuilder().build();
   UpdateLogMetricRequest request = UpdateLogMetricRequest.newBuilder()
     .setMetricName(formattedMetricName)
     .setMetric(metric)
     .build();
   LogMetric response = metricsServiceV2Api.updateLogMetric(request);
 }
 

Parameters:

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

updateLogMetricCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.UpdateLogMetricRequest,com.google.logging.v2.LogMetric> updateLogMetricCallable()

Creates or updates a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   LogMetric metric = LogMetric.newBuilder().build();
   UpdateLogMetricRequest request = UpdateLogMetricRequest.newBuilder()
     .setMetricName(formattedMetricName)
     .setMetric(metric)
     .build();
   ListenableFuture<LogMetric> future = metricsServiceV2Api.updateLogMetricCallable().futureCall(request);
   // Do something
   LogMetric response = future.get();
 }
 

deleteLogMetric

public final void deleteLogMetric(String metricName)

Deletes a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   metricsServiceV2Api.deleteLogMetric(formattedMetricName);
 }
 

Parameters:

metricName - The resource name of the metric to delete. Example: `"projects/my-project-id/metrics/my-metric-id"`.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

deleteLogMetricCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.logging.v2.DeleteLogMetricRequest,com.google.protobuf.Empty> deleteLogMetricCallable()

Deletes a logs-based metric. Sample code:

 try (MetricsServiceV2Api metricsServiceV2Api = MetricsServiceV2Api.create()) {
   String formattedMetricName = MetricsServiceV2Api.formatMetricName("[PROJECT]", "[METRIC]");
   DeleteLogMetricRequest request = DeleteLogMetricRequest.newBuilder()
     .setMetricName(formattedMetricName)
     .build();
   ListenableFuture<Void> future = metricsServiceV2Api.deleteLogMetricCallable().futureCall(request);
   // Do something
   future.get();
 }
 

close

public final void close()
                 throws Exception

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.

Specified by:

close in interface AutoCloseable

Throws:

Exception