Google Cloud Dialogflow Cx V3 Client - Class ListTestCaseResultsRequest (0.5.1)

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

The request message for TestCases.ListTestCaseResults.

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

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 test case to list results for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.
↳ 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.
↳ filter string

The filter expression used to filter test case results. See API Filtering. The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail:

getParent

Required. The test case to list results for.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.

Returns
Type Description
string

setParent

Required. The test case to list results for.

Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.

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

getFilter

The filter expression used to filter test case results. See API Filtering.

The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail:

  • "environment=draft AND latest" matches the latest test result for each test case in the draft environment.
  • "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2".
  • "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713.
Returns
Type Description
string

setFilter

The filter expression used to filter test case results. See API Filtering.

The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail:

  • "environment=draft AND latest" matches the latest test result for each test case in the draft environment.
  • "environment IN (e1,e2)" matches any test case results with an environment resource name of either "e1" or "e2".
  • "test_time > 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The test case to list results for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases. Please see TestCasesClient::testCaseName() for help formatting this field.
Returns
Type Description
ListTestCaseResultsRequest