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

Version 2.3.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.3
• 2.2.2

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

LabelDescriptor

A definition of a label that can be used to describe instances of a Google::Cloud::Logging::Resource. For example, Cloud SQL databases must be labeled with their database_id. See #labels.

Inherits

• Object

Example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
resource_descriptor = logging.resource_descriptors.first
label_descriptor = resource_descriptor.labels.first
label_descriptor.key #=> "database_id"
label_descriptor.description #=> "The ID of the database."

Methods

#description

def description()

A human-readable description for the label.

#key

def key()

The key (name) of the label.

#type

def type() -> Symbol, nil

The type of data that can be assigned to the label.

Returns

• (Symbol, nil) — Returns :string, :boolean, :integer, or nil if there is no type.