Class FunctionCall (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 final class FunctionCall extends GeneratedMessage 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

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > FunctionCall

Implements

FunctionCallOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

PARTIAL_ARGS_FIELD_NUMBER

public static final int PARTIAL_ARGS_FIELD_NUMBER

Field Value
Type	Description
int

WILL_CONTINUE_FIELD_NUMBER

public static final int WILL_CONTINUE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static FunctionCall getDefaultInstance()

Returns
Type	Description
FunctionCall

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static FunctionCall.Builder newBuilder()

Returns
Type	Description
FunctionCall.Builder

newBuilder(FunctionCall prototype)

public static FunctionCall.Builder newBuilder(FunctionCall prototype)

Parameter
Name	Description
prototype	FunctionCall

Returns
Type	Description
FunctionCall.Builder

parseDelimitedFrom(InputStream input)

public static FunctionCall parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionCall parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static FunctionCall parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunctionCall parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunctionCall parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunctionCall parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunctionCall parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionCall parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static FunctionCall parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionCall parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static FunctionCall parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunctionCall parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionCall

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<FunctionCall> parser()

Returns
Type	Description
Parser<FunctionCall>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

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

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.

getParserForType()

public Parser<FunctionCall> getParserForType()

Returns
Type	Description
Parser<FunctionCall>

Overrides

GeneratedMessage.getParserForType()

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

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>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public FunctionCall.Builder newBuilderForType()

Returns
Type	Description
FunctionCall.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected FunctionCall.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
FunctionCall.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public FunctionCall.Builder toBuilder()

Returns
Type	Description
FunctionCall.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException