Class: Google::Apis::ServiceusageV1::DocumentationRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.rb

Overview

A documentation rule provides information about individual API elements.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentationRule

Returns a new instance of DocumentationRule.



1026
1027
1028
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1026

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

Instance Attribute Details

#deprecation_description ⇒ String

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated. Corresponds to the JSON property deprecationDescription

Returns:

  • (String) 


1007
1008
1009
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1007

def deprecation_description
  @deprecation_description
end

#description ⇒ String

The description is the comment in front of the selected proto element, such as a message, a method, a 'service' definition, or a field. Corresponds to the JSON property description

Returns:

  • (String) 


1013
1014
1015
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1013

def description
  @description
end

#selector ⇒ String

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo. " is ok, but not "foo.b*" or "foo..bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "" is used. Corresponds to the JSON property selector

Returns:

  • (String) 


1024
1025
1026
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1024

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1031
1032
1033
1034
1035
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1031

def update!(**args)
  @deprecation_description = args[:deprecation_description] if args.key?(:deprecation_description)
  @description = args[:description] if args.key?(:description)
  @selector = args[:selector] if args.key?(:selector)
end