List

Lists monitored resource descriptors that match a filter

4 variables
11 variables

Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and write monitoring data for all of your Google and third-party Cloud and API projects
  • View monitoring data for all of your Google Cloud and third-party projects
  • Publish metric data to your Google Cloud projects

Input

This building block consumes 4 input parameters

  = Parameter name
  = Format

name STRING Required

The project on which to execute the request. The format is "projects/{project_id_or_number}"

filter STRING

An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id

pageToken STRING

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call

pageSize INTEGER

A positive number that is the maximum number of results to return

Output

This building block provides 11 output parameters

  = Parameter name
  = Format

nextPageToken STRING

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method

resourceDescriptors[] OBJECT

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API

resourceDescriptors[].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"

resourceDescriptors[].description STRING

Optional. A detailed description of the monitored resource type that might be used in documentation

resourceDescriptors[].launchStage ENUMERATION

Optional. The launch stage of the monitored resource definition

resourceDescriptors[].labels[] OBJECT

A description of a label

resourceDescriptors[].labels[].valueType ENUMERATION

The type of data that can be assigned to the label

resourceDescriptors[].labels[].key STRING

The label key

resourceDescriptors[].labels[].description STRING

A human-readable description for the label

resourceDescriptors[].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}"

resourceDescriptors[].type STRING

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters