Class Api (3.19.4)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > GeneratedMessageLite > Api

Implements

ApiOrBuilder

Inherited Members

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageLite.<ContainingType,Type>newRepeatedGeneratedExtension(ContainingType,MessageLite,Internal.EnumLiteMap<?>,int,WireFormat.FieldType,boolean,Class)

GeneratedMessageLite.<ContainingType,Type>newSingularGeneratedExtension(ContainingType,Type,MessageLite,Internal.EnumLiteMap<?>,int,WireFormat.FieldType,Class)

GeneratedMessageLite.<E>emptyProtobufList()

GeneratedMessageLite.<E>mutableCopy(Internal.ProtobufList<E>)

GeneratedMessageLite.<MessageType,BuilderType>createBuilder()

GeneratedMessageLite.<MessageType,BuilderType>createBuilder(MessageType)

GeneratedMessageLite.<T>isInitialized(T,boolean)

GeneratedMessageLite.<T>parseDelimitedFrom(T,InputStream)

GeneratedMessageLite.<T>parseDelimitedFrom(T,InputStream,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,byte[])

GeneratedMessageLite.<T>parseFrom(T,byte[],ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,ByteString)

GeneratedMessageLite.<T>parseFrom(T,ByteString,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,CodedInputStream)

GeneratedMessageLite.<T>parseFrom(T,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,InputStream)

GeneratedMessageLite.<T>parseFrom(T,InputStream,ExtensionRegistryLite)

GeneratedMessageLite.<T>parseFrom(T,ByteBuffer)

GeneratedMessageLite.<T>parseFrom(T,ByteBuffer,ExtensionRegistryLite)

GeneratedMessageLite.<T>parsePartialFrom(T,CodedInputStream)

GeneratedMessageLite.<T>registerDefaultInstance(Class<T>,T)

GeneratedMessageLite.dynamicMethod(GeneratedMessageLite.MethodToInvoke)

GeneratedMessageLite.dynamicMethod(GeneratedMessageLite.MethodToInvoke,Object)

GeneratedMessageLite.dynamicMethod(GeneratedMessageLite.MethodToInvoke,Object,Object)

GeneratedMessageLite.emptyBooleanList()

GeneratedMessageLite.emptyDoubleList()

GeneratedMessageLite.emptyFloatList()

GeneratedMessageLite.emptyIntList()

GeneratedMessageLite.emptyLongList()

GeneratedMessageLite.equals(Object)

GeneratedMessageLite.getDefaultInstanceForType()

GeneratedMessageLite.getParserForType()

GeneratedMessageLite.getSerializedSize()

GeneratedMessageLite.hashCode()

GeneratedMessageLite.isInitialized()

GeneratedMessageLite.makeImmutable()

GeneratedMessageLite.mergeLengthDelimitedField(int,ByteString)

GeneratedMessageLite.mergeUnknownFields(UnknownFieldSetLite)

GeneratedMessageLite.mergeVarintField(int,int)

GeneratedMessageLite.mutableCopy(Internal.BooleanList)

GeneratedMessageLite.mutableCopy(Internal.DoubleList)

GeneratedMessageLite.mutableCopy(Internal.FloatList)

GeneratedMessageLite.mutableCopy(Internal.IntList)

GeneratedMessageLite.mutableCopy(Internal.LongList)

GeneratedMessageLite.newBuilderForType()

GeneratedMessageLite.newMessageInfo(MessageLite,String,Object[])

GeneratedMessageLite.parseUnknownField(int,CodedInputStream)

GeneratedMessageLite.toBuilder()

GeneratedMessageLite.toString()

GeneratedMessageLite.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

METHODS_FIELD_NUMBER

public static final int METHODS_FIELD_NUMBER

Field Value
Type	Description
int

MIXINS_FIELD_NUMBER

public static final int MIXINS_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

SOURCE_CONTEXT_FIELD_NUMBER

public static final int SOURCE_CONTEXT_FIELD_NUMBER

Field Value
Type	Description
int

SYNTAX_FIELD_NUMBER

public static final int SYNTAX_FIELD_NUMBER

Field Value
Type	Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Api getDefaultInstance()

Returns
Type	Description
Api

newBuilder()

public static Api.Builder newBuilder()

Returns
Type	Description
Api.Builder

newBuilder(Api prototype)

public static Api.Builder newBuilder(Api prototype)

Parameter
Name	Description
prototype	Api

Returns
Type	Description
Api.Builder

parseDelimitedFrom(InputStream input)

public static Api parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Api

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Api parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Api

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Api parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Api

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Api parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Api

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Api parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Api

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Api parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Api

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Api parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Api

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Api parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Api

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Api parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Api

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Api parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Api

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Api parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Api

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Api parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Api

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Api> parser()

Returns
Type	Description
Parser<Api>

Methods

dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

A method that implements different types of operations described in 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. 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 isInitialized 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.

This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

For use by generated code only.

Parameters
Name	Description
method	GeneratedMessageLite.MethodToInvoke
arg0	Object
arg1	Object

Returns
Type	Description
Object

Overrides

GeneratedMessageLite<MessageType,BuilderType>.dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)

getMethods(int index)

public Method getMethods(int index)

The methods of this interface, in unspecified order.

repeated .google.protobuf.Method methods = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Method

getMethodsCount()

public int getMethodsCount()

The methods of this interface, in unspecified order.

repeated .google.protobuf.Method methods = 2;

Returns
Type	Description
int

getMethodsList()

public List<Method> getMethodsList()

The methods of this interface, in unspecified order.

repeated .google.protobuf.Method methods = 2;

Returns
Type	Description
List<Method>

getMethodsOrBuilder(int index)

public MethodOrBuilder getMethodsOrBuilder(int index)

The methods of this interface, in unspecified order.

repeated .google.protobuf.Method methods = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
MethodOrBuilder

getMethodsOrBuilderList()

public List<? extends MethodOrBuilder> getMethodsOrBuilderList()

The methods of this interface, in unspecified order.

repeated .google.protobuf.Method methods = 2;

Returns
Type	Description
List<? extends com.google.protobuf.MethodOrBuilder>

getMixins(int index)

public Mixin getMixins(int index)

Included interfaces. See [Mixin][].

repeated .google.protobuf.Mixin mixins = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Mixin

getMixinsCount()

public int getMixinsCount()

Included interfaces. See [Mixin][].

repeated .google.protobuf.Mixin mixins = 6;

Returns
Type	Description
int

getMixinsList()

public List<Mixin> getMixinsList()

Included interfaces. See [Mixin][].

repeated .google.protobuf.Mixin mixins = 6;

Returns
Type	Description
List<Mixin>

getMixinsOrBuilder(int index)

public MixinOrBuilder getMixinsOrBuilder(int index)

Included interfaces. See [Mixin][].

repeated .google.protobuf.Mixin mixins = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
MixinOrBuilder

getMixinsOrBuilderList()

public List<? extends MixinOrBuilder> getMixinsOrBuilderList()

Included interfaces. See [Mixin][].

repeated .google.protobuf.Mixin mixins = 6;

Returns
Type	Description
List<? extends com.google.protobuf.MixinOrBuilder>

getName()

public String getName()

The fully qualified name of this interface, including package name followed by the interface's simple name.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The fully qualified name of this interface, including package name followed by the interface's simple name.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOptions(int index)

public Option getOptions(int index)

Any metadata attached to the interface.

repeated .google.protobuf.Option options = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
Option

getOptionsCount()

public int getOptionsCount()

Any metadata attached to the interface.

repeated .google.protobuf.Option options = 3;

Returns
Type	Description
int

getOptionsList()

public List<Option> getOptionsList()

Any metadata attached to the interface.

repeated .google.protobuf.Option options = 3;

Returns
Type	Description
List<Option>

getOptionsOrBuilder(int index)

public OptionOrBuilder getOptionsOrBuilder(int index)

Any metadata attached to the interface.

repeated .google.protobuf.Option options = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
OptionOrBuilder

getOptionsOrBuilderList()

public List<? extends OptionOrBuilder> getOptionsOrBuilderList()

Any metadata attached to the interface.

repeated .google.protobuf.Option options = 3;

Returns
Type	Description
List<? extends com.google.protobuf.OptionOrBuilder>

getSourceContext()

public SourceContext getSourceContext()

Source context for the protocol buffer service represented by this message.

.google.protobuf.SourceContext source_context = 5;

Returns
Type	Description
SourceContext

getSyntax()

public Syntax getSyntax()

The source syntax of the service.

.google.protobuf.Syntax syntax = 7;

Returns
Type	Description
Syntax	The syntax.

getSyntaxValue()

public int getSyntaxValue()

The source syntax of the service.

.google.protobuf.Syntax syntax = 7;

Returns
Type	Description
int	The enum numeric value on the wire for syntax.

getVersion()

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 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;

Returns
Type	Description
String	The version.

getVersionBytes()

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 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;

Returns
Type	Description
ByteString	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;

Returns
Type	Description
boolean