Cloud Logging API - Class Google::Cloud::Logging::ResourceDescriptor (v2.3.1)

Reference documentation and code samples for the Cloud Logging API class Google::Cloud::Logging::ResourceDescriptor.

ResourceDescriptor

Describes a type of monitored resource supported by Stackdriver Logging. Each ResourceDescriptor has a type name, such as cloudsql_database, gae_app, or gce_instance. It also specifies a set of labels that must all be given values in a Resource instance to represent an actual instance of the type.

ResourceDescriptor instances are read-only. You cannot create your own instances, but you can list them with Project#resource_descriptors.

Inherits

  • Object

Example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
resource_descriptor = logging.resource_descriptors.first
resource_descriptor.type #=> "cloudsql_database"
resource_descriptor.name #=> "Cloud SQL Database"
resource_descriptor.labels.map &:key #=> ["database_id", "zone"]

Methods

#description

def description()

A detailed description of the monitored resource type, which is used in documentation.

#labels

def labels() -> Array<LabelDescriptor>

A set of definitions of the labels that can be used to describe instances of this monitored resource type. For example, Cloud SQL databases must be labeled with their database_id and their region.

Returns

#name

def name()

A display name for the monitored resource type. For example, Cloud SQL Database.

#type

def type()

The monitored resource type. For example, cloudsql_database.