- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.3.0
- 0.2.0
- 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
MetricsScopeName.Builder
Builder for locations/global/metricsScope/{metrics_scope}.
MetricsScopeProto
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.
MetricsScopesGrpc
Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
MetricsScopesGrpc.MetricsScopesBlockingStub
Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
MetricsScopesGrpc.MetricsScopesFutureStub
Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
MetricsScopesGrpc.MetricsScopesImplBase
Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
MetricsScopesGrpc.MetricsScopesStub
Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
MetricsScopesProto
MetricsScopesSettings
Settings class to configure an instance of MetricsScopesClient.
The default instance has everything set to sensible defaults:
- 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();
MetricsScopesSettings.Builder
Builder for MetricsScopesSettings.
MonitoredProject
A project being
monitored
by a Metrics Scope
.
Protobuf type google.monitoring.metricsscope.v1.MonitoredProject
MonitoredProject.Builder
A project being
monitored
by a Metrics Scope
.
Protobuf type google.monitoring.metricsscope.v1.MonitoredProject
MonitoredProjectName
MonitoredProjectName.Builder
Builder for locations/global/metricsScopes/{metrics_scope}/projects/{project}.
OperationMetadata
Contains metadata for longrunning operation for the edit Metrics Scope endpoints.
Protobuf type google.monitoring.metricsscope.v1.OperationMetadata
OperationMetadata.Builder
Contains metadata for longrunning operation for the edit Metrics Scope endpoints.
Protobuf type google.monitoring.metricsscope.v1.OperationMetadata
Interfaces
CreateMonitoredProjectRequestOrBuilder
DeleteMonitoredProjectRequestOrBuilder
GetMetricsScopeRequestOrBuilder
ListMetricsScopesByMonitoredProjectRequestOrBuilder
ListMetricsScopesByMonitoredProjectResponseOrBuilder
MetricsScopeOrBuilder
MonitoredProjectOrBuilder
OperationMetadataOrBuilder
Enums
OperationMetadata.State
Batch operation states.
Protobuf enum google.monitoring.metricsscope.v1.OperationMetadata.State