Class: Google::Cloud::Logging::ResourceDescriptor::LabelDescriptor

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/resource_descriptor.rb

Overview

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.

Examples:

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

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ Object (readonly)

A human-readable description for the label.



118
119
120
 
# File 'lib/google/cloud/logging/resource_descriptor.rb', line 118

def description
  @description
end

#key ⇒ Object (readonly)

The key (name) of the label.



106
107
108
 
# File 'lib/google/cloud/logging/resource_descriptor.rb', line 106

def key
  @key
end

#type ⇒ Symbol? (readonly)

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.



114
115
116
 
# File 'lib/google/cloud/logging/resource_descriptor.rb', line 114

def type
  @type
end