Interface FunctionResponseOrBuilder (3.79.0) 

public interface FunctionResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getId()

public abstract String getId()

Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call id.

string id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The id.

getIdBytes()

public abstract ByteString getIdBytes()

Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call id.

string id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for id.

getName()

public abstract 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 abstract 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 abstract FunctionResponsePart getParts(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
FunctionResponsePart

getPartsCount()

public abstract int getPartsCount()

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

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

Returns
Type Description
int

getPartsList()

public abstract List<FunctionResponsePart> getPartsList()

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

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

Returns
Type Description
List<FunctionResponsePart>

getPartsOrBuilder(int index)

public abstract FunctionResponsePartOrBuilder getPartsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
FunctionResponsePartOrBuilder

getPartsOrBuilderList()

public abstract List<? extends FunctionResponsePartOrBuilder> getPartsOrBuilderList()

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

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

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

getResponse()

public abstract 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.

getResponseOrBuilder()

public abstract 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 abstract 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.