Class MetricsClient (3.20.2)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   LogMetricName metricName = LogMetricName.of("[PROJECT]", "[METRIC]");
   LogMetric response = metricsClient.getLogMetric(metricName);
 }

Note: close() needs to be called on the MetricsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListLogMetrics	Lists logs-based metrics.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLogMetrics(ListLogMetricsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listLogMetrics(ProjectName parent) listLogMetrics(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLogMetricsPagedCallable() listLogMetricsCallable()
GetLogMetric	Gets a logs-based metric.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLogMetric(GetLogMetricRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getLogMetric(LogMetricName metricName) getLogMetric(String metricName) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLogMetricCallable()
CreateLogMetric	Creates a logs-based metric.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createLogMetric(CreateLogMetricRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createLogMetric(ProjectName parent, LogMetric metric) createLogMetric(String parent, LogMetric metric) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createLogMetricCallable()
UpdateLogMetric	Creates or updates a logs-based metric.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateLogMetric(UpdateLogMetricRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateLogMetric(LogMetricName metricName, LogMetric metric) updateLogMetric(String metricName, LogMetric metric) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateLogMetricCallable()
DeleteLogMetric	Deletes a logs-based metric.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteLogMetric(DeleteLogMetricRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteLogMetric(LogMetricName metricName) deleteLogMetric(String metricName) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteLogMetricCallable()

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 MetricsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MetricsSettings metricsSettings =
     MetricsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MetricsClient metricsClient = MetricsClient.create(metricsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 MetricsSettings metricsSettings = MetricsSettings.newBuilder().setEndpoint(myEndpoint).build();
 MetricsClient metricsClient = MetricsClient.create(metricsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > MetricsClient

Static Methods

create()

public static final MetricsClient create()

Constructs an instance of MetricsClient with default settings.

Returns
Type	Description
`MetricsClient`

Exceptions
Type	Description
`IOException`

create(MetricsSettings settings)

public static final MetricsClient create(MetricsSettings settings)

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

Parameter
Name	Description
`settings`	`MetricsSettings`

Returns
Type	Description
`MetricsClient`

Exceptions
Type	Description
`IOException`

create(MetricsServiceV2Stub stub)

public static final MetricsClient create(MetricsServiceV2Stub stub)

Constructs an instance of MetricsClient, using the given stub for making calls. This is for advanced usage - prefer using create(MetricsSettings).

Parameter
Name	Description
`stub`	`MetricsServiceV2Stub`

Returns
Type	Description
`MetricsClient`

Constructors

MetricsClient(MetricsSettings settings)

protected MetricsClient(MetricsSettings settings)

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

Parameter
Name	Description
`settings`	`MetricsSettings`

MetricsClient(MetricsServiceV2Stub stub)

protected MetricsClient(MetricsServiceV2Stub stub)

Parameter
Name	Description
`stub`	`MetricsServiceV2Stub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createLogMetric(CreateLogMetricRequest request)

public final LogMetric createLogMetric(CreateLogMetricRequest request)

Creates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   CreateLogMetricRequest request =
       CreateLogMetricRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setMetric(LogMetric.newBuilder().build())
           .build();
   LogMetric response = metricsClient.createLogMetric(request);
 }

Parameter
Name	Description
`request`	`CreateLogMetricRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LogMetric`

createLogMetric(ProjectName parent, LogMetric metric)

public final LogMetric createLogMetric(ProjectName parent, LogMetric metric)

Creates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   LogMetric metric = LogMetric.newBuilder().build();
   LogMetric response = metricsClient.createLogMetric(parent, metric);
 }

Parameters

Name Description

parent

ProjectName

Required. The resource name of the project in which to create the metric:

"projects/[PROJECT_ID]"

The new metric must be provided in the request.

metric

LogMetric

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

Returns
Type	Description
`LogMetric`

createLogMetric(String parent, LogMetric metric)

public final LogMetric createLogMetric(String parent, LogMetric metric)

Creates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   LogMetric metric = LogMetric.newBuilder().build();
   LogMetric response = metricsClient.createLogMetric(parent, metric);
 }

Parameters

Name Description

parent

String

Required. The resource name of the project in which to create the metric:

"projects/[PROJECT_ID]"

The new metric must be provided in the request.

metric

LogMetric

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

Returns
Type	Description
`LogMetric`

createLogMetricCallable()

public final UnaryCallable<CreateLogMetricRequest,LogMetric> createLogMetricCallable()

Creates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   CreateLogMetricRequest request =
       CreateLogMetricRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setMetric(LogMetric.newBuilder().build())
           .build();
   ApiFuture<LogMetric> future = metricsClient.createLogMetricCallable().futureCall(request);
   // Do something.
   LogMetric response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateLogMetricRequest,LogMetric>`

deleteLogMetric(DeleteLogMetricRequest request)

public final void deleteLogMetric(DeleteLogMetricRequest request)

Deletes a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   DeleteLogMetricRequest request =
       DeleteLogMetricRequest.newBuilder()
           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
           .build();
   metricsClient.deleteLogMetric(request);
 }

Parameter
Name	Description
`request`	`DeleteLogMetricRequest` The request object containing all of the parameters for the API call.

deleteLogMetric(LogMetricName metricName)

public final void deleteLogMetric(LogMetricName metricName)

Deletes a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   LogMetricName metricName = LogMetricName.of("[PROJECT]", "[METRIC]");
   metricsClient.deleteLogMetric(metricName);
 }

Parameter

Name Description

metricName

LogMetricName

Required. The resource name of the metric to delete:

"projects/[PROJECT_ID]/metrics/[METRIC_ID]"

deleteLogMetric(String metricName)

public final void deleteLogMetric(String metricName)

Deletes a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   String metricName = LogMetricName.of("[PROJECT]", "[METRIC]").toString();
   metricsClient.deleteLogMetric(metricName);
 }

Parameter

Name Description

metricName

String

Required. The resource name of the metric to delete:

"projects/[PROJECT_ID]/metrics/[METRIC_ID]"

deleteLogMetricCallable()

public final UnaryCallable<DeleteLogMetricRequest,Empty> deleteLogMetricCallable()

Deletes a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   DeleteLogMetricRequest request =
       DeleteLogMetricRequest.newBuilder()
           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
           .build();
   ApiFuture<Empty> future = metricsClient.deleteLogMetricCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteLogMetricRequest,Empty>`

getLogMetric(GetLogMetricRequest request)

public final LogMetric getLogMetric(GetLogMetricRequest request)

Gets a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   GetLogMetricRequest request =
       GetLogMetricRequest.newBuilder()
           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
           .build();
   LogMetric response = metricsClient.getLogMetric(request);
 }

Parameter
Name	Description
`request`	`GetLogMetricRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LogMetric`

getLogMetric(LogMetricName metricName)

public final LogMetric getLogMetric(LogMetricName metricName)

Gets a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   LogMetricName metricName = LogMetricName.of("[PROJECT]", "[METRIC]");
   LogMetric response = metricsClient.getLogMetric(metricName);
 }

Parameter

Name Description

metricName

LogMetricName

Required. The resource name of the desired metric:

"projects/[PROJECT_ID]/metrics/[METRIC_ID]"

Returns
Type	Description
`LogMetric`

getLogMetric(String metricName)

public final LogMetric getLogMetric(String metricName)

Gets a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   String metricName = LogMetricName.of("[PROJECT]", "[METRIC]").toString();
   LogMetric response = metricsClient.getLogMetric(metricName);
 }

Parameter

Name Description

metricName

String

Required. The resource name of the desired metric:

"projects/[PROJECT_ID]/metrics/[METRIC_ID]"

Returns
Type	Description
`LogMetric`

getLogMetricCallable()

public final UnaryCallable<GetLogMetricRequest,LogMetric> getLogMetricCallable()

Gets a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   GetLogMetricRequest request =
       GetLogMetricRequest.newBuilder()
           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
           .build();
   ApiFuture<LogMetric> future = metricsClient.getLogMetricCallable().futureCall(request);
   // Do something.
   LogMetric response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetLogMetricRequest,LogMetric>`

getSettings()

public final MetricsSettings getSettings()

Returns
Type	Description
`MetricsSettings`

getStub()

public MetricsServiceV2Stub getStub()

Returns
Type	Description
`MetricsServiceV2Stub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLogMetrics(ListLogMetricsRequest request)

public final MetricsClient.ListLogMetricsPagedResponse listLogMetrics(ListLogMetricsRequest request)

Lists logs-based metrics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   ListLogMetricsRequest request =
       ListLogMetricsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   for (LogMetric element : metricsClient.listLogMetrics(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListLogMetricsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`MetricsClient.ListLogMetricsPagedResponse`

listLogMetrics(ProjectName parent)

public final MetricsClient.ListLogMetricsPagedResponse listLogMetrics(ProjectName parent)

Lists logs-based metrics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (LogMetric element : metricsClient.listLogMetrics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

ProjectName

Required. The name of the project containing the metrics:

"projects/[PROJECT_ID]"

Returns
Type	Description
`MetricsClient.ListLogMetricsPagedResponse`

listLogMetrics(String parent)

public final MetricsClient.ListLogMetricsPagedResponse listLogMetrics(String parent)

Lists logs-based metrics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (LogMetric element : metricsClient.listLogMetrics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. The name of the project containing the metrics:

"projects/[PROJECT_ID]"

Returns
Type	Description
`MetricsClient.ListLogMetricsPagedResponse`

listLogMetricsCallable()

public final UnaryCallable<ListLogMetricsRequest,ListLogMetricsResponse> listLogMetricsCallable()

Lists logs-based metrics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   ListLogMetricsRequest request =
       ListLogMetricsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   while (true) {
     ListLogMetricsResponse response = metricsClient.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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListLogMetricsRequest,ListLogMetricsResponse>`

listLogMetricsPagedCallable()

public final UnaryCallable<ListLogMetricsRequest,MetricsClient.ListLogMetricsPagedResponse> listLogMetricsPagedCallable()

Lists logs-based metrics.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   ListLogMetricsRequest request =
       ListLogMetricsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   ApiFuture<LogMetric> future = metricsClient.listLogMetricsPagedCallable().futureCall(request);
   // Do something.
   for (LogMetric element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListLogMetricsRequest,ListLogMetricsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateLogMetric(LogMetricName metricName, LogMetric metric)

public final LogMetric updateLogMetric(LogMetricName metricName, LogMetric metric)

Creates or updates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   LogMetricName metricName = LogMetricName.of("[PROJECT]", "[METRIC]");
   LogMetric metric = LogMetric.newBuilder().build();
   LogMetric response = metricsClient.updateLogMetric(metricName, metric);
 }

Parameters

Name Description

metricName

LogMetricName

Required. The resource name of the metric to update:

"projects/[PROJECT_ID]/metrics/[METRIC_ID]"

The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.

metric

LogMetric

Required. The updated metric.

Returns
Type	Description
`LogMetric`

updateLogMetric(UpdateLogMetricRequest request)

public final LogMetric updateLogMetric(UpdateLogMetricRequest request)

Creates or updates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   UpdateLogMetricRequest request =
       UpdateLogMetricRequest.newBuilder()
           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
           .setMetric(LogMetric.newBuilder().build())
           .build();
   LogMetric response = metricsClient.updateLogMetric(request);
 }

Parameter
Name	Description
`request`	`UpdateLogMetricRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LogMetric`

updateLogMetric(String metricName, LogMetric metric)

public final LogMetric updateLogMetric(String metricName, LogMetric metric)

Creates or updates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   String metricName = LogMetricName.of("[PROJECT]", "[METRIC]").toString();
   LogMetric metric = LogMetric.newBuilder().build();
   LogMetric response = metricsClient.updateLogMetric(metricName, metric);
 }

Parameters

Name Description

metricName

String

Required. The resource name of the metric to update:

"projects/[PROJECT_ID]/metrics/[METRIC_ID]"

The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.

metric

LogMetric

Required. The updated metric.

Returns
Type	Description
`LogMetric`

updateLogMetricCallable()

public final UnaryCallable<UpdateLogMetricRequest,LogMetric> updateLogMetricCallable()

Creates or updates a logs-based metric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetricsClient metricsClient = MetricsClient.create()) {
   UpdateLogMetricRequest request =
       UpdateLogMetricRequest.newBuilder()
           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
           .setMetric(LogMetric.newBuilder().build())
           .build();
   ApiFuture<LogMetric> future = metricsClient.updateLogMetricCallable().futureCall(request);
   // Do something.
   LogMetric response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateLogMetricRequest,LogMetric>`