Class: Google::Api::LogDescriptor

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/log.rb

Overview

A description of a log type. Example in YAML format:

- name: library.googleapis.com/activity_history
  description: The history of borrowing and returning library items.
  display_name: Activity
  labels:
  - key: /customer_id
    description: Identifier of a library customer

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns A human-readable description of this log. This information appears in the documentation and can contain details.

Returns:

  • (::String) —

    A human-readable description of this log. This information appears in the documentation and can contain details.



49
50
51
52
 
# File 'proto_docs/google/api/log.rb', line 49

class LogDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns The human-readable name for this log. This information appears on the user interface and should be concise.

Returns:

  • (::String) —

    The human-readable name for this log. This information appears on the user interface and should be concise.



49
50
51
52
 
# File 'proto_docs/google/api/log.rb', line 49

class LogDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#labels ⇒ ::Array<::Google::Api::LabelDescriptor>

Returns The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

Returns:

  • (::Array<::Google::Api::LabelDescriptor>) —

    The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.



49
50
51
52
 
# File 'proto_docs/google/api/log.rb', line 49

class LogDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Returns:

  • (::String) —

    The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].



49
50
51
52
 
# File 'proto_docs/google/api/log.rb', line 49

class LogDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end