Dialogflow v3 API - Class TestCasesClientImpl (2.17.0) 

public sealed class TestCasesClientImpl : TestCasesClient

Reference documentation and code samples for the Dialogflow v3 API class TestCasesClientImpl.

TestCases client wrapper implementation, for convenient use.

Inheritance

object > TestCasesClient > TestCasesClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Test Cases][google.cloud.dialogflow.cx.v3.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult].

Constructors

TestCasesClientImpl(TestCasesClient, TestCasesSettings, ILogger)

public TestCasesClientImpl(TestCases.TestCasesClient grpcClient, TestCasesSettings settings, ILogger logger)

Constructs a client wrapper for the TestCases service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient TestCasesTestCasesClient

The underlying gRPC client.
settings TestCasesSettings

The base TestCasesSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BatchRunTestCasesOperationsClient

public override OperationsClient BatchRunTestCasesOperationsClient { get; }

The long-running operations client for BatchRunTestCases.

Property Value
Type Description
OperationsClient
Overrides

ExportTestCasesOperationsClient

public override OperationsClient ExportTestCasesOperationsClient { get; }

The long-running operations client for ExportTestCases.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override TestCases.TestCasesClient GrpcClient { get; }

The underlying gRPC TestCases client

Property Value
Type Description
TestCasesTestCasesClient
Overrides

ImportTestCasesOperationsClient

public override OperationsClient ImportTestCasesOperationsClient { get; }

The long-running operations client for ImportTestCases.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RunTestCaseOperationsClient

public override OperationsClient RunTestCaseOperationsClient { get; }

The long-running operations client for RunTestCase.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchDeleteTestCases(BatchDeleteTestCasesRequest, CallSettings)

public override void BatchDeleteTestCases(BatchDeleteTestCasesRequest request, CallSettings callSettings = null)

Batch deletes test cases.

Parameters
Name Description
request BatchDeleteTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

BatchDeleteTestCasesAsync(BatchDeleteTestCasesRequest, CallSettings)

public override Task BatchDeleteTestCasesAsync(BatchDeleteTestCasesRequest request, CallSettings callSettings = null)

Batch deletes test cases.

Parameters
Name Description
request BatchDeleteTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

BatchRunTestCases(BatchRunTestCasesRequest, CallSettings)

public override Operation<BatchRunTestCasesResponse, BatchRunTestCasesMetadata> BatchRunTestCases(BatchRunTestCasesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
  • response: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
Parameters
Name Description
request BatchRunTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchRunTestCasesResponseBatchRunTestCasesMetadata

The RPC response.
Overrides

BatchRunTestCasesAsync(BatchRunTestCasesRequest, CallSettings)

public override Task<Operation<BatchRunTestCasesResponse, BatchRunTestCasesMetadata>> BatchRunTestCasesAsync(BatchRunTestCasesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
  • response: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
Parameters
Name Description
request BatchRunTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchRunTestCasesResponseBatchRunTestCasesMetadata

A Task containing the RPC response.
Overrides

CalculateCoverage(CalculateCoverageRequest, CallSettings)

public override CalculateCoverageResponse CalculateCoverage(CalculateCoverageRequest request, CallSettings callSettings = null)

Calculates the test coverage for an agent.

Parameters
Name Description
request CalculateCoverageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
CalculateCoverageResponse

The RPC response.
Overrides

CalculateCoverageAsync(CalculateCoverageRequest, CallSettings)

public override Task<CalculateCoverageResponse> CalculateCoverageAsync(CalculateCoverageRequest request, CallSettings callSettings = null)

Calculates the test coverage for an agent.

Parameters
Name Description
request CalculateCoverageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCalculateCoverageResponse

A Task containing the RPC response.
Overrides

CreateTestCase(CreateTestCaseRequest, CallSettings)

public override TestCase CreateTestCase(CreateTestCaseRequest request, CallSettings callSettings = null)

Creates a test case for the given agent.

Parameters
Name Description
request CreateTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestCase

The RPC response.
Overrides

CreateTestCaseAsync(CreateTestCaseRequest, CallSettings)

public override Task<TestCase> CreateTestCaseAsync(CreateTestCaseRequest request, CallSettings callSettings = null)

Creates a test case for the given agent.

Parameters
Name Description
request CreateTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestCase

A Task containing the RPC response.
Overrides

ExportTestCases(ExportTestCasesRequest, CallSettings)

public override Operation<ExportTestCasesResponse, ExportTestCasesMetadata> ExportTestCases(ExportTestCasesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
  • response: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
Parameters
Name Description
request ExportTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExportTestCasesResponseExportTestCasesMetadata

The RPC response.
Overrides

ExportTestCasesAsync(ExportTestCasesRequest, CallSettings)

public override Task<Operation<ExportTestCasesResponse, ExportTestCasesMetadata>> ExportTestCasesAsync(ExportTestCasesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
  • response: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
Parameters
Name Description
request ExportTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExportTestCasesResponseExportTestCasesMetadata

A Task containing the RPC response.
Overrides

GetTestCase(GetTestCaseRequest, CallSettings)

public override TestCase GetTestCase(GetTestCaseRequest request, CallSettings callSettings = null)

Gets a test case.

Parameters
Name Description
request GetTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestCase

The RPC response.
Overrides

GetTestCaseAsync(GetTestCaseRequest, CallSettings)

public override Task<TestCase> GetTestCaseAsync(GetTestCaseRequest request, CallSettings callSettings = null)

Gets a test case.

Parameters
Name Description
request GetTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestCase

A Task containing the RPC response.
Overrides

GetTestCaseResult(GetTestCaseResultRequest, CallSettings)

public override TestCaseResult GetTestCaseResult(GetTestCaseResultRequest request, CallSettings callSettings = null)

Gets a test case result.

Parameters
Name Description
request GetTestCaseResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestCaseResult

The RPC response.
Overrides

GetTestCaseResultAsync(GetTestCaseResultRequest, CallSettings)

public override Task<TestCaseResult> GetTestCaseResultAsync(GetTestCaseResultRequest request, CallSettings callSettings = null)

Gets a test case result.

Parameters
Name Description
request GetTestCaseResultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestCaseResult

A Task containing the RPC response.
Overrides

ImportTestCases(ImportTestCasesRequest, CallSettings)

public override Operation<ImportTestCasesResponse, ImportTestCasesMetadata> ImportTestCases(ImportTestCasesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
  • response: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
Parameters
Name Description
request ImportTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportTestCasesResponseImportTestCasesMetadata

The RPC response.
Overrides

ImportTestCasesAsync(ImportTestCasesRequest, CallSettings)

public override Task<Operation<ImportTestCasesResponse, ImportTestCasesMetadata>> ImportTestCasesAsync(ImportTestCasesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
  • response: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
Parameters
Name Description
request ImportTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportTestCasesResponseImportTestCasesMetadata

A Task containing the RPC response.
Overrides

ListTestCaseResults(ListTestCaseResultsRequest, CallSettings)

public override PagedEnumerable<ListTestCaseResultsResponse, TestCaseResult> ListTestCaseResults(ListTestCaseResultsRequest request, CallSettings callSettings = null)

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 ListTestCaseResultsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTestCaseResultsResponseTestCaseResult

A pageable sequence of TestCaseResult resources.
Overrides

ListTestCaseResultsAsync(ListTestCaseResultsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTestCaseResultsResponse, TestCaseResult> ListTestCaseResultsAsync(ListTestCaseResultsRequest request, CallSettings callSettings = null)

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 ListTestCaseResultsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTestCaseResultsResponseTestCaseResult

A pageable asynchronous sequence of TestCaseResult resources.
Overrides

ListTestCases(ListTestCasesRequest, CallSettings)

public override PagedEnumerable<ListTestCasesResponse, TestCase> ListTestCases(ListTestCasesRequest request, CallSettings callSettings = null)

Fetches a list of test cases for a given agent.

Parameters
Name Description
request ListTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTestCasesResponseTestCase

A pageable sequence of TestCase resources.
Overrides

ListTestCasesAsync(ListTestCasesRequest, CallSettings)

public override PagedAsyncEnumerable<ListTestCasesResponse, TestCase> ListTestCasesAsync(ListTestCasesRequest request, CallSettings callSettings = null)

Fetches a list of test cases for a given agent.

Parameters
Name Description
request ListTestCasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTestCasesResponseTestCase

A pageable asynchronous sequence of TestCase resources.
Overrides

RunTestCase(RunTestCaseRequest, CallSettings)

public override Operation<RunTestCaseResponse, RunTestCaseMetadata> RunTestCase(RunTestCaseRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
  • response: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
Parameters
Name Description
request RunTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRunTestCaseResponseRunTestCaseMetadata

The RPC response.
Overrides

RunTestCaseAsync(RunTestCaseRequest, CallSettings)

public override Task<Operation<RunTestCaseResponse, RunTestCaseMetadata>> RunTestCaseAsync(RunTestCaseRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
  • response: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
Parameters
Name Description
request RunTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRunTestCaseResponseRunTestCaseMetadata

A Task containing the RPC response.
Overrides

UpdateTestCase(UpdateTestCaseRequest, CallSettings)

public override TestCase UpdateTestCase(UpdateTestCaseRequest request, CallSettings callSettings = null)

Updates the specified test case.

Parameters
Name Description
request UpdateTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestCase

The RPC response.
Overrides

UpdateTestCaseAsync(UpdateTestCaseRequest, CallSettings)

public override Task<TestCase> UpdateTestCaseAsync(UpdateTestCaseRequest request, CallSettings callSettings = null)

Updates the specified test case.

Parameters
Name Description
request UpdateTestCaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestCase

A Task containing the RPC response.
Overrides