Package com.google.protobuf
Class Api
- All Implemented Interfaces:
ApiOrBuilder
,Message
,MessageLite
,MessageLiteOrBuilder
,MessageOrBuilder
,Serializable
Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.Protobuf type
google.protobuf.Api
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Api is a light-weight descriptor for an API Interface.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,
BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Api
private byte
static final int
static final int
private Object
static final int
static final int
private static final long
static final int
private SourceContext
private int
static final int
private Object
static final int
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
-
Constructor Summary
Constructors -
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) The methods of this interface, in unspecified order.int
The methods of this interface, in unspecified order.The methods of this interface, in unspecified order.getMethodsOrBuilder
(int index) The methods of this interface, in unspecified order.List
<? extends MethodOrBuilder> The methods of this interface, in unspecified order.getMixins
(int index) Included interfaces.int
Included interfaces.Included interfaces.getMixinsOrBuilder
(int index) Included interfaces.List
<? extends MixinOrBuilder> Included interfaces.getName()
The fully qualified name of this interface, including package name followed by the interface's simple name.The fully qualified name of this interface, including package name followed by the interface's simple name.getOptions
(int index) Any metadata attached to the interface.int
Any metadata attached to the interface.Any metadata attached to the interface.getOptionsOrBuilder
(int index) Any metadata attached to the interface.List
<? extends OptionOrBuilder> Any metadata attached to the interface.Gets the parser for a message of the same type as this message.int
Get the number of bytes required to encode this message.Source context for the protocol buffer service represented by this message.Source context for the protocol buffer service represented by this message.The source syntax of the service.int
The source syntax of the service.final UnknownFieldSet
Get theUnknownFieldSet
for this message.A version string for this interface.A version string for this interface.int
hashCode()
Returns the hash code value for this message.boolean
Source context for the protocol buffer service represented by this message.protected GeneratedMessageV3.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
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.protected Object
Creates a new instance of this message type.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.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, getSerializedSize, 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, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
METHODS_FIELD_NUMBER
public static final int METHODS_FIELD_NUMBER- See Also:
-
methods_
-
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER- See Also:
-
options_
-
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER- See Also:
-
version_
-
SOURCE_CONTEXT_FIELD_NUMBER
public static final int SOURCE_CONTEXT_FIELD_NUMBER- See Also:
-
sourceContext_
-
MIXINS_FIELD_NUMBER
public static final int MIXINS_FIELD_NUMBER- See Also:
-
mixins_
-
SYNTAX_FIELD_NUMBER
public static final int SYNTAX_FIELD_NUMBER- See Also:
-
syntax_
private int syntax_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Api
-
Api
private Api()
-
-
Method Details
-
newInstance
Description copied from class:GeneratedMessageV3
Creates a new instance of this message type. Overridden in the generated code.- Overrides:
newInstance
in classGeneratedMessageV3
-
getUnknownFields
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message.- Specified by:
getUnknownFields
in interfaceMessageOrBuilder
- Overrides:
getUnknownFields
in classGeneratedMessageV3
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3
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 classGeneratedMessageV3
-
getName
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
- Specified by:
getName
in interfaceApiOrBuilder
- Returns:
- The name.
-
getNameBytes
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
- Specified by:
getNameBytes
in interfaceApiOrBuilder
- Returns:
- The bytes for name.
-
getMethodsList
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethodsList
in interfaceApiOrBuilder
-
getMethodsOrBuilderList
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethodsOrBuilderList
in interfaceApiOrBuilder
-
getMethodsCount
public int getMethodsCount()The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethodsCount
in interfaceApiOrBuilder
-
getMethods
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethods
in interfaceApiOrBuilder
-
getMethodsOrBuilder
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethodsOrBuilder
in interfaceApiOrBuilder
-
getOptionsList
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsList
in interfaceApiOrBuilder
-
getOptionsOrBuilderList
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsOrBuilderList
in interfaceApiOrBuilder
-
getOptionsCount
public int getOptionsCount()Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsCount
in interfaceApiOrBuilder
-
getOptions
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptions
in interfaceApiOrBuilder
-
getOptionsOrBuilder
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsOrBuilder
in interfaceApiOrBuilder
-
getVersion
A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
string version = 4;
- Specified by:
getVersion
in interfaceApiOrBuilder
- Returns:
- The version.
-
getVersionBytes
A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
string version = 4;
- Specified by:
getVersionBytes
in interfaceApiOrBuilder
- Returns:
- The bytes for version.
-
hasSourceContext
public boolean hasSourceContext()Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
- Specified by:
hasSourceContext
in interfaceApiOrBuilder
- Returns:
- Whether the sourceContext field is set.
-
getSourceContext
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
- Specified by:
getSourceContext
in interfaceApiOrBuilder
- Returns:
- The sourceContext.
-
getSourceContextOrBuilder
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
- Specified by:
getSourceContextOrBuilder
in interfaceApiOrBuilder
-
getMixinsList
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixinsList
in interfaceApiOrBuilder
-
getMixinsOrBuilderList
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixinsOrBuilderList
in interfaceApiOrBuilder
-
getMixinsCount
public int getMixinsCount()Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixinsCount
in interfaceApiOrBuilder
-
getMixins
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixins
in interfaceApiOrBuilder
-
getMixinsOrBuilder
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixinsOrBuilder
in interfaceApiOrBuilder
-
getSyntaxValue
public int getSyntaxValue()The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
- Specified by:
getSyntaxValue
in interfaceApiOrBuilder
- Returns:
- The enum numeric value on the wire for syntax.
-
getSyntax
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
- 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 classGeneratedMessageV3
-
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 classGeneratedMessageV3
- 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 classGeneratedMessageV3
-
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:GeneratedMessageV3
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.- Specified by:
newBuilderForType
in classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from interface:MessageLite
Gets the parser for a message of the same type as this message.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classGeneratedMessageV3
-
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
-