Service Usage V1 API - Class Google::Api::MonitoredResourceDescriptor (v1.0.0)

Reference documentation and code samples for the Service Usage V1 API class Google::Api::MonitoredResourceDescriptor.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. A detailed description of the monitored resource type that might be used in documentation.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A detailed description of the monitored resource type that might be used in documentation.
Returns
  • (::String) — Optional. A detailed description of the monitored resource type that might be used in documentation.

#display_name

def display_name() -> ::String
Returns
  • (::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".

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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".
Returns
  • (::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

def labels() -> ::Array<::Google::Api::LabelDescriptor>
Returns
  • (::Array<::Google::Api::LabelDescriptor>) — 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".

#labels=

def labels=(value) -> ::Array<::Google::Api::LabelDescriptor>
Parameter
  • value (::Array<::Google::Api::LabelDescriptor>) — 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".
Returns
  • (::Array<::Google::Api::LabelDescriptor>) — 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".

#launch_stage

def launch_stage() -> ::Google::Api::LaunchStage
Returns

#launch_stage=

def launch_stage=(value) -> ::Google::Api::LaunchStage
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::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}".

#name=

def name=(value) -> ::String
Parameter
  • value (::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}".
Returns
  • (::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}".

#type

def type() -> ::String
Returns

#type=

def type=(value) -> ::String
Parameter
Returns