Interface ApiOrBuilder

All Superinterfaces:
MessageLiteOrBuilder, MessageOrBuilder
All Known Implementing Classes:
Api, Api.Builder
@Generated public interface ApiOrBuilder extends MessageOrBuilder

  • Method Details

    • getName

      String getName()
      The fully qualified name of this interface, including package name
followed by the interface's simple name.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      ByteString getNameBytes()
      The fully qualified name of this interface, including package name
followed by the interface's simple name.
      string name = 1;
      Returns:
      The bytes for name.

    • getMethodsList

      List<Method> getMethodsList()
      The methods of this interface, in unspecified order.
      repeated .google.protobuf.Method methods = 2;

    • getMethods

      Method getMethods(int index)
      The methods of this interface, in unspecified order.
      repeated .google.protobuf.Method methods = 2;

    • getMethodsCount

      int getMethodsCount()
      The methods of this interface, in unspecified order.
      repeated .google.protobuf.Method methods = 2;

    • getMethodsOrBuilderList

      List<? extends MethodOrBuilder> getMethodsOrBuilderList()
      The methods of this interface, in unspecified order.
      repeated .google.protobuf.Method methods = 2;

    • getMethodsOrBuilder

      MethodOrBuilder getMethodsOrBuilder(int index)
      The methods of this interface, in unspecified order.
      repeated .google.protobuf.Method methods = 2;

    • getOptionsList

      List<Option> getOptionsList()
      Any metadata attached to the interface.
      repeated .google.protobuf.Option options = 3;

    • getOptions

      Option getOptions(int index)
      Any metadata attached to the interface.
      repeated .google.protobuf.Option options = 3;

    • getOptionsCount

      int getOptionsCount()
      Any metadata attached to the interface.
      repeated .google.protobuf.Option options = 3;

    • getOptionsOrBuilderList

      List<? extends OptionOrBuilder> getOptionsOrBuilderList()
      Any metadata attached to the interface.
      repeated .google.protobuf.Option options = 3;

    • getOptionsOrBuilder

      OptionOrBuilder getOptionsOrBuilder(int index)
      Any metadata attached to the interface.
      repeated .google.protobuf.Option options = 3;

    • getVersion

      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;
      Returns:
      The version.

    • getVersionBytes

      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;
      Returns:
      The bytes for version.

    • hasSourceContext

      boolean hasSourceContext()
      Source context for the protocol buffer service represented by this
message.
      .google.protobuf.SourceContext source_context = 5;
      Returns:
      Whether the sourceContext field is set.

    • getSourceContext

      SourceContext getSourceContext()
      Source context for the protocol buffer service represented by this
message.
      .google.protobuf.SourceContext source_context = 5;
      Returns:
      The sourceContext.

    • getSourceContextOrBuilder

      SourceContextOrBuilder getSourceContextOrBuilder()
      Source context for the protocol buffer service represented by this
message.
      .google.protobuf.SourceContext source_context = 5;

    • getMixinsList

      List<Mixin> getMixinsList()
      Included interfaces. See [Mixin][].
      repeated .google.protobuf.Mixin mixins = 6;

    • getMixins

      Mixin getMixins(int index)
      Included interfaces. See [Mixin][].
      repeated .google.protobuf.Mixin mixins = 6;

    • getMixinsCount

      int getMixinsCount()
      Included interfaces. See [Mixin][].
      repeated .google.protobuf.Mixin mixins = 6;

    • getMixinsOrBuilderList

      List<? extends MixinOrBuilder> getMixinsOrBuilderList()
      Included interfaces. See [Mixin][].
      repeated .google.protobuf.Mixin mixins = 6;

    • getMixinsOrBuilder

      MixinOrBuilder getMixinsOrBuilder(int index)
      Included interfaces. See [Mixin][].
      repeated .google.protobuf.Mixin mixins = 6;

    • getSyntaxValue

      int getSyntaxValue()
      The source syntax of the service.
      .google.protobuf.Syntax syntax = 7;
      Returns:
      The enum numeric value on the wire for syntax.

    • getSyntax

      Syntax getSyntax()
      The source syntax of the service.
      .google.protobuf.Syntax syntax = 7;
      Returns:
      The syntax.

    • getEdition

      String getEdition()
      The source edition string, only valid when syntax is SYNTAX_EDITIONS.
      string edition = 8;
      Returns:
      The edition.

    • getEditionBytes

      ByteString getEditionBytes()
      The source edition string, only valid when syntax is SYNTAX_EDITIONS.
      string edition = 8;
      Returns:
      The bytes for edition.