Reference documentation and code samples for the Google API Common Protos Client class DocumentationRule.
A documentation rule provides information about individual API elements.
Generated from protobuf message google.api.DocumentationRule
Namespace
Google \ ApiMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ 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. |
↳ 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. |
↳ deprecation_description |
string
Deprecation description of the selected element(s). It can be provided if an element is marked as |
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSelector
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeprecationDescription
Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeprecationDescription
Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|