Api.Function.Builder (volc-sdk-java 1.0.230 API)

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

All Implemented Interfaces:

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

Enclosing class:

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Api.Function.Builder`	`addAllExamples(Iterable<String> values)` The examples of the function parameters, as the above json schema describes.
`Api.Function.Builder`	`addExamples(String value)` The examples of the function parameters, as the above json schema describes.
`Api.Function.Builder`	`addExamplesBytes(com.google.protobuf.ByteString value)` The examples of the function parameters, as the above json schema describes.
`Api.Function.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Api.Function`	`build()`
`Api.Function`	`buildPartial()`
`Api.Function.Builder`	`clear()`
`Api.Function.Builder`	`clearDescription()` A description of the function, used by the model to choose when and how to call the function.
`Api.Function.Builder`	`clearExamples()` The examples of the function parameters, as the above json schema describes.
`Api.Function.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Api.Function.Builder`	`clearName()` The name of the function.
`Api.Function.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Api.Function.Builder`	`clearParameters()` The parameters of the function, described as Json Schema.
`Api.Function.Builder`	`clone()`
`Api.Function`	`getDefaultInstanceForType()`
`String`	`getDescription()` A description of the function, used by the model to choose when and how to call the function.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` A description of the function, used by the model to choose when and how to call the function.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getExamples(int index)` The examples of the function parameters, as the above json schema describes.
`com.google.protobuf.ByteString`	`getExamplesBytes(int index)` The examples of the function parameters, as the above json schema describes.
`int`	`getExamplesCount()` The examples of the function parameters, as the above json schema describes.
`com.google.protobuf.ProtocolStringList`	`getExamplesList()` The examples of the function parameters, as the above json schema describes.
`String`	`getName()` The name of the function.
`com.google.protobuf.ByteString`	`getNameBytes()` The name of the function.
`com.google.protobuf.Struct`	`getParameters()` The parameters of the function, described as Json Schema.
`com.google.protobuf.Struct.Builder`	`getParametersBuilder()` The parameters of the function, described as Json Schema.
`com.google.protobuf.StructOrBuilder`	`getParametersOrBuilder()` The parameters of the function, described as Json Schema.
`boolean`	`hasParameters()` The parameters of the function, described as Json Schema.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Api.Function.Builder`	`mergeFrom(Api.Function other)`
`Api.Function.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Api.Function.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Api.Function.Builder`	`mergeParameters(com.google.protobuf.Struct value)` The parameters of the function, described as Json Schema.
`Api.Function.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Api.Function.Builder`	`setDescription(String value)` A description of the function, used by the model to choose when and how to call the function.
`Api.Function.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` A description of the function, used by the model to choose when and how to call the function.
`Api.Function.Builder`	`setExamples(int index, String value)` The examples of the function parameters, as the above json schema describes.
`Api.Function.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Api.Function.Builder`	`setName(String value)` The name of the function.
`Api.Function.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The name of the function.
`Api.Function.Builder`	`setParameters(com.google.protobuf.Struct.Builder builderForValue)` The parameters of the function, described as Json Schema.
`Api.Function.Builder`	`setParameters(com.google.protobuf.Struct value)` The parameters of the function, described as Json Schema.
`Api.Function.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Api.Function.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.Function.Builder>
  - clear
```
public Api.Function.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.Function.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.Function.Builder>
  - getDefaultInstanceForType
```
public Api.Function getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Api.Function build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Api.Function buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Api.Function.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.Function.Builder>
  - setField
```
public Api.Function.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.Function.Builder>
  - clearField
```
public Api.Function.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.Function.Builder>
  - clearOneof
```
public Api.Function.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.Function.Builder>
  - setRepeatedField
```
public Api.Function.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.Function.Builder>
  - addRepeatedField
```
public Api.Function.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.Function.Builder>
  - mergeFrom
```
public Api.Function.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.Function.Builder>
  - mergeFrom
```
public Api.Function.Builder mergeFrom(Api.Function 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.Function.Builder>
  - mergeFrom
```
public Api.Function.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.Function.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
```
 The name of the function.
 
```
    string name = 1;
    Specified by:
    
    getName in interface Api.FunctionOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The name of the function.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface Api.FunctionOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public Api.Function.Builder setName(String value)
```
```
 The name of the function.
 
```
    string name = 1;
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - clearName
```
public Api.Function.Builder clearName()
```
```
 The name of the function.
 
```
    string name = 1;
    Returns:
    
    This builder for chaining.
  - setNameBytes
```
public Api.Function.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 The name of the function.
 
```
    string name = 1;
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - getDescription
```
public String getDescription()
```
```
 A description of the function, used by the model to choose when and how to
 call the function.
 
```
    string description = 2;
    Specified by:
    
    getDescription in interface Api.FunctionOrBuilder
    
    Returns:
    
    The description.
  - getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 A description of the function, used by the model to choose when and how to
 call the function.
 
```
    string description = 2;
    Specified by:
    
    getDescriptionBytes in interface Api.FunctionOrBuilder
    
    Returns:
    
    The bytes for description.
  - setDescription
```
public Api.Function.Builder setDescription(String value)
```
```
 A description of the function, used by the model to choose when and how to
 call the function.
 
```
    string description = 2;
    Parameters:
    
    value - The description to set.
    
    Returns:
    
    This builder for chaining.
  - clearDescription
```
public Api.Function.Builder clearDescription()
```
```
 A description of the function, used by the model to choose when and how to
 call the function.
 
```
    string description = 2;
    Returns:
    
    This builder for chaining.
  - setDescriptionBytes
```
public Api.Function.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
```
```
 A description of the function, used by the model to choose when and how to
 call the function.
 
```
    string description = 2;
    Parameters:
    
    value - The bytes for description to set.
    
    Returns:
    
    This builder for chaining.
  - hasParameters
```
public boolean hasParameters()
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
    Specified by:
    
    hasParameters in interface Api.FunctionOrBuilder
    
    Returns:
    
    Whether the parameters field is set.
  - getParameters
```
public com.google.protobuf.Struct getParameters()
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
    Specified by:
    
    getParameters in interface Api.FunctionOrBuilder
    
    Returns:
    
    The parameters.
  - setParameters
```
public Api.Function.Builder setParameters(com.google.protobuf.Struct value)
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
  - setParameters
```
public Api.Function.Builder setParameters(com.google.protobuf.Struct.Builder builderForValue)
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
  - mergeParameters
```
public Api.Function.Builder mergeParameters(com.google.protobuf.Struct value)
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
  - clearParameters
```
public Api.Function.Builder clearParameters()
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
  - getParametersBuilder
```
public com.google.protobuf.Struct.Builder getParametersBuilder()
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
  - getParametersOrBuilder
```
public com.google.protobuf.StructOrBuilder getParametersOrBuilder()
```
```
 The parameters of the function, described as Json Schema.
 
```
    .google.protobuf.Struct parameters = 3;
    Specified by:
    
    getParametersOrBuilder in interface Api.FunctionOrBuilder
  - getExamplesList
```
public com.google.protobuf.ProtocolStringList getExamplesList()
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Specified by:
    
    getExamplesList in interface Api.FunctionOrBuilder
    
    Returns:
    
    A list containing the examples.
  - getExamplesCount
```
public int getExamplesCount()
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Specified by:
    
    getExamplesCount in interface Api.FunctionOrBuilder
    
    Returns:
    
    The count of examples.
  - getExamples
```
public String getExamples(int index)
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Specified by:
    
    getExamples in interface Api.FunctionOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The examples at the given index.
  - getExamplesBytes
```
public com.google.protobuf.ByteString getExamplesBytes(int index)
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Specified by:
    
    getExamplesBytes in interface Api.FunctionOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the examples at the given index.
  - setExamples
```
public Api.Function.Builder setExamples(int index,
                                        String value)
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Parameters:
    
    index - The index to set the value at.
    
    value - The examples to set.
    
    Returns:
    
    This builder for chaining.
  - addExamples
```
public Api.Function.Builder addExamples(String value)
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Parameters:
    
    value - The examples to add.
    
    Returns:
    
    This builder for chaining.
  - addAllExamples
```
public Api.Function.Builder addAllExamples(Iterable<String> values)
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Parameters:
    
    values - The examples to add.
    
    Returns:
    
    This builder for chaining.
  - clearExamples
```
public Api.Function.Builder clearExamples()
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Returns:
    
    This builder for chaining.
  - addExamplesBytes
```
public Api.Function.Builder addExamplesBytes(com.google.protobuf.ByteString value)
```
```
 The examples of the function parameters, as the above json schema
 describes.
 
```
    repeated string examples = 4;
    Parameters:
    
    value - The bytes of the examples to add.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Api.Function.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Function.Builder>
  - mergeUnknownFields
```
public final Api.Function.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Function.Builder>

Class Api.Function.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getDescription

getDescriptionBytes

setDescription

clearDescription

setDescriptionBytes

hasParameters

getParameters

setParameters

setParameters

mergeParameters

clearParameters

getParametersBuilder

getParametersOrBuilder

getExamplesList

getExamplesCount

getExamples

getExamplesBytes

setExamples

addExamples

addAllExamples

clearExamples

addExamplesBytes

setUnknownFields

mergeUnknownFields