Send feedback
Class DocumentationRule (2.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.10.0 keyboard_arrow_down
public sealed class DocumentationRule : IMessage<DocumentationRule>, IEquatable<DocumentationRule>, IDeepCloneable<DocumentationRule>, IBufferMessage, IMessage
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
int
DescriptionFieldNumber
public const int DescriptionFieldNumber = 2
Field number for the "description" field.
Field Value
Type
Description
int
SelectorFieldNumber
public const int SelectorFieldNumber = 1
Field number for the "selector" field.
Field Value
Type
Description
int
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 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.
Property Value
Type
Description
string
Descriptor
public static MessageDescriptor Descriptor { get; }
Parser
public static MessageParser<DocumentationRule> Parser { get; }
Selector
public string Selector { get; set; }
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.
Property Value
Type
Description
string
Methods
CalculateSize()
public int CalculateSize()
Returns
Type
Description
int
Clone()
public DocumentationRule Clone()
Equals(DocumentationRule)
public bool Equals(DocumentationRule other)
Returns
Type
Description
bool
Equals(object)
public override bool Equals(object other)
Parameter
Name
Description
other
object
Returns
Type
Description
bool
Overrides
GetHashCode()
public override int GetHashCode()
Returns
Type
Description
int
Overrides
MergeFrom(DocumentationRule)
public void MergeFrom(DocumentationRule other)
public void MergeFrom(CodedInputStream input)
ToString()
public override string ToString()
Returns
Type
Description
string
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-24 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-24 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-24 UTC."]]