Class 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, Serializable
@Generated public final class Api extends GeneratedMessage 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.

New usages of this message as an alternative to ServiceDescriptorProto are
strongly discouraged. This message does not reliability preserve all
information necessary to model the schema and preserve semantics. Instead
make use of FileDescriptorSet which preserves the necessary information.
Protobuf type google.protobuf.Api
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • name_

      private volatile Object name_

    • METHODS_FIELD_NUMBER

      public static final int METHODS_FIELD_NUMBER
      See Also:

    • methods_

      private List<Method> methods_

    • OPTIONS_FIELD_NUMBER

      public static final int OPTIONS_FIELD_NUMBER
      See Also:

    • options_

      private List<Option> options_

    • VERSION_FIELD_NUMBER

      public static final int VERSION_FIELD_NUMBER
      See Also:

    • version_

      private volatile Object version_

    • SOURCE_CONTEXT_FIELD_NUMBER

      public static final int SOURCE_CONTEXT_FIELD_NUMBER
      See Also:

    • sourceContext_

      private SourceContext sourceContext_

    • MIXINS_FIELD_NUMBER

      public static final int MIXINS_FIELD_NUMBER
      See Also:

    • mixins_

      private List<Mixin> mixins_

    • SYNTAX_FIELD_NUMBER

      public static final int SYNTAX_FIELD_NUMBER
      See Also:

    • syntax_

      private int syntax_

    • EDITION_FIELD_NUMBER

      public static final int EDITION_FIELD_NUMBER
      See Also:

    • edition_

      private volatile Object edition_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final Api DEFAULT_INSTANCE

    • PARSER

      private static final Parser<Api> PARSER

  • Constructor Details

  • Method Details

    • getDescriptor

      public static final Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public Descriptors.Descriptor getDescriptorForType()
      Description copied from interface: MessageOrBuilder
      Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.
      Specified by:
      getDescriptorForType in interface MessageOrBuilder
      Overrides:
      getDescriptorForType in class GeneratedMessage

    • internalGetFieldAccessorTable

      protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Description copied from class: GeneratedMessage
      Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
      Specified by:
      internalGetFieldAccessorTable in class GeneratedMessage

    • getName

      public 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 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 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 List<Option> getOptionsList()
      Any metadata attached to the interface.
      repeated .google.protobuf.Option options = 3;
      Specified by:
      getOptionsList in interface ApiOrBuilder

    • getOptionsOrBuilderList

      public 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 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 List<Mixin> getMixinsList()
      Included interfaces. See [Mixin][].
      repeated .google.protobuf.Mixin mixins = 6;
      Specified by:
      getMixinsList in interface ApiOrBuilder

    • getMixinsOrBuilderList

      public 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.

    • getEdition

      public String getEdition()
      The source edition string, only valid when syntax is SYNTAX_EDITIONS.
      string edition = 8;
      Specified by:
      getEdition in interface ApiOrBuilder
      Returns:
      The edition.

    • getEditionBytes

      public ByteString getEditionBytes()
      The source edition string, only valid when syntax is SYNTAX_EDITIONS.
      string edition = 8;
      Specified by:
      getEditionBytes in interface ApiOrBuilder
      Returns:
      The bytes for edition.

    • 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 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:
      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. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.
      Specified by:
      getSerializedSize in interface MessageLite
      Overrides:
      getSerializedSize in class GeneratedMessage

    • equals

      public boolean equals(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:

    • parseFrom

      public static Api parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
      Throws:
      InvalidProtocolBufferException

    • parseFrom

      public static Api parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Api parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Api parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Api parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Api parseFrom(CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Api parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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

    • newBuilderForType

      protected Api.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
      Description copied from class: AbstractMessage
      Create a nested builder.
      Overrides:
      newBuilderForType in class AbstractMessage

    • getDefaultInstance

      public static Api getDefaultInstance()

    • parser

      public static Parser<Api> parser()

    • getParserForType

      public Parser<Api> getParserForType()
      Description copied from class: GeneratedMessage
      TODO: Remove this unnecessary intermediate implementation of this method.
      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