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 class
Protobuf typegoogle.protobuf.Api
Nested 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.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the specified object with this message for equality.static Api
Get an instance of the type with no fields set.static final Descriptors.Descriptor
getMethods
(int index) repeated .google.protobuf.Method methods = 2 [json_name = "methods"];
int
repeated .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"];
int
repeated .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"];
int
repeated .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.int
Get 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"];
int
hashCode()
Returns the hash code value for this message.boolean
.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];
protected GeneratedMessage.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.static Api.Builder
static Api.Builder
newBuilder
(Api prototype) Constructs a new builder for a message of the same type as this message.protected Api.Builder
Create a nested builder.static Api
parseDelimitedFrom
(InputStream input) static Api
parseDelimitedFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Api
parseFrom
(byte[] data) static Api
parseFrom
(byte[] data, ExtensionRegistryLite extensionRegistry) static Api
parseFrom
(ByteString data) static Api
parseFrom
(ByteString data, ExtensionRegistryLite extensionRegistry) static Api
parseFrom
(CodedInputStream input) static Api
parseFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) static Api
parseFrom
(InputStream input) static Api
parseFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Api
parseFrom
(ByteBuffer data) static Api
parseFrom
(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()
Constructs a builder initialized with the current message.void
writeTo
(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, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods 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:GeneratedMessage
Get 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:
internalGetFieldAccessorTable
in classGeneratedMessage
-
getName
string name = 1 [json_name = "name"];
- Specified by:
getName
in interfaceApiOrBuilder
- Returns:
- The name.
-
getNameBytes
string name = 1 [json_name = "name"];
- Specified by:
getNameBytes
in interfaceApiOrBuilder
- Returns:
- The bytes for name.
-
getMethodsList
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];
- Specified by:
getMethodsList
in interfaceApiOrBuilder
-
getMethodsOrBuilderList
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];
- Specified by:
getMethodsOrBuilderList
in interfaceApiOrBuilder
-
getMethodsCount
public int getMethodsCount()repeated .google.protobuf.Method methods = 2 [json_name = "methods"];
- Specified by:
getMethodsCount
in interfaceApiOrBuilder
-
getMethods
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];
- Specified by:
getMethods
in interfaceApiOrBuilder
-
getMethodsOrBuilder
repeated .google.protobuf.Method methods = 2 [json_name = "methods"];
- Specified by:
getMethodsOrBuilder
in interfaceApiOrBuilder
-
getOptionsList
repeated .google.protobuf.Option options = 3 [json_name = "options"];
- Specified by:
getOptionsList
in interfaceApiOrBuilder
-
getOptionsOrBuilderList
repeated .google.protobuf.Option options = 3 [json_name = "options"];
- Specified by:
getOptionsOrBuilderList
in interfaceApiOrBuilder
-
getOptionsCount
public int getOptionsCount()repeated .google.protobuf.Option options = 3 [json_name = "options"];
- Specified by:
getOptionsCount
in interfaceApiOrBuilder
-
getOptions
repeated .google.protobuf.Option options = 3 [json_name = "options"];
- Specified by:
getOptions
in interfaceApiOrBuilder
-
getOptionsOrBuilder
repeated .google.protobuf.Option options = 3 [json_name = "options"];
- Specified by:
getOptionsOrBuilder
in interfaceApiOrBuilder
-
getVersion
string version = 4 [json_name = "version"];
- Specified by:
getVersion
in interfaceApiOrBuilder
- Returns:
- The version.
-
getVersionBytes
string version = 4 [json_name = "version"];
- Specified by:
getVersionBytes
in interfaceApiOrBuilder
- Returns:
- The bytes for version.
-
hasSourceContext
public boolean hasSourceContext().google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];
- Specified by:
hasSourceContext
in interfaceApiOrBuilder
- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];
- Specified by:
getSourceContext
in interfaceApiOrBuilder
- Returns:
- The sourceContext.
-
getSourceContextOrBuilder
.google.protobuf.SourceContext source_context = 5 [json_name = "sourceContext"];
- Specified by:
getSourceContextOrBuilder
in interfaceApiOrBuilder
-
getMixinsList
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];
- Specified by:
getMixinsList
in interfaceApiOrBuilder
-
getMixinsOrBuilderList
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];
- Specified by:
getMixinsOrBuilderList
in interfaceApiOrBuilder
-
getMixinsCount
public int getMixinsCount()repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];
- Specified by:
getMixinsCount
in interfaceApiOrBuilder
-
getMixins
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];
- Specified by:
getMixins
in interfaceApiOrBuilder
-
getMixinsOrBuilder
repeated .google.protobuf.Mixin mixins = 6 [json_name = "mixins"];
- Specified by:
getMixinsOrBuilder
in interfaceApiOrBuilder
-
getSyntaxValue
public int getSyntaxValue().google.protobuf.Syntax syntax = 7 [json_name = "syntax"];
- Specified by:
getSyntaxValue
in interfaceApiOrBuilder
- Returns:
- The enum numeric value on the wire for syntax.
-
getSyntax
.google.protobuf.Syntax syntax = 7 [json_name = "syntax"];
- Specified by:
getSyntax
in interfaceApiOrBuilder
- Returns:
- The syntax.
-
isInitialized
public final boolean isInitialized()Description copied from interface:MessageLiteOrBuilder
Returns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessage
-
writeTo
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Overrides:
writeTo
in classGeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLite
Get 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:
getSerializedSize
in interfaceMessageLite
- Overrides:
getSerializedSize
in classGeneratedMessage
-
equals
Description copied from interface:Message
Compares the specified object with this message for equality. Returnstrue
if 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:
equals
in interfaceMessage
- Overrides:
equals
in classAbstractMessage
- Parameters:
obj
- object to be compared for equality with this message- Returns:
true
if the specified object is equal to this message
-
hashCode
public int hashCode()Description copied from interface:Message
Returns 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:
hashCode
in interfaceMessage
- Overrides:
hashCode
in 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:MessageLite
Constructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForType
in interfaceMessage
- Specified by:
newBuilderForType
in interfaceMessageLite
-
newBuilder
-
newBuilder
-
toBuilder
Description copied from interface:MessageLite
Constructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilder
in interfaceMessage
- Specified by:
toBuilder
in interfaceMessageLite
-
newBuilderForType
Description copied from class:AbstractMessage
Create a nested builder.- Overrides:
newBuilderForType
in classAbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from class:GeneratedMessage
TODO: Remove this unnecessary intermediate implementation of this method.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classGeneratedMessage
-
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilder
Get 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 theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-