Class FunctionCall.Builder (3.82.0)

public static final class FunctionCall.Builder extends GeneratedMessageV3.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.aiplatform.v1.FunctionCall

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.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
PartialArg.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FunctionCall.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunctionCall.Builder
Overrides

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

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

clearField(Descriptors.FieldDescriptor field)

public FunctionCall.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FunctionCall.Builder
Overrides

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.

clearOneof(Descriptors.OneofDescriptor oneof)

public FunctionCall.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FunctionCall.Builder
Overrides

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

clone()

public FunctionCall.Builder clone()
Returns
Type Description
FunctionCall.Builder
Overrides

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

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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FunctionCall.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FunctionCall.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FunctionCall.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunctionCall.Builder
Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

public FunctionCall.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunctionCall.Builder
Overrides

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.aiplatform.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.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue PartialArg.Builder
Returns
Type Description
FunctionCall.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FunctionCall.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FunctionCall.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FunctionCall.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunctionCall.Builder
Overrides

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.