A client to Cloud Monitoring API
The interfaces provided are listed below, along with usage samples.
DashboardsServiceClient
Service Description: Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
Sample for DashboardsServiceClient:
// 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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
CreateDashboardRequest request =
CreateDashboardRequest.newBuilder()
.setParent("parent-995424086")
.setDashboard(Dashboard.newBuilder().build())
.setValidateOnly(true)
.build();
Dashboard response = dashboardsServiceClient.createDashboard(request);
}
Classes
DashboardsServiceClient
Service Description: Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.
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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
CreateDashboardRequest request =
CreateDashboardRequest.newBuilder()
.setParent("parent-995424086")
.setDashboard(Dashboard.newBuilder().build())
.setValidateOnly(true)
.build();
Dashboard response = dashboardsServiceClient.createDashboard(request);
}
Note: close() needs to be called on the DashboardsServiceClient 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 DashboardsServiceSettings 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
DashboardsServiceSettings dashboardsServiceSettings =
DashboardsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DashboardsServiceClient dashboardsServiceClient =
DashboardsServiceClient.create(dashboardsServiceSettings);
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
DashboardsServiceSettings dashboardsServiceSettings =
DashboardsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DashboardsServiceClient dashboardsServiceClient =
DashboardsServiceClient.create(dashboardsServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
DashboardsServiceSettings dashboardsServiceSettings =
DashboardsServiceSettings.newHttpJsonBuilder().build();
DashboardsServiceClient dashboardsServiceClient =
DashboardsServiceClient.create(dashboardsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DashboardsServiceClient.ListDashboardsFixedSizeCollection
DashboardsServiceClient.ListDashboardsPage
DashboardsServiceClient.ListDashboardsPagedResponse
DashboardsServiceSettings
Settings class to configure an instance of DashboardsServiceClient.
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 createDashboard 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
DashboardsServiceSettings.Builder dashboardsServiceSettingsBuilder =
DashboardsServiceSettings.newBuilder();
dashboardsServiceSettingsBuilder
.createDashboardSettings()
.setRetrySettings(
dashboardsServiceSettingsBuilder
.createDashboardSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DashboardsServiceSettings dashboardsServiceSettings = dashboardsServiceSettingsBuilder.build();
DashboardsServiceSettings.Builder
Builder for DashboardsServiceSettings.