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
Implements
ApiOrBuilderStatic Fields
METHODS_FIELD_NUMBER
public
static
final
int
METHODS_FIELD_NUMBER
MIXINS_FIELD_NUMBER
public
static
final
int
MIXINS_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
OPTIONS_FIELD_NUMBER
public
static
final
int
OPTIONS_FIELD_NUMBER
SOURCE_CONTEXT_FIELD_NUMBER
public
static
final
int
SOURCE_CONTEXT_FIELD_NUMBER
SYNTAX_FIELD_NUMBER
public
static
final
int
SYNTAX_FIELD_NUMBER
VERSION_FIELD_NUMBER
public
static
final
int
VERSION_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Api
getDefaultInstance
()
newBuilder()
public
static
Api
.
Builder
newBuilder
()
newBuilder(Api prototype)
public
static
Api
.
Builder
newBuilder
(
Api
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Api
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Api
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Api
parseFrom
(
byte
[]
data
)
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Api
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Api
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Api
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Api
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Api
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Api
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Api
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Api
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Api
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Api>
parser
()
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_INSTANCEreturns a new instance of the protocol buffer that has not yet been made immutable. SeeMAKE_IMMUTABLE. -
IS_INITIALIZEDreturnsnullfor false and the default instance for true. It doesn't use or modify any memoized value. -
GET_MEMOIZED_IS_INITIALIZEDreturns the memoizedisInitializedbyte value. -
SET_MEMOIZED_IS_INITIALIZEDsets the memoizedisInitializedbyte value to 1 if the first parameter is not null, or to 0 if the first parameter is null. -
NEW_BUILDERreturns aBuilderTypeinstance.
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.
getMethods(int index)
public
Method
getMethods
(
int
index
)
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;
getMethodsList()
public
List<Method>
getMethodsList
()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethodsOrBuilder(int index)
public
MethodOrBuilder
getMethodsOrBuilder
(
int
index
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethodsOrBuilderList()
public
List
< ?
extends
MethodOrBuilder
>
getMethodsOrBuilderList
()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMixins(int index)
public
Mixin
getMixins
(
int
index
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsCount()
public
int
getMixinsCount
()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsList()
public
List<Mixin>
getMixinsList
()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsOrBuilder(int index)
public
MixinOrBuilder
getMixinsOrBuilder
(
int
index
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsOrBuilderList()
public
List
< ?
extends
MixinOrBuilder
>
getMixinsOrBuilderList
()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getName()
public
String
getName
()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getNameBytes()
public
ByteString
getNameBytes
()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getOptions(int index)
public
Option
getOptions
(
int
index
)
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;
getOptionsList()
public
List<Option>
getOptionsList
()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptionsOrBuilder(int index)
public
OptionOrBuilder
getOptionsOrBuilder
(
int
index
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptionsOrBuilderList()
public
List
< ?
extends
OptionOrBuilder
>
getOptionsOrBuilderList
()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getSourceContext()
public
SourceContext
getSourceContext
()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
getSyntax()
public
Syntax
getSyntax
()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
getSyntaxValue()
public
int
getSyntaxValue
()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
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;
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;
hasSourceContext()
public
boolean
hasSourceContext
()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
