Dialogflow v3 API - Class TestCases.TestCasesBase (2.16.0)

[BindServiceMethod(typeof(TestCases), "BindService")]
public abstract class TestCases.TestCasesBase

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

Base class for server-side implementations of TestCases

Inheritance

object > TestCases.TestCasesBase

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Methods

BatchDeleteTestCases(BatchDeleteTestCasesRequest, ServerCallContext)

public virtual Task<Empty> BatchDeleteTestCases(BatchDeleteTestCasesRequest request, ServerCallContext context)

Batch deletes test cases.

Parameters
NameDescription
requestBatchDeleteTestCasesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

BatchRunTestCases(BatchRunTestCasesRequest, ServerCallContext)

public virtual Task<Operation> BatchRunTestCases(BatchRunTestCasesRequest request, ServerCallContext context)

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
NameDescription
requestBatchRunTestCasesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CalculateCoverage(CalculateCoverageRequest, ServerCallContext)

public virtual Task<CalculateCoverageResponse> CalculateCoverage(CalculateCoverageRequest request, ServerCallContext context)

Calculates the test coverage for an agent.

Parameters
NameDescription
requestCalculateCoverageRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskCalculateCoverageResponse

The response to send back to the client (wrapped by a task).

CreateTestCase(CreateTestCaseRequest, ServerCallContext)

public virtual Task<TestCase> CreateTestCase(CreateTestCaseRequest request, ServerCallContext context)

Creates a test case for the given agent.

Parameters
NameDescription
requestCreateTestCaseRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTestCase

The response to send back to the client (wrapped by a task).

ExportTestCases(ExportTestCasesRequest, ServerCallContext)

public virtual Task<Operation> ExportTestCases(ExportTestCasesRequest request, ServerCallContext context)

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
NameDescription
requestExportTestCasesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

GetTestCase(GetTestCaseRequest, ServerCallContext)

public virtual Task<TestCase> GetTestCase(GetTestCaseRequest request, ServerCallContext context)

Gets a test case.

Parameters
NameDescription
requestGetTestCaseRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTestCase

The response to send back to the client (wrapped by a task).

GetTestCaseResult(GetTestCaseResultRequest, ServerCallContext)

public virtual Task<TestCaseResult> GetTestCaseResult(GetTestCaseResultRequest request, ServerCallContext context)

Gets a test case result.

Parameters
NameDescription
requestGetTestCaseResultRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTestCaseResult

The response to send back to the client (wrapped by a task).

ImportTestCases(ImportTestCasesRequest, ServerCallContext)

public virtual Task<Operation> ImportTestCases(ImportTestCasesRequest request, ServerCallContext context)

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
NameDescription
requestImportTestCasesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

ListTestCaseResults(ListTestCaseResultsRequest, ServerCallContext)

public virtual Task<ListTestCaseResultsResponse> ListTestCaseResults(ListTestCaseResultsRequest request, ServerCallContext context)

Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.

Parameters
NameDescription
requestListTestCaseResultsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTestCaseResultsResponse

The response to send back to the client (wrapped by a task).

ListTestCases(ListTestCasesRequest, ServerCallContext)

public virtual Task<ListTestCasesResponse> ListTestCases(ListTestCasesRequest request, ServerCallContext context)

Fetches a list of test cases for a given agent.

Parameters
NameDescription
requestListTestCasesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTestCasesResponse

The response to send back to the client (wrapped by a task).

RunTestCase(RunTestCaseRequest, ServerCallContext)

public virtual Task<Operation> RunTestCase(RunTestCaseRequest request, ServerCallContext context)

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
NameDescription
requestRunTestCaseRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateTestCase(UpdateTestCaseRequest, ServerCallContext)

public virtual Task<TestCase> UpdateTestCase(UpdateTestCaseRequest request, ServerCallContext context)

Updates the specified test case.

Parameters
NameDescription
requestUpdateTestCaseRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTestCase

The response to send back to the client (wrapped by a task).