Interface DocumentationRuleOrBuilder (2.44.0)

Version 2.44.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface DocumentationRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeprecationDescription()

public abstract String getDeprecationDescription()

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

string deprecation_description = 3;

Returns
Type	Description
String	The deprecationDescription.

getDeprecationDescriptionBytes()

public abstract ByteString getDeprecationDescriptionBytes()

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

string deprecation_description = 3;

Returns
Type	Description
ByteString	The bytes for deprecationDescription.

getDescription()

public abstract String getDescription()

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.

string description = 2;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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.

string description = 2;

Returns
Type	Description
ByteString	The bytes for description.

getSelector()

public abstract String getSelector()

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.

string selector = 1;

Returns
Type	Description
String	The selector.

getSelectorBytes()

public abstract ByteString getSelectorBytes()

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.

string selector = 1;

Returns
Type	Description
ByteString	The bytes for selector.