Class Api

All Implemented Interfaces:
ApiOrBuilder, MessageLite, MessageLiteOrBuilder

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
  • Field Details

  • Constructor Details

    • Api

      private Api()
  • Method Details

    • 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.
    • setName

      private void setName(String value)
       The fully qualified name of this interface, including package name
       followed by the interface's simple name.
       
      string name = 1;
      Parameters:
      value - The name to set.
    • clearName

      private void clearName()
       The fully qualified name of this interface, including package name
       followed by the interface's simple name.
       
      string name = 1;
    • setNameBytes

      private void setNameBytes(ByteString value)
       The fully qualified name of this interface, including package name
       followed by the interface's simple name.
       
      string name = 1;
      Parameters:
      value - The bytes for name to set.
    • 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;
    • 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;
    • ensureMethodsIsMutable

      private void ensureMethodsIsMutable()
    • setMethods

      private void setMethods(int index, Method value)
       The methods of this interface, in unspecified order.
       
      repeated .google.protobuf.Method methods = 2;
    • addMethods

      private void addMethods(Method value)
       The methods of this interface, in unspecified order.
       
      repeated .google.protobuf.Method methods = 2;
    • addMethods

      private void addMethods(int index, Method value)
       The methods of this interface, in unspecified order.
       
      repeated .google.protobuf.Method methods = 2;
    • addAllMethods

      private void addAllMethods(Iterable<? extends Method> values)
       The methods of this interface, in unspecified order.
       
      repeated .google.protobuf.Method methods = 2;
    • clearMethods

      private void clearMethods()
       The methods of this interface, in unspecified order.
       
      repeated .google.protobuf.Method methods = 2;
    • removeMethods

      private void removeMethods(int index)
       The methods of this interface, in unspecified order.
       
      repeated .google.protobuf.Method methods = 2;
    • 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;
    • 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;
    • ensureOptionsIsMutable

      private void ensureOptionsIsMutable()
    • setOptions

      private void setOptions(int index, Option value)
       Any metadata attached to the interface.
       
      repeated .google.protobuf.Option options = 3;
    • addOptions

      private void addOptions(Option value)
       Any metadata attached to the interface.
       
      repeated .google.protobuf.Option options = 3;
    • addOptions

      private void addOptions(int index, Option value)
       Any metadata attached to the interface.
       
      repeated .google.protobuf.Option options = 3;
    • addAllOptions

      private void addAllOptions(Iterable<? extends Option> values)
       Any metadata attached to the interface.
       
      repeated .google.protobuf.Option options = 3;
    • clearOptions

      private void clearOptions()
       Any metadata attached to the interface.
       
      repeated .google.protobuf.Option options = 3;
    • removeOptions

      private void removeOptions(int index)
       Any metadata attached to the interface.
       
      repeated .google.protobuf.Option options = 3;
    • 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.
    • setVersion

      private void setVersion(String value)
       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;
      Parameters:
      value - The version to set.
    • clearVersion

      private void clearVersion()
       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;
    • setVersionBytes

      private void setVersionBytes(ByteString value)
       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;
      Parameters:
      value - The bytes for version to set.
    • 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.
    • setSourceContext

      private void setSourceContext(SourceContext value)
       Source context for the protocol buffer service represented by this
       message.
       
      .google.protobuf.SourceContext source_context = 5;
    • mergeSourceContext

      private void mergeSourceContext(SourceContext value)
       Source context for the protocol buffer service represented by this
       message.
       
      .google.protobuf.SourceContext source_context = 5;
    • clearSourceContext

      private void clearSourceContext()
       Source context for the protocol buffer service represented by this
       message.
       
      .google.protobuf.SourceContext source_context = 5;
    • 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;
    • 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;
    • ensureMixinsIsMutable

      private void ensureMixinsIsMutable()
    • setMixins

      private void setMixins(int index, Mixin value)
       Included interfaces. See [Mixin][].
       
      repeated .google.protobuf.Mixin mixins = 6;
    • addMixins

      private void addMixins(Mixin value)
       Included interfaces. See [Mixin][].
       
      repeated .google.protobuf.Mixin mixins = 6;
    • addMixins

      private void addMixins(int index, Mixin value)
       Included interfaces. See [Mixin][].
       
      repeated .google.protobuf.Mixin mixins = 6;
    • addAllMixins

      private void addAllMixins(Iterable<? extends Mixin> values)
       Included interfaces. See [Mixin][].
       
      repeated .google.protobuf.Mixin mixins = 6;
    • clearMixins

      private void clearMixins()
       Included interfaces. See [Mixin][].
       
      repeated .google.protobuf.Mixin mixins = 6;
    • removeMixins

      private void removeMixins(int index)
       Included interfaces. See [Mixin][].
       
      repeated .google.protobuf.Mixin mixins = 6;
    • 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.
    • setSyntaxValue

      private void setSyntaxValue(int value)
       The source syntax of the service.
       
      .google.protobuf.Syntax syntax = 7;
      Parameters:
      value - The enum numeric value on the wire for syntax to set.
    • setSyntax

      private void setSyntax(Syntax value)
       The source syntax of the service.
       
      .google.protobuf.Syntax syntax = 7;
      Parameters:
      value - The syntax to set.
    • clearSyntax

      private void clearSyntax()
       The source syntax of the service.
       
      .google.protobuf.Syntax syntax = 7;
    • 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
    • newBuilder

      public static Api.Builder newBuilder()
    • newBuilder

      public static Api.Builder newBuilder(Api prototype)
    • dynamicMethod

      protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Description copied from class: GeneratedMessageLite
      A method that implements different types of operations described in GeneratedMessageLite.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.

      Specified by:
      dynamicMethod in class GeneratedMessageLite<Api,Api.Builder>
    • getDefaultInstance

      public static Api getDefaultInstance()
    • parser

      public static Parser<Api> parser()