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: |
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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetTestCase(std::string const &, Options)
Gets a test case.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the testcase. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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
: RunTestCaseMetadataresponse
: 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 |
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 |
RunTestCase(NoAwaitTag, google::cloud::dialogflow::cx::v3::RunTestCaseRequest const &, Options)
Kicks off a test case run.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::cx::v3::RunTestCaseRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RunTestCase(google::longrunning::Operation const &, Options)
Kicks off a test case run.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::cx::v3::RunTestCaseResponse > > |
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
: BatchRunTestCasesMetadataresponse
: 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 |
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 |
BatchRunTestCases(NoAwaitTag, google::cloud::dialogflow::cx::v3::BatchRunTestCasesRequest const &, Options)
Kicks off a batch run of test cases.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::cx::v3::BatchRunTestCasesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
BatchRunTestCases(google::longrunning::Operation const &, Options)
Kicks off a batch run of test cases.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::cx::v3::BatchRunTestCasesResponse > > |
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 |
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 |
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
: ImportTestCasesMetadataresponse
: 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 |
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 |
ImportTestCases(NoAwaitTag, google::cloud::dialogflow::cx::v3::ImportTestCasesRequest const &, Options)
Imports the test cases from a Cloud Storage bucket or a local file.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::cx::v3::ImportTestCasesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ImportTestCases(google::longrunning::Operation const &, Options)
Imports the test cases from a Cloud Storage bucket or a local file.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::cx::v3::ImportTestCasesResponse > > |
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
: ExportTestCasesMetadataresponse
: 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 |
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 |
ExportTestCases(NoAwaitTag, google::cloud::dialogflow::cx::v3::ExportTestCasesRequest const &, Options)
Exports the test cases under the agent to a Cloud Storage bucket or a local file.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dialogflow::cx::v3::ExportTestCasesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ExportTestCases(google::longrunning::Operation const &, Options)
Exports the test cases under the agent to a Cloud Storage bucket or a local file.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportTestCasesResponse > > |
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: |
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 |
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 |
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 |
GetTestCaseResult(std::string const &, Options)
Gets a test case result.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the testcase. Format: |
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 |
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 |
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 |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |