public static final class ExecuteToolRequest.Builder extends GeneratedMessage.Builder<ExecuteToolRequest.Builder> implements ExecuteToolRequestOrBuilderRequest message for ToolService.ExecuteTool.
Protobuf type google.cloud.ces.v1beta.ExecuteToolRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ExecuteToolRequest.BuilderImplements
ExecuteToolRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ExecuteToolRequest build()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest |
|
buildPartial()
public ExecuteToolRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest |
|
clear()
public ExecuteToolRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearArgs()
public ExecuteToolRequest.Builder clearArgs()Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearContext()
public ExecuteToolRequest.Builder clearContext()Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearMockConfig()
public ExecuteToolRequest.Builder clearMockConfig()Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearParent()
public ExecuteToolRequest.Builder clearParent() Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
This builder for chaining. |
clearTool()
public ExecuteToolRequest.Builder clearTool()Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
This builder for chaining. |
clearToolExecutionContext()
public ExecuteToolRequest.Builder clearToolExecutionContext()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearToolIdentifier()
public ExecuteToolRequest.Builder clearToolIdentifier()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearToolsetTool()
public ExecuteToolRequest.Builder clearToolsetTool()Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
clearVariables()
public ExecuteToolRequest.Builder clearVariables()Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
getArgs()
public Struct getArgs()Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Struct |
The args. |
getArgsBuilder()
public Struct.Builder getArgsBuilder()Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getArgsOrBuilder()
public StructOrBuilder getArgsOrBuilder()Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getContext()
public Struct getContext()Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Struct |
The context. |
getContextBuilder()
public Struct.Builder getContextBuilder()Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getContextOrBuilder()
public StructOrBuilder getContextOrBuilder()Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getDefaultInstanceForType()
public ExecuteToolRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMockConfig()
public MockConfig getMockConfig()Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MockConfig |
The mockConfig. |
getMockConfigBuilder()
public MockConfig.Builder getMockConfigBuilder()Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MockConfig.Builder |
|
getMockConfigOrBuilder()
public MockConfigOrBuilder getMockConfigOrBuilder()Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
MockConfigOrBuilder |
|
getParent()
public String getParent() Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getTool()
public String getTool()Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The tool. |
getToolBytes()
public ByteString getToolBytes()Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for tool. |
getToolExecutionContextCase()
public ExecuteToolRequest.ToolExecutionContextCase getToolExecutionContextCase()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.ToolExecutionContextCase |
|
getToolIdentifierCase()
public ExecuteToolRequest.ToolIdentifierCase getToolIdentifierCase()| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.ToolIdentifierCase |
|
getToolsetTool()
public ToolsetTool getToolsetTool()Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolsetTool |
The toolsetTool. |
getToolsetToolBuilder()
public ToolsetTool.Builder getToolsetToolBuilder()Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolsetTool.Builder |
|
getToolsetToolOrBuilder()
public ToolsetToolOrBuilder getToolsetToolOrBuilder()Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolsetToolOrBuilder |
|
getVariables()
public Struct getVariables()Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Struct |
The variables. |
getVariablesBuilder()
public Struct.Builder getVariablesBuilder()Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getVariablesOrBuilder()
public StructOrBuilder getVariablesOrBuilder()Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
hasArgs()
public boolean hasArgs()Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the args field is set. |
hasContext()
public boolean hasContext()Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the context field is set. |
hasMockConfig()
public boolean hasMockConfig()Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mockConfig field is set. |
hasTool()
public boolean hasTool()Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the tool field is set. |
hasToolsetTool()
public boolean hasToolsetTool()Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the toolsetTool field is set. |
hasVariables()
public boolean hasVariables()Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the variables field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeArgs(Struct value)
public ExecuteToolRequest.Builder mergeArgs(Struct value)Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
mergeContext(Struct value)
public ExecuteToolRequest.Builder mergeContext(Struct value)Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
mergeFrom(ExecuteToolRequest other)
public ExecuteToolRequest.Builder mergeFrom(ExecuteToolRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExecuteToolRequest |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecuteToolRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExecuteToolRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
mergeMockConfig(MockConfig value)
public ExecuteToolRequest.Builder mergeMockConfig(MockConfig value)Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
MockConfig |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
mergeToolsetTool(ToolsetTool value)
public ExecuteToolRequest.Builder mergeToolsetTool(ToolsetTool value)Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ToolsetTool |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
mergeVariables(Struct value)
public ExecuteToolRequest.Builder mergeVariables(Struct value)Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setArgs(Struct value)
public ExecuteToolRequest.Builder setArgs(Struct value)Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setArgs(Struct.Builder builderForValue)
public ExecuteToolRequest.Builder setArgs(Struct.Builder builderForValue)Optional. The input parameters and values for the tool in JSON object format.
.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setContext(Struct value)
public ExecuteToolRequest.Builder setContext(Struct value)Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setContext(Struct.Builder builderForValue)
public ExecuteToolRequest.Builder setContext(Struct.Builder builderForValue)Optional. The ToolCallContext to be passed to the Python tool.
.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setMockConfig(MockConfig value)
public ExecuteToolRequest.Builder setMockConfig(MockConfig value)Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
MockConfig |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setMockConfig(MockConfig.Builder builderForValue)
public ExecuteToolRequest.Builder setMockConfig(MockConfig.Builder builderForValue)Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses.
.google.cloud.ces.v1beta.MockConfig mock_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
MockConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setParent(String value)
public ExecuteToolRequest.Builder setParent(String value) Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ExecuteToolRequest.Builder setParentBytes(ByteString value) Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
This builder for chaining. |
setTool(String value)
public ExecuteToolRequest.Builder setTool(String value)Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe tool to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
This builder for chaining. |
setToolBytes(ByteString value)
public ExecuteToolRequest.Builder setToolBytes(ByteString value)Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for tool to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
This builder for chaining. |
setToolsetTool(ToolsetTool value)
public ExecuteToolRequest.Builder setToolsetTool(ToolsetTool value)Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ToolsetTool |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setToolsetTool(ToolsetTool.Builder builderForValue)
public ExecuteToolRequest.Builder setToolsetTool(ToolsetTool.Builder builderForValue)Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ToolsetTool.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setVariables(Struct value)
public ExecuteToolRequest.Builder setVariables(Struct value)Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|
setVariables(Struct.Builder builderForValue)
public ExecuteToolRequest.Builder setVariables(Struct.Builder builderForValue)Optional. The variables that are available for the tool execution.
.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteToolRequest.Builder |
|