Package com.google.monitoring.metricsscope.v1 (0.1.0)

A client to Cloud Monitoring API

The interfaces provided are listed below, along with usage samples.

MetricsScopesClient

Service Description: Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.

Sample for MetricsScopesClient:


 // 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
   MetricsScopeName name = MetricsScopeName.of("[METRICS_SCOPE]");
   MetricsScope response = metricsScopesClient.getMetricsScope(name);
 }

Classes

CreateMonitoredProjectRequest

Request for the CreateMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.CreateMonitoredProjectRequest

CreateMonitoredProjectRequest.Builder

Request for the CreateMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.CreateMonitoredProjectRequest

DeleteMonitoredProjectRequest

Request for the DeleteMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.DeleteMonitoredProjectRequest

DeleteMonitoredProjectRequest.Builder

Request for the DeleteMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.DeleteMonitoredProjectRequest

GetMetricsScopeRequest

Request for the GetMetricsScope method.

Protobuf type google.monitoring.metricsscope.v1.GetMetricsScopeRequest

GetMetricsScopeRequest.Builder

Request for the GetMetricsScope method.

Protobuf type google.monitoring.metricsscope.v1.GetMetricsScopeRequest

ListMetricsScopesByMonitoredProjectRequest

Request for the ListMetricsScopesByMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectRequest

ListMetricsScopesByMonitoredProjectRequest.Builder

Request for the ListMetricsScopesByMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectRequest

ListMetricsScopesByMonitoredProjectResponse

Response for the ListMetricsScopesByMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectResponse

ListMetricsScopesByMonitoredProjectResponse.Builder

Response for the ListMetricsScopesByMonitoredProject method.

Protobuf type google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectResponse

MetricsScope

Represents a Metrics Scope in Cloud Monitoring, which specifies one or more Google projects and zero or more AWS accounts to monitor together.

Protobuf type google.monitoring.metricsscope.v1.MetricsScope

MetricsScope.Builder

Represents a Metrics Scope in Cloud Monitoring, which specifies one or more Google projects and zero or more AWS accounts to monitor together.

Protobuf type google.monitoring.metricsscope.v1.MetricsScope

MetricsScopeName.Builder

Builder for locations/global/metricsScope/{metrics_scope}.

MetricsScopesClient

Service Description: Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.

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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
   MetricsScopeName name = MetricsScopeName.of("[METRICS_SCOPE]");
   MetricsScope response = metricsScopesClient.getMetricsScope(name);
 }

Note: close() needs to be called on the MetricsScopesClient 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 MetricsScopesSettings 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
 MetricsScopesSettings metricsScopesSettings =
     MetricsScopesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MetricsScopesClient metricsScopesClient = MetricsScopesClient.create(metricsScopesSettings);

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
 MetricsScopesSettings metricsScopesSettings =
     MetricsScopesSettings.newBuilder().setEndpoint(myEndpoint).build();
 MetricsScopesClient metricsScopesClient = MetricsScopesClient.create(metricsScopesSettings);

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

The default service address (monitoring.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getMetricsScope to 30 seconds:


 // 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
 MetricsScopesSettings.Builder metricsScopesSettingsBuilder = MetricsScopesSettings.newBuilder();
 metricsScopesSettingsBuilder
     .getMetricsScopeSettings()
     .setRetrySettings(
         metricsScopesSettingsBuilder.getMetricsScopeSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetricsScopesSettings metricsScopesSettings = metricsScopesSettingsBuilder.build();

Enums

OperationMetadata.State

Batch operation states.

Protobuf enum google.monitoring.metricsscope.v1.OperationMetadata.State

Package com.google.monitoring.metricsscope.v1 (0.1.0)

MetricsScopesClient

Classes

Interfaces

Enums