Package com.google.protobuf
Class Api.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
-
- com.google.protobuf.GeneratedMessageLite.Builder<Api,Api.Builder>
-
- com.google.protobuf.Api.Builder
-
- All Implemented Interfaces:
ApiOrBuilder
,MessageLite.Builder
,MessageLiteOrBuilder
,java.lang.Cloneable
- Enclosing class:
- Api
public static final class Api.Builder extends GeneratedMessageLite.Builder<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 typegoogle.protobuf.Api
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
-
Field Summary
-
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Api.Builder
addAllMethods(java.lang.Iterable<? extends Method> values)
The methods of this interface, in unspecified order.Api.Builder
addAllMixins(java.lang.Iterable<? extends Mixin> values)
Included interfaces.Api.Builder
addAllOptions(java.lang.Iterable<? extends Option> values)
Any metadata attached to the interface.Api.Builder
addMethods(int index, Method value)
The methods of this interface, in unspecified order.Api.Builder
addMethods(int index, Method.Builder builderForValue)
The methods of this interface, in unspecified order.Api.Builder
addMethods(Method value)
The methods of this interface, in unspecified order.Api.Builder
addMethods(Method.Builder builderForValue)
The methods of this interface, in unspecified order.Api.Builder
addMixins(int index, Mixin value)
Included interfaces.Api.Builder
addMixins(int index, Mixin.Builder builderForValue)
Included interfaces.Api.Builder
addMixins(Mixin value)
Included interfaces.Api.Builder
addMixins(Mixin.Builder builderForValue)
Included interfaces.Api.Builder
addOptions(int index, Option value)
Any metadata attached to the interface.Api.Builder
addOptions(int index, Option.Builder builderForValue)
Any metadata attached to the interface.Api.Builder
addOptions(Option value)
Any metadata attached to the interface.Api.Builder
addOptions(Option.Builder builderForValue)
Any metadata attached to the interface.Api.Builder
clearMethods()
The methods of this interface, in unspecified order.Api.Builder
clearMixins()
Included interfaces.Api.Builder
clearName()
The fully qualified name of this interface, including package name followed by the interface's simple name.Api.Builder
clearOptions()
Any metadata attached to the interface.Api.Builder
clearSourceContext()
Source context for the protocol buffer service represented by this message.Api.Builder
clearSyntax()
The source syntax of the service.Api.Builder
clearVersion()
A version string for this interface.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.Mixin
getMixins(int index)
Included interfaces.int
getMixinsCount()
Included interfaces.java.util.List<Mixin>
getMixinsList()
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.SourceContext
getSourceContext()
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.java.lang.String
getVersion()
A version string for this interface.ByteString
getVersionBytes()
A version string for this interface.boolean
hasSourceContext()
Source context for the protocol buffer service represented by this message.Api.Builder
mergeSourceContext(SourceContext value)
Source context for the protocol buffer service represented by this message.Api.Builder
removeMethods(int index)
The methods of this interface, in unspecified order.Api.Builder
removeMixins(int index)
Included interfaces.Api.Builder
removeOptions(int index)
Any metadata attached to the interface.Api.Builder
setMethods(int index, Method value)
The methods of this interface, in unspecified order.Api.Builder
setMethods(int index, Method.Builder builderForValue)
The methods of this interface, in unspecified order.Api.Builder
setMixins(int index, Mixin value)
Included interfaces.Api.Builder
setMixins(int index, Mixin.Builder builderForValue)
Included interfaces.Api.Builder
setName(java.lang.String value)
The fully qualified name of this interface, including package name followed by the interface's simple name.Api.Builder
setNameBytes(ByteString value)
The fully qualified name of this interface, including package name followed by the interface's simple name.Api.Builder
setOptions(int index, Option value)
Any metadata attached to the interface.Api.Builder
setOptions(int index, Option.Builder builderForValue)
Any metadata attached to the interface.Api.Builder
setSourceContext(SourceContext value)
Source context for the protocol buffer service represented by this message.Api.Builder
setSourceContext(SourceContext.Builder builderForValue)
Source context for the protocol buffer service represented by this message.Api.Builder
setSyntax(Syntax value)
The source syntax of the service.Api.Builder
setSyntaxValue(int value)
The source syntax of the service.Api.Builder
setVersion(java.lang.String value)
A version string for this interface.Api.Builder
setVersionBytes(ByteString value)
A version string for this interface.-
Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
-
-
-
Method Detail
-
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 interfaceApiOrBuilder
- 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 interfaceApiOrBuilder
- 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 interfaceApiOrBuilder
-
getMethodsCount
public int getMethodsCount()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethodsCount
in interfaceApiOrBuilder
-
getMethods
public Method getMethods(int index)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
- Specified by:
getMethods
in interfaceApiOrBuilder
-
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;
-
getOptionsList
public java.util.List<Option> getOptionsList()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsList
in interfaceApiOrBuilder
-
getOptionsCount
public int getOptionsCount()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptionsCount
in interfaceApiOrBuilder
-
getOptions
public Option getOptions(int index)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
- Specified by:
getOptions
in interfaceApiOrBuilder
-
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;
-
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 interfaceApiOrBuilder
- 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 interfaceApiOrBuilder
- 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 interfaceApiOrBuilder
- 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 interfaceApiOrBuilder
- 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;
-
getMixinsList
public java.util.List<Mixin> getMixinsList()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixinsList
in interfaceApiOrBuilder
-
getMixinsCount
public int getMixinsCount()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixinsCount
in interfaceApiOrBuilder
-
getMixins
public Mixin getMixins(int index)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
- Specified by:
getMixins
in interfaceApiOrBuilder
-
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;
-
getSyntaxValue
public int getSyntaxValue()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
- Specified by:
getSyntaxValue
in interfaceApiOrBuilder
- 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 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 interfaceApiOrBuilder
- Returns:
- The syntax.
-
setSyntax
public Api.Builder setSyntax(Syntax 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.
-
clearSyntax
public Api.Builder clearSyntax()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
- Returns:
- This builder for chaining.
-
-