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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > GeneratedMessageLite.Builder > Api.BuilderImplements
ApiOrBuilderMethods
addAllMethods(Iterable<? extends Method> values)
public
Api
.
Builder
addAllMethods
(
Iterable
< ?
extends
Method
>
values
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
addAllMixins(Iterable<? extends Mixin> values)
public
Api
.
Builder
addAllMixins
(
Iterable
< ?
extends
Mixin
>
values
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
addAllOptions(Iterable<? extends Option> values)
public
Api
.
Builder
addAllOptions
(
Iterable
< ?
extends
Option
>
values
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
addMethods(Method value)
public
Api
.
Builder
addMethods
(
Method
value
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
addMethods(Method.Builder builderForValue)
public
Api
.
Builder
addMethods
(
Method
.
Builder
builderForValue
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
addMethods(int index, Method value)
public
Api
.
Builder
addMethods
(
int
index
,
Method
value
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
addMethods(int index, Method.Builder builderForValue)
public
Api
.
Builder
addMethods
(
int
index
,
Method
.
Builder
builderForValue
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
addMixins(Mixin value)
public
Api
.
Builder
addMixins
(
Mixin
value
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
addMixins(Mixin.Builder builderForValue)
public
Api
.
Builder
addMixins
(
Mixin
.
Builder
builderForValue
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
addMixins(int index, Mixin value)
public
Api
.
Builder
addMixins
(
int
index
,
Mixin
value
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
addMixins(int index, Mixin.Builder builderForValue)
public
Api
.
Builder
addMixins
(
int
index
,
Mixin
.
Builder
builderForValue
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
addOptions(Option value)
public
Api
.
Builder
addOptions
(
Option
value
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
addOptions(Option.Builder builderForValue)
public
Api
.
Builder
addOptions
(
Option
.
Builder
builderForValue
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
addOptions(int index, Option value)
public
Api
.
Builder
addOptions
(
int
index
,
Option
value
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
addOptions(int index, Option.Builder builderForValue)
public
Api
.
Builder
addOptions
(
int
index
,
Option
.
Builder
builderForValue
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
clearMethods()
public
Api
.
Builder
clearMethods
()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
clearMixins()
public
Api
.
Builder
clearMixins
()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
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;
clearOptions()
public
Api
.
Builder
clearOptions
()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
clearSourceContext()
public
Api
.
Builder
clearSourceContext
()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
clearSyntax()
public
Api
.
Builder
clearSyntax
()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
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
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;
getMethods(int index)
public
Method
getMethods
(
int
index
)
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;
getMethodsList()
public
List<Method>
getMethodsList
()
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
getMixins(int index)
public
Mixin
getMixins
(
int
index
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsCount()
public
int
getMixinsCount
()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getMixinsList()
public
List<Mixin>
getMixinsList
()
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
getName()
public
String
getName
()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getNameBytes()
public
ByteString
getNameBytes
()
The fully qualified name of this interface, including package name followed by the interface's simple name.
string name = 1;
getOptions(int index)
public
Option
getOptions
(
int
index
)
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;
getOptionsList()
public
List<Option>
getOptionsList
()
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
getSourceContext()
public
SourceContext
getSourceContext
()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
getSyntax()
public
Syntax
getSyntax
()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
getSyntaxValue()
public
int
getSyntaxValue
()
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
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
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()
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
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;
hasSourceContext()
public
boolean
hasSourceContext
()
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
mergeSourceContext(SourceContext value)
public
Api
.
Builder
mergeSourceContext
(
SourceContext
value
)
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
removeMethods(int index)
public
Api
.
Builder
removeMethods
(
int
index
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
removeMixins(int index)
public
Api
.
Builder
removeMixins
(
int
index
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
removeOptions(int index)
public
Api
.
Builder
removeOptions
(
int
index
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
setMethods(int index, Method value)
public
Api
.
Builder
setMethods
(
int
index
,
Method
value
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
setMethods(int index, Method.Builder builderForValue)
public
Api
.
Builder
setMethods
(
int
index
,
Method
.
Builder
builderForValue
)
The methods of this interface, in unspecified order.
repeated .google.protobuf.Method methods = 2;
setMixins(int index, Mixin value)
public
Api
.
Builder
setMixins
(
int
index
,
Mixin
value
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
setMixins(int index, Mixin.Builder builderForValue)
public
Api
.
Builder
setMixins
(
int
index
,
Mixin
.
Builder
builderForValue
)
Included interfaces. See [Mixin][].
repeated .google.protobuf.Mixin mixins = 6;
setName(String value)
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;
setNameBytes(ByteString value)
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;
setOptions(int index, Option value)
public
Api
.
Builder
setOptions
(
int
index
,
Option
value
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
setOptions(int index, Option.Builder builderForValue)
public
Api
.
Builder
setOptions
(
int
index
,
Option
.
Builder
builderForValue
)
Any metadata attached to the interface.
repeated .google.protobuf.Option options = 3;
setSourceContext(SourceContext value)
public
Api
.
Builder
setSourceContext
(
SourceContext
value
)
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
setSourceContext(SourceContext.Builder builderForValue)
public
Api
.
Builder
setSourceContext
(
SourceContext
.
Builder
builderForValue
)
Source context for the protocol buffer service represented by this message.
.google.protobuf.SourceContext source_context = 5;
setSyntax(Syntax value)
public
Api
.
Builder
setSyntax
(
Syntax
value
)
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
setSyntaxValue(int value)
public
Api
.
Builder
setSyntaxValue
(
int
value
)
The source syntax of the service.
.google.protobuf.Syntax syntax = 7;
setVersion(String value)
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
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(ByteString value)
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
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;
