com.google.api

Class DocumentationRule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.DocumentationRule

All Implemented Interfaces:

DocumentationRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class DocumentationRule
extends com.google.protobuf.GeneratedMessageV3
implements DocumentationRuleOrBuilder

 A documentation rule provides information about individual API elements.
 

Protobuf type google.api.DocumentationRule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentationRule.Builder A documentation rule provides information about individual API elements.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEPRECATION_DESCRIPTION_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	SELECTOR_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static DocumentationRule	getDefaultInstance()
DocumentationRule	getDefaultInstanceForType()
java.lang.String	getDeprecationDescription() Deprecation description of the selected element(s).
com.google.protobuf.ByteString	getDeprecationDescriptionBytes() Deprecation description of the selected element(s).
java.lang.String	getDescription() Description of the selected API(s).
com.google.protobuf.ByteString	getDescriptionBytes() Description of the selected API(s).
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<DocumentationRule>	getParserForType()
java.lang.String	getSelector() The selector is a comma-separated list of patterns.
com.google.protobuf.ByteString	getSelectorBytes() The selector is a comma-separated list of patterns.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentationRule.Builder	newBuilder()
static DocumentationRule.Builder	newBuilder(DocumentationRule prototype)
DocumentationRule.Builder	newBuilderForType()
protected DocumentationRule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static DocumentationRule	parseDelimitedFrom(java.io.InputStream input)
static DocumentationRule	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentationRule	parseFrom(byte[] data)
static DocumentationRule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentationRule	parseFrom(java.nio.ByteBuffer data)
static DocumentationRule	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentationRule	parseFrom(com.google.protobuf.ByteString data)
static DocumentationRule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentationRule	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentationRule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentationRule	parseFrom(java.io.InputStream input)
static DocumentationRule	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentationRule>	parser()
DocumentationRule.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

DEPRECATION_DESCRIPTION_FIELD_NUMBER

public static final int DEPRECATION_DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSelector

public java.lang.String getSelector()

 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.
 

string selector = 1;

Specified by:

getSelector in interface DocumentationRuleOrBuilder

getSelectorBytes

public com.google.protobuf.ByteString getSelectorBytes()

 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". To
 specify a default for all applicable elements, the whole pattern "*"
 is used.
 

string selector = 1;

Specified by:

getSelectorBytes in interface DocumentationRuleOrBuilder

getDescription

public java.lang.String getDescription()

 Description of the selected API(s).
 

string description = 2;

Specified by:

getDescription in interface DocumentationRuleOrBuilder

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of the selected API(s).
 

string description = 2;

Specified by:

getDescriptionBytes in interface DocumentationRuleOrBuilder

getDeprecationDescription

public java.lang.String getDeprecationDescription()

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

string deprecation_description = 3;

Specified by:

getDeprecationDescription in interface DocumentationRuleOrBuilder

getDeprecationDescriptionBytes

public com.google.protobuf.ByteString getDeprecationDescriptionBytes()

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

string deprecation_description = 3;

Specified by:

getDeprecationDescriptionBytes in interface DocumentationRuleOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DocumentationRule parseFrom(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentationRule parseFrom(java.nio.ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentationRule parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentationRule parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentationRule parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentationRule parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentationRule parseFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DocumentationRule parseFrom(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DocumentationRule parseDelimitedFrom(java.io.InputStream input)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DocumentationRule parseDelimitedFrom(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DocumentationRule parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DocumentationRule parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public DocumentationRule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentationRule.Builder newBuilder()

newBuilder

public static DocumentationRule.Builder newBuilder(DocumentationRule prototype)

toBuilder

public DocumentationRule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentationRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentationRule getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentationRule> parser()

getParserForType

public com.google.protobuf.Parser<DocumentationRule> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DocumentationRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder