Send feedback
Class DocumentationRule (2.2.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.2.0 keyboard_arrow_down
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 otherObject
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)
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-11-06 UTC.
Need to tell us more?
[[["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-11-06 UTC."],[],[]]
