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 type
google.protobuf.Api
instance, isBuilt
Modifier and Type | Method and Description |
---|---|
Api.Builder |
addAllMethods(Iterable<? extends Method> values)
The methods of this interface, in unspecified order.
|
Api.Builder |
addAllMixins(Iterable<? extends Mixin> values)
Included interfaces.
|
Api.Builder |
addAllOptions(Iterable<? extends Option> values)
Any metadata attached to the interface.
|
Api.Builder |
addMethods(int index,
Method.Builder builderForValue)
The methods of this interface, in unspecified order.
|
Api.Builder |
addMethods(int index,
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 |
addMethods(Method value)
The methods of this interface, in unspecified order.
|
Api.Builder |
addMixins(int index,
Mixin.Builder builderForValue)
Included interfaces.
|
Api.Builder |
addMixins(int index,
Mixin value)
Included interfaces.
|
Api.Builder |
addMixins(Mixin.Builder builderForValue)
Included interfaces.
|
Api.Builder |
addMixins(Mixin value)
Included interfaces.
|
Api.Builder |
addOptions(int index,
Option.Builder builderForValue)
Any metadata attached to the interface.
|
Api.Builder |
addOptions(int index,
Option value)
Any metadata attached to the interface.
|
Api.Builder |
addOptions(Option.Builder builderForValue)
Any metadata attached to the interface.
|
Api.Builder |
addOptions(Option value)
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.
|
List<Method> |
getMethodsList()
The methods of this interface, in unspecified order.
|
Mixin |
getMixins(int index)
Included interfaces.
|
int |
getMixinsCount()
Included interfaces.
|
List<Mixin> |
getMixinsList()
Included interfaces.
|
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.
|
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.
|
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.Builder builderForValue)
The methods of this interface, in unspecified order.
|
Api.Builder |
setMethods(int index,
Method value)
The methods of this interface, in unspecified order.
|
Api.Builder |
setMixins(int index,
Mixin.Builder builderForValue)
Included interfaces.
|
Api.Builder |
setMixins(int index,
Mixin value)
Included interfaces.
|
Api.Builder |
setName(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.Builder builderForValue)
Any metadata attached to the interface.
|
Api.Builder |
setOptions(int index,
Option value)
Any metadata attached to the interface.
|
Api.Builder |
setSourceContext(SourceContext.Builder builderForValue)
Source context for the protocol buffer service represented by this
message.
|
Api.Builder |
setSourceContext(SourceContext value)
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(String value)
A version string for this interface.
|
Api.Builder |
setVersionBytes(ByteString value)
A version string for this interface.
|
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefaultInstanceForType, isInitialized
public String getName()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getName
in interface ApiOrBuilder
public ByteString getNameBytes()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getNameBytes
in interface ApiOrBuilder
public Api.Builder setName(String value)
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
value
- The name to set.public Api.Builder clearName()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
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;
value
- The bytes for name to set.public List<Method> getMethodsList()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethodsList
in interface ApiOrBuilder
public int getMethodsCount()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethodsCount
in interface ApiOrBuilder
public Method getMethods(int index)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMethods
in interface ApiOrBuilder
public Api.Builder setMethods(int index, Method value)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder setMethods(int index, Method.Builder builderForValue)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder addMethods(Method value)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder addMethods(int index, Method value)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder addMethods(Method.Builder builderForValue)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder addMethods(int index, Method.Builder builderForValue)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder addAllMethods(Iterable<? extends Method> values)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder clearMethods()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public Api.Builder removeMethods(int index)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
public List<Option> getOptionsList()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptionsList
in interface ApiOrBuilder
public int getOptionsCount()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptionsCount
in interface ApiOrBuilder
public Option getOptions(int index)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getOptions
in interface ApiOrBuilder
public Api.Builder setOptions(int index, Option value)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder setOptions(int index, Option.Builder builderForValue)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder addOptions(Option value)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder addOptions(int index, Option value)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder addOptions(Option.Builder builderForValue)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder addOptions(int index, Option.Builder builderForValue)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder addAllOptions(Iterable<? extends Option> values)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder clearOptions()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
public Api.Builder removeOptions(int index)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
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;
getVersion
in interface ApiOrBuilder
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;
getVersionBytes
in interface ApiOrBuilder
public Api.Builder 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;
value
- The version to set.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;
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;
value
- The bytes for version to set.public boolean hasSourceContext()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
hasSourceContext
in interface ApiOrBuilder
public SourceContext getSourceContext()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
getSourceContext
in interface ApiOrBuilder
public Api.Builder setSourceContext(SourceContext value)
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
public Api.Builder setSourceContext(SourceContext.Builder builderForValue)
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
public Api.Builder mergeSourceContext(SourceContext value)
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
public Api.Builder clearSourceContext()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
public List<Mixin> getMixinsList()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsList
in interface ApiOrBuilder
public int getMixinsCount()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsCount
in interface ApiOrBuilder
public Mixin getMixins(int index)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixins
in interface ApiOrBuilder
public Api.Builder setMixins(int index, Mixin value)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder setMixins(int index, Mixin.Builder builderForValue)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder addMixins(Mixin value)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder addMixins(int index, Mixin value)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder addMixins(Mixin.Builder builderForValue)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder addMixins(int index, Mixin.Builder builderForValue)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder addAllMixins(Iterable<? extends Mixin> values)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder clearMixins()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public Api.Builder removeMixins(int index)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
public int getSyntaxValue()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
getSyntaxValue
in interface ApiOrBuilder
public Api.Builder setSyntaxValue(int value)
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
value
- The syntax to set.public Syntax getSyntax()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
getSyntax
in interface ApiOrBuilder
public Api.Builder setSyntax(Syntax value)
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
value
- The enum numeric value on the wire for syntax to set.public Api.Builder clearSyntax()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
Copyright © 2008–2022. All rights reserved.