Service Usage V1 API - Class Google::Api::DocumentationRule (v1.0.0)

Reference documentation and code samples for the Service Usage V1 API class Google::Api::DocumentationRule.

A documentation rule provides information about individual API elements.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#deprecation_description

def deprecation_description() -> ::String
Returns
  • (::String) — Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

#deprecation_description=

def deprecation_description=(value) -> ::String
Parameter
  • value (::String) — Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.
Returns
  • (::String) — Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

#description

def description() -> ::String
Returns
  • (::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.

#description=

def description=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#selector

def selector() -> ::String
Returns
  • (::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.

#selector=

def selector=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.