Class: Google::Apis::ServicemanagementV1::DocumentationRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/servicemanagement_v1/classes.rb,
lib/google/apis/servicemanagement_v1/representations.rb,
lib/google/apis/servicemanagement_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.



1329
1330
1331
 
# File 'lib/google/apis/servicemanagement_v1/classes.rb', line 1329

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) 


1303
1304
1305
 
# File 'lib/google/apis/servicemanagement_v1/classes.rb', line 1303

def deprecation_description
  @deprecation_description
end

#description ⇒ String

Description of the selected proto element (e.g. a message, a method, a ' service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. Corresponds to the JSON property description

Returns:

  • (String) 


1310
1311
1312
 
# File 'lib/google/apis/servicemanagement_v1/classes.rb', line 1310

def description
  @description
end

#disable_replacement_words ⇒ String

String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. Corresponds to the JSON property disableReplacementWords

Returns:

  • (String) 


1316
1317
1318
 
# File 'lib/google/apis/servicemanagement_v1/classes.rb', line 1316

def disable_replacement_words
  @disable_replacement_words
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) 


1327
1328
1329
 
# File 'lib/google/apis/servicemanagement_v1/classes.rb', line 1327

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1334
1335
1336
1337
1338
1339
 
# File 'lib/google/apis/servicemanagement_v1/classes.rb', line 1334

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