Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details .

List data with a filter

When listing data with the API, some list method requests provide a filter field. You can use these filters to only return results you are interested in. This filtering feature is common across many Google Cloud APIs.

The following examples show how to filter the response when listing test case results.

Java

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.dialogflow.cx.v3. ListTestCaseResultsRequest 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. ListTestCaseResultsRequest 
.Builder 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. TestCaseResult 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. TestCasesClient 
 
 ; 
 import 
  
 com.google.cloud.dialogflow.cx.v3. TestCasesSettings 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 ListTestCaseResults 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "my-project-id" 
 ; 
  
 String 
  
 agentId 
  
 = 
  
 "my-agent-id" 
 ; 
  
 String 
  
 testId 
  
 = 
  
 "my-test-id" 
 ; 
  
 String 
  
 location 
  
 = 
  
 "my-location" 
 ; 
  
 listTestCaseResults 
 ( 
 projectId 
 , 
  
 agentId 
 , 
  
 testId 
 , 
  
 location 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 listTestCaseResults 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 agentId 
 , 
  
 String 
  
 testId 
 , 
  
 String 
  
 location 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 String 
  
 parent 
  
 = 
  
 "projects/" 
  
 + 
  
 projectId 
  
 + 
  
 "/locations/" 
  
 + 
  
 location 
  
 + 
  
 "/agents/" 
  
 + 
  
 agentId 
  
 + 
  
 "/testCases/" 
  
 + 
  
 testId 
 ; 
  
 Builder 
  
 req 
  
 = 
  
  ListTestCaseResultsRequest 
 
 . 
 newBuilder 
 (); 
  
 req 
 . 
 setParent 
 ( 
 parent 
 ); 
  
 req 
 . 
 setFilter 
 ( 
 "environment=draft" 
 ); 
  
  TestCasesSettings 
 
  
 testCasesSettings 
  
 = 
  
  TestCasesSettings 
 
 . 
 newBuilder 
 () 
  
 . 
 setEndpoint 
 ( 
 location 
  
 + 
  
 "-dialogflow.googleapis.com:443" 
 ) 
  
 . 
 build 
 (); 
  
 // Note: close() needs to be called on the TestCasesClient object to clean up resources 
  
 // such as threads. In the example below, try-with-resources is used, 
  
 // which automatically calls close(). 
  
 try 
  
 ( 
  TestCasesClient 
 
  
 client 
  
 = 
  
  TestCasesClient 
 
 . 
 create 
 ( 
 testCasesSettings 
 )) 
  
 { 
  
 for 
  
 ( 
  TestCaseResult 
 
  
 element 
  
 : 
  
 client 
 . 
 listTestCaseResults 
 ( 
 req 
 . 
 build 
 ()). 
 iterateAll 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 element 
 ); 
  
 } 
  
 } 
  
 } 
 }

Node.js

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  const 
  
 parent 
  
 = 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/ 
 ${ 
 location 
 } 
 /agents/ 
 ${ 
 agentId 
 } 
 /testCases/ 
 ${ 
 testId 
 } 
 ` 
 ; 
 const 
  
 { 
 TestCasesClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dialogflow-cx 
' 
 ); 
 const 
  
 client 
  
 = 
  
 new 
  
  TestCasesClient 
 
 ({ 
  
 apiEndpoint 
 : 
  
 'global-dialogflow.googleapis.com' 
 , 
 }); 
 const 
  
 req 
  
 = 
  
 { 
  
 parent 
 , 
  
 filter 
 : 
  
 'environment=draft' 
 , 
 }; 
 const 
  
 res 
  
 = 
  
 await 
  
 client 
 . 
 listTestCaseResults 
 ( 
 req 
 ); 
 console 
 . 
 log 
 ( 
 res 
 );

Python

To authenticate to Dialogflow, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  from 
  
 google.cloud.dialogflowcx_v3.services.test_cases.client 
  
 import 
 TestCasesClient 
 from 
  
 google.cloud.dialogflowcx_v3.types.test_case 
  
 import 
 ListTestCaseResultsRequest 
 def 
  
 list_test_case 
 ( 
 project_id 
 , 
 agent_id 
 , 
 test_id 
 , 
 location 
 ): 
 req 
 = 
 ListTestCaseResultsRequest 
 () 
 req 
 . 
 parent 
 = 
 f 
 "projects/ 
 { 
 project_id 
 } 
 /locations/ 
 { 
 location 
 } 
 /agents/ 
 { 
 agent_id 
 } 
 /testCases/ 
 { 
 test_id 
 } 
 " 
 req 
 . 
 filter 
 = 
 "environment=draft" 
 client 
 = 
 TestCasesClient 
 ( 
 client_options 
 = 
 { 
 "api_endpoint" 
 : 
 f 
 " 
 { 
 location 
 } 
 -dialogflow.googleapis.com" 
 } 
 ) 
 # Makes a call to list all test case results that match filter 
 result 
 = 
 client 
 . 
 list_test_case_results 
 ( 
 request 
 = 
 req 
 ) 
 print 
 ( 
 result 
 ) 
 return 
 result

Update data with a FieldMask

Long-running operations

List data with a filter Stay organized with collections Save and categorize content based on your preferences.

Java

Node.js

Python

List data with a filter