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

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

Overview

A documentation rule provides information about individual API elements.

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) ⇒ DocumentationRule

Returns a new instance of DocumentationRule



937
938
939
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 937

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) 


920
921
922
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 920

def deprecation_description
  @deprecation_description
end

#description ⇒ String

Description of the selected API(s). Corresponds to the JSON property description

Returns:

  • (String) 


925
926
927
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 925

def description
  @description
end

#selector ⇒ String

The selector is a comma-separated list of patterns. 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". To specify a default for all applicable elements, the whole pattern "" is used. Corresponds to the JSON property selector

Returns:

  • (String) 


935
936
937
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 935

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



942
943
944
945
946
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 942

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