Google Cloud Dialogflow Cx V3 Client - Class ListAgentsRequest (0.3.2)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ListAgentsRequest.

The request message for Agents.ListAgents.

Generated from protobuf message google.cloud.dialogflow.cx.v3.ListAgentsRequest

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The location to list all agents for. Format: projects/<Project ID>/locations/<Location ID>.

↳ page_size int

The maximum number of items to return in a single page. By default 100 and at most 1000.

↳ page_token string

The next_page_token value returned from a previous list request.

getParent

Required. The location to list all agents for.

Format: projects/<Project ID>/locations/<Location ID>.

Returns
Type Description
string

setParent

Required. The location to list all agents for.

Format: projects/<Project ID>/locations/<Location ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of items to return in a single page. By default 100 and at most 1000.

Returns
Type Description
int

setPageSize

The maximum number of items to return in a single page. By default 100 and at most 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The next_page_token value returned from a previous list request.

Returns
Type Description
string

setPageToken

The next_page_token value returned from a previous list request.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The location to list all agents for. Format: projects/<Project ID>/locations/<Location ID>. Please see Google\Cloud\Dialogflow\Cx\V3\AgentsClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\ListAgentsRequest