Class DocumentationRule

A documentation rule provides information about individual API elements.

Inheritance
System.Object
DocumentationRule
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class DocumentationRule : IMessage<DocumentationRule>, IMessage, IEquatable<DocumentationRule>, IDeepCloneable<DocumentationRule>

Constructors

DocumentationRule()

Declaration
public DocumentationRule()

DocumentationRule(DocumentationRule)

Declaration
public DocumentationRule(DocumentationRule other)
Parameters
Type Name Description
DocumentationRule other

Fields

DeprecationDescriptionFieldNumber

Field number for the "deprecation_description" field.

Declaration
public const int DeprecationDescriptionFieldNumber = 3
Field Value
Type Description
System.Int32

DescriptionFieldNumber

Field number for the "description" field.

Declaration
public const int DescriptionFieldNumber = 2
Field Value
Type Description
System.Int32

SelectorFieldNumber

Field number for the "selector" field.

Declaration
public const int SelectorFieldNumber = 1
Field Value
Type Description
System.Int32

Properties

DeprecationDescription

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

Declaration
public string DeprecationDescription { get; set; }
Property Value
Type Description
System.String

Description

Description of the selected API(s).

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

Descriptor

Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Parser

Declaration
public static MessageParser<DocumentationRule> Parser { get; }
Property Value
Type Description
MessageParser<DocumentationRule>

Selector

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.

Declaration
public string Selector { get; set; }
Property Value
Type Description
System.String

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

Clone()

Declaration
public DocumentationRule Clone()
Returns
Type Description
DocumentationRule
Implements

Equals(DocumentationRule)

Declaration
public bool Equals(DocumentationRule other)
Parameters
Type Name Description
DocumentationRule other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(DocumentationRule)

Declaration
public void MergeFrom(DocumentationRule other)
Parameters
Type Name Description
DocumentationRule other
Implements

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements