| GitHub Repository | Product Reference |
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().
| Method | Description | Method Variants |
|---|---|---|
QueryTimeSeries |
Queries time series using Monitoring Query Language. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable 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 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.
Static Methods
create()
public static final QueryServiceClient create()Constructs an instance of QueryServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
QueryServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(QueryServiceSettings settings)
public static final QueryServiceClient create(QueryServiceSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
QueryServiceSettings |
| Returns | |
|---|---|
| Type | Description |
QueryServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(QueryServiceStub stub)
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).
| Parameter | |
|---|---|
| Name | Description |
stub |
QueryServiceStub |
| Returns | |
|---|---|
| Type | Description |
QueryServiceClient |
|
Constructors
QueryServiceClient(QueryServiceSettings settings)
protected QueryServiceClient(QueryServiceSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
QueryServiceSettings |
QueryServiceClient(QueryServiceStub stub)
protected QueryServiceClient(QueryServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
QueryServiceStub |
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()getSettings()
public final QueryServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
QueryServiceSettings |
|
getStub()
public QueryServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
QueryServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
queryTimeSeries(QueryTimeSeriesRequest request)
public final QueryServiceClient.QueryTimeSeriesPagedResponse queryTimeSeries(QueryTimeSeriesRequest request)Queries time series using Monitoring Query Language.
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);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
QueryTimeSeriesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
QueryServiceClient.QueryTimeSeriesPagedResponse |
|
queryTimeSeriesCallable()
public final UnaryCallable<QueryTimeSeriesRequest,QueryTimeSeriesResponse> queryTimeSeriesCallable()Queries time series using Monitoring Query Language.
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;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<QueryTimeSeriesRequest,QueryTimeSeriesResponse> |
|
queryTimeSeriesPagedCallable()
public final UnaryCallable<QueryTimeSeriesRequest,QueryServiceClient.QueryTimeSeriesPagedResponse> queryTimeSeriesPagedCallable()Queries time series using Monitoring Query Language.
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);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<QueryTimeSeriesRequest,QueryTimeSeriesPagedResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()