Class FunctionResponse.Builder (3.84.0)

Version latest

• 3.84.0 (latest)
• 3.83.0
• 3.82.0
• 3.81.0
• 3.79.0
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class FunctionResponse.Builder extends GeneratedMessage.Builder<FunctionResponse.Builder> implements FunctionResponseOrBuilder

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.aiplatform.v1.FunctionResponse

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > FunctionResponse.Builder

Implements

FunctionResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllParts(Iterable<? extends FunctionResponsePart> values)

public FunctionResponse.Builder addAllParts(Iterable<? extends FunctionResponsePart> values)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.aiplatform.v1.FunctionResponsePart>

Returns
Type	Description
FunctionResponse.Builder

addParts(FunctionResponsePart value)

public FunctionResponse.Builder addParts(FunctionResponsePart value)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	FunctionResponsePart

Returns
Type	Description
FunctionResponse.Builder

addParts(FunctionResponsePart.Builder builderForValue)

public FunctionResponse.Builder addParts(FunctionResponsePart.Builder builderForValue)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	FunctionResponsePart.Builder

Returns
Type	Description
FunctionResponse.Builder

addParts(int index, FunctionResponsePart value)

public FunctionResponse.Builder addParts(int index, FunctionResponsePart value)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	FunctionResponsePart

Returns
Type	Description
FunctionResponse.Builder

addParts(int index, FunctionResponsePart.Builder builderForValue)

public FunctionResponse.Builder addParts(int index, FunctionResponsePart.Builder builderForValue)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	FunctionResponsePart.Builder

Returns
Type	Description
FunctionResponse.Builder

addPartsBuilder()

public FunctionResponsePart.Builder addPartsBuilder()

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FunctionResponsePart.Builder

addPartsBuilder(int index)

public FunctionResponsePart.Builder addPartsBuilder(int index)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FunctionResponsePart.Builder

build()

public FunctionResponse build()

Returns
Type	Description
FunctionResponse

buildPartial()

public FunctionResponse buildPartial()

Returns
Type	Description
FunctionResponse

clear()

public FunctionResponse.Builder clear()

Returns
Type	Description
FunctionResponse.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearName()

public FunctionResponse.Builder clearName()

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
FunctionResponse.Builder	This builder for chaining.

clearParts()

public FunctionResponse.Builder clearParts()

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FunctionResponse.Builder

clearResponse()

public FunctionResponse.Builder clearResponse()

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
FunctionResponse.Builder

getDefaultInstanceForType()

public FunctionResponse getDefaultInstanceForType()

Returns
Type	Description
FunctionResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getName()

public String 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()

public ByteString getNameBytes()

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.

getParts(int index)

public FunctionResponsePart getParts(int index)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FunctionResponsePart

getPartsBuilder(int index)

public FunctionResponsePart.Builder getPartsBuilder(int index)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FunctionResponsePart.Builder

getPartsBuilderList()

public List<FunctionResponsePart.Builder> getPartsBuilderList()

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getPartsCount()

public int getPartsCount()

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getPartsList()

public List<FunctionResponsePart> getPartsList()

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<FunctionResponsePart>

getPartsOrBuilder(int index)

public FunctionResponsePartOrBuilder getPartsOrBuilder(int index)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FunctionResponsePartOrBuilder

getPartsOrBuilderList()

public List<? extends FunctionResponsePartOrBuilder> getPartsOrBuilderList()

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.FunctionResponsePartOrBuilder>

getResponse()

public Struct getResponse()

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

public Struct.Builder getResponseBuilder()

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
Builder

getResponseOrBuilder()

public StructOrBuilder getResponseOrBuilder()

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
StructOrBuilder

hasResponse()

public boolean hasResponse()

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

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(FunctionResponse other)

public FunctionResponse.Builder mergeFrom(FunctionResponse other)

Parameter
Name	Description
other	FunctionResponse

Returns
Type	Description
FunctionResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunctionResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunctionResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FunctionResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FunctionResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeResponse(Struct value)

public FunctionResponse.Builder mergeResponse(Struct value)

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

Returns
Type	Description
FunctionResponse.Builder

removeParts(int index)

public FunctionResponse.Builder removeParts(int index)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FunctionResponse.Builder

setName(String value)

public FunctionResponse.Builder setName(String value)

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.

Returns
Type	Description
FunctionResponse.Builder	This builder for chaining.

setNameBytes(ByteString value)

public FunctionResponse.Builder setNameBytes(ByteString value)

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.

Returns
Type	Description
FunctionResponse.Builder	This builder for chaining.

setParts(int index, FunctionResponsePart value)

public FunctionResponse.Builder setParts(int index, FunctionResponsePart value)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	FunctionResponsePart

Returns
Type	Description
FunctionResponse.Builder

setParts(int index, FunctionResponsePart.Builder builderForValue)

public FunctionResponse.Builder setParts(int index, FunctionResponsePart.Builder builderForValue)

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	FunctionResponsePart.Builder

Returns
Type	Description
FunctionResponse.Builder

setResponse(Struct value)

public FunctionResponse.Builder setResponse(Struct value)

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

Returns
Type	Description
FunctionResponse.Builder

setResponse(Struct.Builder builderForValue)

public FunctionResponse.Builder setResponse(Struct.Builder builderForValue)

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

Returns
Type	Description
FunctionResponse.Builder