Api.Builder
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method
com.google.protobuf

Class Api.Builder

  • All Implemented Interfaces:
    ApiOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    Api

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

    • Method Detail

      • clear

        public Api.Builder clear()
        Description copied from class: com.google.protobuf.GeneratedMessageV3.Builder
        Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
        Specified by:
        clear in interface Message.Builder
        Specified by:
        clear in interface MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

      • 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

      • mergeFrom

        public Api.Builder mergeFrom(Message other)
        Description copied from interface: Message.Builder
        Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

        Merging occurs as follows. For each field:
        * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
        * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
        * For repeated fields, the elements in other are concatenated with the elements in this message.
        * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

        This is equivalent to the Message::MergeFrom method in C++.

        Specified by:
        mergeFrom in interface Message.Builder
        Overrides:
        mergeFrom in class AbstractMessage.Builder<Api.Builder>

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

      • setName

        public Api.Builder setName(java.lang.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.
        Returns:
        This builder for chaining.

      • clearName

        public Api.Builder clearName()
         The fully qualified name of this interface, including package name
 followed by the interface's simple name.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Api.Builder 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.
        Returns:
        This builder for chaining.

      • 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

      • 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

      • setMethods

        public Api.Builder setMethods(int index,
                              Method value)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • setMethods

        public Api.Builder setMethods(int index,
                              Method.Builder builderForValue)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • addMethods

        public Api.Builder addMethods(Method value)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • addMethods

        public Api.Builder addMethods(int index,
                              Method value)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • addMethods

        public Api.Builder addMethods(Method.Builder builderForValue)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • addMethods

        public Api.Builder addMethods(int index,
                              Method.Builder builderForValue)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • addAllMethods

        public Api.Builder addAllMethods(java.lang.Iterable<? extends Method> values)
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • clearMethods

        public Api.Builder clearMethods()
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • removeMethods

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

      • getMethodsBuilder

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

      • 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

      • 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

      • addMethodsBuilder

        public Method.Builder addMethodsBuilder()
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • addMethodsBuilder

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

      • getMethodsBuilderList

        public java.util.List<Method.Builder> getMethodsBuilderList()
         The methods of this interface, in unspecified order.
        repeated .google.protobuf.Method methods = 2;

      • 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

      • 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

      • setOptions

        public Api.Builder setOptions(int index,
                              Option value)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • setOptions

        public Api.Builder setOptions(int index,
                              Option.Builder builderForValue)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • addOptions

        public Api.Builder addOptions(Option value)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • addOptions

        public Api.Builder addOptions(int index,
                              Option value)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • addOptions

        public Api.Builder addOptions(Option.Builder builderForValue)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • addOptions

        public Api.Builder addOptions(int index,
                              Option.Builder builderForValue)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • addAllOptions

        public Api.Builder addAllOptions(java.lang.Iterable<? extends Option> values)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • clearOptions

        public Api.Builder clearOptions()
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • removeOptions

        public Api.Builder removeOptions(int index)
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • getOptionsBuilder

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

      • addOptionsBuilder

        public Option.Builder addOptionsBuilder()
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

      • addOptionsBuilder

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

      • getOptionsBuilderList

        public java.util.List<Option.Builder> getOptionsBuilderList()
         Any metadata attached to the interface.
        repeated .google.protobuf.Option options = 3;

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

      • setVersion

        public Api.Builder setVersion(java.lang.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.
        Returns:
        This builder for chaining.

      • clearVersion

        public Api.Builder 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;
        Returns:
        This builder for chaining.

      • setVersionBytes

        public Api.Builder 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.
        Returns:
        This builder for chaining.

      • 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

        public Api.Builder setSourceContext(SourceContext value)
         Source context for the protocol buffer service represented by this
 message.
        .google.protobuf.SourceContext source_context = 5;

      • setSourceContext

        public Api.Builder setSourceContext(SourceContext.Builder builderForValue)
         Source context for the protocol buffer service represented by this
 message.
        .google.protobuf.SourceContext source_context = 5;

      • mergeSourceContext

        public Api.Builder mergeSourceContext(SourceContext value)
         Source context for the protocol buffer service represented by this
 message.
        .google.protobuf.SourceContext source_context = 5;

      • clearSourceContext

        public Api.Builder clearSourceContext()
         Source context for the protocol buffer service represented by this
 message.
        .google.protobuf.SourceContext source_context = 5;

      • getSourceContextBuilder

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

      • getMixinsList

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

      • setMixins

        public Api.Builder setMixins(int index,
                             Mixin value)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • setMixins

        public Api.Builder setMixins(int index,
                             Mixin.Builder builderForValue)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • addMixins

        public Api.Builder addMixins(Mixin value)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • addMixins

        public Api.Builder addMixins(int index,
                             Mixin value)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • addMixins

        public Api.Builder addMixins(Mixin.Builder builderForValue)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • addMixins

        public Api.Builder addMixins(int index,
                             Mixin.Builder builderForValue)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • addAllMixins

        public Api.Builder addAllMixins(java.lang.Iterable<? extends Mixin> values)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • clearMixins

        public Api.Builder clearMixins()
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • removeMixins

        public Api.Builder removeMixins(int index)
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • getMixinsBuilder

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

      • addMixinsBuilder

        public Mixin.Builder addMixinsBuilder()
         Included interfaces. See [Mixin][].
        repeated .google.protobuf.Mixin mixins = 6;

      • addMixinsBuilder

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

      • getMixinsBuilderList

        public java.util.List<Mixin.Builder> getMixinsBuilderList()
         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.

      • setSyntaxValue

        public Api.Builder 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.
        Returns:
        This builder for chaining.

      • getSyntax

        public Syntax getSyntax()
         The source syntax of the service.
        .google.protobuf.Syntax syntax = 7;
        Specified by:
        getSyntax in interface ApiOrBuilder
        Returns:
        The syntax.

      • setSyntax

        public Api.Builder setSyntax(Syntax value)
         The source syntax of the service.
        .google.protobuf.Syntax syntax = 7;
        Parameters:
        value - The syntax to set.
        Returns:
        This builder for chaining.

      • clearSyntax

        public Api.Builder clearSyntax()
         The source syntax of the service.
        .google.protobuf.Syntax syntax = 7;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Api.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
        Description copied from interface: Message.Builder
        Set the UnknownFieldSet for this message.
        Specified by:
        setUnknownFields in interface Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

      • mergeUnknownFields

        public final Api.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
        Description copied from interface: Message.Builder
        Merge some unknown fields into the UnknownFieldSet for this message.
        Specified by:
        mergeUnknownFields in interface Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method