- 2.50.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.6
- 2.4.0
- 2.3.0
- 2.2.6
public class DashboardsServiceClient implements 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:
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:
DashboardsServiceSettings dashboardsServiceSettings =
DashboardsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DashboardsServiceClient dashboardsServiceClient =
DashboardsServiceClient.create(dashboardsServiceSettings);
To customize the endpoint:
DashboardsServiceSettings dashboardsServiceSettings =
DashboardsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DashboardsServiceClient dashboardsServiceClient =
DashboardsServiceClient.create(dashboardsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final DashboardsServiceClient create()
Constructs an instance of DashboardsServiceClient with default settings.
Type | Description |
DashboardsServiceClient |
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.
Name | Description |
settings | DashboardsServiceSettings |
Type | Description |
DashboardsServiceClient |
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).
Name | Description |
stub | DashboardsServiceStub |
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.
Name | Description |
settings | DashboardsServiceSettings |
DashboardsServiceClient(DashboardsServiceStub stub)
protected DashboardsServiceClient(DashboardsServiceStub stub)
Name | Description |
stub | DashboardsServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
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:
try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
CreateDashboardRequest request =
CreateDashboardRequest.newBuilder()
.setParent("parent-995424086")
.setDashboard(Dashboard.newBuilder().build())
.setValidateOnly(true)
.build();
Dashboard response = dashboardsServiceClient.createDashboard(request);
}
Name | Description |
request | CreateDashboardRequest The request object containing all of the parameters for the API call. |
Type | Description |
Dashboard |
createDashboardCallable()
public final 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.
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:
try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
CreateDashboardRequest request =
CreateDashboardRequest.newBuilder()
.setParent("parent-995424086")
.setDashboard(Dashboard.newBuilder().build())
.setValidateOnly(true)
.build();
ApiFuture<Dashboard> future =
dashboardsServiceClient.createDashboardCallable().futureCall(request);
// Do something.
Dashboard response = future.get();
}
Type | Description |
UnaryCallable<CreateDashboardRequest,Dashboard> |
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:
try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
DeleteDashboardRequest request =
DeleteDashboardRequest.newBuilder()
.setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
.build();
dashboardsServiceClient.deleteDashboard(request);
}
Name | Description |
request | DeleteDashboardRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Type | Description |
UnaryCallable<DeleteDashboardRequest,Empty> |
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:
try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
GetDashboardRequest request =
GetDashboardRequest.newBuilder()
.setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
.build();
Dashboard response = dashboardsServiceClient.getDashboard(request);
}
Name | Description |
request | GetDashboardRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Type | Description |
UnaryCallable<GetDashboardRequest,Dashboard> |
getSettings()
public final DashboardsServiceSettings getSettings()
Type | Description |
DashboardsServiceSettings |
getStub()
public DashboardsServiceStub getStub()
Type | Description |
DashboardsServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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:
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);
}
}
Name | Description |
request | ListDashboardsRequest The request object containing all of the parameters for the API call. |
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:
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.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
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:
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);
}
}
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:
try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
UpdateDashboardRequest request =
UpdateDashboardRequest.newBuilder()
.setDashboard(Dashboard.newBuilder().build())
.setValidateOnly(true)
.build();
Dashboard response = dashboardsServiceClient.updateDashboard(request);
}
Name | Description |
request | UpdateDashboardRequest The request object containing all of the parameters for the API call. |
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:
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();
}
Type | Description |
UnaryCallable<UpdateDashboardRequest,Dashboard> |