Class DashboardsServiceClient (2.43.0)

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. This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.	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.	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.	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.	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.	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.

Inheritance

java.lang.Object > DashboardsServiceClient

Static Methods

create()

public static final DashboardsServiceClient create()

Constructs an instance of DashboardsServiceClient with default settings.

Returns
Type	Description
`DashboardsServiceClient`

Exceptions
Type	Description
`IOException`

create(DashboardsServiceSettings settings)

public static final DashboardsServiceClient create(DashboardsServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`DashboardsServiceSettings`

Returns
Type	Description
`DashboardsServiceClient`

Exceptions
Type	Description
`IOException`

create(DashboardsServiceStub stub)

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

Parameter
Name	Description
`stub`	`DashboardsServiceStub`

Returns
Type	Description
`DashboardsServiceClient`

Constructors

DashboardsServiceClient(DashboardsServiceSettings settings)

protected DashboardsServiceClient(DashboardsServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`DashboardsServiceSettings`

DashboardsServiceClient(DashboardsServiceStub stub)

protected DashboardsServiceClient(DashboardsServiceStub stub)

Parameter
Name	Description
`stub`	`DashboardsServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createDashboard(CreateDashboardRequest request)

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. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.

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);
 }

Parameter
Name	Description
`request`	`CreateDashboardRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Dashboard`

createDashboard(ProjectName parent, Dashboard dashboard)

public final Dashboard createDashboard(ProjectName parent, Dashboard dashboard)

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

Name Description

parent

ProjectName

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

Dashboard

Required. The initial dashboard specification.

Returns
Type	Description
`Dashboard`

createDashboard(String parent, Dashboard dashboard)

public final Dashboard createDashboard(String parent, Dashboard dashboard)

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

Name Description

parent

String

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

Dashboard

Required. The initial dashboard specification.

Returns
Type	Description
`Dashboard`

createDashboardCallable()

public final UnaryCallable<CreateDashboardRequest,Dashboard> createDashboardCallable()

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();
 }

Returns
Type	Description
`UnaryCallable<CreateDashboardRequest,Dashboard>`

deleteDashboard(DashboardName name)

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.

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);
 }

Parameter

Name Description

name

DashboardName

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

projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

deleteDashboard(DeleteDashboardRequest request)

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.

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);
 }

Parameter
Name	Description
`request`	`DeleteDashboardRequest` The request object containing all of the parameters for the API call.

deleteDashboard(String name)

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.

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);
 }

Parameter

Name Description

name

String

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

projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

deleteDashboardCallable()

public final UnaryCallable<DeleteDashboardRequest,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.

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();
 }

Returns
Type	Description
`UnaryCallable<DeleteDashboardRequest,Empty>`

getDashboard(DashboardName name)

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.

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);
 }

Parameter

Name Description

name

DashboardName

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

Returns
Type	Description
`Dashboard`

getDashboard(GetDashboardRequest request)

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.

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);
 }

Parameter
Name	Description
`request`	`GetDashboardRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Dashboard`

getDashboard(String name)

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.

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);
 }

Parameter

Name Description

name

String

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

Returns
Type	Description
`Dashboard`

getDashboardCallable()

public final 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.

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();
 }

Returns
Type	Description
`UnaryCallable<GetDashboardRequest,Dashboard>`

getSettings()

public final DashboardsServiceSettings getSettings()

Returns
Type	Description
`DashboardsServiceSettings`

getStub()

public DashboardsServiceStub getStub()

Returns
Type	Description
`DashboardsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listDashboards(ListDashboardsRequest request)

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.

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);
   }
 }

Parameter
Name	Description
`request`	`ListDashboardsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DashboardsServiceClient.ListDashboardsPagedResponse`

listDashboards(ProjectName parent)

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.

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);
   }
 }

Parameter

Name Description

parent

ProjectName

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

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`DashboardsServiceClient.ListDashboardsPagedResponse`

listDashboards(String parent)

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.

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);
   }
 }

Parameter

Name Description

parent

String

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

projects/[PROJECT_ID_OR_NUMBER]

Returns
Type	Description
`DashboardsServiceClient.ListDashboardsPagedResponse`

listDashboardsCallable()

public final 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.

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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListDashboardsRequest,ListDashboardsResponse>`

listDashboardsPagedCallable()

public final 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.

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);
   }
 }

Returns
Type	Description
`UnaryCallable<ListDashboardsRequest,ListDashboardsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDashboard(UpdateDashboardRequest request)

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.

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);
 }

Parameter
Name	Description
`request`	`UpdateDashboardRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Dashboard`

updateDashboardCallable()

public final 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.

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();
 }

Returns
Type	Description
`UnaryCallable<UpdateDashboardRequest,Dashboard>`