Class TestCasesClient (2.19.0)

Version 2.19.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service for managing Test Cases and Test Case Results.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

TestCasesClient(TestCasesClient const &)

Copy and move support

Parameter
Name	Description
	TestCasesClient const &

TestCasesClient(TestCasesClient &&)

Copy and move support

Parameter
Name	Description
	TestCasesClient &&

TestCasesClient(std::shared_ptr< TestCasesConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< TestCasesConnection >
opts	Options

Operators

operator=(TestCasesClient const &)

Copy and move support

Parameter
Name	Description
	TestCasesClient const &

Returns
Type	Description
TestCasesClient &

operator=(TestCasesClient &&)

Copy and move support

Parameter
Name	Description
	TestCasesClient &&

Returns
Type	Description
TestCasesClient &

Functions

ListTestCases(std::string const &, Options)

Fetches a list of test cases for a given agent.

Parameters
Name	Description
parent	std::string const & Required. The agent to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::TestCase >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.TestCase, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTestCases(google::cloud::dialogflow::cx::v3::ListTestCasesRequest, Options)

Fetches a list of test cases for a given agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListTestCasesRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ListTestCasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::TestCase >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.TestCase, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

BatchDeleteTestCases(std::string const &, Options)

Batch deletes test cases.

Parameters
Name	Description
parent	std::string const & Required. The agent to delete test cases from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

BatchDeleteTestCases(google::cloud::dialogflow::cx::v3::BatchDeleteTestCasesRequest const &, Options)

Batch deletes test cases.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::BatchDeleteTestCasesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.BatchDeleteTestCasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

GetTestCase(std::string const &, Options)

Gets a test case.

Parameters
Name	Description
name	std::string const & Required. The name of the testcase. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/testCases/<TestCase ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCase >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTestCase(google::cloud::dialogflow::cx::v3::GetTestCaseRequest const &, Options)

Gets a test case.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetTestCaseRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.GetTestCaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCase >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTestCase(std::string const &, google::cloud::dialogflow::cx::v3::TestCase const &, Options)

Creates a test case for the given agent.

Parameters
Name	Description
parent	std::string const & Required. The agent to create the test case for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
test_case	google::cloud::dialogflow::cx::v3::TestCase const & Required. The test case to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCase >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTestCase(google::cloud::dialogflow::cx::v3::CreateTestCaseRequest const &, Options)

Creates a test case for the given agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CreateTestCaseRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.CreateTestCaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCase >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTestCase(google::cloud::dialogflow::cx::v3::TestCase const &, google::protobuf::FieldMask const &, Options)

Updates the specified test case.

Parameters
Name	Description
test_case	google::cloud::dialogflow::cx::v3::TestCase const & Required. The test case to update.
update_mask	google::protobuf::FieldMask const & Required. The mask to specify which fields should be updated. The [creationTime][google.cloud.dialogflow.cx.v3.TestCase.creation_time] and [lastTestResult][google.cloud.dialogflow.cx.v3.TestCase.last_test_result] cannot be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCase >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTestCase(google::cloud::dialogflow::cx::v3::UpdateTestCaseRequest const &, Options)

Updates the specified test case.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateTestCaseRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.UpdateTestCaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCase >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCase) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RunTestCase(google::cloud::dialogflow::cx::v3::RunTestCaseRequest const &, Options)

Kicks off a test case run.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: RunTestCaseMetadata
• response: RunTestCaseResponse

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::RunTestCaseRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.RunTestCaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::RunTestCaseResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.RunTestCaseResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchRunTestCases(google::cloud::dialogflow::cx::v3::BatchRunTestCasesRequest const &, Options)

Kicks off a batch run of test cases.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: BatchRunTestCasesMetadata
• response: BatchRunTestCasesResponse

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::BatchRunTestCasesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.BatchRunTestCasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::BatchRunTestCasesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CalculateCoverage(google::cloud::dialogflow::cx::v3::CalculateCoverageRequest const &, Options)

Calculates the test coverage for an agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CalculateCoverageRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.CalculateCoverageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::CalculateCoverageResponse >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.CalculateCoverageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportTestCases(google::cloud::dialogflow::cx::v3::ImportTestCasesRequest const &, Options)

Imports the test cases from a Cloud Storage bucket or a local file.

It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: ImportTestCasesMetadata
• response: ImportTestCasesResponse

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ImportTestCasesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ImportTestCasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::ImportTestCasesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ImportTestCasesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportTestCases(google::cloud::dialogflow::cx::v3::ExportTestCasesRequest const &, Options)

Exports the test cases under the agent to a Cloud Storage bucket or a local file.

Filter can be applied to export a subset of test cases.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: ExportTestCasesMetadata
• response: ExportTestCasesResponse

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ExportTestCasesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ExportTestCasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportTestCasesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ExportTestCasesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListTestCaseResults(std::string const &, Options)

Fetches the list of run results for the given test case.

A maximum of 100 results are kept for each test case.

Parameters
Name	Description
parent	std::string const & Required. The test case to list results for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/ testCases/<TestCase ID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::TestCaseResult >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.TestCaseResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTestCaseResults(google::cloud::dialogflow::cx::v3::ListTestCaseResultsRequest, Options)

Fetches the list of run results for the given test case.

A maximum of 100 results are kept for each test case.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListTestCaseResultsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ListTestCaseResultsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::TestCaseResult >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.TestCaseResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetTestCaseResult(std::string const &, Options)

Gets a test case result.

Parameters
Name	Description
name	std::string const & Required. The name of the testcase. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCaseResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCaseResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTestCaseResult(google::cloud::dialogflow::cx::v3::GetTestCaseResultRequest const &, Options)

Gets a test case result.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetTestCaseResultRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.GetTestCaseResultRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::TestCaseResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.TestCaseResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.