public final class DocumentationRule extends GeneratedMessageV3 implements DocumentationRuleOrBuilder
A documentation rule provides information about individual API elements.
Protobuf type google.api.DocumentationRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DEPRECATION_DESCRIPTION_FIELD_NUMBER
public static final int DEPRECATION_DESCRIPTION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DocumentationRule getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DocumentationRule.Builder newBuilder()
newBuilder(DocumentationRule prototype)
public static DocumentationRule.Builder newBuilder(DocumentationRule prototype)
public static DocumentationRule parseDelimitedFrom(InputStream input)
public static DocumentationRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DocumentationRule parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DocumentationRule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom(CodedInputStream input)
public static DocumentationRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom(InputStream input)
public static DocumentationRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DocumentationRule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentationRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DocumentationRule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public DocumentationRule getDefaultInstanceForType()
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()
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 |
Type |
Description |
ByteString |
The bytes for selector.
|
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DocumentationRule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentationRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public DocumentationRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides