Package com.google.protobuf
Class Api
- All Implemented Interfaces:
ApiOrBuilder
,MessageLite
,MessageLiteOrBuilder
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
-
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.GeneratedMessageLite
GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,
?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageLite.ExtensionDescriptor, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite, Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final Api
private Internal.ProtobufList
<Method> static final int
private Internal.ProtobufList
<Mixin> static final int
private String
static final int
private Internal.ProtobufList
<Option> static final int
static final int
private SourceContext
private int
static final int
private String
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageLite
UNINITIALIZED_HASH_CODE, UNINITIALIZED_SERIALIZED_SIZE, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addAllMethods
(Iterable<? extends Method> values) The methods of this interface, in unspecified order.private void
addAllMixins
(Iterable<? extends Mixin> values) Included interfaces.private void
addAllOptions
(Iterable<? extends Option> values) Any metadata attached to the interface.private void
addMethods
(int index, Method value) The methods of this interface, in unspecified order.private void
addMethods
(Method value) The methods of this interface, in unspecified order.private void
Included interfaces.private void
Included interfaces.private void
addOptions
(int index, Option value) Any metadata attached to the interface.private void
addOptions
(Option value) Any metadata attached to the interface.private void
The methods of this interface, in unspecified order.private void
Included interfaces.private void
The fully qualified name of this interface, including package name followed by the interface's simple name.private void
Any metadata attached to the interface.private void
Source context for the protocol buffer service represented by this message.private void
The source syntax of the service.private void
A version string for this interface.protected final Object
dynamicMethod
(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
.private void
private void
private void
static Api
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.Source context for the protocol buffer service represented by this message.The source syntax of the service.int
The source syntax of the service.A version string for this interface.A version string for this interface.boolean
Source context for the protocol buffer service represented by this message.private void
mergeSourceContext
(SourceContext value) Source context for the protocol buffer service represented by this message.static Api.Builder
static Api.Builder
newBuilder
(Api prototype) 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()
private void
removeMethods
(int index) The methods of this interface, in unspecified order.private void
removeMixins
(int index) Included interfaces.private void
removeOptions
(int index) Any metadata attached to the interface.private void
setMethods
(int index, Method value) The methods of this interface, in unspecified order.private void
Included interfaces.private void
The fully qualified name of this interface, including package name followed by the interface's simple name.private void
setNameBytes
(ByteString value) The fully qualified name of this interface, including package name followed by the interface's simple name.private void
setOptions
(int index, Option value) Any metadata attached to the interface.private void
setSourceContext
(SourceContext value) Source context for the protocol buffer service represented by this message.private void
The source syntax of the service.private void
setSyntaxValue
(int value) The source syntax of the service.private void
setVersion
(String value) A version string for this interface.private void
setVersionBytes
(ByteString value) A version string for this interface.Methods inherited from class com.google.protobuf.GeneratedMessageLite
buildMessageInfo, clearMemoizedHashCode, clearMemoizedSerializedSize, computeHashCode, createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstance, getDefaultInstanceForType, getMemoizedHashCode, getMemoizedSerializedSize, getMethodOrDie, getParserForType, getSerializedSize, getSerializedSize, hashCode, hashCodeIsNotMemoized, invokeOrDie, isInitialized, isInitialized, isMutable, makeImmutable, markImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newMutableInstance, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, setMemoizedHashCode, setMemoizedSerializedSize, toBuilder, toString, writeTo
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, newUninitializedMessageException, 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.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
bitField0_
private int bitField0_ -
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_ -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Api
private Api()
-
-
Method Details
-
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.
-
setName
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
- Parameters:
value
- The name to set.
-
clearName
private void clearName()The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
-
setNameBytes
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
- Parameters:
value
- The bytes for name to set.
-
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;
-
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;
-
ensureMethodsIsMutable
private void ensureMethodsIsMutable() -
setMethods
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
-
addMethods
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
-
addMethods
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
-
addAllMethods
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
-
clearMethods
private void clearMethods()The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
-
removeMethods
private void removeMethods(int index) The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
-
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;
-
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;
-
ensureOptionsIsMutable
private void ensureOptionsIsMutable() -
setOptions
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
-
addOptions
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
-
addOptions
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
-
addAllOptions
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
-
clearOptions
private void clearOptions()Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
-
removeOptions
private void removeOptions(int index) Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
-
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.
-
setVersion
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;
- Parameters:
value
- The version to set.
-
clearVersion
private void clearVersion()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;
-
setVersionBytes
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;
- Parameters:
value
- The bytes for version to set.
-
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.
-
setSourceContext
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
-
mergeSourceContext
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
-
clearSourceContext
private void clearSourceContext()Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
-
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;
-
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;
-
ensureMixinsIsMutable
private void ensureMixinsIsMutable() -
setMixins
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
-
addMixins
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
-
addMixins
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
-
addAllMixins
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
-
clearMixins
private void clearMixins()Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
-
removeMixins
private void removeMixins(int index) Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
-
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.
-
setSyntaxValue
private void setSyntaxValue(int value) The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
- Parameters:
value
- The enum numeric value on the wire for syntax to set.
-
setSyntax
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
- Parameters:
value
- The syntax to set.
-
clearSyntax
private void clearSyntax()The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
-
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
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) Description copied from class:GeneratedMessageLite
A method that implements different types of operations described inGeneratedMessageLite.MethodToInvoke
. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.NEW_INSTANCE
returns a new instance of the protocol buffer that has not yet been made immutable. SeeMAKE_IMMUTABLE
.IS_INITIALIZED
returnsnull
for false and the default instance for true. It doesn't use or modify any memoized value.GET_MEMOIZED_IS_INITIALIZED
returns the memoizedisInitialized
byte value.SET_MEMOIZED_IS_INITIALIZED
sets the memoizedisInitialized
byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.NEW_BUILDER
returns aBuilderType
instance.
For use by generated code only.
- Specified by:
dynamicMethod
in classGeneratedMessageLite<Api,
Api.Builder>
-
getDefaultInstance
-
parser
-