Class ProjectsResource.DashboardsResource

The "dashboards" collection of methods.

Inheritance

object

ProjectsResource.DashboardsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Monitoring.v1

Assembly: Google.Apis.Monitoring.v1.dll

Syntax

public class ProjectsResource.DashboardsResource

Constructors

DashboardsResource(IClientService)

Constructs a new resource.

Declaration

public DashboardsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(Dashboard, string)

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

Declaration

public virtual ProjectsResource.DashboardsResource.CreateRequest Create(Dashboard body, string parent)

Parameters

Type	Name	Description
Dashboard	body	The body of the request.
string	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.

Returns

Type	Description
ProjectsResource.DashboardsResource.CreateRequest

Delete(string)

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

Declaration

public virtual ProjectsResource.DashboardsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

Returns

Type	Description
ProjectsResource.DashboardsResource.DeleteRequest

Get(string)

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

Declaration

public virtual ProjectsResource.DashboardsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	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

Type	Description
ProjectsResource.DashboardsResource.GetRequest

List(string)

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

Declaration

public virtual ProjectsResource.DashboardsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER]

Returns

Type	Description
ProjectsResource.DashboardsResource.ListRequest

Patch(Dashboard, string)

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

Declaration

public virtual ProjectsResource.DashboardsResource.PatchRequest Patch(Dashboard body, string name)

Parameters

Type	Name	Description
Dashboard	body	The body of the request.
string	name	Identifier. The resource name of the dashboard.

Returns

Type	Description
ProjectsResource.DashboardsResource.PatchRequest