Service Management V1 API - Class Google::Api::LogDescriptor (v0.5.0)

Reference documentation and code samples for the Service Management V1 API class Google::Api::LogDescriptor.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — A human-readable description of this log. This information appears in the documentation and can contain details.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — 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.

#display_name

def display_name() -> ::String
Returns
  • (::String) — The human-readable name for this log. This information appears on the user interface and should be concise.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — 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.

#labels

def labels() -> ::Array<::Google::Api::LabelDescriptor>
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.

#labels=

def labels=(value) -> ::Array<::Google::Api::LabelDescriptor>
Parameter
  • value (::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.
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.

#name

def name() -> ::String
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 [/_-.].

#name=

def name=(value) -> ::String
Parameter
  • value (::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 [/_-.].
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 [/_-.].