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

Inherits:

Object

• Object
• Google::Apis::ServiceusageV1::DocumentationRule

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

• #deprecation_description ⇒ String

  Deprecation description of the selected element(s).

• #description ⇒ String

  Description of the selected proto element (e.g. a message, a method, a ' service' definition, or a field).

• #selector ⇒ String

  The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.

Instance Method Summary

• #initialize(**args) ⇒ DocumentationRule constructor

  A new instance of DocumentationRule.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ DocumentationRule

Returns a new instance of DocumentationRule.

# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1160

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)

# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1140

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)

# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1147

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)

# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1158

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1165

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