Api.Builder (Protocol Buffers [Lite] 3.0.1 API)

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, 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 a protocol buffer service.

Protobuf type google.protobuf.Api

Field Summary
- Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
  instance, isBuilt

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Api.Builder`	`addAllMethods(Iterable<? extends Method> values)` The methods of this api, in unspecified order.
`Api.Builder`	`addAllMixins(Iterable<? extends Mixin> values)` Included APIs.
`Api.Builder`	`addAllOptions(Iterable<? extends Option> values)` Any metadata attached to the API.
`Api.Builder`	`addMethods(int index, Method.Builder builderForValue)` The methods of this api, in unspecified order.
`Api.Builder`	`addMethods(int index, Method value)` The methods of this api, in unspecified order.
`Api.Builder`	`addMethods(Method.Builder builderForValue)` The methods of this api, in unspecified order.
`Api.Builder`	`addMethods(Method value)` The methods of this api, in unspecified order.
`Api.Builder`	`addMixins(int index, Mixin.Builder builderForValue)` Included APIs.
`Api.Builder`	`addMixins(int index, Mixin value)` Included APIs.
`Api.Builder`	`addMixins(Mixin.Builder builderForValue)` Included APIs.
`Api.Builder`	`addMixins(Mixin value)` Included APIs.
`Api.Builder`	`addOptions(int index, Option.Builder builderForValue)` Any metadata attached to the API.
`Api.Builder`	`addOptions(int index, Option value)` Any metadata attached to the API.
`Api.Builder`	`addOptions(Option.Builder builderForValue)` Any metadata attached to the API.
`Api.Builder`	`addOptions(Option value)` Any metadata attached to the API.
`Api.Builder`	`clearMethods()` The methods of this api, in unspecified order.
`Api.Builder`	`clearMixins()` Included APIs.
`Api.Builder`	`clearName()` The fully qualified name of this api, including package name followed by the api's simple name.
`Api.Builder`	`clearOptions()` Any metadata attached to the API.
`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 api.
`Method`	`getMethods(int index)` The methods of this api, in unspecified order.
`int`	`getMethodsCount()` The methods of this api, in unspecified order.
`List<Method>`	`getMethodsList()` The methods of this api, in unspecified order.
`Mixin`	`getMixins(int index)` Included APIs.
`int`	`getMixinsCount()` Included APIs.
`List<Mixin>`	`getMixinsList()` Included APIs.
`String`	`getName()` The fully qualified name of this api, including package name followed by the api's simple name.
`ByteString`	`getNameBytes()` The fully qualified name of this api, including package name followed by the api's simple name.
`Option`	`getOptions(int index)` Any metadata attached to the API.
`int`	`getOptionsCount()` Any metadata attached to the API.
`List<Option>`	`getOptionsList()` Any metadata attached to the API.
`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 api.
`ByteString`	`getVersionBytes()` A version string for this api.
`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 api, in unspecified order.
`Api.Builder`	`removeMixins(int index)` Included APIs.
`Api.Builder`	`removeOptions(int index)` Any metadata attached to the API.
`Api.Builder`	`setMethods(int index, Method.Builder builderForValue)` The methods of this api, in unspecified order.
`Api.Builder`	`setMethods(int index, Method value)` The methods of this api, in unspecified order.
`Api.Builder`	`setMixins(int index, Mixin.Builder builderForValue)` Included APIs.
`Api.Builder`	`setMixins(int index, Mixin value)` Included APIs.
`Api.Builder`	`setName(String value)` The fully qualified name of this api, including package name followed by the api's simple name.
`Api.Builder`	`setNameBytes(ByteString value)` The fully qualified name of this api, including package name followed by the api's simple name.
`Api.Builder`	`setOptions(int index, Option.Builder builderForValue)` Any metadata attached to the API.
`Api.Builder`	`setOptions(int index, Option value)` Any metadata attached to the API.
`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 api.
`Api.Builder`	`setVersionBytes(ByteString value)` A version string for this api.

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, 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 String getName()

 The fully qualified name of this api, including package name
 followed by the api's simple name.

optional string name = 1;

Specified by:: getName in interface ApiOrBuilder

getNameBytes

public ByteString getNameBytes()

 The fully qualified name of this api, including package name
 followed by the api's simple name.

optional string name = 1;

Specified by:: getNameBytes in interface ApiOrBuilder

setName

public Api.Builder setName(String value)

 The fully qualified name of this api, including package name
 followed by the api's simple name.

optional string name = 1;

clearName

public Api.Builder clearName()

 The fully qualified name of this api, including package name
 followed by the api's simple name.

optional string name = 1;

setNameBytes

public Api.Builder setNameBytes(ByteString value)

 The fully qualified name of this api, including package name
 followed by the api's simple name.

optional string name = 1;

getMethodsList
```
public List<Method> getMethodsList()
```
```
 The methods of this api, in unspecified order.
 
```
repeated .google.protobuf.Method methods = 2;
Specified by:

getMethodsList in interface ApiOrBuilder

getMethodsCount
```
public int getMethodsCount()
```
```
 The methods of this api, 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 api, 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 api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

setMethods

public Api.Builder setMethods(int index,
                              Method.Builder builderForValue)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

addMethods

public Api.Builder addMethods(Method value)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

addMethods

public Api.Builder addMethods(int index,
                              Method value)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

addMethods

public Api.Builder addMethods(Method.Builder builderForValue)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

addMethods

public Api.Builder addMethods(int index,
                              Method.Builder builderForValue)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

addAllMethods

public Api.Builder addAllMethods(Iterable<? extends Method> values)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

clearMethods

public Api.Builder clearMethods()

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

removeMethods

public Api.Builder removeMethods(int index)

 The methods of this api, in unspecified order.

repeated .google.protobuf.Method methods = 2;

getOptionsList
```
public List<Option> getOptionsList()
```
```
 Any metadata attached to the API.
 
```
repeated .google.protobuf.Option options = 3;
Specified by:

getOptionsList in interface ApiOrBuilder

getOptionsCount
```
public int getOptionsCount()
```
```
 Any metadata attached to the API.
 
```
repeated .google.protobuf.Option options = 3;
Specified by:

getOptionsCount in interface ApiOrBuilder

getOptions
```
public Option getOptions(int index)
```
```
 Any metadata attached to the API.
 
```
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 API.

repeated .google.protobuf.Option options = 3;

setOptions

public Api.Builder setOptions(int index,
                              Option.Builder builderForValue)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

addOptions

public Api.Builder addOptions(Option value)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

addOptions

public Api.Builder addOptions(int index,
                              Option value)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

addOptions

public Api.Builder addOptions(Option.Builder builderForValue)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

addOptions

public Api.Builder addOptions(int index,
                              Option.Builder builderForValue)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

addAllOptions

public Api.Builder addAllOptions(Iterable<? extends Option> values)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

clearOptions

public Api.Builder clearOptions()

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

removeOptions

public Api.Builder removeOptions(int index)

 Any metadata attached to the API.

repeated .google.protobuf.Option options = 3;

getVersion

public String getVersion()

 A version string for this api. 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
 API, 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, none-GA apis.

optional string version = 4;

Specified by:: getVersion in interface ApiOrBuilder

getVersionBytes

public ByteString getVersionBytes()

 A version string for this api. 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
 API, 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, none-GA apis.

optional string version = 4;

Specified by:: getVersionBytes in interface ApiOrBuilder

setVersion

public Api.Builder setVersion(String value)

 A version string for this api. 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
 API, 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, none-GA apis.

optional string version = 4;

clearVersion

public Api.Builder clearVersion()

 A version string for this api. 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
 API, 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, none-GA apis.

optional string version = 4;

setVersionBytes

public Api.Builder setVersionBytes(ByteString value)

 A version string for this api. 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
 API, 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, none-GA apis.

optional string version = 4;

hasSourceContext
```
public boolean hasSourceContext()
```
```
 Source context for the protocol buffer service represented by this
 message.
 
```
optional .google.protobuf.SourceContext source_context = 5;
Specified by:

hasSourceContext in interface ApiOrBuilder

getSourceContext
```
public SourceContext getSourceContext()
```
```
 Source context for the protocol buffer service represented by this
 message.
 
```
optional .google.protobuf.SourceContext source_context = 5;
Specified by:

getSourceContext in interface ApiOrBuilder

setSourceContext

public Api.Builder setSourceContext(SourceContext value)

 Source context for the protocol buffer service represented by this
 message.

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

optional .google.protobuf.SourceContext source_context = 5;

mergeSourceContext

public Api.Builder mergeSourceContext(SourceContext value)

 Source context for the protocol buffer service represented by this
 message.

optional .google.protobuf.SourceContext source_context = 5;

clearSourceContext

public Api.Builder clearSourceContext()

 Source context for the protocol buffer service represented by this
 message.

optional .google.protobuf.SourceContext source_context = 5;

getMixinsList
```
public List<Mixin> getMixinsList()
```
```
 Included APIs. See [Mixin][].
 
```
repeated .google.protobuf.Mixin mixins = 6;
Specified by:

getMixinsList in interface ApiOrBuilder

getMixinsCount
```
public int getMixinsCount()
```
```
 Included APIs. See [Mixin][].
 
```
repeated .google.protobuf.Mixin mixins = 6;
Specified by:

getMixinsCount in interface ApiOrBuilder

getMixins
```
public Mixin getMixins(int index)
```
```
 Included APIs. See [Mixin][].
 
```
repeated .google.protobuf.Mixin mixins = 6;
Specified by:

getMixins in interface ApiOrBuilder