class Google::Apis::ServicenetworkingV1beta::DocumentationRule

A documentation rule provides information about individual API elements.

Attributes

deprecation_description[RW]

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

description[RW]

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` @return [String]

selector[RW]

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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/servicenetworking_v1beta/classes.rb, line 1184
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/servicenetworking_v1beta/classes.rb, line 1189
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