com.google.cloud.monitoring.dashboard.v1

Class DashboardsServiceClient

java.lang.Object

com.google.cloud.monitoring.dashboard.v1.DashboardsServiceClient

All Implemented Interfaces:

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

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

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()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Dashboard dashboard = Dashboard.newBuilder().build();
   Dashboard response = dashboardsServiceClient.createDashboard(parent, dashboard);
 }
 

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().

Methods

Method	Description	Method Variants
CreateDashboard	Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).	Request object method variants only take one parameter, a request object, which must be constructed before the call. createDashboard(CreateDashboardRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createDashboard(ProjectName parent, Dashboard dashboard) createDashboard(String parent, Dashboard dashboard) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createDashboardCallable()
ListDashboards	Lists the existing dashboards. This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDashboards(ListDashboardsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDashboards(ProjectName parent) listDashboards(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listDashboardsPagedCallable() listDashboardsCallable()
GetDashboard	Fetches a specific dashboard. This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDashboard(GetDashboardRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDashboard(DashboardName name) getDashboard(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDashboardCallable()
DeleteDashboard	Deletes an existing custom dashboard. This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteDashboard(DeleteDashboardRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteDashboard(DashboardName name) deleteDashboard(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteDashboardCallable()
UpdateDashboard	Replaces an existing custom dashboard with a new definition. This method requires the `monitoring.dashboards.update` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateDashboard(UpdateDashboardRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateDashboardCallable()

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DashboardsServiceClient.ListDashboardsFixedSizeCollection
static class	DashboardsServiceClient.ListDashboardsPage
static class	DashboardsServiceClient.ListDashboardsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DashboardsServiceClient(DashboardsServiceSettings settings) Constructs an instance of DashboardsServiceClient, using the given settings.
protected	DashboardsServiceClient(DashboardsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static DashboardsServiceClient	create() Constructs an instance of DashboardsServiceClient with default settings.
static DashboardsServiceClient	create(DashboardsServiceSettings settings) Constructs an instance of DashboardsServiceClient, using the given settings.
static DashboardsServiceClient	create(DashboardsServiceStub stub) Constructs an instance of DashboardsServiceClient, using the given stub for making calls.
Dashboard	createDashboard(CreateDashboardRequest request) Creates a new custom dashboard.
Dashboard	createDashboard(ProjectName parent, Dashboard dashboard) Creates a new custom dashboard.
Dashboard	createDashboard(String parent, Dashboard dashboard) Creates a new custom dashboard.
com.google.api.gax.rpc.UnaryCallable<CreateDashboardRequest,Dashboard>	createDashboardCallable() Creates a new custom dashboard.
void	deleteDashboard(DashboardName name) Deletes an existing custom dashboard.
void	deleteDashboard(DeleteDashboardRequest request) Deletes an existing custom dashboard.
void	deleteDashboard(String name) Deletes an existing custom dashboard.
com.google.api.gax.rpc.UnaryCallable<DeleteDashboardRequest,com.google.protobuf.Empty>	deleteDashboardCallable() Deletes an existing custom dashboard.
Dashboard	getDashboard(DashboardName name) Fetches a specific dashboard.
Dashboard	getDashboard(GetDashboardRequest request) Fetches a specific dashboard.
Dashboard	getDashboard(String name) Fetches a specific dashboard.
com.google.api.gax.rpc.UnaryCallable<GetDashboardRequest,Dashboard>	getDashboardCallable() Fetches a specific dashboard.
DashboardsServiceSettings	getSettings()
DashboardsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
DashboardsServiceClient.ListDashboardsPagedResponse	listDashboards(ListDashboardsRequest request) Lists the existing dashboards.
DashboardsServiceClient.ListDashboardsPagedResponse	listDashboards(ProjectName parent) Lists the existing dashboards.
DashboardsServiceClient.ListDashboardsPagedResponse	listDashboards(String parent) Lists the existing dashboards.
com.google.api.gax.rpc.UnaryCallable<ListDashboardsRequest,ListDashboardsResponse>	listDashboardsCallable() Lists the existing dashboards.
com.google.api.gax.rpc.UnaryCallable<ListDashboardsRequest,DashboardsServiceClient.ListDashboardsPagedResponse>	listDashboardsPagedCallable() Lists the existing dashboards.
void	shutdown()
void	shutdownNow()
Dashboard	updateDashboard(UpdateDashboardRequest request) Replaces an existing custom dashboard with a new definition.
com.google.api.gax.rpc.UnaryCallable<UpdateDashboardRequest,Dashboard>	updateDashboardCallable() Replaces an existing custom dashboard with a new definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardsServiceClient

protected DashboardsServiceClient(DashboardsServiceSettings settings)
                           throws IOException

Constructs an instance of DashboardsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

DashboardsServiceClient

protected DashboardsServiceClient(DashboardsServiceStub stub)

Method Detail

create

public static final DashboardsServiceClient create()
                                            throws IOException

Constructs an instance of DashboardsServiceClient with default settings.

Throws:

IOException

create

public static final DashboardsServiceClient create(DashboardsServiceSettings settings)
                                            throws IOException

Constructs an instance of DashboardsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final DashboardsServiceClient create(DashboardsServiceStub stub)

Constructs an instance of DashboardsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DashboardsServiceSettings).

getSettings

public final DashboardsServiceSettings getSettings()

getStub

public DashboardsServiceStub getStub()

createDashboard

public final Dashboard createDashboard(ProjectName parent,
                                       Dashboard dashboard)

Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Dashboard dashboard = Dashboard.newBuilder().build();
   Dashboard response = dashboardsServiceClient.createDashboard(parent, dashboard);
 }
 

Parameters:

parent - Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.

dashboard - Required. The initial dashboard specification.

Throws:

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

createDashboard

public final Dashboard createDashboard(String parent,
                                       Dashboard dashboard)

Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Dashboard dashboard = Dashboard.newBuilder().build();
   Dashboard response = dashboardsServiceClient.createDashboard(parent, dashboard);
 }
 

Parameters:

parent - Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.

dashboard - Required. The initial dashboard specification.

Throws:

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

createDashboard

public final Dashboard createDashboard(CreateDashboardRequest request)

Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   CreateDashboardRequest request =
       CreateDashboardRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDashboard(Dashboard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Dashboard response = dashboardsServiceClient.createDashboard(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

createDashboardCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDashboardRequest,Dashboard> createDashboardCallable()

Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   CreateDashboardRequest request =
       CreateDashboardRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDashboard(Dashboard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Dashboard> future =
       dashboardsServiceClient.createDashboardCallable().futureCall(request);
   // Do something.
   Dashboard response = future.get();
 }
 

listDashboards

public final DashboardsServiceClient.ListDashboardsPagedResponse listDashboards(ProjectName parent)

Lists the existing dashboards.

This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Dashboard element : dashboardsServiceClient.listDashboards(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The scope of the dashboards to list. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

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

listDashboards

public final DashboardsServiceClient.ListDashboardsPagedResponse listDashboards(String parent)

Lists the existing dashboards.

This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Dashboard element : dashboardsServiceClient.listDashboards(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The scope of the dashboards to list. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

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

listDashboards

public final DashboardsServiceClient.ListDashboardsPagedResponse listDashboards(ListDashboardsRequest request)

Lists the existing dashboards.

This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   ListDashboardsRequest request =
       ListDashboardsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Dashboard element : dashboardsServiceClient.listDashboards(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

listDashboardsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDashboardsRequest,DashboardsServiceClient.ListDashboardsPagedResponse> listDashboardsPagedCallable()

Lists the existing dashboards.

This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   ListDashboardsRequest request =
       ListDashboardsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Dashboard> future =
       dashboardsServiceClient.listDashboardsPagedCallable().futureCall(request);
   // Do something.
   for (Dashboard element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listDashboardsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDashboardsRequest,ListDashboardsResponse> listDashboardsCallable()

Lists the existing dashboards.

This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   ListDashboardsRequest request =
       ListDashboardsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDashboardsResponse response =
         dashboardsServiceClient.listDashboardsCallable().call(request);
     for (Dashboard element : response.getDashboardsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getDashboard

public final Dashboard getDashboard(DashboardName name)

Fetches a specific dashboard.

This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   DashboardName name = DashboardName.of("[PROJECT]", "[DASHBOARD]");
   Dashboard response = dashboardsServiceClient.getDashboard(name);
 }
 

Parameters:

name - Required. The resource name of the Dashboard. The format is one of:

- `dashboards/[DASHBOARD_ID]` (for system dashboards) - `projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]` (for custom dashboards).

Throws:

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

getDashboard

public final Dashboard getDashboard(String name)

Fetches a specific dashboard.

This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   String name = DashboardName.of("[PROJECT]", "[DASHBOARD]").toString();
   Dashboard response = dashboardsServiceClient.getDashboard(name);
 }
 

Parameters:

name - Required. The resource name of the Dashboard. The format is one of:

- `dashboards/[DASHBOARD_ID]` (for system dashboards) - `projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]` (for custom dashboards).

Throws:

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

getDashboard

public final Dashboard getDashboard(GetDashboardRequest request)

Fetches a specific dashboard.

This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   GetDashboardRequest request =
       GetDashboardRequest.newBuilder()
           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
           .build();
   Dashboard response = dashboardsServiceClient.getDashboard(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

getDashboardCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDashboardRequest,Dashboard> getDashboardCallable()

Fetches a specific dashboard.

This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   GetDashboardRequest request =
       GetDashboardRequest.newBuilder()
           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
           .build();
   ApiFuture<Dashboard> future =
       dashboardsServiceClient.getDashboardCallable().futureCall(request);
   // Do something.
   Dashboard response = future.get();
 }
 

deleteDashboard

public final void deleteDashboard(DashboardName name)

Deletes an existing custom dashboard.

This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   DashboardName name = DashboardName.of("[PROJECT]", "[DASHBOARD]");
   dashboardsServiceClient.deleteDashboard(name);
 }
 

Parameters:

name - Required. The resource name of the Dashboard. The format is:

projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

Throws:

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

deleteDashboard

public final void deleteDashboard(String name)

Deletes an existing custom dashboard.

This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   String name = DashboardName.of("[PROJECT]", "[DASHBOARD]").toString();
   dashboardsServiceClient.deleteDashboard(name);
 }
 

Parameters:

name - Required. The resource name of the Dashboard. The format is:

projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

Throws:

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

deleteDashboard

public final void deleteDashboard(DeleteDashboardRequest request)

Deletes an existing custom dashboard.

This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   DeleteDashboardRequest request =
       DeleteDashboardRequest.newBuilder()
           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
           .build();
   dashboardsServiceClient.deleteDashboard(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

deleteDashboardCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDashboardRequest,com.google.protobuf.Empty> deleteDashboardCallable()

Deletes an existing custom dashboard.

This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   DeleteDashboardRequest request =
       DeleteDashboardRequest.newBuilder()
           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
           .build();
   ApiFuture<Empty> future =
       dashboardsServiceClient.deleteDashboardCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

updateDashboard

public final Dashboard updateDashboard(UpdateDashboardRequest request)

Replaces an existing custom dashboard with a new definition.

This method requires the `monitoring.dashboards.update` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   UpdateDashboardRequest request =
       UpdateDashboardRequest.newBuilder()
           .setDashboard(Dashboard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Dashboard response = dashboardsServiceClient.updateDashboard(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

updateDashboardCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDashboardRequest,Dashboard> updateDashboardCallable()

Replaces an existing custom dashboard with a new definition.

This method requires the `monitoring.dashboards.update` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).

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 (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   UpdateDashboardRequest request =
       UpdateDashboardRequest.newBuilder()
           .setDashboard(Dashboard.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Dashboard> future =
       dashboardsServiceClient.updateDashboardCallable().futureCall(request);
   // Do something.
   Dashboard response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException