publicstaticfinalclass FunctionResponse.BuilderextendsGeneratedMessageV3.Builder<FunctionResponse.Builder>implementsFunctionResponseOrBuilder
The result output from a [FunctionCall] that contains a string representing
the [FunctionDeclaration.name] and a structured JSON object containing any
output from the function is used as context to the model. This should contain
the result of a [FunctionCall] made based on model prediction.
Protobuf type google.cloud.vertexai.v1.FunctionResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicFunctionResponse.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Overrides
build()
publicFunctionResponsebuild()
buildPartial()
publicFunctionResponsebuildPartial()
clear()
publicFunctionResponse.Builderclear()
Overrides
clearField(Descriptors.FieldDescriptor field)
publicFunctionResponse.BuilderclearField(Descriptors.FieldDescriptorfield)
Overrides
clearName()
publicFunctionResponse.BuilderclearName()
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
clearOneof(Descriptors.OneofDescriptor oneof)
publicFunctionResponse.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Overrides
clearResponse()
publicFunctionResponse.BuilderclearResponse()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
clone()
publicFunctionResponse.Builderclone()
Overrides
getDefaultInstanceForType()
publicFunctionResponsegetDefaultInstanceForType()
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()
Overrides
getName()
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
publicByteStringgetNameBytes()
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getResponse()
publicStructgetResponse()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Struct |
The response.
|
getResponseBuilder()
publicStruct.BuildergetResponseBuilder()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
getResponseOrBuilder()
publicStructOrBuildergetResponseOrBuilder()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
hasResponse()
publicbooleanhasResponse()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the response field is set.
|
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
mergeFrom(FunctionResponse other)
publicFunctionResponse.BuildermergeFrom(FunctionResponseother)
publicFunctionResponse.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Overrides
mergeFrom(Message other)
publicFunctionResponse.BuildermergeFrom(Messageother)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeResponse(Struct value)
publicFunctionResponse.BuildermergeResponse(Structvalue)
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
Struct
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalFunctionResponse.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
publicFunctionResponse.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Overrides
setName(String value)
publicFunctionResponse.BuildersetName(Stringvalue)
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
String
The name to set.
|
setNameBytes(ByteString value)
publicFunctionResponse.BuildersetNameBytes(ByteStringvalue)
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicFunctionResponse.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Overrides
setResponse(Struct value)
publicFunctionResponse.BuildersetResponse(Structvalue)
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
Struct
|
setResponse(Struct.Builder builderForValue)
publicFunctionResponse.BuildersetResponse(Struct.BuilderbuilderForValue)
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
builderForValue |
Builder
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalFunctionResponse.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Overrides