Class FunctionCall.Builder (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class FunctionCall.Builder extends GeneratedMessage.Builder<FunctionCall.Builder> implements FunctionCallOrBuilder

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

Protobuf type google.cloud.vertexai.v1.FunctionCall

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > FunctionCall.Builder

Implements

FunctionCallOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllPartialArgs(Iterable<? extends PartialArg> values)

public FunctionCall.Builder addAllPartialArgs(Iterable<? extends PartialArg> values)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.vertexai.api.PartialArg>

Returns
Type	Description
FunctionCall.Builder

addPartialArgs(PartialArg value)

public FunctionCall.Builder addPartialArgs(PartialArg value)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	PartialArg

Returns
Type	Description
FunctionCall.Builder

addPartialArgs(PartialArg.Builder builderForValue)

public FunctionCall.Builder addPartialArgs(PartialArg.Builder builderForValue)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	PartialArg.Builder

Returns
Type	Description
FunctionCall.Builder

addPartialArgs(int index, PartialArg value)

public FunctionCall.Builder addPartialArgs(int index, PartialArg value)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	PartialArg

Returns
Type	Description
FunctionCall.Builder

addPartialArgs(int index, PartialArg.Builder builderForValue)

public FunctionCall.Builder addPartialArgs(int index, PartialArg.Builder builderForValue)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	PartialArg.Builder

Returns
Type	Description
FunctionCall.Builder

addPartialArgsBuilder()

public PartialArg.Builder addPartialArgsBuilder()

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PartialArg.Builder

addPartialArgsBuilder(int index)

public PartialArg.Builder addPartialArgsBuilder(int index)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PartialArg.Builder

build()

public FunctionCall build()

Returns
Type	Description
FunctionCall

buildPartial()

public FunctionCall buildPartial()

Returns
Type	Description
FunctionCall

clear()

public FunctionCall.Builder clear()

Returns
Type	Description
FunctionCall.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearArgs()

public FunctionCall.Builder clearArgs()

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FunctionCall.Builder

clearName()

public FunctionCall.Builder clearName()

Optional. The name of the function to call. Matches [FunctionDeclaration.name].

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FunctionCall.Builder	This builder for chaining.

clearPartialArgs()

public FunctionCall.Builder clearPartialArgs()

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FunctionCall.Builder

clearWillContinue()

public FunctionCall.Builder clearWillContinue()

Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.

bool will_continue = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FunctionCall.Builder	This builder for chaining.

getArgs()

public Struct getArgs()

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The args.

getArgsBuilder()

public Struct.Builder getArgsBuilder()

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getArgsOrBuilder()

public StructOrBuilder getArgsOrBuilder()

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getDefaultInstanceForType()

public FunctionCall getDefaultInstanceForType()

Returns
Type	Description
FunctionCall

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

Optional. The name of the function to call. Matches [FunctionDeclaration.name].

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The name of the function to call. Matches [FunctionDeclaration.name].

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for name.

getPartialArgs(int index)

public PartialArg getPartialArgs(int index)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PartialArg

getPartialArgsBuilder(int index)

public PartialArg.Builder getPartialArgsBuilder(int index)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PartialArg.Builder

getPartialArgsBuilderList()

public List<PartialArg.Builder> getPartialArgsBuilderList()

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getPartialArgsCount()

public int getPartialArgsCount()

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getPartialArgsList()

public List<PartialArg> getPartialArgsList()

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<PartialArg>

getPartialArgsOrBuilder(int index)

public PartialArgOrBuilder getPartialArgsOrBuilder(int index)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PartialArgOrBuilder

getPartialArgsOrBuilderList()

public List<? extends PartialArgOrBuilder> getPartialArgsOrBuilderList()

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.PartialArgOrBuilder>

getWillContinue()

public boolean getWillContinue()

Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.

bool will_continue = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The willContinue.

hasArgs()

public boolean hasArgs()

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the args field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeArgs(Struct value)

public FunctionCall.Builder mergeArgs(Struct value)

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
FunctionCall.Builder

mergeFrom(FunctionCall other)

public FunctionCall.Builder mergeFrom(FunctionCall other)

Parameter
Name	Description
other	FunctionCall

Returns
Type	Description
FunctionCall.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunctionCall.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FunctionCall.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FunctionCall.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

removePartialArgs(int index)

public FunctionCall.Builder removePartialArgs(int index)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FunctionCall.Builder

setArgs(Struct value)

public FunctionCall.Builder setArgs(Struct value)

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
FunctionCall.Builder

setArgs(Struct.Builder builderForValue)

public FunctionCall.Builder setArgs(Struct.Builder builderForValue)

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
FunctionCall.Builder

setName(String value)

public FunctionCall.Builder setName(String value)

Optional. The name of the function to call. Matches [FunctionDeclaration.name].

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
FunctionCall.Builder	This builder for chaining.

setNameBytes(ByteString value)

public FunctionCall.Builder setNameBytes(ByteString value)

Optional. The name of the function to call. Matches [FunctionDeclaration.name].

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
FunctionCall.Builder	This builder for chaining.

setPartialArgs(int index, PartialArg value)

public FunctionCall.Builder setPartialArgs(int index, PartialArg value)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	PartialArg

Returns
Type	Description
FunctionCall.Builder

setPartialArgs(int index, PartialArg.Builder builderForValue)

public FunctionCall.Builder setPartialArgs(int index, PartialArg.Builder builderForValue)

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

repeated .google.cloud.vertexai.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	PartialArg.Builder

Returns
Type	Description
FunctionCall.Builder

setWillContinue(boolean value)

public FunctionCall.Builder setWillContinue(boolean value)

Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.

bool will_continue = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The willContinue to set.

Returns
Type	Description
FunctionCall.Builder	This builder for chaining.