Google Cloud Dialogflow Cx V3 Client - Class ListExamplesRequest (0.10.1)

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

The request message for Examples.ListExamples.

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

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 playbook to list the examples from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

↳ page_size int

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

↳ page_token string

Optional. The next_page_token value returned from a previous list request.

↳ language_code string

Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.

getParent

Required. The playbook to list the examples from.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

Returns
Type Description
string

setParent

Required. The playbook to list the examples from.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

Optional. 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

Optional. The next_page_token value returned from a previous list request.

Returns
Type Description
string

setPageToken

Optional. The next_page_token value returned from a previous list request.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguageCode

Optional. The language to list examples for.

If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.

Returns
Type Description
string

setLanguageCode

Optional. The language to list examples for.

If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The playbook to list the examples from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>. Please see ExamplesClient::playbookName() for help formatting this field.

Returns
Type Description
ListExamplesRequest