Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class TestCase.
Represents a test case.
Generated from protobuf messagegoogle.cloud.dialogflow.cx.v3.TestCase
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of the test case.TestCases.CreateTestCasewill populate the name automatically. Otherwise use format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.
↳ tags
array
Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters.
↳ display_name
string
Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.
↳ notes
string
Additional freeform notes about the test case. Limit of 400 characters.
The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.
TestCases.CreateTestCasewill populate the name automatically. Otherwise use format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.
Returns
Type
Description
string
setName
The unique identifier of the test case.
TestCases.CreateTestCasewill populate the name automatically. Otherwise use format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTags
Tags are short descriptions that users may apply to test cases for
organizational and filtering purposes. Each tag should start with "#" and
has a limit of 30 characters.
Tags are short descriptions that users may apply to test cases for
organizational and filtering purposes. Each tag should start with "#" and
has a limit of 30 characters.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getDisplayName
Required. The human-readable name of the test case, unique within the
agent. Limit of 200 characters.
Returns
Type
Description
string
setDisplayName
Required. The human-readable name of the test case, unique within the
agent. Limit of 200 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getNotes
Additional freeform notes about the test case. Limit of 400 characters.
Returns
Type
Description
string
setNotes
Additional freeform notes about the test case. Limit of 400 characters.
The conversation turns uttered when the test case was created, in
chronological order. These include the canonical set of agent utterances
that should occur when the agent is working properly.
The conversation turns uttered when the test case was created, in
chronological order. These include the canonical set of agent utterances
that should occur when the agent is working properly.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow Cx V3 Client - Class TestCase (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.TestCase)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.TestCase)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.TestCase)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.TestCase)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.TestCase)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.TestCase)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.TestCase)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.TestCase)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.TestCase) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class TestCase.\n\nRepresents a test case.\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.TestCase`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe unique identifier of the test case.\n\n[TestCases.CreateTestCase](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.TestCasesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_TestCasesClient__createTestCase__)\nwill populate the name automatically. Otherwise use format:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/testCases/\u003cTestCaseID\u003e`.\n\n### setName\n\nThe unique identifier of the test case.\n\n[TestCases.CreateTestCase](/php/docs/reference/cloud-dialogflow-cx/latest/V3.Client.TestCasesClient#_Google_Cloud_Dialogflow_Cx_V3_Client_TestCasesClient__createTestCase__)\nwill populate the name automatically. Otherwise use format:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/testCases/\u003cTestCaseID\u003e`.\n\n### getTags\n\nTags are short descriptions that users may apply to test cases for\norganizational and filtering purposes. Each tag should start with \"#\" and\nhas a limit of 30 characters.\n\n### setTags\n\nTags are short descriptions that users may apply to test cases for\norganizational and filtering purposes. Each tag should start with \"#\" and\nhas a limit of 30 characters.\n\n### getDisplayName\n\nRequired. The human-readable name of the test case, unique within the\nagent. Limit of 200 characters.\n\n### setDisplayName\n\nRequired. The human-readable name of the test case, unique within the\nagent. Limit of 200 characters.\n\n### getNotes\n\nAdditional freeform notes about the test case. Limit of 400 characters.\n\n### setNotes\n\nAdditional freeform notes about the test case. Limit of 400 characters.\n\n### getTestConfig\n\nConfig for the test case.\n\n### hasTestConfig\n\n### clearTestConfig\n\n### setTestConfig\n\nConfig for the test case.\n\n### getTestCaseConversationTurns\n\nThe conversation turns uttered when the test case was created, in\nchronological order. These include the canonical set of agent utterances\nthat should occur when the agent is working properly.\n\n### setTestCaseConversationTurns\n\nThe conversation turns uttered when the test case was created, in\nchronological order. These include the canonical set of agent utterances\nthat should occur when the agent is working properly.\n\n### getCreationTime\n\nOutput only. When the test was created.\n\n### hasCreationTime\n\n### clearCreationTime\n\n### setCreationTime\n\nOutput only. When the test was created.\n\n### getLastTestResult\n\nThe latest test result.\n\n### hasLastTestResult\n\n### clearLastTestResult\n\n### setLastTestResult\n\nThe latest test result."]]
