Api.Message.Builder (volc-sdk-java 1.0.214 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>
    - - com.volcengine.model.maas.api.Api.Message.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Api.MessageOrBuilder, Cloneable

Enclosing class:

Api.Message
```
public static final class Api.Message.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>
implements Api.MessageOrBuilder
```
Protobuf type api.Message

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Api.Message.Builder`	`addAllReferences(Iterable<? extends Api.Reference> values)` url reference for searching, optional
`Api.Message.Builder`	`addReferences(Api.Reference.Builder builderForValue)` url reference for searching, optional
`Api.Message.Builder`	`addReferences(Api.Reference value)` url reference for searching, optional
`Api.Message.Builder`	`addReferences(int index, Api.Reference.Builder builderForValue)` url reference for searching, optional
`Api.Message.Builder`	`addReferences(int index, Api.Reference value)` url reference for searching, optional
`Api.Reference.Builder`	`addReferencesBuilder()` url reference for searching, optional
`Api.Reference.Builder`	`addReferencesBuilder(int index)` url reference for searching, optional
`Api.Message.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Api.Message`	`build()`
`Api.Message`	`buildPartial()`
`Api.Message.Builder`	`clear()`
`Api.Message.Builder`	`clearContent()` The real content of the message, may be empty for assistant message with function call.
`Api.Message.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Api.Message.Builder`	`clearFunctionCall()` The name and arguments of a function call generated by model.
`Api.Message.Builder`	`clearName()` If the role is `function`, is the name of the function which generate the content.
`Api.Message.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Api.Message.Builder`	`clearReferences()` url reference for searching, optional
`Api.Message.Builder`	`clearRole()` The role of the author of this message.
`Api.Message.Builder`	`clone()`
`String`	`getContent()` The real content of the message, may be empty for assistant message with function call.
`com.google.protobuf.ByteString`	`getContentBytes()` The real content of the message, may be empty for assistant message with function call.
`Api.Message`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`Api.FunctionCall`	`getFunctionCall()` The name and arguments of a function call generated by model.
`Api.FunctionCall.Builder`	`getFunctionCallBuilder()` The name and arguments of a function call generated by model.
`Api.FunctionCallOrBuilder`	`getFunctionCallOrBuilder()` The name and arguments of a function call generated by model.
`String`	`getName()` If the role is `function`, is the name of the function which generate the content.
`com.google.protobuf.ByteString`	`getNameBytes()` If the role is `function`, is the name of the function which generate the content.
`Api.Reference`	`getReferences(int index)` url reference for searching, optional
`Api.Reference.Builder`	`getReferencesBuilder(int index)` url reference for searching, optional
`List<Api.Reference.Builder>`	`getReferencesBuilderList()` url reference for searching, optional
`int`	`getReferencesCount()` url reference for searching, optional
`List<Api.Reference>`	`getReferencesList()` url reference for searching, optional
`Api.ReferenceOrBuilder`	`getReferencesOrBuilder(int index)` url reference for searching, optional
`List<? extends Api.ReferenceOrBuilder>`	`getReferencesOrBuilderList()` url reference for searching, optional
`String`	`getRole()` The role of the author of this message.
`com.google.protobuf.ByteString`	`getRoleBytes()` The role of the author of this message.
`boolean`	`hasFunctionCall()` The name and arguments of a function call generated by model.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Api.Message.Builder`	`mergeFrom(Api.Message other)`
`Api.Message.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Api.Message.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Api.Message.Builder`	`mergeFunctionCall(Api.FunctionCall value)` The name and arguments of a function call generated by model.
`Api.Message.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Api.Message.Builder`	`removeReferences(int index)` url reference for searching, optional
`Api.Message.Builder`	`setContent(String value)` The real content of the message, may be empty for assistant message with function call.
`Api.Message.Builder`	`setContentBytes(com.google.protobuf.ByteString value)` The real content of the message, may be empty for assistant message with function call.
`Api.Message.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Api.Message.Builder`	`setFunctionCall(Api.FunctionCall.Builder builderForValue)` The name and arguments of a function call generated by model.
`Api.Message.Builder`	`setFunctionCall(Api.FunctionCall value)` The name and arguments of a function call generated by model.
`Api.Message.Builder`	`setName(String value)` If the role is `function`, is the name of the function which generate the content.
`Api.Message.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` If the role is `function`, is the name of the function which generate the content.
`Api.Message.Builder`	`setReferences(int index, Api.Reference.Builder builderForValue)` url reference for searching, optional
`Api.Message.Builder`	`setReferences(int index, Api.Reference value)` url reference for searching, optional
`Api.Message.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Api.Message.Builder`	`setRole(String value)` The role of the author of this message.
`Api.Message.Builder`	`setRoleBytes(com.google.protobuf.ByteString value)` The role of the author of this message.
`Api.Message.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

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

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>

clear
```
public Api.Message.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>

getDefaultInstanceForType
```
public Api.Message getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Api.Message build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Api.Message buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Api.Message.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

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

setField

public Api.Message.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>

clearField
```
public Api.Message.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

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

clearOneof
```
public Api.Message.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

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

setRepeatedField

public Api.Message.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>

addRepeatedField

public Api.Message.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Message.Builder>

mergeFrom
```
public Api.Message.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Api.Message.Builder>

mergeFrom

public Api.Message.Builder mergeFrom(Api.Message other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public Api.Message.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Api.Message.Builder>

Throws:

IOException

getRole

public String getRole()

 The role of the author of this message. One of system, user, assistant or
 function.

string role = 1;

Specified by:: getRole in interface Api.MessageOrBuilder
Returns:: The role.

getRoleBytes

public com.google.protobuf.ByteString getRoleBytes()

 The role of the author of this message. One of system, user, assistant or
 function.

string role = 1;

Specified by:: getRoleBytes in interface Api.MessageOrBuilder
Returns:: The bytes for role.

setRole

public Api.Message.Builder setRole(String value)

 The role of the author of this message. One of system, user, assistant or
 function.

string role = 1;

Parameters:: value - The role to set.
Returns:: This builder for chaining.

clearRole

public Api.Message.Builder clearRole()

 The role of the author of this message. One of system, user, assistant or
 function.

string role = 1;

Returns:: This builder for chaining.

setRoleBytes

public Api.Message.Builder setRoleBytes(com.google.protobuf.ByteString value)

 The role of the author of this message. One of system, user, assistant or
 function.

string role = 1;

Parameters:: value - The bytes for role to set.
Returns:: This builder for chaining.

getContent

public String getContent()

 The real content of the message, may be empty for assistant message with
 function call.

string content = 2;

Specified by:: getContent in interface Api.MessageOrBuilder
Returns:: The content.

getContentBytes

public com.google.protobuf.ByteString getContentBytes()

 The real content of the message, may be empty for assistant message with
 function call.

string content = 2;

Specified by:: getContentBytes in interface Api.MessageOrBuilder
Returns:: The bytes for content.

setContent

public Api.Message.Builder setContent(String value)

 The real content of the message, may be empty for assistant message with
 function call.

string content = 2;

Parameters:: value - The content to set.
Returns:: This builder for chaining.

clearContent

public Api.Message.Builder clearContent()

 The real content of the message, may be empty for assistant message with
 function call.

string content = 2;

Returns:: This builder for chaining.

setContentBytes

public Api.Message.Builder setContentBytes(com.google.protobuf.ByteString value)

 The real content of the message, may be empty for assistant message with
 function call.

string content = 2;

Parameters:: value - The bytes for content to set.
Returns:: This builder for chaining.

getName

public String getName()

 If the role is `function`, is the name of the function which generate the
 content.

string name = 4;

Specified by:: getName in interface Api.MessageOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 If the role is `function`, is the name of the function which generate the
 content.

string name = 4;

Specified by:: getNameBytes in interface Api.MessageOrBuilder
Returns:: The bytes for name.

setName

public Api.Message.Builder setName(String value)

 If the role is `function`, is the name of the function which generate the
 content.

string name = 4;

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Api.Message.Builder clearName()

 If the role is `function`, is the name of the function which generate the
 content.

string name = 4;

Returns:: This builder for chaining.

setNameBytes

public Api.Message.Builder setNameBytes(com.google.protobuf.ByteString value)

 If the role is `function`, is the name of the function which generate the
 content.

string name = 4;

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.

hasFunctionCall
```
public boolean hasFunctionCall()
```
```
 The name and arguments of a function call generated by model.
 
```
.api.FunctionCall function_call = 5;
Specified by:

hasFunctionCall in interface Api.MessageOrBuilder

Returns:

Whether the functionCall field is set.

getFunctionCall
```
public Api.FunctionCall getFunctionCall()
```
```
 The name and arguments of a function call generated by model.
 
```
.api.FunctionCall function_call = 5;
Specified by:

getFunctionCall in interface Api.MessageOrBuilder

Returns:

The functionCall.

setFunctionCall

public Api.Message.Builder setFunctionCall(Api.FunctionCall value)

 The name and arguments of a function call generated by model.

.api.FunctionCall function_call = 5;

setFunctionCall

public Api.Message.Builder setFunctionCall(Api.FunctionCall.Builder builderForValue)

 The name and arguments of a function call generated by model.

.api.FunctionCall function_call = 5;

mergeFunctionCall

public Api.Message.Builder mergeFunctionCall(Api.FunctionCall value)

 The name and arguments of a function call generated by model.

.api.FunctionCall function_call = 5;

clearFunctionCall

public Api.Message.Builder clearFunctionCall()

 The name and arguments of a function call generated by model.

.api.FunctionCall function_call = 5;

getFunctionCallBuilder

public Api.FunctionCall.Builder getFunctionCallBuilder()

 The name and arguments of a function call generated by model.

.api.FunctionCall function_call = 5;

getFunctionCallOrBuilder

public Api.FunctionCallOrBuilder getFunctionCallOrBuilder()

 The name and arguments of a function call generated by model.

.api.FunctionCall function_call = 5;

Specified by:: getFunctionCallOrBuilder in interface Api.MessageOrBuilder

getReferencesList
```
public List<Api.Reference> getReferencesList()
```
```
 url reference for searching, optional
 
```
repeated .api.Reference references = 3;
Specified by:

getReferencesList in interface Api.MessageOrBuilder

getReferencesCount
```
public int getReferencesCount()
```
```
 url reference for searching, optional
 
```
repeated .api.Reference references = 3;
Specified by:

getReferencesCount in interface Api.MessageOrBuilder

getReferences
```
public Api.Reference getReferences(int index)
```
```
 url reference for searching, optional
 
```
repeated .api.Reference references = 3;
Specified by:

getReferences in interface Api.MessageOrBuilder