Package com.google.protobuf
Class Api
- All Implemented Interfaces:
ApiOrBuilder,Message,MessageLite,MessageLiteOrBuilder,MessageOrBuilder,Serializable
Protobuf type
google.protobuf.Api- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typegoogle.protobuf.ApiNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
GeneratedMessage.ExtendableBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, GeneratedMessage.ExtendableMessage<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends GeneratedMessage.ExtendableMessage<MessageT>>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingT extends Message, T>, GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanCompares the specified object with this message for equality.static ApiGet an instance of the type with no fields set.static final Descriptors.DescriptorgetMethods(int index) repeated .google.protobuf.Method methods = 2 [json_name = "methods"];intrepeated .google.protobuf.Method methods = 2 [json_name = "methods"];repeated .google.protobuf.Method methods = 2 [json_name = "methods"];getMethodsOrBuilder(int index) repeated .google.protobuf.Method methods = 2 [json_name = "methods"];List<? extends MethodOrBuilder> repeated .google.protobuf.Method methods = 2 [json_name = "methods"];getMixins(int index) repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];intrepeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];getMixinsOrBuilder(int index) repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];List<? extends MixinOrBuilder> repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];getName()string name = 1 [json_name = "name"];string name = 1 [json_name = "name"];getOptions(int index) repeated .google.protobuf.Option options = 3 [json_name = "options"];intrepeated .google.protobuf.Option options = 3 [json_name = "options"];repeated .google.protobuf.Option options = 3 [json_name = "options"];getOptionsOrBuilder(int index) repeated .google.protobuf.Option options = 3 [json_name = "options"];List<? extends OptionOrBuilder> repeated .google.protobuf.Option options = 3 [json_name = "options"];TODO: Remove this unnecessary intermediate implementation of this method.intGet the number of bytes required to encode this message..google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];.google.protobuf.Syntax syntax = 7 [json_name = "syntax"];int.google.protobuf.Syntax syntax = 7 [json_name = "syntax"];string version = 4 [json_name = "version"];string version = 4 [json_name = "version"];inthashCode()Returns the hash code value for this message.boolean.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];protected GeneratedMessage.FieldAccessorTableGet the FieldAccessorTable for this type.final booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.static Api.Builderstatic Api.BuildernewBuilder(Api prototype) Constructs a new builder for a message of the same type as this message.protected Api.BuilderCreate a nested builder.static ApiparseDelimitedFrom(InputStream input) static ApiparseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) static ApiparseFrom(byte[] data) static ApiparseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) static ApiparseFrom(ByteString data) static ApiparseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) static ApiparseFrom(CodedInputStream input) static ApiparseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) static ApiparseFrom(InputStream input) static ApiparseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) static ApiparseFrom(ByteBuffer data) static ApiparseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()Constructs a builder initialized with the current message.voidwriteTo(CodedOutputStream output) Serializes the message and writes it tooutput.Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
METHODS_FIELD_NUMBER
public static final int METHODS_FIELD_NUMBER- See Also:
-
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER- See Also:
-
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER- See Also:
-
SOURCE_CONTEXT_FIELD_NUMBER
public static final int SOURCE_CONTEXT_FIELD_NUMBER- See Also:
-
MIXINS_FIELD_NUMBER
public static final int MIXINS_FIELD_NUMBER- See Also:
-
SYNTAX_FIELD_NUMBER
public static final int SYNTAX_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageGet the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTablein classGeneratedMessage
-
getName
string name = 1 [json_name = "name"];- Specified by:
getNamein interfaceApiOrBuilder- Returns:
- The name.
-
getNameBytes
string name = 1 [json_name = "name"];- Specified by:
getNameBytesin interfaceApiOrBuilder- Returns:
- The bytes for name.
-
getMethodsList
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];- Specified by:
getMethodsListin interfaceApiOrBuilder
-
getMethodsOrBuilderList
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];- Specified by:
getMethodsOrBuilderListin interfaceApiOrBuilder
-
getMethodsCount
public int getMethodsCount()repeated .google.protobuf.Method methods = 2 [json_name = "methods"];- Specified by:
getMethodsCountin interfaceApiOrBuilder
-
getMethods
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];- Specified by:
getMethodsin interfaceApiOrBuilder
-
getMethodsOrBuilder
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];- Specified by:
getMethodsOrBuilderin interfaceApiOrBuilder
-
getOptionsList
repeated .google.protobuf.Option options = 3 [json_name = "options"];- Specified by:
getOptionsListin interfaceApiOrBuilder
-
getOptionsOrBuilderList
repeated .google.protobuf.Option options = 3 [json_name = "options"];- Specified by:
getOptionsOrBuilderListin interfaceApiOrBuilder
-
getOptionsCount
public int getOptionsCount()repeated .google.protobuf.Option options = 3 [json_name = "options"];- Specified by:
getOptionsCountin interfaceApiOrBuilder
-
getOptions
repeated .google.protobuf.Option options = 3 [json_name = "options"];- Specified by:
getOptionsin interfaceApiOrBuilder
-
getOptionsOrBuilder
repeated .google.protobuf.Option options = 3 [json_name = "options"];- Specified by:
getOptionsOrBuilderin interfaceApiOrBuilder
-
getVersion
string version = 4 [json_name = "version"];- Specified by:
getVersionin interfaceApiOrBuilder- Returns:
- The version.
-
getVersionBytes
string version = 4 [json_name = "version"];- Specified by:
getVersionBytesin interfaceApiOrBuilder- Returns:
- The bytes for version.
-
hasSourceContext
public boolean hasSourceContext().google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];- Specified by:
hasSourceContextin interfaceApiOrBuilder- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];- Specified by:
getSourceContextin interfaceApiOrBuilder- Returns:
- The sourceContext.
-
getSourceContextOrBuilder
.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];- Specified by:
getSourceContextOrBuilderin interfaceApiOrBuilder
-
getMixinsList
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];- Specified by:
getMixinsListin interfaceApiOrBuilder
-
getMixinsOrBuilderList
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];- Specified by:
getMixinsOrBuilderListin interfaceApiOrBuilder
-
getMixinsCount
public int getMixinsCount()repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];- Specified by:
getMixinsCountin interfaceApiOrBuilder
-
getMixins
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];- Specified by:
getMixinsin interfaceApiOrBuilder
-
getMixinsOrBuilder
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];- Specified by:
getMixinsOrBuilderin interfaceApiOrBuilder
-
getSyntaxValue
public int getSyntaxValue().google.protobuf.Syntax syntax = 7 [json_name = "syntax"];- Specified by:
getSyntaxValuein interfaceApiOrBuilder- Returns:
- The enum numeric value on the wire for syntax.
-
getSyntax
.google.protobuf.Syntax syntax = 7 [json_name = "syntax"];- Specified by:
getSyntaxin interfaceApiOrBuilder- Returns:
- The syntax.
-
isInitialized
public final boolean isInitialized()Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessage
-
writeTo
Description copied from interface:MessageLiteSerializes the message and writes it tooutput. This does not flush or close the stream.- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classGeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLiteGet the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.- Specified by:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classGeneratedMessage
-
equals
Description copied from interface:MessageCompares the specified object with this message for equality. Returnstrueif the given object is a message of the same type (as defined bygetDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()is incorrect.- Specified by:
equalsin interfaceMessage- Overrides:
equalsin classAbstractMessage- Parameters:
obj- object to be compared for equality with this message- Returns:
trueif the specified object is equal to this message
-
hashCode
public int hashCode()Description copied from interface:MessageReturns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheritingObject.hashCode()is incorrect.- Specified by:
hashCodein interfaceMessage- Overrides:
hashCodein classAbstractMessage- Returns:
- the hash code value for this message
- See Also:
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Api parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Api parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Api parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Api parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Api parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Api parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
Description copied from interface:MessageLiteConstructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForTypein interfaceMessage- Specified by:
newBuilderForTypein interfaceMessageLite
-
newBuilder
-
newBuilder
-
toBuilder
Description copied from interface:MessageLiteConstructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilderin interfaceMessage- Specified by:
toBuilderin interfaceMessageLite
-
newBuilderForType
Description copied from class:AbstractMessageCreate a nested builder.- Overrides:
newBuilderForTypein classAbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from class:GeneratedMessageTODO: Remove this unnecessary intermediate implementation of this method.- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessage
-
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilderGet an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from thegetDefaultInstance()method of generated message classes in that this method is an abstract method of theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-