public sealed class DocumentationRule : Protobuf.IMessage<DocumentationRule>, Protobuf.IBufferMessage
A documentation rule provides information about individual API elements.
Inheritance
Object >
DocumentationRule
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
DocumentationRule()
public DocumentationRule()
DocumentationRule(DocumentationRule)
public DocumentationRule(DocumentationRule other)
Fields
DeprecationDescriptionFieldNumber
public const int DeprecationDescriptionFieldNumber = 3
Field number for the "deprecation_description" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
DescriptionFieldNumber
public const int DescriptionFieldNumber = 2
Field number for the "description" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
SelectorFieldNumber
public const int SelectorFieldNumber = 1
Field number for the "selector" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
Properties
DeprecationDescription
public string DeprecationDescription { get; set; }
Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
| Property Value |
|---|
| Type | Description |
String | |
Description
public string Description { get; set; }
Description of the selected API(s).
| Property Value |
|---|
| Type | Description |
String | |
Descriptor
public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Parser
public static Protobuf.MessageParser<DocumentationRule> Parser { get; }
Selector
public string Selector { get; set; }
The selector is a comma-separated list of patterns. 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.
| Property Value |
|---|
| Type | Description |
String | |
Methods
CalculateSize()
public int CalculateSize()
| Returns |
|---|
| Type | Description |
Int32 | |
Clone()
public DocumentationRule Clone()
Equals(DocumentationRule)
public bool Equals(DocumentationRule other)
Equals(Object)
public override bool Equals(object other)
| Parameter |
|---|
| Name | Description |
other | Object
|
GetHashCode()
public override int GetHashCode()
| Returns |
|---|
| Type | Description |
Int32 | |
MergeFrom(DocumentationRule)
public void MergeFrom(DocumentationRule other)
public void MergeFrom(Protobuf.CodedInputStream input)
ToString()
public override string ToString()
WriteTo(Protobuf.CodedOutputStream)
public void WriteTo(Protobuf.CodedOutputStream output)
