Dialogflow v3 API - Class TestCases.TestCasesClient (2.9.0)

public class TestCases.TestCasesClient : ClientBase<TestCases.TestCasesClient>

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

Client for TestCases

Inheritance

object > ClientBase > ClientBaseTestCasesTestCasesClient > TestCases.TestCasesClient

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

TestCasesClient()

protected TestCasesClient()

Protected parameterless constructor to allow creation of test doubles.

TestCasesClient(CallInvoker)

public TestCasesClient(CallInvoker callInvoker)

Creates a new client for TestCases that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

TestCasesClient(ChannelBase)

public TestCasesClient(ChannelBase channel)

Creates a new client for TestCases

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

TestCasesClient(ClientBaseConfiguration)

protected TestCasesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchDeleteTestCases(BatchDeleteTestCasesRequest, CallOptions)

public virtual Empty BatchDeleteTestCases(BatchDeleteTestCasesRequest request, CallOptions options)

Batch deletes test cases.

Parameters
NameDescription
requestBatchDeleteTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

BatchDeleteTestCases(BatchDeleteTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty BatchDeleteTestCases(BatchDeleteTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Batch deletes test cases.

Parameters
NameDescription
requestBatchDeleteTestCasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

BatchDeleteTestCasesAsync(BatchDeleteTestCasesRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> BatchDeleteTestCasesAsync(BatchDeleteTestCasesRequest request, CallOptions options)

Batch deletes test cases.

Parameters
NameDescription
requestBatchDeleteTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

BatchDeleteTestCasesAsync(BatchDeleteTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> BatchDeleteTestCasesAsync(BatchDeleteTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Batch deletes test cases.

Parameters
NameDescription
requestBatchDeleteTestCasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

BatchRunTestCases(BatchRunTestCasesRequest, CallOptions)

public virtual Operation BatchRunTestCases(BatchRunTestCasesRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
  • response: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
Parameters
NameDescription
requestBatchRunTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchRunTestCases(BatchRunTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation BatchRunTestCases(BatchRunTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchRunTestCasesAsync(BatchRunTestCasesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchRunTestCasesAsync(BatchRunTestCasesRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
  • response: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
Parameters
NameDescription
requestBatchRunTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

BatchRunTestCasesAsync(BatchRunTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> BatchRunTestCasesAsync(BatchRunTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CalculateCoverage(CalculateCoverageRequest, CallOptions)

public virtual CalculateCoverageResponse CalculateCoverage(CalculateCoverageRequest request, CallOptions options)

Calculates the test coverage for an agent.

Parameters
NameDescription
requestCalculateCoverageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CalculateCoverageResponse

The response received from the server.

CalculateCoverage(CalculateCoverageRequest, Metadata, DateTime?, CancellationToken)

public virtual CalculateCoverageResponse CalculateCoverage(CalculateCoverageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Calculates the test coverage for an agent.

Parameters
NameDescription
requestCalculateCoverageRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
CalculateCoverageResponse

The response received from the server.

CalculateCoverageAsync(CalculateCoverageRequest, CallOptions)

public virtual AsyncUnaryCall<CalculateCoverageResponse> CalculateCoverageAsync(CalculateCoverageRequest request, CallOptions options)

Calculates the test coverage for an agent.

Parameters
NameDescription
requestCalculateCoverageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallCalculateCoverageResponse

The call object.

CalculateCoverageAsync(CalculateCoverageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CalculateCoverageResponse> CalculateCoverageAsync(CalculateCoverageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Calculates the test coverage for an agent.

Parameters
NameDescription
requestCalculateCoverageRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallCalculateCoverageResponse

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateTestCase(CreateTestCaseRequest, CallOptions)

public virtual TestCase CreateTestCase(CreateTestCaseRequest request, CallOptions options)

Creates a test case for the given agent.

Parameters
NameDescription
requestCreateTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestCase

The response received from the server.

CreateTestCase(CreateTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual TestCase CreateTestCase(CreateTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a test case for the given agent.

Parameters
NameDescription
requestCreateTestCaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestCase

The response received from the server.

CreateTestCaseAsync(CreateTestCaseRequest, CallOptions)

public virtual AsyncUnaryCall<TestCase> CreateTestCaseAsync(CreateTestCaseRequest request, CallOptions options)

Creates a test case for the given agent.

Parameters
NameDescription
requestCreateTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTestCase

The call object.

CreateTestCaseAsync(CreateTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestCase> CreateTestCaseAsync(CreateTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a test case for the given agent.

Parameters
NameDescription
requestCreateTestCaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTestCase

The call object.

ExportTestCases(ExportTestCasesRequest, CallOptions)

public virtual Operation ExportTestCases(ExportTestCasesRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
  • response: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
Parameters
NameDescription
requestExportTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportTestCases(ExportTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportTestCases(ExportTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportTestCasesAsync(ExportTestCasesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportTestCasesAsync(ExportTestCasesRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
  • response: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
Parameters
NameDescription
requestExportTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ExportTestCasesAsync(ExportTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportTestCasesAsync(ExportTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetTestCase(GetTestCaseRequest, CallOptions)

public virtual TestCase GetTestCase(GetTestCaseRequest request, CallOptions options)

Gets a test case.

Parameters
NameDescription
requestGetTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestCase

The response received from the server.

GetTestCase(GetTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual TestCase GetTestCase(GetTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a test case.

Parameters
NameDescription
requestGetTestCaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestCase

The response received from the server.

GetTestCaseAsync(GetTestCaseRequest, CallOptions)

public virtual AsyncUnaryCall<TestCase> GetTestCaseAsync(GetTestCaseRequest request, CallOptions options)

Gets a test case.

Parameters
NameDescription
requestGetTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTestCase

The call object.

GetTestCaseAsync(GetTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestCase> GetTestCaseAsync(GetTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a test case.

Parameters
NameDescription
requestGetTestCaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTestCase

The call object.

GetTestCaseResult(GetTestCaseResultRequest, CallOptions)

public virtual TestCaseResult GetTestCaseResult(GetTestCaseResultRequest request, CallOptions options)

Gets a test case result.

Parameters
NameDescription
requestGetTestCaseResultRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestCaseResult

The response received from the server.

GetTestCaseResult(GetTestCaseResultRequest, Metadata, DateTime?, CancellationToken)

public virtual TestCaseResult GetTestCaseResult(GetTestCaseResultRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a test case result.

Parameters
NameDescription
requestGetTestCaseResultRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestCaseResult

The response received from the server.

GetTestCaseResultAsync(GetTestCaseResultRequest, CallOptions)

public virtual AsyncUnaryCall<TestCaseResult> GetTestCaseResultAsync(GetTestCaseResultRequest request, CallOptions options)

Gets a test case result.

Parameters
NameDescription
requestGetTestCaseResultRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTestCaseResult

The call object.

GetTestCaseResultAsync(GetTestCaseResultRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestCaseResult> GetTestCaseResultAsync(GetTestCaseResultRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a test case result.

Parameters
NameDescription
requestGetTestCaseResultRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTestCaseResult

The call object.

ImportTestCases(ImportTestCasesRequest, CallOptions)

public virtual Operation ImportTestCases(ImportTestCasesRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
  • response: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
Parameters
NameDescription
requestImportTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportTestCases(ImportTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportTestCases(ImportTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportTestCasesAsync(ImportTestCasesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportTestCasesAsync(ImportTestCasesRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
  • response: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
Parameters
NameDescription
requestImportTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ImportTestCasesAsync(ImportTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportTestCasesAsync(ImportTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ListTestCaseResults(ListTestCaseResultsRequest, CallOptions)

public virtual ListTestCaseResultsResponse ListTestCaseResults(ListTestCaseResultsRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTestCaseResultsResponse

The response received from the server.

ListTestCaseResults(ListTestCaseResultsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTestCaseResultsResponse ListTestCaseResults(ListTestCaseResultsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTestCaseResultsResponse

The response received from the server.

ListTestCaseResultsAsync(ListTestCaseResultsRequest, CallOptions)

public virtual AsyncUnaryCall<ListTestCaseResultsResponse> ListTestCaseResultsAsync(ListTestCaseResultsRequest request, CallOptions options)

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListTestCaseResultsResponse

The call object.

ListTestCaseResultsAsync(ListTestCaseResultsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTestCaseResultsResponse> ListTestCaseResultsAsync(ListTestCaseResultsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListTestCaseResultsResponse

The call object.

ListTestCases(ListTestCasesRequest, CallOptions)

public virtual ListTestCasesResponse ListTestCases(ListTestCasesRequest request, CallOptions options)

Fetches a list of test cases for a given agent.

Parameters
NameDescription
requestListTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTestCasesResponse

The response received from the server.

ListTestCases(ListTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTestCasesResponse ListTestCases(ListTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches a list of test cases for a given agent.

Parameters
NameDescription
requestListTestCasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTestCasesResponse

The response received from the server.

ListTestCasesAsync(ListTestCasesRequest, CallOptions)

public virtual AsyncUnaryCall<ListTestCasesResponse> ListTestCasesAsync(ListTestCasesRequest request, CallOptions options)

Fetches a list of test cases for a given agent.

Parameters
NameDescription
requestListTestCasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListTestCasesResponse

The call object.

ListTestCasesAsync(ListTestCasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTestCasesResponse> ListTestCasesAsync(ListTestCasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches a list of test cases for a given agent.

Parameters
NameDescription
requestListTestCasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListTestCasesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override TestCases.TestCasesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
TestCasesTestCasesClient
Overrides

RunTestCase(RunTestCaseRequest, CallOptions)

public virtual Operation RunTestCase(RunTestCaseRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
  • response: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
Parameters
NameDescription
requestRunTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RunTestCase(RunTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RunTestCase(RunTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RunTestCaseAsync(RunTestCaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RunTestCaseAsync(RunTestCaseRequest request, CallOptions 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][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
  • response: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
Parameters
NameDescription
requestRunTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RunTestCaseAsync(RunTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RunTestCaseAsync(RunTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateTestCase(UpdateTestCaseRequest, CallOptions)

public virtual TestCase UpdateTestCase(UpdateTestCaseRequest request, CallOptions options)

Updates the specified test case.

Parameters
NameDescription
requestUpdateTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestCase

The response received from the server.

UpdateTestCase(UpdateTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual TestCase UpdateTestCase(UpdateTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified test case.

Parameters
NameDescription
requestUpdateTestCaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TestCase

The response received from the server.

UpdateTestCaseAsync(UpdateTestCaseRequest, CallOptions)

public virtual AsyncUnaryCall<TestCase> UpdateTestCaseAsync(UpdateTestCaseRequest request, CallOptions options)

Updates the specified test case.

Parameters
NameDescription
requestUpdateTestCaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTestCase

The call object.

UpdateTestCaseAsync(UpdateTestCaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestCase> UpdateTestCaseAsync(UpdateTestCaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified test case.

Parameters
NameDescription
requestUpdateTestCaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTestCase

The call object.