# Interface MockedToolCallOrBuilder (0.9.0)

0.9.0 (latest) 0.7.0 0.4.0 0.3.0 0.1.0

    public interface MockedToolCallOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getExpectedArgsPattern()

    public abstract Struct getExpectedArgsPattern()

Required. A pattern to match against the args / inputs of all dispatched
tool calls. If the tool call inputs match this pattern, then mock output
will be returned.

`
.google.protobuf.Struct expected_args_pattern = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Struct.html` | The expectedArgsPattern. |

### getExpectedArgsPatternOrBuilder()

    public abstract StructOrBuilder getExpectedArgsPatternOrBuilder()

Required. A pattern to match against the args / inputs of all dispatched
tool calls. If the tool call inputs match this pattern, then mock output
will be returned.

`
.google.protobuf.Struct expected_args_pattern = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.StructOrBuilder.html` |   |

### getMockResponse()

    public abstract Struct getMockResponse()

Optional. The mock response / output to return if the tool call args /
inputs match the pattern.

`.google.protobuf.Struct mock_response = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Struct.html` | The mockResponse. |

### getMockResponseOrBuilder()

    public abstract StructOrBuilder getMockResponseOrBuilder()

Optional. The mock response / output to return if the tool call args /
inputs match the pattern.

`.google.protobuf.Struct mock_response = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.StructOrBuilder.html` |   |

### getTool() (deprecated)

    public abstract String getTool()

**Deprecated.** *google.cloud.ces.v1beta.MockedToolCall.tool is deprecated. See
google/cloud/ces/v1beta/mocks.proto;l=48*

Optional. Deprecated. Use tool_identifier instead.

`
string tool = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The tool. |

### getToolBytes() (deprecated)

    public abstract ByteString getToolBytes()

**Deprecated.** *google.cloud.ces.v1beta.MockedToolCall.tool is deprecated. See
google/cloud/ces/v1beta/mocks.proto;l=48*

Optional. Deprecated. Use tool_identifier instead.

`
string tool = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for tool. |

### getToolId()

    public abstract String getToolId()

Optional. The name of the tool to mock.
Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`

`
string tool_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The toolId. |

### getToolIdBytes()

    public abstract ByteString getToolIdBytes()

Optional. The name of the tool to mock.
Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`

`
string tool_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for toolId. |

### getToolIdentifierCase()

    public abstract MockedToolCall.ToolIdentifierCase getToolIdentifierCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-ces/latest/com.google.cloud.ces.v1beta.MockedToolCall.ToolIdentifierCase` |   |

### getToolset()

    public abstract ToolsetTool getToolset()

Optional. The toolset to mock.

`
.google.cloud.ces.v1beta.ToolsetTool toolset = 5 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-ces/latest/com.google.cloud.ces.v1beta.ToolsetTool` | The toolset. |

### getToolsetOrBuilder()

    public abstract ToolsetToolOrBuilder getToolsetOrBuilder()

Optional. The toolset to mock.

`
.google.cloud.ces.v1beta.ToolsetTool toolset = 5 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-ces/latest/com.google.cloud.ces.v1beta.ToolsetToolOrBuilder` |   |

### hasExpectedArgsPattern()

    public abstract boolean hasExpectedArgsPattern()

Required. A pattern to match against the args / inputs of all dispatched
tool calls. If the tool call inputs match this pattern, then mock output
will be returned.

`
.google.protobuf.Struct expected_args_pattern = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the expectedArgsPattern field is set. |

### hasMockResponse()

    public abstract boolean hasMockResponse()

Optional. The mock response / output to return if the tool call args /
inputs match the pattern.

`.google.protobuf.Struct mock_response = 3 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the mockResponse field is set. |

### hasToolId()

    public abstract boolean hasToolId()

Optional. The name of the tool to mock.
Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`

`
string tool_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the toolId field is set. |

### hasToolset()

    public abstract boolean hasToolset()

Optional. The toolset to mock.

`
.google.cloud.ces.v1beta.ToolsetTool toolset = 5 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the toolset field is set. |