# Service Management V1 API - Class Google::Api::MonitoredResourceDescriptor (v1.8.0)

1.8.0 (latest) 1.7.1 1.6.0 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.2 0.11.0 0.10.2 0.9.0 0.8.0 0.7.0 0.6.1 0.5.0 0.4.1 0.3.10 Reference documentation and code samples for the Service Management V1 API class Google::Api::MonitoredResourceDescriptor.

An object that describes the schema of a
[MonitoredResource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-MonitoredResource "Google::Api::MonitoredResource (class)") 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.


<br />

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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/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**

- ([::Google::Api::LaunchStage](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-LaunchStage)) --- Optional. The launch stage of the monitored resource definition.

### #launch_stage=

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

**Parameter**

- **value** ([::Google::Api::LaunchStage](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-LaunchStage)) --- Optional. The launch stage of the monitored resource definition.
**Returns**

- ([::Google::Api::LaunchStage](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-LaunchStage)) --- Optional. The launch stage of the monitored resource definition.

### #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**

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

### #type=

    def type=(value) -> ::String

**Parameter**

- **value** (::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).
**Returns**

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