QueryServiceClient (Google Cloud Monitoring 3.73.0 API)

java.lang.Object
- com.google.cloud.monitoring.v3.QueryServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class QueryServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The QueryService API is used to manage time series data in Cloud Monitoring. Time series data is a collection of data points that describes the time-varying values of a metric.

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 (QueryServiceClient queryServiceClient = QueryServiceClient.create()) {
   QueryTimeSeriesRequest request =
       QueryTimeSeriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TimeSeriesData element : queryServiceClient.queryTimeSeries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the QueryServiceClient 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
QueryTimeSeries	Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the [MQL deprecation notice](https://cloud.google.com/stackdriver/docs/deprecations/mql).	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryTimeSeries(QueryTimeSeriesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryTimeSeriesPagedCallable() queryTimeSeriesCallable()

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 QueryServiceSettings 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
 QueryServiceSettings queryServiceSettings =
     QueryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 QueryServiceClient queryServiceClient = QueryServiceClient.create(queryServiceSettings);

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
 QueryServiceSettings queryServiceSettings =
     QueryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 QueryServiceClient queryServiceClient = QueryServiceClient.create(queryServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryServiceClient.QueryTimeSeriesFixedSizeCollection`
`static class`	`QueryServiceClient.QueryTimeSeriesPage`
`static class`	`QueryServiceClient.QueryTimeSeriesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QueryServiceClient(QueryServiceSettings settings)` Constructs an instance of QueryServiceClient, using the given settings.
`protected`	`QueryServiceClient(QueryServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static QueryServiceClient`	`create()` Constructs an instance of QueryServiceClient with default settings.
`static QueryServiceClient`	`create(QueryServiceSettings settings)` Constructs an instance of QueryServiceClient, using the given settings.
`static QueryServiceClient`	`create(QueryServiceStub stub)` Constructs an instance of QueryServiceClient, using the given stub for making calls.
`QueryServiceSettings`	`getSettings()`
`QueryServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`QueryServiceClient.QueryTimeSeriesPagedResponse`	`queryTimeSeries(QueryTimeSeriesRequest request)` Deprecated. This method is deprecated and will be removed in the next major version update.
`com.google.api.gax.rpc.UnaryCallable<QueryTimeSeriesRequest,QueryTimeSeriesResponse>`	`queryTimeSeriesCallable()` Deprecated. This method is deprecated and will be removed in the next major version update.
`com.google.api.gax.rpc.UnaryCallable<QueryTimeSeriesRequest,QueryServiceClient.QueryTimeSeriesPagedResponse>`	`queryTimeSeriesPagedCallable()` Deprecated. This method is deprecated and will be removed in the next major version update.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- QueryServiceClient
```
protected QueryServiceClient(QueryServiceSettings settings)
                      throws IOException
```
  Constructs an instance of QueryServiceClient, 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.
  
  Throws:
  
  IOException
- QueryServiceClient
```
protected QueryServiceClient(QueryServiceStub stub)
```

Method Detail

create

public static final QueryServiceClient create()
                                       throws IOException

Constructs an instance of QueryServiceClient with default settings.

Throws:: IOException

create
```
public static final QueryServiceClient create(QueryServiceSettings settings)
                                       throws IOException
```
Constructs an instance of QueryServiceClient, 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

create
```
public static final QueryServiceClient create(QueryServiceStub stub)
```
Constructs an instance of QueryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(QueryServiceSettings).

getSettings

public final QueryServiceSettings getSettings()

getStub
```
public QueryServiceStub getStub()
```

queryTimeSeries

@Deprecated
public final QueryServiceClient.QueryTimeSeriesPagedResponse queryTimeSeries(QueryTimeSeriesRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the [MQL deprecation notice](https://cloud.google.com/stackdriver/docs/deprecations/mql).

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 (QueryServiceClient queryServiceClient = QueryServiceClient.create()) {
   QueryTimeSeriesRequest request =
       QueryTimeSeriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TimeSeriesData element : queryServiceClient.queryTimeSeries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

queryTimeSeriesPagedCallable

@Deprecated
public final com.google.api.gax.rpc.UnaryCallable<QueryTimeSeriesRequest,QueryServiceClient.QueryTimeSeriesPagedResponse> queryTimeSeriesPagedCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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 (QueryServiceClient queryServiceClient = QueryServiceClient.create()) {
   QueryTimeSeriesRequest request =
       QueryTimeSeriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TimeSeriesData> future =
       queryServiceClient.queryTimeSeriesPagedCallable().futureCall(request);
   // Do something.
   for (TimeSeriesData element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

queryTimeSeriesCallable

@Deprecated
public final com.google.api.gax.rpc.UnaryCallable<QueryTimeSeriesRequest,QueryTimeSeriesResponse> queryTimeSeriesCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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 (QueryServiceClient queryServiceClient = QueryServiceClient.create()) {
   QueryTimeSeriesRequest request =
       QueryTimeSeriesRequest.newBuilder()
           .setName("name3373707")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     QueryTimeSeriesResponse response =
         queryServiceClient.queryTimeSeriesCallable().call(request);
     for (TimeSeriesData element : response.getTimeSeriesDataList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class QueryServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryServiceClient

QueryServiceClient

Method Detail

create

create

create

getSettings

getStub

queryTimeSeries

queryTimeSeriesPagedCallable

queryTimeSeriesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination