monitored_resource_descriptors

Creates, updates, deletes, gets or lists a monitored_resource_descriptors resource.

Overview

Name	monitored_resource_descriptors
Type	Resource
Id	google.monitoring.monitored_resource_descriptors

Fields

The following fields are returned by SELECT queries:

projects_monitored_resource_descriptors_get

Successful response

Name	Datatype	Description
name	string	Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
description	string	Optional. A detailed description of the monitored resource type that might be used in documentation.
displayName	string	Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
labels	array	Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
launchStage	string	Optional. The launch stage of the monitored resource definition.
type	string	Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitored resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).

projects_monitored_resource_descriptors_list

Successful response

Name	Datatype	Description
name	string	Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
description	string	Optional. A detailed description of the monitored resource type that might be used in documentation.
displayName	string	Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
labels	array	Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
launchStage	string	Optional. The launch stage of the monitored resource definition.
type	string	Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitored resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_monitored_resource_descriptors_get	select	projectsId, monitoredResourceDescriptorsId		Gets a single monitored resource descriptor.
projects_monitored_resource_descriptors_list	select	projectsId	filter, pageSize, pageToken	Lists monitored resource descriptors that match a filter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
monitoredResourceDescriptorsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_monitored_resource_descriptors_get

Gets a single monitored resource descriptor.

SELECT
name,
description,
displayName,
labels,
launchStage,
type
FROM google.monitoring.monitored_resource_descriptors
WHERE projectsId = '{{ projectsId }}' -- required
AND monitoredResourceDescriptorsId = '{{ monitoredResourceDescriptorsId }}' -- required;

projects_monitored_resource_descriptors_list

Lists monitored resource descriptors that match a filter.

SELECT
name,
description,
displayName,
labels,
launchStage,
type
FROM google.monitoring.monitored_resource_descriptors
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';