Send feedback
Class DocumentationRule (2.14.3)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.14.3 keyboard_arrow_down
public final class DocumentationRule extends GeneratedMessageV3 implements DocumentationRuleOrBuilder
A documentation rule provides information about individual API elements.
Protobuf type google.api.DocumentationRule
Static Fields
DEPRECATION_DESCRIPTION_FIELD_NUMBER
public static final int DEPRECATION_DESCRIPTION_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DocumentationRule getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static DocumentationRule . Builder newBuilder ()
Returns
newBuilder(DocumentationRule prototype)
public static DocumentationRule . Builder newBuilder ( DocumentationRule prototype )
Parameter
Returns
public static DocumentationRule parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentationRule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentationRule parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentationRule parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentationRule parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static DocumentationRule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentationRule parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentationRule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentationRule parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentationRule> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentationRule getDefaultInstanceForType ()
Returns
getDeprecationDescription()
public String getDeprecationDescription ()
Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
string deprecation_description = 3;
Returns
Type Description String The deprecationDescription.
getDeprecationDescriptionBytes()
public ByteString getDeprecationDescriptionBytes ()
Deprecation description of the selected element(s). It can be provided if
an element is marked as deprecated.
string deprecation_description = 3;
Returns
Type Description ByteString The bytes for deprecationDescription.
getDescription()
public String 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.
string description = 2;
Returns
Type Description String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
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.
string description = 2;
Returns
Type Description ByteString The bytes for description.
getParserForType()
public Parser<DocumentationRule> getParserForType ()
Returns
Overrides
getSelector()
public String 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.
string selector = 1;
Returns
Type Description String The selector.
getSelectorBytes()
public ByteString getSelectorBytes ()
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.
string selector = 1;
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public DocumentationRule . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentationRule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public DocumentationRule . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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 2025-02-04 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 2025-02-04 UTC."],[],[]]
