Api

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.protobuf.Api

All Implemented Interfaces:

ApiOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable
```
public final class Api
extends GeneratedMessage
implements ApiOrBuilder
```
Protobuf type google.protobuf.Api
```
 Api is a light-weight descriptor for a protocol buffer service.
 
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Api.Builder
Protobuf type google.protobuf.Api
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
  GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Api.Builder` Protobuf type `google.protobuf.Api`

Field Summary

Fields
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`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Compares the specified object with this message for equality.
`static Api`	`getDefaultInstance()`
`Api`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Method`	`getMethods(int index)` `repeated .google.protobuf.Method methods = 2;`
`int`	`getMethodsCount()` `repeated .google.protobuf.Method methods = 2;`
`java.util.List<Method>`	`getMethodsList()` `repeated .google.protobuf.Method methods = 2;`
`MethodOrBuilder`	`getMethodsOrBuilder(int index)` `repeated .google.protobuf.Method methods = 2;`
`java.util.List<? extends MethodOrBuilder>`	`getMethodsOrBuilderList()` `repeated .google.protobuf.Method methods = 2;`
`Mixin`	`getMixins(int index)` `repeated .google.protobuf.Mixin mixins = 6;`
`int`	`getMixinsCount()` `repeated .google.protobuf.Mixin mixins = 6;`
`java.util.List<Mixin>`	`getMixinsList()` `repeated .google.protobuf.Mixin mixins = 6;`
`MixinOrBuilder`	`getMixinsOrBuilder(int index)` `repeated .google.protobuf.Mixin mixins = 6;`
`java.util.List<? extends MixinOrBuilder>`	`getMixinsOrBuilderList()` `repeated .google.protobuf.Mixin mixins = 6;`
`java.lang.String`	`getName()` `optional string name = 1;`
`ByteString`	`getNameBytes()` `optional string name = 1;`
`Option`	`getOptions(int index)` `repeated .google.protobuf.Option options = 3;`
`int`	`getOptionsCount()` `repeated .google.protobuf.Option options = 3;`
`java.util.List<Option>`	`getOptionsList()` `repeated .google.protobuf.Option options = 3;`
`OptionOrBuilder`	`getOptionsOrBuilder(int index)` `repeated .google.protobuf.Option options = 3;`
`java.util.List<? extends OptionOrBuilder>`	`getOptionsOrBuilderList()` `repeated .google.protobuf.Option options = 3;`
`Parser<Api>`	`getParserForType()` Gets the parser for a message of the same type as this message.
`int`	`getSerializedSize()` Get the number of bytes required to encode this message.
`SourceContext`	`getSourceContext()` `optional .google.protobuf.SourceContext source_context = 5;`
`SourceContextOrBuilder`	`getSourceContextOrBuilder()` `optional .google.protobuf.SourceContext source_context = 5;`
`Syntax`	`getSyntax()` `optional .google.protobuf.Syntax syntax = 7;`
`int`	`getSyntaxValue()` `optional .google.protobuf.Syntax syntax = 7;`
`UnknownFieldSet`	`getUnknownFields()` Get the `UnknownFieldSet` for this message.
`java.lang.String`	`getVersion()` `optional string version = 4;`
`ByteString`	`getVersionBytes()` `optional string version = 4;`
`int`	`hashCode()` Returns the hash code value for this message.
`boolean`	`hasSourceContext()` `optional .google.protobuf.SourceContext source_context = 5;`
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`static Api.Builder`	`newBuilder()`
`static Api.Builder`	`newBuilder(Api prototype)`
`Api.Builder`	`newBuilderForType()` Constructs a new builder for a message of the same type as this message.
`static Api`	`parseDelimitedFrom(java.io.InputStream input)`
`static Api`	`parseDelimitedFrom(java.io.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(java.io.InputStream input)`
`static Api`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Api>`	`parser()`
`Api.Builder`	`toBuilder()` Constructs a builder initialized with the current message.
`void`	`writeTo(CodedOutputStream output)` Serializes the message and writes it to `output`.

Methods inherited from class com.google.protobuf.GeneratedMessage
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - METHODS_FIELD_NUMBER
```
public static final int METHODS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - OPTIONS_FIELD_NUMBER
```
public static final int OPTIONS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - VERSION_FIELD_NUMBER
```
public static final int VERSION_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SOURCE_CONTEXT_FIELD_NUMBER
```
public static final int SOURCE_CONTEXT_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - MIXINS_FIELD_NUMBER
```
public static final int MIXINS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SYNTAX_FIELD_NUMBER
```
public static final int SYNTAX_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class GeneratedMessage
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - getName
```
public java.lang.String getName()
```
    optional string name = 1;
```
 The fully qualified name of this api, including package name
 followed by the api's simple name.
 
```
    Specified by:
    
    getName in interface ApiOrBuilder
  - getNameBytes
```
public ByteString getNameBytes()
```
    optional string name = 1;
```
 The fully qualified name of this api, including package name
 followed by the api's simple name.
 
```
    Specified by:
    
    getNameBytes in interface ApiOrBuilder
  - getMethodsList
```
public java.util.List<Method> getMethodsList()
```
    repeated .google.protobuf.Method methods = 2;
```
 The methods of this api, in unspecified order.
 
```
    Specified by:
    
    getMethodsList in interface ApiOrBuilder
  - getMethodsOrBuilderList
```
public java.util.List<? extends MethodOrBuilder> getMethodsOrBuilderList()
```
    repeated .google.protobuf.Method methods = 2;
```
 The methods of this api, in unspecified order.
 
```
    Specified by:
    
    getMethodsOrBuilderList in interface ApiOrBuilder
  - getMethodsCount
```
public int getMethodsCount()
```
    repeated .google.protobuf.Method methods = 2;
```
 The methods of this api, in unspecified order.
 
```
    Specified by:
    
    getMethodsCount in interface ApiOrBuilder
  - getMethods
```
public Method getMethods(int index)
```
    repeated .google.protobuf.Method methods = 2;
```
 The methods of this api, in unspecified order.
 
```
    Specified by:
    
    getMethods in interface ApiOrBuilder
  - getMethodsOrBuilder
```
public MethodOrBuilder getMethodsOrBuilder(int index)
```
    repeated .google.protobuf.Method methods = 2;
```
 The methods of this api, in unspecified order.
 
```
    Specified by:
    
    getMethodsOrBuilder in interface ApiOrBuilder
  - getOptionsList
```
public java.util.List<Option> getOptionsList()
```
    repeated .google.protobuf.Option options = 3;
```
 Any metadata attached to the API.
 
```
    Specified by:
    
    getOptionsList in interface ApiOrBuilder
  - getOptionsOrBuilderList
```
public java.util.List<? extends OptionOrBuilder> getOptionsOrBuilderList()
```
    repeated .google.protobuf.Option options = 3;
```
 Any metadata attached to the API.
 
```
    Specified by:
    
    getOptionsOrBuilderList in interface ApiOrBuilder
  - getOptionsCount
```
public int getOptionsCount()
```
    repeated .google.protobuf.Option options = 3;
```
 Any metadata attached to the API.
 
```
    Specified by:
    
    getOptionsCount in interface ApiOrBuilder
  - getOptions
```
public Option getOptions(int index)
```
    repeated .google.protobuf.Option options = 3;
```
 Any metadata attached to the API.
 
```
    Specified by:
    
    getOptions in interface ApiOrBuilder
  - getOptionsOrBuilder
```
public OptionOrBuilder getOptionsOrBuilder(int index)
```
    repeated .google.protobuf.Option options = 3;
```
 Any metadata attached to the API.
 
```
    Specified by:
    
    getOptionsOrBuilder in interface ApiOrBuilder
  - getVersion
```
public java.lang.String getVersion()
```
    optional string version = 4;
```
 A version string for this api. 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
 API, 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, none-GA apis.
 
```
    Specified by:
    
    getVersion in interface ApiOrBuilder
  - getVersionBytes
```
public ByteString getVersionBytes()
```
    optional string version = 4;
```
 A version string for this api. 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
 API, 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, none-GA apis.
 
```
    Specified by:
    
    getVersionBytes in interface ApiOrBuilder
  - hasSourceContext
```
public boolean hasSourceContext()
```
    optional .google.protobuf.SourceContext source_context = 5;
```
 Source context for the protocol buffer service represented by this
 message.
 
```
    Specified by:
    
    hasSourceContext in interface ApiOrBuilder
  - getSourceContext
```
public SourceContext getSourceContext()
```
    optional .google.protobuf.SourceContext source_context = 5;
```
 Source context for the protocol buffer service represented by this
 message.
 
```
    Specified by:
    
    getSourceContext in interface ApiOrBuilder
  - getSourceContextOrBuilder
```
public SourceContextOrBuilder getSourceContextOrBuilder()
```
    optional .google.protobuf.SourceContext source_context = 5;
```
 Source context for the protocol buffer service represented by this
 message.
 
```
    Specified by:
    
    getSourceContextOrBuilder in interface ApiOrBuilder
  - getMixinsList
```
public java.util.List<Mixin> getMixinsList()
```
    repeated .google.protobuf.Mixin mixins = 6;
```
 Included APIs. See [Mixin][].
 
```
    Specified by:
    
    getMixinsList in interface ApiOrBuilder
  - getMixinsOrBuilderList
```
public java.util.List<? extends MixinOrBuilder> getMixinsOrBuilderList()
```
    repeated .google.protobuf.Mixin mixins = 6;
```
 Included APIs. See [Mixin][].
 
```
    Specified by:
    
    getMixinsOrBuilderList in interface ApiOrBuilder
  - getMixinsCount
```
public int getMixinsCount()
```
    repeated .google.protobuf.Mixin mixins = 6;
```
 Included APIs. See [Mixin][].
 
```
    Specified by:
    
    getMixinsCount in interface ApiOrBuilder
  - getMixins
```
public Mixin getMixins(int index)
```
    repeated .google.protobuf.Mixin mixins = 6;
```
 Included APIs. See [Mixin][].
 
```
    Specified by:
    
    getMixins in interface ApiOrBuilder
  - getMixinsOrBuilder
```
public MixinOrBuilder getMixinsOrBuilder(int index)
```
    repeated .google.protobuf.Mixin mixins = 6;
```
 Included APIs. See [Mixin][].
 
```
    Specified by:
    
    getMixinsOrBuilder in interface ApiOrBuilder
  - getSyntaxValue
```
public int getSyntaxValue()
```
    optional .google.protobuf.Syntax syntax = 7;
```
 The source syntax of the service.
 
```
    Specified by:
    
    getSyntaxValue in interface ApiOrBuilder
  - getSyntax
```
public Syntax getSyntax()
```
    optional .google.protobuf.Syntax syntax = 7;
```
 The source syntax of the service.
 
```
    Specified by:
    
    getSyntax in interface ApiOrBuilder
  - 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.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessage
  - writeTo
```
public void writeTo(CodedOutputStream output)
             throws java.io.IOException
```
    Description copied from interface: MessageLite
    
    Serializes the message and writes it to output. This does not flush or close the stream.
    
    Specified by:
    
    writeTo in interface MessageLite
    
    Overrides:
    
    writeTo in class GeneratedMessage
    
    Throws:
    
    java.io.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.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class GeneratedMessage
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from interface: Message
    
    Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
    
    Specified by:
    
    equals in interface Message
    
    Overrides:
    
    equals in class AbstractMessage
    
    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; inheriting Object.hashCode() is incorrect.
    
    Specified by:
    
    hashCode in interface Message
    
    Overrides:
    
    hashCode in class AbstractMessage
    
    Returns:
    
    the hash code value for this message
    
    See Also:
    
    Map.hashCode()
  - parseFrom
```
public static Api parseFrom(ByteString data)
                     throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Api parseFrom(ByteString data,
                            ExtensionRegistryLite extensionRegistry)
                     throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Api parseFrom(byte[] data)
                     throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Api parseFrom(byte[] data,
                            ExtensionRegistryLite extensionRegistry)
                     throws InvalidProtocolBufferException
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static Api parseFrom(java.io.InputStream input)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Api parseFrom(java.io.InputStream input,
                            ExtensionRegistryLite extensionRegistry)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static Api parseDelimitedFrom(java.io.InputStream input)
                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseDelimitedFrom
```
public static Api parseDelimitedFrom(java.io.InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Api parseFrom(CodedInputStream input)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static Api parseFrom(CodedInputStream input,
                            ExtensionRegistryLite extensionRegistry)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - newBuilderForType
```
public Api.Builder newBuilderForType()
```
    Description copied from interface: MessageLite
    
    Constructs a new builder for a message of the same type as this message.
    
    Specified by:
    
    newBuilderForType in interface Message
    
    Specified by:
    
    newBuilderForType in interface MessageLite
  - newBuilder
```
public static Api.Builder newBuilder()
```
  - newBuilder
```
public static Api.Builder newBuilder(Api prototype)
```
  - toBuilder
```
public Api.Builder 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 interface Message
    
    Specified by:
    
    toBuilder in interface MessageLite
  - getDefaultInstance
```
public static Api getDefaultInstance()
```
  - parser
```
public static Parser<Api> parser()
```
  - getParserForType
```
public Parser<Api> getParserForType()
```
    Description copied from interface: MessageLite
    
    Gets the parser for a message of the same type as this message.
    
    Specified by:
    
    getParserForType in interface Message
    
    Specified by:
    
    getParserForType in interface MessageLite
    
    Overrides:
    
    getParserForType in class GeneratedMessage
  - getDefaultInstanceForType
```
public Api 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 the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder

Class Api

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

Field Summary

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

METHODS_FIELD_NUMBER

OPTIONS_FIELD_NUMBER

VERSION_FIELD_NUMBER

SOURCE_CONTEXT_FIELD_NUMBER

MIXINS_FIELD_NUMBER

SYNTAX_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

getName

getNameBytes

getMethodsList

getMethodsOrBuilderList

getMethodsCount

getMethods

getMethodsOrBuilder

getOptionsList

getOptionsOrBuilderList

getOptionsCount

getOptions

getOptionsOrBuilder

getVersion

getVersionBytes

hasSourceContext

getSourceContext

getSourceContextOrBuilder

getMixinsList

getMixinsOrBuilderList

getMixinsCount

getMixins

getMixinsOrBuilder

getSyntaxValue

getSyntax

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType