Class FunctionCall.Builder (1.2.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.vertexai.v1.FunctionCall

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

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. Required. 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()

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

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

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

clone()

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

getArgs()

public Struct getArgs()

Optional. Required. 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. Required. 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. Required. 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()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

hasArgs()

public boolean hasArgs()

Optional. Required. 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. Required. 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

setArgs(Struct value)

public FunctionCall.Builder setArgs(Struct value)

Optional. Required. 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. Required. 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)

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

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

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)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
FunctionCall.Builder

This builder for chaining.

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