public final class Api extends GeneratedMessageLite<Api,Api.Builder> implements ApiOrBuilder
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
Modifier and Type | Class and Description |
---|---|
static class |
Api.Builder
Api is a light-weight descriptor for an API Interface.
|
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.GeneratedExtension<ContainingType extends MessageLite,Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
METHODS_FIELD_NUMBER |
static int |
MIXINS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
OPTIONS_FIELD_NUMBER |
static int |
SOURCE_CONTEXT_FIELD_NUMBER |
static int |
SYNTAX_FIELD_NUMBER |
static int |
VERSION_FIELD_NUMBER |
memoizedSerializedSize, unknownFields
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
protected Object |
dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
Object arg0,
Object arg1)
A method that implements different types of operations described in
GeneratedMessageLite.MethodToInvoke . |
static Api |
getDefaultInstance() |
Method |
getMethods(int index)
The methods of this interface, in unspecified order.
|
int |
getMethodsCount()
The methods of this interface, in unspecified order.
|
List<Method> |
getMethodsList()
The methods of this interface, in unspecified order.
|
MethodOrBuilder |
getMethodsOrBuilder(int index)
The methods of this interface, in unspecified order.
|
List<? extends MethodOrBuilder> |
getMethodsOrBuilderList()
The methods of this interface, in unspecified order.
|
Mixin |
getMixins(int index)
Included interfaces.
|
int |
getMixinsCount()
Included interfaces.
|
List<Mixin> |
getMixinsList()
Included interfaces.
|
MixinOrBuilder |
getMixinsOrBuilder(int index)
Included interfaces.
|
List<? extends MixinOrBuilder> |
getMixinsOrBuilderList()
Included interfaces.
|
String |
getName()
The fully qualified name of this interface, including package name
followed by the interface's simple name.
|
ByteString |
getNameBytes()
The fully qualified name of this interface, including package name
followed by the interface's simple name.
|
Option |
getOptions(int index)
Any metadata attached to the interface.
|
int |
getOptionsCount()
Any metadata attached to the interface.
|
List<Option> |
getOptionsList()
Any metadata attached to the interface.
|
OptionOrBuilder |
getOptionsOrBuilder(int index)
Any metadata attached to the interface.
|
List<? extends OptionOrBuilder> |
getOptionsOrBuilderList()
Any metadata attached to the interface.
|
SourceContext |
getSourceContext()
Source context for the protocol buffer service represented by this
message.
|
Syntax |
getSyntax()
The source syntax of the service.
|
int |
getSyntaxValue()
The source syntax of the service.
|
String |
getVersion()
A version string for this interface.
|
ByteString |
getVersionBytes()
A version string for this interface.
|
boolean |
hasSourceContext()
Source context for the protocol buffer service represented by this
message.
|
static Api.Builder |
newBuilder() |
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(ByteBuffer data) |
static Api |
parseFrom(ByteBuffer 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 Parser<Api> |
parser() |
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getDefaultInstanceForType, isInitialized
public static final int NAME_FIELD_NUMBER
public static final int METHODS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
public static final int SOURCE_CONTEXT_FIELD_NUMBER
public static final int MIXINS_FIELD_NUMBER
public static final int SYNTAX_FIELD_NUMBER
public String getName()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getName
in interface ApiOrBuilder
public ByteString getNameBytes()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getNameBytes
in interface ApiOrBuilder
public List<Method> getMethodsList()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethodsList
in interface ApiOrBuilder
public List<? extends MethodOrBuilder> getMethodsOrBuilderList()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public int getMethodsCount()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethodsCount
in interface ApiOrBuilder
public Method getMethods(int index)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethods
in interface ApiOrBuilder
public MethodOrBuilder getMethodsOrBuilder(int index)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public List<Option> getOptionsList()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptionsList
in interface ApiOrBuilder
public List<? extends OptionOrBuilder> getOptionsOrBuilderList()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public int getOptionsCount()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptionsCount
in interface ApiOrBuilder
public Option getOptions(int index)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptions
in interface ApiOrBuilder
public OptionOrBuilder getOptionsOrBuilder(int index)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public String 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;
getVersion
in interface ApiOrBuilder
public ByteString 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;
getVersionBytes
in interface ApiOrBuilder
public boolean hasSourceContext()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
hasSourceContext
in interface ApiOrBuilder
public SourceContext getSourceContext()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
getSourceContext
in interface ApiOrBuilder
public List<Mixin> getMixinsList()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsList
in interface ApiOrBuilder
public List<? extends MixinOrBuilder> getMixinsOrBuilderList()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public int getMixinsCount()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsCount
in interface ApiOrBuilder
public Mixin getMixins(int index)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixins
in interface ApiOrBuilder
public MixinOrBuilder getMixinsOrBuilder(int index)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public int getSyntaxValue()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
getSyntaxValue
in interface ApiOrBuilder
public Syntax getSyntax()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
getSyntax
in interface ApiOrBuilder
public static Api parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Api parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Api parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Api parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Api parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Api parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Api parseFrom(InputStream input) throws IOException
IOException
public static Api parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Api parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Api parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Api parseFrom(CodedInputStream input) throws IOException
IOException
public static Api parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Api.Builder newBuilder()
public static Api.Builder newBuilder(Api prototype)
protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
GeneratedMessageLite
GeneratedMessageLite.MethodToInvoke
.
Theses 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. See MAKE_IMMUTABLE
.
IS_INITIALIZED
returns null
for false and the default instance for true.
It doesn't use or modify any memoized value.
GET_MEMOIZED_IS_INITIALIZED
returns the memoized isInitialized
byte
value.
SET_MEMOIZED_IS_INITIALIZED
sets the memoized isInitilaized
byte value to
1 if the first parameter is not null, or to 0 if the first parameter is null.
NEW_BUILDER
returns a BuilderType
instance.
For use by generated code only.
dynamicMethod
in class GeneratedMessageLite<Api,Api.Builder>
public static Api getDefaultInstance()
Copyright © 2008–2021. All rights reserved.