Class FunctionCallingConfig (3.42.0)

public final class FunctionCallingConfig extends GeneratedMessageV3 implements FunctionCallingConfigOrBuilder

Function calling config.

Protobuf type google.cloud.aiplatform.v1beta1.FunctionCallingConfig

Static Fields

ALLOWED_FUNCTION_NAMES_FIELD_NUMBER

public static final int ALLOWED_FUNCTION_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FunctionCallingConfig getDefaultInstance()
Returns
TypeDescription
FunctionCallingConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FunctionCallingConfig.Builder newBuilder()
Returns
TypeDescription
FunctionCallingConfig.Builder

newBuilder(FunctionCallingConfig prototype)

public static FunctionCallingConfig.Builder newBuilder(FunctionCallingConfig prototype)
Parameter
NameDescription
prototypeFunctionCallingConfig
Returns
TypeDescription
FunctionCallingConfig.Builder

parseDelimitedFrom(InputStream input)

public static FunctionCallingConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionCallingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FunctionCallingConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunctionCallingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunctionCallingConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunctionCallingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunctionCallingConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionCallingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FunctionCallingConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionCallingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FunctionCallingConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunctionCallingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionCallingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FunctionCallingConfig> parser()
Returns
TypeDescription
Parser<FunctionCallingConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllowedFunctionNames(int index)

public String getAllowedFunctionNames(int index)

Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowedFunctionNames at the given index.

getAllowedFunctionNamesBytes(int index)

public ByteString getAllowedFunctionNamesBytes(int index)

Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowedFunctionNames at the given index.

getAllowedFunctionNamesCount()

public int getAllowedFunctionNamesCount()

Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of allowedFunctionNames.

getAllowedFunctionNamesList()

public ProtocolStringList getAllowedFunctionNamesList()

Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the allowedFunctionNames.

getDefaultInstanceForType()

public FunctionCallingConfig getDefaultInstanceForType()
Returns
TypeDescription
FunctionCallingConfig

getMode()

public FunctionCallingConfig.Mode getMode()

Function calling mode.

.google.cloud.aiplatform.v1beta1.FunctionCallingConfig.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FunctionCallingConfig.Mode

The mode.

getModeValue()

public int getModeValue()

Function calling mode.

.google.cloud.aiplatform.v1beta1.FunctionCallingConfig.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for mode.

getParserForType()

public Parser<FunctionCallingConfig> getParserForType()
Returns
TypeDescription
Parser<FunctionCallingConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FunctionCallingConfig.Builder newBuilderForType()
Returns
TypeDescription
FunctionCallingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FunctionCallingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FunctionCallingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FunctionCallingConfig.Builder toBuilder()
Returns
TypeDescription
FunctionCallingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException