com.google.cloud.monitoring.v3

Class MetricServiceClient

java.lang.Object

com.google.cloud.monitoring.v3.MetricServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Manages metric descriptors, monitored resource descriptors, and time series data.

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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MonitoredResourceDescriptorName name = MonitoredResourceDescriptorName.of("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
   MonitoredResourceDescriptor response = metricServiceClient.getMonitoredResourceDescriptor(name);
 }
 
 

Note: close() needs to be called on the metricServiceClient 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 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 MetricServiceSettings to create(). For example:

To customize credentials:

 
 MetricServiceSettings metricServiceSettings =
     MetricServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MetricServiceClient metricServiceClient =
     MetricServiceClient.create(metricServiceSettings);
 
 

To customize the endpoint:

 
 MetricServiceSettings metricServiceSettings =
     MetricServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MetricServiceClient metricServiceClient =
     MetricServiceClient.create(metricServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricServiceClient.ListMetricDescriptorsFixedSizeCollection
static class	MetricServiceClient.ListMetricDescriptorsPage
static class	MetricServiceClient.ListMetricDescriptorsPagedResponse
static class	MetricServiceClient.ListMonitoredResourceDescriptorsFixedSizeCollection
static class	MetricServiceClient.ListMonitoredResourceDescriptorsPage
static class	MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse
static class	MetricServiceClient.ListTimeSeriesFixedSizeCollection
static class	MetricServiceClient.ListTimeSeriesPage
static class	MetricServiceClient.ListTimeSeriesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetricServiceClient(MetricServiceSettings settings) Constructs an instance of MetricServiceClient, using the given settings.
protected	MetricServiceClient(MetricServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static MetricServiceClient	create() Constructs an instance of MetricServiceClient with default settings.
static MetricServiceClient	create(MetricServiceSettings settings) Constructs an instance of MetricServiceClient, using the given settings.
static MetricServiceClient	create(MetricServiceStub stub) Constructs an instance of MetricServiceClient, using the given stub for making calls.
com.google.api.MetricDescriptor	createMetricDescriptor(CreateMetricDescriptorRequest request) Creates a new metric descriptor.
com.google.api.MetricDescriptor	createMetricDescriptor(ProjectName name, com.google.api.MetricDescriptor metricDescriptor) Creates a new metric descriptor.
com.google.api.MetricDescriptor	createMetricDescriptor(String name, com.google.api.MetricDescriptor metricDescriptor) Creates a new metric descriptor.
com.google.api.gax.rpc.UnaryCallable<CreateMetricDescriptorRequest,com.google.api.MetricDescriptor>	createMetricDescriptorCallable() Creates a new metric descriptor.
void	createTimeSeries(CreateTimeSeriesRequest request) Creates or adds data to one or more time series.
void	createTimeSeries(ProjectName name, List<TimeSeries> timeSeries) Creates or adds data to one or more time series.
void	createTimeSeries(String name, List<TimeSeries> timeSeries) Creates or adds data to one or more time series.
com.google.api.gax.rpc.UnaryCallable<CreateTimeSeriesRequest,Empty>	createTimeSeriesCallable() Creates or adds data to one or more time series.
void	deleteMetricDescriptor(DeleteMetricDescriptorRequest request) Deletes a metric descriptor.
void	deleteMetricDescriptor(MetricDescriptorName name) Deletes a metric descriptor.
void	deleteMetricDescriptor(String name) Deletes a metric descriptor.
com.google.api.gax.rpc.UnaryCallable<DeleteMetricDescriptorRequest,Empty>	deleteMetricDescriptorCallable() Deletes a metric descriptor.
com.google.api.MetricDescriptor	getMetricDescriptor(GetMetricDescriptorRequest request) Gets a single metric descriptor.
com.google.api.MetricDescriptor	getMetricDescriptor(MetricDescriptorName name) Gets a single metric descriptor.
com.google.api.MetricDescriptor	getMetricDescriptor(String name) Gets a single metric descriptor.
com.google.api.gax.rpc.UnaryCallable<GetMetricDescriptorRequest,com.google.api.MetricDescriptor>	getMetricDescriptorCallable() Gets a single metric descriptor.
com.google.api.MonitoredResourceDescriptor	getMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest request) Gets a single monitored resource descriptor.
com.google.api.MonitoredResourceDescriptor	getMonitoredResourceDescriptor(MonitoredResourceDescriptorName name) Gets a single monitored resource descriptor.
com.google.api.MonitoredResourceDescriptor	getMonitoredResourceDescriptor(String name) Gets a single monitored resource descriptor.
com.google.api.gax.rpc.UnaryCallable<GetMonitoredResourceDescriptorRequest,com.google.api.MonitoredResourceDescriptor>	getMonitoredResourceDescriptorCallable() Gets a single monitored resource descriptor.
MetricServiceSettings	getSettings()
MetricServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MetricServiceClient.ListMetricDescriptorsPagedResponse	listMetricDescriptors(ListMetricDescriptorsRequest request) Lists metric descriptors that match a filter.
MetricServiceClient.ListMetricDescriptorsPagedResponse	listMetricDescriptors(ProjectName name) Lists metric descriptors that match a filter.
MetricServiceClient.ListMetricDescriptorsPagedResponse	listMetricDescriptors(String name) Lists metric descriptors that match a filter.
com.google.api.gax.rpc.UnaryCallable<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse>	listMetricDescriptorsCallable() Lists metric descriptors that match a filter.
com.google.api.gax.rpc.UnaryCallable<ListMetricDescriptorsRequest,MetricServiceClient.ListMetricDescriptorsPagedResponse>	listMetricDescriptorsPagedCallable() Lists metric descriptors that match a filter.
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse	listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request) Lists monitored resource descriptors that match a filter.
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse	listMonitoredResourceDescriptors(ProjectName name) Lists monitored resource descriptors that match a filter.
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse	listMonitoredResourceDescriptors(String name) Lists monitored resource descriptors that match a filter.
com.google.api.gax.rpc.UnaryCallable<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse>	listMonitoredResourceDescriptorsCallable() Lists monitored resource descriptors that match a filter.
com.google.api.gax.rpc.UnaryCallable<ListMonitoredResourceDescriptorsRequest,MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse>	listMonitoredResourceDescriptorsPagedCallable() Lists monitored resource descriptors that match a filter.
MetricServiceClient.ListTimeSeriesPagedResponse	listTimeSeries(ListTimeSeriesRequest request) Lists time series that match a filter.
MetricServiceClient.ListTimeSeriesPagedResponse	listTimeSeries(ProjectName name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view) Lists time series that match a filter.
MetricServiceClient.ListTimeSeriesPagedResponse	listTimeSeries(String name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view) Lists time series that match a filter.
com.google.api.gax.rpc.UnaryCallable<ListTimeSeriesRequest,ListTimeSeriesResponse>	listTimeSeriesCallable() Lists time series that match a filter.
com.google.api.gax.rpc.UnaryCallable<ListTimeSeriesRequest,MetricServiceClient.ListTimeSeriesPagedResponse>	listTimeSeriesPagedCallable() Lists time series that match a filter.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricServiceClient

protected MetricServiceClient(MetricServiceSettings settings)
                       throws IOException

Constructs an instance of MetricServiceClient, 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

MetricServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected MetricServiceClient(MetricServiceStub stub)

Method Detail

create

public static final MetricServiceClient create()
                                        throws IOException

Constructs an instance of MetricServiceClient with default settings.

Throws:

IOException

create

public static final MetricServiceClient create(MetricServiceSettings settings)
                                        throws IOException

Constructs an instance of MetricServiceClient, 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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final MetricServiceClient create(MetricServiceStub stub)

Constructs an instance of MetricServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use MetricServiceSettings}.

getSettings

public final MetricServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public MetricServiceStub getStub()

listMonitoredResourceDescriptors

public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(ProjectName name)

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (MonitoredResourceDescriptor element : metricServiceClient.listMonitoredResourceDescriptors(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

Throws:

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

listMonitoredResourceDescriptors

public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(String name)

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (MonitoredResourceDescriptor element : metricServiceClient.listMonitoredResourceDescriptors(name.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

Throws:

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

listMonitoredResourceDescriptors

public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request)

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (MonitoredResourceDescriptor element : metricServiceClient.listMonitoredResourceDescriptors(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

listMonitoredResourceDescriptorsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListMonitoredResourceDescriptorsRequest,MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse> listMonitoredResourceDescriptorsPagedCallable()

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListMonitoredResourceDescriptorsPagedResponse> future = metricServiceClient.listMonitoredResourceDescriptorsPagedCallable().futureCall(request);
   // Do something
   for (MonitoredResourceDescriptor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listMonitoredResourceDescriptorsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse> listMonitoredResourceDescriptorsCallable()

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListMonitoredResourceDescriptorsResponse response = metricServiceClient.listMonitoredResourceDescriptorsCallable().call(request);
     for (MonitoredResourceDescriptor element : response.getResourceDescriptorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getMonitoredResourceDescriptor

public final com.google.api.MonitoredResourceDescriptor getMonitoredResourceDescriptor(MonitoredResourceDescriptorName name)

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MonitoredResourceDescriptorName name = MonitoredResourceDescriptorName.of("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
   MonitoredResourceDescriptor response = metricServiceClient.getMonitoredResourceDescriptor(name);
 }
 

Parameters:

name - The monitored resource descriptor to get. The format is `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`. The `{resource_type}` is a predefined type, such as `cloudsql_database`.

Throws:

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

getMonitoredResourceDescriptor

public final com.google.api.MonitoredResourceDescriptor getMonitoredResourceDescriptor(String name)

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MonitoredResourceDescriptorName name = MonitoredResourceDescriptorName.of("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
   MonitoredResourceDescriptor response = metricServiceClient.getMonitoredResourceDescriptor(name.toString());
 }
 

Parameters:

name - The monitored resource descriptor to get. The format is `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`. The `{resource_type}` is a predefined type, such as `cloudsql_database`.

Throws:

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

getMonitoredResourceDescriptor

public final com.google.api.MonitoredResourceDescriptor getMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest request)

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MonitoredResourceDescriptorName name = MonitoredResourceDescriptorName.of("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
   GetMonitoredResourceDescriptorRequest request = GetMonitoredResourceDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   MonitoredResourceDescriptor response = metricServiceClient.getMonitoredResourceDescriptor(request);
 }
 

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

getMonitoredResourceDescriptorCallable

public final com.google.api.gax.rpc.UnaryCallable<GetMonitoredResourceDescriptorRequest,com.google.api.MonitoredResourceDescriptor> getMonitoredResourceDescriptorCallable()

Gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MonitoredResourceDescriptorName name = MonitoredResourceDescriptorName.of("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
   GetMonitoredResourceDescriptorRequest request = GetMonitoredResourceDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<MonitoredResourceDescriptor> future = metricServiceClient.getMonitoredResourceDescriptorCallable().futureCall(request);
   // Do something
   MonitoredResourceDescriptor response = future.get();
 }
 

listMetricDescriptors

public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(ProjectName name)

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (MetricDescriptor element : metricServiceClient.listMetricDescriptors(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

Throws:

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

listMetricDescriptors

public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(String name)

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (MetricDescriptor element : metricServiceClient.listMetricDescriptors(name.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

Throws:

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

listMetricDescriptors

public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(ListMetricDescriptorsRequest request)

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListMetricDescriptorsRequest request = ListMetricDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (MetricDescriptor element : metricServiceClient.listMetricDescriptors(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

listMetricDescriptorsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListMetricDescriptorsRequest,MetricServiceClient.ListMetricDescriptorsPagedResponse> listMetricDescriptorsPagedCallable()

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListMetricDescriptorsRequest request = ListMetricDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListMetricDescriptorsPagedResponse> future = metricServiceClient.listMetricDescriptorsPagedCallable().futureCall(request);
   // Do something
   for (MetricDescriptor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listMetricDescriptorsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse> listMetricDescriptorsCallable()

Lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   ListMetricDescriptorsRequest request = ListMetricDescriptorsRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListMetricDescriptorsResponse response = metricServiceClient.listMetricDescriptorsCallable().call(request);
     for (MetricDescriptor element : response.getMetricDescriptorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getMetricDescriptor

public final com.google.api.MetricDescriptor getMetricDescriptor(MetricDescriptorName name)

Gets a single metric descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   MetricDescriptor response = metricServiceClient.getMetricDescriptor(name);
 }
 

Parameters:

name - The metric descriptor on which to execute the request. The format is `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example value of `{metric_id}` is `"compute.googleapis.com/instance/disk/read_bytes_count"`.

Throws:

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

getMetricDescriptor

public final com.google.api.MetricDescriptor getMetricDescriptor(String name)

Gets a single metric descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   MetricDescriptor response = metricServiceClient.getMetricDescriptor(name.toString());
 }
 

Parameters:

name - The metric descriptor on which to execute the request. The format is `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example value of `{metric_id}` is `"compute.googleapis.com/instance/disk/read_bytes_count"`.

Throws:

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

getMetricDescriptor

public final com.google.api.MetricDescriptor getMetricDescriptor(GetMetricDescriptorRequest request)

Gets a single metric descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   GetMetricDescriptorRequest request = GetMetricDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   MetricDescriptor response = metricServiceClient.getMetricDescriptor(request);
 }
 

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

getMetricDescriptorCallable

public final com.google.api.gax.rpc.UnaryCallable<GetMetricDescriptorRequest,com.google.api.MetricDescriptor> getMetricDescriptorCallable()

Gets a single metric descriptor. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   GetMetricDescriptorRequest request = GetMetricDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<MetricDescriptor> future = metricServiceClient.getMetricDescriptorCallable().futureCall(request);
   // Do something
   MetricDescriptor response = future.get();
 }
 

createMetricDescriptor

public final com.google.api.MetricDescriptor createMetricDescriptor(ProjectName name,
                                                                    com.google.api.MetricDescriptor metricDescriptor)

Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
   MetricDescriptor response = metricServiceClient.createMetricDescriptor(name, metricDescriptor);
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

metricDescriptor - The new [custom metric](/monitoring/custom-metrics) descriptor.

Throws:

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

createMetricDescriptor

public final com.google.api.MetricDescriptor createMetricDescriptor(String name,
                                                                    com.google.api.MetricDescriptor metricDescriptor)

Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
   MetricDescriptor response = metricServiceClient.createMetricDescriptor(name.toString(), metricDescriptor);
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

metricDescriptor - The new [custom metric](/monitoring/custom-metrics) descriptor.

Throws:

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

createMetricDescriptor

public final com.google.api.MetricDescriptor createMetricDescriptor(CreateMetricDescriptorRequest request)

Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
   CreateMetricDescriptorRequest request = CreateMetricDescriptorRequest.newBuilder()
     .setName(name.toString())
     .setMetricDescriptor(metricDescriptor)
     .build();
   MetricDescriptor response = metricServiceClient.createMetricDescriptor(request);
 }
 

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

createMetricDescriptorCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateMetricDescriptorRequest,com.google.api.MetricDescriptor> createMetricDescriptorCallable()

Creates a new metric descriptor. User-created metric descriptors define [custom metrics](/monitoring/custom-metrics).

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
   CreateMetricDescriptorRequest request = CreateMetricDescriptorRequest.newBuilder()
     .setName(name.toString())
     .setMetricDescriptor(metricDescriptor)
     .build();
   ApiFuture<MetricDescriptor> future = metricServiceClient.createMetricDescriptorCallable().futureCall(request);
   // Do something
   MetricDescriptor response = future.get();
 }
 

deleteMetricDescriptor

public final void deleteMetricDescriptor(MetricDescriptorName name)

Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   metricServiceClient.deleteMetricDescriptor(name);
 }
 

Parameters:

name - The metric descriptor on which to execute the request. The format is `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example of `{metric_id}` is: `"custom.googleapis.com/my_test_metric"`.

Throws:

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

deleteMetricDescriptor

public final void deleteMetricDescriptor(String name)

Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   metricServiceClient.deleteMetricDescriptor(name.toString());
 }
 

Parameters:

name - The metric descriptor on which to execute the request. The format is `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`. An example of `{metric_id}` is: `"custom.googleapis.com/my_test_metric"`.

Throws:

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

deleteMetricDescriptor

public final void deleteMetricDescriptor(DeleteMetricDescriptorRequest request)

Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   DeleteMetricDescriptorRequest request = DeleteMetricDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   metricServiceClient.deleteMetricDescriptor(request);
 }
 

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

deleteMetricDescriptorCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteMetricDescriptorRequest,Empty> deleteMetricDescriptorCallable()

Deletes a metric descriptor. Only user-created [custom metrics](/monitoring/custom-metrics) can be deleted.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   MetricDescriptorName name = MetricDescriptorName.of("[PROJECT]", "[METRIC_DESCRIPTOR]");
   DeleteMetricDescriptorRequest request = DeleteMetricDescriptorRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = metricServiceClient.deleteMetricDescriptorCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listTimeSeries

public final MetricServiceClient.ListTimeSeriesPagedResponse listTimeSeries(ProjectName name,
                                                                            String filter,
                                                                            TimeInterval interval,
                                                                            ListTimeSeriesRequest.TimeSeriesView view)

Lists time series that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   String filter = "";
   TimeInterval interval = TimeInterval.newBuilder().build();
   ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.FULL;
   for (TimeSeries element : metricServiceClient.listTimeSeries(name, filter, interval, view).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is "projects/{project_id_or_number}".

filter - A [monitoring filter](/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"

interval - The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

view - Specifies which information is returned about the time series.

Throws:

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

listTimeSeries

public final MetricServiceClient.ListTimeSeriesPagedResponse listTimeSeries(String name,
                                                                            String filter,
                                                                            TimeInterval interval,
                                                                            ListTimeSeriesRequest.TimeSeriesView view)

Lists time series that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   String filter = "";
   TimeInterval interval = TimeInterval.newBuilder().build();
   ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.FULL;
   for (TimeSeries element : metricServiceClient.listTimeSeries(name.toString(), filter, interval, view).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The project on which to execute the request. The format is "projects/{project_id_or_number}".

filter - A [monitoring filter](/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"

interval - The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

view - Specifies which information is returned about the time series.

Throws:

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

listTimeSeries

public final MetricServiceClient.ListTimeSeriesPagedResponse listTimeSeries(ListTimeSeriesRequest request)

Lists time series that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   String filter = "";
   TimeInterval interval = TimeInterval.newBuilder().build();
   ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.FULL;
   ListTimeSeriesRequest request = ListTimeSeriesRequest.newBuilder()
     .setName(name.toString())
     .setFilter(filter)
     .setInterval(interval)
     .setView(view)
     .build();
   for (TimeSeries element : metricServiceClient.listTimeSeries(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

listTimeSeriesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTimeSeriesRequest,MetricServiceClient.ListTimeSeriesPagedResponse> listTimeSeriesPagedCallable()

Lists time series that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   String filter = "";
   TimeInterval interval = TimeInterval.newBuilder().build();
   ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.FULL;
   ListTimeSeriesRequest request = ListTimeSeriesRequest.newBuilder()
     .setName(name.toString())
     .setFilter(filter)
     .setInterval(interval)
     .setView(view)
     .build();
   ApiFuture<ListTimeSeriesPagedResponse> future = metricServiceClient.listTimeSeriesPagedCallable().futureCall(request);
   // Do something
   for (TimeSeries element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTimeSeriesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTimeSeriesRequest,ListTimeSeriesResponse> listTimeSeriesCallable()

Lists time series that match a filter. This method does not require a Stackdriver account.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   String filter = "";
   TimeInterval interval = TimeInterval.newBuilder().build();
   ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.FULL;
   ListTimeSeriesRequest request = ListTimeSeriesRequest.newBuilder()
     .setName(name.toString())
     .setFilter(filter)
     .setInterval(interval)
     .setView(view)
     .build();
   while (true) {
     ListTimeSeriesResponse response = metricServiceClient.listTimeSeriesCallable().call(request);
     for (TimeSeries element : response.getTimeSeriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

createTimeSeries

public final void createTimeSeries(ProjectName name,
                                   List<TimeSeries> timeSeries)

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   List<TimeSeries> timeSeries = new ArrayList<>();
   metricServiceClient.createTimeSeries(name, timeSeries);
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

timeSeries - The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each `TimeSeries` value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

The maximum number of `TimeSeries` objects per `Create` request is 200.

Throws:

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

createTimeSeries

public final void createTimeSeries(String name,
                                   List<TimeSeries> timeSeries)

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   List<TimeSeries> timeSeries = new ArrayList<>();
   metricServiceClient.createTimeSeries(name.toString(), timeSeries);
 }
 

Parameters:

name - The project on which to execute the request. The format is `"projects/{project_id_or_number}"`.

timeSeries - The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each `TimeSeries` value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

The maximum number of `TimeSeries` objects per `Create` request is 200.

Throws:

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

createTimeSeries

public final void createTimeSeries(CreateTimeSeriesRequest request)

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   List<TimeSeries> timeSeries = new ArrayList<>();
   CreateTimeSeriesRequest request = CreateTimeSeriesRequest.newBuilder()
     .setName(name.toString())
     .addAllTimeSeries(timeSeries)
     .build();
   metricServiceClient.createTimeSeries(request);
 }
 

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

createTimeSeriesCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTimeSeriesRequest,Empty> createTimeSeriesCallable()

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Sample code:

 try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   List<TimeSeries> timeSeries = new ArrayList<>();
   CreateTimeSeriesRequest request = CreateTimeSeriesRequest.newBuilder()
     .setName(name.toString())
     .addAllTimeSeries(timeSeries)
     .build();
   ApiFuture<Void> future = metricServiceClient.createTimeSeriesCallable().futureCall(request);
   // Do something
   future.get();
 }
 

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