com.google.protobuf

Class Api

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.Api

All Implemented Interfaces:

ApiOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class Api
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Api.Builder Api is a light-weight descriptor for an API Interface.

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

com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

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

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) The methods of this interface, in unspecified order.
int	getMethodsCount() The methods of this interface, in unspecified order.
java.util.List<Method>	getMethodsList() The methods of this interface, in unspecified order.
MethodOrBuilder	getMethodsOrBuilder(int index) The methods of this interface, in unspecified order.
java.util.List<? extends MethodOrBuilder>	getMethodsOrBuilderList() The methods of this interface, in unspecified order.
Mixin	getMixins(int index) Included interfaces.
int	getMixinsCount() Included interfaces.
java.util.List<Mixin>	getMixinsList() Included interfaces.
MixinOrBuilder	getMixinsOrBuilder(int index) Included interfaces.
java.util.List<? extends MixinOrBuilder>	getMixinsOrBuilderList() Included interfaces.
java.lang.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.
java.util.List<Option>	getOptionsList() Any metadata attached to the interface.
OptionOrBuilder	getOptionsOrBuilder(int index) Any metadata attached to the interface.
java.util.List<? extends OptionOrBuilder>	getOptionsOrBuilderList() Any metadata attached to the interface.
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() Source context for the protocol buffer service represented by this message.
SourceContextOrBuilder	getSourceContextOrBuilder() 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.
com.google.protobuf.UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
java.lang.String	getVersion() A version string for this interface.
ByteString	getVersionBytes() A version string for this interface.
int	hashCode() Returns the hash code value for this message.
boolean	hasSourceContext() Source context for the protocol buffer service represented by this message.
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(java.nio.ByteBuffer data)
static Api	parseFrom(java.nio.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(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.GeneratedMessageV3

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

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 com.google.protobuf.UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getName

public java.lang.String 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 interface ApiOrBuilder

Returns:

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;

Specified by:

getNameBytes in interface ApiOrBuilder

Returns:

The bytes for name.

getMethodsList

public java.util.List<Method> getMethodsList()

 The methods of this interface, in unspecified order.
 

repeated .google.protobuf.Method methods = 2;

Specified by:

getMethodsList in interface ApiOrBuilder

getMethodsOrBuilderList

public java.util.List<? extends MethodOrBuilder> getMethodsOrBuilderList()

 The methods of this interface, in unspecified order.
 

repeated .google.protobuf.Method methods = 2;

Specified by:

getMethodsOrBuilderList in interface ApiOrBuilder

getMethodsCount

public int getMethodsCount()

 The methods of this interface, in unspecified order.
 

repeated .google.protobuf.Method methods = 2;

Specified by:

getMethodsCount in interface ApiOrBuilder

getMethods

public Method getMethods(int index)

 The methods of this interface, in unspecified order.
 

repeated .google.protobuf.Method methods = 2;

Specified by:

getMethods in interface ApiOrBuilder

getMethodsOrBuilder

public MethodOrBuilder getMethodsOrBuilder(int index)

 The methods of this interface, in unspecified order.
 

repeated .google.protobuf.Method methods = 2;

Specified by:

getMethodsOrBuilder in interface ApiOrBuilder

getOptionsList

public java.util.List<Option> getOptionsList()

 Any metadata attached to the interface.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsList in interface ApiOrBuilder

getOptionsOrBuilderList

public java.util.List<? extends OptionOrBuilder> getOptionsOrBuilderList()

 Any metadata attached to the interface.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsOrBuilderList in interface ApiOrBuilder

getOptionsCount

public int getOptionsCount()

 Any metadata attached to the interface.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsCount in interface ApiOrBuilder

getOptions

public Option getOptions(int index)

 Any metadata attached to the interface.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptions in interface ApiOrBuilder

getOptionsOrBuilder

public OptionOrBuilder getOptionsOrBuilder(int index)

 Any metadata attached to the interface.
 

repeated .google.protobuf.Option options = 3;

Specified by:

getOptionsOrBuilder in interface ApiOrBuilder

getVersion

public java.lang.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;

Specified by:

getVersion in interface ApiOrBuilder

Returns:

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](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 interface ApiOrBuilder

Returns:

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;

Specified by:

hasSourceContext in interface ApiOrBuilder

Returns:

Whether the sourceContext field is set.

getSourceContext

public SourceContext getSourceContext()

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

.google.protobuf.SourceContext source_context = 5;

Specified by:

getSourceContext in interface ApiOrBuilder

Returns:

The sourceContext.

getSourceContextOrBuilder

public SourceContextOrBuilder getSourceContextOrBuilder()

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

.google.protobuf.SourceContext source_context = 5;

Specified by:

getSourceContextOrBuilder in interface ApiOrBuilder

getMixinsList

public java.util.List<Mixin> getMixinsList()

 Included interfaces. See [Mixin][].
 

repeated .google.protobuf.Mixin mixins = 6;

Specified by:

getMixinsList in interface ApiOrBuilder

getMixinsOrBuilderList

public java.util.List<? extends MixinOrBuilder> getMixinsOrBuilderList()

 Included interfaces. See [Mixin][].
 

repeated .google.protobuf.Mixin mixins = 6;

Specified by:

getMixinsOrBuilderList in interface ApiOrBuilder

getMixinsCount

public int getMixinsCount()

 Included interfaces. See [Mixin][].
 

repeated .google.protobuf.Mixin mixins = 6;

Specified by:

getMixinsCount in interface ApiOrBuilder

getMixins

public Mixin getMixins(int index)

 Included interfaces. See [Mixin][].
 

repeated .google.protobuf.Mixin mixins = 6;

Specified by:

getMixins in interface ApiOrBuilder

getMixinsOrBuilder

public MixinOrBuilder getMixinsOrBuilder(int index)

 Included interfaces. See [Mixin][].
 

repeated .google.protobuf.Mixin mixins = 6;

Specified by:

getMixinsOrBuilder in interface ApiOrBuilder

getSyntaxValue

public int getSyntaxValue()

 The source syntax of the service.
 

.google.protobuf.Syntax syntax = 7;

Specified by:

getSyntaxValue in interface ApiOrBuilder

Returns:

The enum numeric value on the wire for syntax.

getSyntax

public Syntax getSyntax()

 The source syntax of the service.
 

.google.protobuf.Syntax syntax = 7;

Specified by:

getSyntax in interface ApiOrBuilder

Returns:

The syntax.

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 com.google.protobuf.GeneratedMessageV3

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 com.google.protobuf.GeneratedMessageV3

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 com.google.protobuf.GeneratedMessageV3

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(java.nio.ByteBuffer data)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Api parseFrom(java.nio.ByteBuffer data,
                            ExtensionRegistryLite extensionRegistry)
                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

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 com.google.protobuf.GeneratedMessageV3

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