MonitoredResourceDescriptor

import type { MonitoredResourceDescriptor } from "https://googleapis.deno.dev/v1/serviceusage:v1.ts";

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.

interface MonitoredResourceDescriptor {

description?: string;

displayName?: string;

labels?: LabelDescriptor[];

launchStage?:

| "LAUNCH_STAGE_UNSPECIFIED"

| "UNIMPLEMENTED"

| "PRELAUNCH"

| "EARLY_ACCESS"

| "ALPHA"

| "BETA"

| "GA"

| "DEPRECATED";

name?: string;

type?: string;

}

§Properties

description?: string

[src]

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

displayName?: string

[src]

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?: LabelDescriptor[]

[src]

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

[src]

Optional. The launch stage of the monitored resource definition.

name?: string

[src]

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}".

type?: string

[src]

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 and Logging resource types.