public interface ToolResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDisplayName()
public abstract String getDisplayName()Output only. Display name of the tool.
string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Output only. Display name of the tool.
string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getId()
public abstract String getId()Optional. The matching ID of the tool call the response is for.
string id = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
public abstract ByteString getIdBytes()Optional. The matching ID of the tool call the response is for.
string id = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getResponse()
public abstract Struct getResponse()Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
.google.protobuf.Struct response = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Struct |
The response. |
getResponseOrBuilder()
public abstract StructOrBuilder getResponseOrBuilder()Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
.google.protobuf.Struct response = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getTool()
public abstract String getTool() Optional. The name of the tool to execute.
Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The tool. |
getToolBytes()
public abstract ByteString getToolBytes() Optional. The name of the tool to execute.
Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for tool. |
getToolIdentifierCase()
public abstract ToolResponse.ToolIdentifierCase getToolIdentifierCase()| Returns | |
|---|---|
| Type | Description |
ToolResponse.ToolIdentifierCase |
|
getToolsetTool()
public abstract ToolsetTool getToolsetTool()Optional. The toolset tool that got executed.
.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolsetTool |
The toolsetTool. |
getToolsetToolOrBuilder()
public abstract ToolsetToolOrBuilder getToolsetToolOrBuilder()Optional. The toolset tool that got executed.
.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolsetToolOrBuilder |
|
hasResponse()
public abstract boolean hasResponse()Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
.google.protobuf.Struct response = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the response field is set. |
hasTool()
public abstract boolean hasTool() Optional. The name of the tool to execute.
Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the tool field is set. |
hasToolsetTool()
public abstract boolean hasToolsetTool()Optional. The toolset tool that got executed.
.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the toolsetTool field is set. |