Reference documentation and code samples for the Google Cloud Ces V1 Client class ListToolsRequest.
Request message for AgentService.ListTools.
Generated from protobuf message google.cloud.ces.v1.ListToolsRequest
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the app to list tools from. |
↳ page_size |
int
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
↳ page_token |
string
Optional. The next_page_token value returned from a previous list AgentService.ListTools call. |
↳ filter |
string
Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details. |
↳ order_by |
string
Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
getParent
Required. The resource name of the app to list tools from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the app to list tools from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. The next_page_token value returned from a previous list AgentService.ListTools call.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. The next_page_token value returned from a previous list AgentService.ListTools call.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Field to sort by. Only "name" and "create_time" is supported.
See https://google.aip.dev/132#ordering for more details.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Field to sort by. Only "name" and "create_time" is supported.
See https://google.aip.dev/132#ordering for more details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the app to list tools from. Please see AgentServiceClient::appName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListToolsRequest |
|