Api.Builder

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>
    - - com.google.protobuf.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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.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.
`Method.Builder`	`addMethodsBuilder()` The methods of this interface, in unspecified order.
`Method.Builder`	`addMethodsBuilder(int index)` 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.
`Mixin.Builder`	`addMixinsBuilder()` Included interfaces.
`Mixin.Builder`	`addMixinsBuilder(int index)` 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.
`Option.Builder`	`addOptionsBuilder()` Any metadata attached to the interface.
`Option.Builder`	`addOptionsBuilder(int index)` Any metadata attached to the interface.
`Api.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)` Like `setRepeatedField`, but appends the value as a new element.
`Api`	`build()` Constructs the message based on the state of the Builder.
`Api`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Api.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`Api.Builder`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`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`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`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.
`Api.Builder`	`clone()` Clones the Builder.
`Api`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`Method`	`getMethods(int index)` The methods of this interface, in unspecified order.
`Method.Builder`	`getMethodsBuilder(int index)` The methods of this interface, in unspecified order.
`java.util.List<Method.Builder>`	`getMethodsBuilderList()` 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.
`MethodOrBuilder`	`getMethodsOrBuilder(int index)` The methods of this interface, in unspecified order.
`java.util.List<? extends MethodOrBuilder>`	`getMethodsOrBuilderList()` The methods of this interface, in unspecified order.
`Mixin`	`getMixins(int index)` Included interfaces.
`Mixin.Builder`	`getMixinsBuilder(int index)` Included interfaces.
`java.util.List<Mixin.Builder>`	`getMixinsBuilderList()` Included interfaces.
`int`	`getMixinsCount()` Included interfaces.
`java.util.List<Mixin>`	`getMixinsList()` Included interfaces.
`MixinOrBuilder`	`getMixinsOrBuilder(int index)` Included interfaces.
`java.util.List<? extends MixinOrBuilder>`	`getMixinsOrBuilderList()` 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.
`Option.Builder`	`getOptionsBuilder(int index)` Any metadata attached to the interface.
`java.util.List<Option.Builder>`	`getOptionsBuilderList()` 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.
`OptionOrBuilder`	`getOptionsOrBuilder(int index)` Any metadata attached to the interface.
`java.util.List<? extends OptionOrBuilder>`	`getOptionsOrBuilderList()` Any metadata attached to the interface.
`SourceContext`	`getSourceContext()` Source context for the protocol buffer service represented by this message.
`SourceContext.Builder`	`getSourceContextBuilder()` Source context for the protocol buffer service represented by this message.
`SourceContextOrBuilder`	`getSourceContextOrBuilder()` 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.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Api.Builder`	`mergeFrom(Api other)`
`Api.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Api.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Api.Builder`	`mergeSourceContext(SourceContext value)` Source context for the protocol buffer service represented by this message.
`Api.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for 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`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)` Sets a field to the given value.
`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(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.Builder builderForValue)` Any metadata attached to the interface.
`Api.Builder`	`setOptions(int index, Option value)` Any metadata attached to the interface.
`Api.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)` Sets an element of a repeated field to the given value.
`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`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.
`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.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
mergeFrom

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType 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

build
```
public Api build()
```
Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public Api buildPartial()
```
Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public Api.Builder clone()
```
Description copied from interface: MessageLite.Builder

Clones the Builder.

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

See Also:

Object.clone()

setField
```
public Api.Builder setField(Descriptors.FieldDescriptor field,
                            java.lang.Object value)
```
Description copied from interface: Message.Builder

Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.

Specified by:

setField in interface Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

clearField
```
public Api.Builder clearField(Descriptors.FieldDescriptor field)
```
Description copied from interface: Message.Builder

Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

clearOneof
```
public Api.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Description copied from class: AbstractMessage.Builder

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

setRepeatedField
```
public Api.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                    int index,
                                    java.lang.Object value)
```
Description copied from interface: Message.Builder

Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

addRepeatedField
```
public Api.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
```
Description copied from interface: Message.Builder

Like setRepeatedField, but appends the value as a new element.

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

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>

mergeFrom

public Api.Builder mergeFrom(Api other)

isInitialized
```
public final boolean isInitialized()
```
Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.
See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Builder>

mergeFrom
```
public Api.Builder mergeFrom(CodedInputStream input,
                             ExtensionRegistryLite extensionRegistry)
                      throws java.io.IOException
```
Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Api.Builder>

Throws:

java.io.IOException

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