Class FunctionCall (3.42.0)

public final class FunctionCall extends GeneratedMessageV3 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.v1beta1.FunctionCall

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FunctionCall getDefaultInstance()
Returns
TypeDescription
FunctionCall

getDescriptor()

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

newBuilder()

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

newBuilder(FunctionCall prototype)

public static FunctionCall.Builder newBuilder(FunctionCall prototype)
Parameter
NameDescription
prototypeFunctionCall
Returns
TypeDescription
FunctionCall.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
Struct

The args.

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
TypeDescription
StructOrBuilder

getDefaultInstanceForType()

public FunctionCall getDefaultInstanceForType()
Returns
TypeDescription
FunctionCall

getName()

public String getName()

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

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

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
boolean

Whether the args field is set.

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 FunctionCall.Builder newBuilderForType()
Returns
TypeDescription
FunctionCall.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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