com.google.api.services.monitoring.v1

Class Monitoring.Projects.Dashboards

java.lang.Object

com.google.api.services.monitoring.v1.Monitoring.Projects.Dashboards

Enclosing class:

Monitoring.Projects

public class Monitoring.Projects.Dashboards
extends Object

The "dashboards" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Monitoring.Projects.Dashboards.Create
class	Monitoring.Projects.Dashboards.Delete
class	Monitoring.Projects.Dashboards.Get
class	Monitoring.Projects.Dashboards.List
class	Monitoring.Projects.Dashboards.Patch

Constructor Summary

Constructors

Constructor and Description
Dashboards()

Method Summary

Modifier and Type	Method and Description
Monitoring.Projects.Dashboards.Create	create(String parent, Dashboard content) Creates a new custom dashboard.
Monitoring.Projects.Dashboards.Delete	delete(String name) Deletes an existing custom dashboard.This method requires the monitoring.dashboards.delete permission on the specified dashboard.
Monitoring.Projects.Dashboards.Get	get(String name) Fetches a specific dashboard.This method requires the monitoring.dashboards.get permission on the specified dashboard.
Monitoring.Projects.Dashboards.List	list(String parent) Lists the existing dashboards.This method requires the monitoring.dashboards.list permission on the specified project.
Monitoring.Projects.Dashboards.Patch	patch(String name, Dashboard content) Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dashboards

public Dashboards()

Method Detail

create

public Monitoring.Projects.Dashboards.Create create(String parent,
                                                    Dashboard content)
                                             throws IOException

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. Create a request for the method "dashboards.create". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the Dashboard

Returns:

the request

Throws:

IOException

delete

public Monitoring.Projects.Dashboards.Delete delete(String name)
                                             throws IOException

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). Create a request for the method "dashboards.delete". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

Returns:

the request

Throws:

IOException

get

public Monitoring.Projects.Dashboards.Get get(String name)
                                       throws IOException

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). Create a request for the method "dashboards.get". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Returns:

the request

Throws:

IOException

list

public Monitoring.Projects.Dashboards.List list(String parent)
                                         throws IOException

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). Create a request for the method "dashboards.list". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER]

Returns:

the request

Throws:

IOException

patch

public Monitoring.Projects.Dashboards.Patch patch(String name,
                                                  Dashboard content)
                                           throws IOException

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). Create a request for the method "dashboards.patch". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Immutable. The resource name of the dashboard.

content - the Dashboard

Returns:

the request

Throws:

IOException