Class: Google::Apis::ServiceuserV1::LogDescriptor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_v1/representations.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 Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LogDescriptor

Returns a new instance of LogDescriptor



1537
1538
1539
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1537

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


1514
1515
1516
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1514

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


1520
1521
1522
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1520

def display_name
  @display_name
end

#labels ⇒ Array<Google::Apis::ServiceuserV1::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. Corresponds to the JSON property labels

Returns:



1527
1528
1529
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1527

def labels
  @labels
end

#name ⇒ 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 [/_-.]. Corresponds to the JSON property name

Returns:

  • (String) 


1535
1536
1537
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1535

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1542
1543
1544
1545
1546
1547
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1542

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
end