public final class ToolResponse extends GeneratedMessage implements ToolResponseOrBuilder
The execution result of a specific tool from the client or the agent.
Protobuf type google.cloud.ces.v1.ToolResponse
Inherited Members
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)
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()
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()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOLSET_TOOL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ToolResponse getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ToolResponse.Builder newBuilder()
public static ToolResponse.Builder newBuilder(ToolResponse prototype)
public static ToolResponse parseDelimitedFrom(InputStream input)
public static ToolResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ToolResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ToolResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ToolResponse parseFrom(ByteString data)
public static ToolResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ToolResponse parseFrom(CodedInputStream input)
public static ToolResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ToolResponse parseFrom(InputStream input)
public static ToolResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ToolResponse parseFrom(ByteBuffer data)
public static ToolResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ToolResponse> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ToolResponse getDefaultInstanceForType()
public 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.
|
public 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.
|
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.
|
public 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.
|
public Parser<ToolResponse> getParserForType()
Overrides
public 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.
|
public 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];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
public 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.
|
public ToolResponse.ToolIdentifierCase getToolIdentifierCase()
public ToolsetTool getToolsetTool()
Optional. The toolset tool that got executed.
.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
public ToolsetToolOrBuilder getToolsetToolOrBuilder()
Optional. The toolset tool that got executed.
.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
public 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.
|
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.
|
public 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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ToolResponse.Builder newBuilderForType()
protected ToolResponse.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public ToolResponse.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides