- 3.49.0 (latest)
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public class MetricServiceClient implements 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:
// 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
MonitoredResourceDescriptorName name =
MonitoredResourceDescriptorName.ofProjectMonitoredResourceDescriptorName(
"[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:
- 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.
- 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.
- 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:
// 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
MetricServiceSettings metricServiceSettings =
MetricServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
MetricServiceClient metricServiceClient = MetricServiceClient.create(metricServiceSettings);
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
MetricServiceSettings metricServiceSettings =
MetricServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
MetricServiceClient metricServiceClient = MetricServiceClient.create(metricServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final MetricServiceClient create()
Constructs an instance of MetricServiceClient with default settings.
Type | Description |
MetricServiceClient |
Type | Description |
IOException |
create(MetricServiceSettings settings)
public static final MetricServiceClient create(MetricServiceSettings settings)
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.
Name | Description |
settings | MetricServiceSettings |
Type | Description |
MetricServiceClient |
Type | Description |
IOException |
create(MetricServiceStub stub)
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 using create(MetricServiceSettings).
Name | Description |
stub | MetricServiceStub |
Type | Description |
MetricServiceClient |
Constructors
MetricServiceClient(MetricServiceSettings settings)
protected MetricServiceClient(MetricServiceSettings settings)
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.
Name | Description |
settings | MetricServiceSettings |
MetricServiceClient(MetricServiceStub stub)
protected MetricServiceClient(MetricServiceStub stub)
Name | Description |
stub | MetricServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createMetricDescriptor(ResourceName name, MetricDescriptor metricDescriptor)
public final MetricDescriptor createMetricDescriptor(ResourceName name, MetricDescriptor metricDescriptor)
Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ResourceName name = ResourceName.of("[FOLDER]");
MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
MetricDescriptor response =
metricServiceClient.createMetricDescriptor(name, metricDescriptor);
}
Name | Description |
name | com.google.api.resourcenames.ResourceName Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER] |
metricDescriptor | com.google.api.MetricDescriptor Required. The new custom metric descriptor. |
Type | Description |
com.google.api.MetricDescriptor |
createMetricDescriptor(CreateMetricDescriptorRequest request)
public final MetricDescriptor createMetricDescriptor(CreateMetricDescriptorRequest request)
Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
CreateMetricDescriptorRequest request =
CreateMetricDescriptorRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setMetricDescriptor(MetricDescriptor.newBuilder().build())
.build();
MetricDescriptor response = metricServiceClient.createMetricDescriptor(request);
}
Name | Description |
request | CreateMetricDescriptorRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.api.MetricDescriptor |
createMetricDescriptor(OrganizationName name, MetricDescriptor metricDescriptor)
public final MetricDescriptor createMetricDescriptor(OrganizationName name, MetricDescriptor metricDescriptor)
Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
OrganizationName name = OrganizationName.of("[ORGANIZATION]");
MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
MetricDescriptor response =
metricServiceClient.createMetricDescriptor(name, metricDescriptor);
}
Name | Description |
name | OrganizationName Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER] |
metricDescriptor | com.google.api.MetricDescriptor Required. The new custom metric descriptor. |
Type | Description |
com.google.api.MetricDescriptor |
createMetricDescriptor(ProjectName name, MetricDescriptor metricDescriptor)
public final MetricDescriptor createMetricDescriptor(ProjectName name, MetricDescriptor metricDescriptor)
Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
MetricDescriptor response =
metricServiceClient.createMetricDescriptor(name, metricDescriptor);
}
Name | Description |
name | ProjectName Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER] |
metricDescriptor | com.google.api.MetricDescriptor Required. The new custom metric descriptor. |
Type | Description |
com.google.api.MetricDescriptor |
createMetricDescriptor(String name, MetricDescriptor metricDescriptor)
public final MetricDescriptor createMetricDescriptor(String name, MetricDescriptor metricDescriptor)
Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name = ProjectName.of("[PROJECT]").toString();
MetricDescriptor metricDescriptor = MetricDescriptor.newBuilder().build();
MetricDescriptor response =
metricServiceClient.createMetricDescriptor(name, metricDescriptor);
}
Name | Description |
name | String Required. The project on which to execute the request. The format is: 4 projects/[PROJECT_ID_OR_NUMBER] |
metricDescriptor | com.google.api.MetricDescriptor Required. The new custom metric descriptor. |
Type | Description |
com.google.api.MetricDescriptor |
createMetricDescriptorCallable()
public final UnaryCallable<CreateMetricDescriptorRequest,MetricDescriptor> createMetricDescriptorCallable()
Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
CreateMetricDescriptorRequest request =
CreateMetricDescriptorRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setMetricDescriptor(MetricDescriptor.newBuilder().build())
.build();
ApiFuture<MetricDescriptor> future =
metricServiceClient.createMetricDescriptorCallable().futureCall(request);
// Do something.
MetricDescriptor response = future.get();
}
Type | Description |
UnaryCallable<CreateMetricDescriptorRequest,com.google.api.MetricDescriptor> |
createServiceTimeSeries(CreateTimeSeriesRequest request)
public final void createServiceTimeSeries(CreateTimeSeriesRequest request)
Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. 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. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
CreateTimeSeriesRequest request =
CreateTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.addAllTimeSeries(new ArrayList<TimeSeries>())
.build();
metricServiceClient.createServiceTimeSeries(request);
}
Name | Description |
request | CreateTimeSeriesRequest The request object containing all of the parameters for the API call. |
createServiceTimeSeries(ProjectName name, List<TimeSeries> timeSeries)
public final void createServiceTimeSeries(ProjectName name, List<TimeSeries> timeSeries)
Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. 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. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
List<TimeSeries> timeSeries = new ArrayList<>();
metricServiceClient.createServiceTimeSeries(name, timeSeries);
}
Name | Description |
name | ProjectName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
timeSeries | List<TimeSeries> Required. 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 The maximum number of |
createServiceTimeSeries(String name, List<TimeSeries> timeSeries)
public final void createServiceTimeSeries(String name, List<TimeSeries> timeSeries)
Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. 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. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name = ProjectName.of("[PROJECT]").toString();
List<TimeSeries> timeSeries = new ArrayList<>();
metricServiceClient.createServiceTimeSeries(name, timeSeries);
}
Name | Description |
name | String Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
timeSeries | List<TimeSeries> Required. 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 The maximum number of |
createServiceTimeSeriesCallable()
public final UnaryCallable<CreateTimeSeriesRequest,Empty> createServiceTimeSeriesCallable()
Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. 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. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
CreateTimeSeriesRequest request =
CreateTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.addAllTimeSeries(new ArrayList<TimeSeries>())
.build();
ApiFuture<Empty> future =
metricServiceClient.createServiceTimeSeriesCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<CreateTimeSeriesRequest,Empty> |
createTimeSeries(CreateTimeSeriesRequest request)
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:
// 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
CreateTimeSeriesRequest request =
CreateTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.addAllTimeSeries(new ArrayList<TimeSeries>())
.build();
metricServiceClient.createTimeSeries(request);
}
Name | Description |
request | CreateTimeSeriesRequest The request object containing all of the parameters for the API call. |
createTimeSeries(ProjectName name, List<TimeSeries> timeSeries)
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:
// 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
List<TimeSeries> timeSeries = new ArrayList<>();
metricServiceClient.createTimeSeries(name, timeSeries);
}
Name | Description |
name | ProjectName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
timeSeries | List<TimeSeries> Required. 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 The maximum number of |
createTimeSeries(String name, List<TimeSeries> timeSeries)
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:
// 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name = ProjectName.of("[PROJECT]").toString();
List<TimeSeries> timeSeries = new ArrayList<>();
metricServiceClient.createTimeSeries(name, timeSeries);
}
Name | Description |
name | String Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
timeSeries | List<TimeSeries> Required. 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 The maximum number of |
createTimeSeriesCallable()
public final 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:
// 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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
CreateTimeSeriesRequest request =
CreateTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.addAllTimeSeries(new ArrayList<TimeSeries>())
.build();
ApiFuture<Empty> future = metricServiceClient.createTimeSeriesCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<CreateTimeSeriesRequest,Empty> |
deleteMetricDescriptor(DeleteMetricDescriptorRequest request)
public final void deleteMetricDescriptor(DeleteMetricDescriptorRequest request)
Deletes a metric descriptor. Only user-created custom metrics can be deleted.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
DeleteMetricDescriptorRequest request =
DeleteMetricDescriptorRequest.newBuilder()
.setName(
MetricDescriptorName.ofProjectMetricDescriptorName(
"[PROJECT]", "[METRIC_DESCRIPTOR]")
.toString())
.build();
metricServiceClient.deleteMetricDescriptor(request);
}
Name | Description |
request | DeleteMetricDescriptorRequest The request object containing all of the parameters for the API call. |
deleteMetricDescriptor(MetricDescriptorName name)
public final void deleteMetricDescriptor(MetricDescriptorName name)
Deletes a metric descriptor. Only user-created custom metrics can be deleted.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
MetricDescriptorName name =
MetricDescriptorName.ofProjectMetricDescriptorName("[PROJECT]", "[METRIC_DESCRIPTOR]");
metricServiceClient.deleteMetricDescriptor(name);
}
Name | Description |
name | MetricDescriptorName Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of |
deleteMetricDescriptor(String name)
public final void deleteMetricDescriptor(String name)
Deletes a metric descriptor. Only user-created custom metrics can be deleted.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name =
MetricDescriptorName.ofProjectMetricDescriptorName("[PROJECT]", "[METRIC_DESCRIPTOR]")
.toString();
metricServiceClient.deleteMetricDescriptor(name);
}
Name | Description |
name | String Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of |
deleteMetricDescriptorCallable()
public final UnaryCallable<DeleteMetricDescriptorRequest,Empty> deleteMetricDescriptorCallable()
Deletes a metric descriptor. Only user-created custom metrics can be deleted.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
DeleteMetricDescriptorRequest request =
DeleteMetricDescriptorRequest.newBuilder()
.setName(
MetricDescriptorName.ofProjectMetricDescriptorName(
"[PROJECT]", "[METRIC_DESCRIPTOR]")
.toString())
.build();
ApiFuture<Empty> future =
metricServiceClient.deleteMetricDescriptorCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteMetricDescriptorRequest,Empty> |
getMetricDescriptor(GetMetricDescriptorRequest request)
public final MetricDescriptor getMetricDescriptor(GetMetricDescriptorRequest request)
Gets a single metric descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
GetMetricDescriptorRequest request =
GetMetricDescriptorRequest.newBuilder()
.setName(
MetricDescriptorName.ofProjectMetricDescriptorName(
"[PROJECT]", "[METRIC_DESCRIPTOR]")
.toString())
.build();
MetricDescriptor response = metricServiceClient.getMetricDescriptor(request);
}
Name | Description |
request | GetMetricDescriptorRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.api.MetricDescriptor |
getMetricDescriptor(MetricDescriptorName name)
public final MetricDescriptor getMetricDescriptor(MetricDescriptorName name)
Gets a single metric descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
MetricDescriptorName name =
MetricDescriptorName.ofProjectMetricDescriptorName("[PROJECT]", "[METRIC_DESCRIPTOR]");
MetricDescriptor response = metricServiceClient.getMetricDescriptor(name);
}
Name | Description |
name | MetricDescriptorName Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of |
Type | Description |
com.google.api.MetricDescriptor |
getMetricDescriptor(String name)
public final MetricDescriptor getMetricDescriptor(String name)
Gets a single metric descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name =
MetricDescriptorName.ofProjectMetricDescriptorName("[PROJECT]", "[METRIC_DESCRIPTOR]")
.toString();
MetricDescriptor response = metricServiceClient.getMetricDescriptor(name);
}
Name | Description |
name | String Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of |
Type | Description |
com.google.api.MetricDescriptor |
getMetricDescriptorCallable()
public final UnaryCallable<GetMetricDescriptorRequest,MetricDescriptor> getMetricDescriptorCallable()
Gets a single metric descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
GetMetricDescriptorRequest request =
GetMetricDescriptorRequest.newBuilder()
.setName(
MetricDescriptorName.ofProjectMetricDescriptorName(
"[PROJECT]", "[METRIC_DESCRIPTOR]")
.toString())
.build();
ApiFuture<MetricDescriptor> future =
metricServiceClient.getMetricDescriptorCallable().futureCall(request);
// Do something.
MetricDescriptor response = future.get();
}
Type | Description |
UnaryCallable<GetMetricDescriptorRequest,com.google.api.MetricDescriptor> |
getMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest request)
public final MonitoredResourceDescriptor getMonitoredResourceDescriptor(GetMonitoredResourceDescriptorRequest request)
Gets a single monitored resource descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
GetMonitoredResourceDescriptorRequest request =
GetMonitoredResourceDescriptorRequest.newBuilder()
.setName(
MonitoredResourceDescriptorName.ofProjectMonitoredResourceDescriptorName(
"[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]")
.toString())
.build();
MonitoredResourceDescriptor response =
metricServiceClient.getMonitoredResourceDescriptor(request);
}
Name | Description |
request | GetMonitoredResourceDescriptorRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.api.MonitoredResourceDescriptor |
getMonitoredResourceDescriptor(MonitoredResourceDescriptorName name)
public final MonitoredResourceDescriptor getMonitoredResourceDescriptor(MonitoredResourceDescriptorName name)
Gets a single monitored resource descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
MonitoredResourceDescriptorName name =
MonitoredResourceDescriptorName.ofProjectMonitoredResourceDescriptorName(
"[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
MonitoredResourceDescriptor response =
metricServiceClient.getMonitoredResourceDescriptor(name);
}
Name | Description |
name | MonitoredResourceDescriptorName Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The |
Type | Description |
com.google.api.MonitoredResourceDescriptor |
getMonitoredResourceDescriptor(String name)
public final MonitoredResourceDescriptor getMonitoredResourceDescriptor(String name)
Gets a single monitored resource descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name =
MonitoredResourceDescriptorName.ofProjectMonitoredResourceDescriptorName(
"[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]")
.toString();
MonitoredResourceDescriptor response =
metricServiceClient.getMonitoredResourceDescriptor(name);
}
Name | Description |
name | String Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The |
Type | Description |
com.google.api.MonitoredResourceDescriptor |
getMonitoredResourceDescriptorCallable()
public final UnaryCallable<GetMonitoredResourceDescriptorRequest,MonitoredResourceDescriptor> getMonitoredResourceDescriptorCallable()
Gets a single monitored resource descriptor. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
GetMonitoredResourceDescriptorRequest request =
GetMonitoredResourceDescriptorRequest.newBuilder()
.setName(
MonitoredResourceDescriptorName.ofProjectMonitoredResourceDescriptorName(
"[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]")
.toString())
.build();
ApiFuture<MonitoredResourceDescriptor> future =
metricServiceClient.getMonitoredResourceDescriptorCallable().futureCall(request);
// Do something.
MonitoredResourceDescriptor response = future.get();
}
Type | Description |
UnaryCallable<GetMonitoredResourceDescriptorRequest,com.google.api.MonitoredResourceDescriptor> |
getSettings()
public final MetricServiceSettings getSettings()
Type | Description |
MetricServiceSettings |
getStub()
public MetricServiceStub getStub()
Type | Description |
MetricServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listMetricDescriptors(ResourceName name)
public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(ResourceName name)
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ResourceName name = ResourceName.of("[FOLDER]");
for (MetricDescriptor element :
metricServiceClient.listMetricDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | com.google.api.resourcenames.ResourceName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMetricDescriptorsPagedResponse |
listMetricDescriptors(ListMetricDescriptorsRequest request)
public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(ListMetricDescriptorsRequest request)
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListMetricDescriptorsRequest request =
ListMetricDescriptorsRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (MetricDescriptor element :
metricServiceClient.listMetricDescriptors(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListMetricDescriptorsRequest The request object containing all of the parameters for the API call. |
Type | Description |
MetricServiceClient.ListMetricDescriptorsPagedResponse |
listMetricDescriptors(OrganizationName name)
public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(OrganizationName name)
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
OrganizationName name = OrganizationName.of("[ORGANIZATION]");
for (MetricDescriptor element :
metricServiceClient.listMetricDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | OrganizationName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMetricDescriptorsPagedResponse |
listMetricDescriptors(ProjectName name)
public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(ProjectName name)
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
for (MetricDescriptor element :
metricServiceClient.listMetricDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | ProjectName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMetricDescriptorsPagedResponse |
listMetricDescriptors(String name)
public final MetricServiceClient.ListMetricDescriptorsPagedResponse listMetricDescriptors(String name)
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name = ProjectName.of("[PROJECT]").toString();
for (MetricDescriptor element :
metricServiceClient.listMetricDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | String Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMetricDescriptorsPagedResponse |
listMetricDescriptorsCallable()
public final UnaryCallable<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse> listMetricDescriptorsCallable()
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListMetricDescriptorsRequest request =
ListMetricDescriptorsRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.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;
}
}
}
Type | Description |
UnaryCallable<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse> |
listMetricDescriptorsPagedCallable()
public final UnaryCallable<ListMetricDescriptorsRequest,MetricServiceClient.ListMetricDescriptorsPagedResponse> listMetricDescriptorsPagedCallable()
Lists metric descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListMetricDescriptorsRequest request =
ListMetricDescriptorsRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<MetricDescriptor> future =
metricServiceClient.listMetricDescriptorsPagedCallable().futureCall(request);
// Do something.
for (MetricDescriptor element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListMetricDescriptorsRequest,ListMetricDescriptorsPagedResponse> |
listMonitoredResourceDescriptors(ResourceName name)
public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(ResourceName name)
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ResourceName name = ResourceName.of("[FOLDER]");
for (MonitoredResourceDescriptor element :
metricServiceClient.listMonitoredResourceDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | com.google.api.resourcenames.ResourceName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse |
listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request)
public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request)
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListMonitoredResourceDescriptorsRequest request =
ListMonitoredResourceDescriptorsRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (MonitoredResourceDescriptor element :
metricServiceClient.listMonitoredResourceDescriptors(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListMonitoredResourceDescriptorsRequest The request object containing all of the parameters for the API call. |
Type | Description |
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse |
listMonitoredResourceDescriptors(OrganizationName name)
public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(OrganizationName name)
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
OrganizationName name = OrganizationName.of("[ORGANIZATION]");
for (MonitoredResourceDescriptor element :
metricServiceClient.listMonitoredResourceDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | OrganizationName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse |
listMonitoredResourceDescriptors(ProjectName name)
public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(ProjectName name)
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
for (MonitoredResourceDescriptor element :
metricServiceClient.listMonitoredResourceDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | ProjectName Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse |
listMonitoredResourceDescriptors(String name)
public final MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse listMonitoredResourceDescriptors(String name)
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name = ProjectName.of("[PROJECT]").toString();
for (MonitoredResourceDescriptor element :
metricServiceClient.listMonitoredResourceDescriptors(name).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | String Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] |
Type | Description |
MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse |
listMonitoredResourceDescriptorsCallable()
public final UnaryCallable<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse> listMonitoredResourceDescriptorsCallable()
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListMonitoredResourceDescriptorsRequest request =
ListMonitoredResourceDescriptorsRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.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;
}
}
}
Type | Description |
UnaryCallable<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse> |
listMonitoredResourceDescriptorsPagedCallable()
public final UnaryCallable<ListMonitoredResourceDescriptorsRequest,MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse> listMonitoredResourceDescriptorsPagedCallable()
Lists monitored resource descriptors that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListMonitoredResourceDescriptorsRequest request =
ListMonitoredResourceDescriptorsRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<MonitoredResourceDescriptor> future =
metricServiceClient.listMonitoredResourceDescriptorsPagedCallable().futureCall(request);
// Do something.
for (MonitoredResourceDescriptor element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsPagedResponse> |
listTimeSeries(ResourceName name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view)
public final MetricServiceClient.ListTimeSeriesPagedResponse listTimeSeries(ResourceName name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view)
Lists time series that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ResourceName name = ResourceName.of("[FOLDER]");
String filter = "filter-1274492040";
TimeInterval interval = TimeInterval.newBuilder().build();
ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.forNumber(0);
for (TimeSeries element :
metricServiceClient.listTimeSeries(name, filter, interval, view).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | com.google.api.resourcenames.ResourceName Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] |
filter | String Required. A monitoring filter 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 | TimeInterval Required. 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 | ListTimeSeriesRequest.TimeSeriesView Required. Specifies which information is returned about the time series. |
Type | Description |
MetricServiceClient.ListTimeSeriesPagedResponse |
listTimeSeries(ListTimeSeriesRequest request)
public final MetricServiceClient.ListTimeSeriesPagedResponse listTimeSeries(ListTimeSeriesRequest request)
Lists time series that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListTimeSeriesRequest request =
ListTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setInterval(TimeInterval.newBuilder().build())
.setAggregation(Aggregation.newBuilder().build())
.setSecondaryAggregation(Aggregation.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (TimeSeries element : metricServiceClient.listTimeSeries(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListTimeSeriesRequest The request object containing all of the parameters for the API call. |
Type | Description |
MetricServiceClient.ListTimeSeriesPagedResponse |
listTimeSeries(OrganizationName name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view)
public final MetricServiceClient.ListTimeSeriesPagedResponse listTimeSeries(OrganizationName name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view)
Lists time series that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
OrganizationName name = OrganizationName.of("[ORGANIZATION]");
String filter = "filter-1274492040";
TimeInterval interval = TimeInterval.newBuilder().build();
ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.forNumber(0);
for (TimeSeries element :
metricServiceClient.listTimeSeries(name, filter, interval, view).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | OrganizationName Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] |
filter | String Required. A monitoring filter 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 | TimeInterval Required. 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 | ListTimeSeriesRequest.TimeSeriesView Required. Specifies which information is returned about the time series. |
Type | Description |
MetricServiceClient.ListTimeSeriesPagedResponse |
listTimeSeries(ProjectName name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view)
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 Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
String filter = "filter-1274492040";
TimeInterval interval = TimeInterval.newBuilder().build();
ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.forNumber(0);
for (TimeSeries element :
metricServiceClient.listTimeSeries(name, filter, interval, view).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | ProjectName Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] |
filter | String Required. A monitoring filter 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 | TimeInterval Required. 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 | ListTimeSeriesRequest.TimeSeriesView Required. Specifies which information is returned about the time series. |
Type | Description |
MetricServiceClient.ListTimeSeriesPagedResponse |
listTimeSeries(String name, String filter, TimeInterval interval, ListTimeSeriesRequest.TimeSeriesView view)
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 Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
String name = ProjectName.of("[PROJECT]").toString();
String filter = "filter-1274492040";
TimeInterval interval = TimeInterval.newBuilder().build();
ListTimeSeriesRequest.TimeSeriesView view = ListTimeSeriesRequest.TimeSeriesView.forNumber(0);
for (TimeSeries element :
metricServiceClient.listTimeSeries(name, filter, interval, view).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
name | String Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] |
filter | String Required. A monitoring filter 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 | TimeInterval Required. 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 | ListTimeSeriesRequest.TimeSeriesView Required. Specifies which information is returned about the time series. |
Type | Description |
MetricServiceClient.ListTimeSeriesPagedResponse |
listTimeSeriesCallable()
public final UnaryCallable<ListTimeSeriesRequest,ListTimeSeriesResponse> listTimeSeriesCallable()
Lists time series that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListTimeSeriesRequest request =
ListTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setInterval(TimeInterval.newBuilder().build())
.setAggregation(Aggregation.newBuilder().build())
.setSecondaryAggregation(Aggregation.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.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;
}
}
}
Type | Description |
UnaryCallable<ListTimeSeriesRequest,ListTimeSeriesResponse> |
listTimeSeriesPagedCallable()
public final UnaryCallable<ListTimeSeriesRequest,MetricServiceClient.ListTimeSeriesPagedResponse> listTimeSeriesPagedCallable()
Lists time series that match a filter. This method does not require a Workspace.
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 (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
ListTimeSeriesRequest request =
ListTimeSeriesRequest.newBuilder()
.setName(ProjectName.of("[PROJECT]").toString())
.setFilter("filter-1274492040")
.setInterval(TimeInterval.newBuilder().build())
.setAggregation(Aggregation.newBuilder().build())
.setSecondaryAggregation(Aggregation.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<TimeSeries> future =
metricServiceClient.listTimeSeriesPagedCallable().futureCall(request);
// Do something.
for (TimeSeries element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListTimeSeriesRequest,ListTimeSeriesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()