Class TestCasesClient (0.8.0)

TestCasesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Inheritance

builtins.object > TestCasesClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
TestCasesTransport	The transport used by the client instance.

Methods

agent_path

agent_path(project: str, location: str, agent: str)

Returns a fully-qualified agent string.

Parameters

Name	Description
project
location
agent

batch_delete_test_cases

batch_delete_test_cases(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.BatchDeleteTestCasesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Batch deletes test cases.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.BatchDeleteTestCasesRequest` The request object. The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchDeleteTestCases].

batch_run_test_cases

batch_run_test_cases(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.BatchRunTestCasesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Kicks off a batch run of test cases.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.BatchRunTestCasesRequest` The request object. The request message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be

calculate_coverage

calculate_coverage(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.CalculateCoverageRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Calculates the test coverage for an agent.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.CalculateCoverageRequest` The request object. The request message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.CalculateCoverageResponse	The response message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter

Name	Description
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter

Name	Description
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters

Name	Description
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter

Name	Description
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter

Name	Description
project

create_test_case

create_test_case(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.CreateTestCaseRequest] = None, *, parent: Optional[str] = None, test_case: Optional[google.cloud.dialogflowcx_v3.types.test_case.TestCase] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a test case for the given agent.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.CreateTestCaseRequest` The request object. The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase].

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.TestCase	Represents a test case.

entity_type_path

entity_type_path(project: str, location: str, agent: str, entity_type: str)

Returns a fully-qualified entity_type string.

Parameters

Name	Description
project
location
agent
entity_type

environment_path

environment_path(project: str, location: str, agent: str, environment: str)

Returns a fully-qualified environment string.

Parameters

Name	Description
project
location
agent
environment

export_test_cases

export_test_cases(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.ExportTestCasesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.ExportTestCasesRequest` The request object. The request message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be

flow_path

flow_path(project: str, location: str, agent: str, flow: str)

Returns a fully-qualified flow string.

Parameters

Name	Description
project
location
agent
flow

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

Name	Description
filename	`str` The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
TestCasesClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters

Name	Description
info	`dict` The service account private key info.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
TestCasesClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

Name	Description
filename	`str` The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
TestCasesClient	The constructed client.

get_test_case

get_test_case(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.GetTestCaseRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a test case.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.GetTestCaseRequest` The request object. The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3.TestCases.GetTestCase].

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.TestCase	Represents a test case.

get_test_case_result

get_test_case_result(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.GetTestCaseResultRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a test case result.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.GetTestCaseResultRequest` The request object. The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3.TestCases.GetTestCaseResult].

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.TestCaseResult	Represents a result from running a test case in an agent environment.

import_test_cases

import_test_cases(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.ImportTestCasesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwite any existing ones. The provided ID in the imported test case is neglected.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.ImportTestCasesRequest` The request object. The request message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be

intent_path

intent_path(project: str, location: str, agent: str, intent: str)

Returns a fully-qualified intent string.

Parameters

Name	Description
project
location
agent
intent

list_test_case_results

list_test_case_results(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Fetches a list of results for a given test case.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.ListTestCaseResultsRequest` The request object. The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

Returns

Type	Description
google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsPager	The response message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults]. Iterating over this object will yield results and resolve additional pages automatically.

list_test_cases

list_test_cases(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Fetches a list of test cases for a given agent.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.ListTestCasesRequest` The request object. The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

Returns

Type	Description
google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesPager	The response message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases]. Iterating over this object will yield results and resolve additional pages automatically.

page_path

page_path(project: str, location: str, agent: str, flow: str, page: str)

Returns a fully-qualified page string.

Parameters

Name	Description
project
location
agent
flow
page

parse_agent_path

parse_agent_path(path: str)

Parses a agent path into its component segments.

Parameter

Name	Description
path

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter

Name	Description
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter

Name	Description
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter

Name	Description
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter

Name	Description
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter

Name	Description
path

parse_entity_type_path

parse_entity_type_path(path: str)

Parses a entity_type path into its component segments.

Parameter

Name	Description
path

parse_environment_path

parse_environment_path(path: str)

Parses a environment path into its component segments.

Parameter

Name	Description
path

parse_flow_path

parse_flow_path(path: str)

Parses a flow path into its component segments.

Parameter

Name	Description
path

parse_intent_path

parse_intent_path(path: str)

Parses a intent path into its component segments.

Parameter

Name	Description
path

parse_page_path

parse_page_path(path: str)

Parses a page path into its component segments.

Parameter

Name	Description
path

parse_test_case_path

parse_test_case_path(path: str)

Parses a test_case path into its component segments.

Parameter

Name	Description
path

parse_test_case_result_path

parse_test_case_result_path(path: str)

Parses a test_case_result path into its component segments.

Parameter

Name	Description
path

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parses a transition_route_group path into its component segments.

Parameter

Name	Description
path

parse_webhook_path

parse_webhook_path(path: str)

Parses a webhook path into its component segments.

Parameter

Name	Description
path

run_test_case

run_test_case(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.RunTestCaseRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Kicks off a test case run.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.RunTestCaseRequest` The request object. The request message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

Returns

Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be

test_case_path

test_case_path(project: str, location: str, agent: str, test_case: str)

Returns a fully-qualified test_case string.

Parameters

Name	Description
project
location
agent
test_case

test_case_result_path

test_case_result_path(project: str, location: str, agent: str, test_case: str, result: str)

Returns a fully-qualified test_case_result string.

Parameters

Name	Description
project
location
agent
test_case
result

transition_route_group_path

transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)

Returns a fully-qualified transition_route_group string.

Parameters

Name	Description
project
location
agent
flow
transition_route_group

update_test_case

update_test_case(request: Optional[google.cloud.dialogflowcx_v3.types.test_case.UpdateTestCaseRequest] = None, *, test_case: Optional[google.cloud.dialogflowcx_v3.types.test_case.TestCase] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified test case.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.UpdateTestCaseRequest` The request object. The request message for [TestCases.UpdateTestCase][google.cloud.dialogflow.cx.v3.TestCases.UpdateTestCase].

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.TestCase	Represents a test case.

webhook_path

webhook_path(project: str, location: str, agent: str, webhook: str)

Returns a fully-qualified webhook string.

Parameters

Name	Description
project
location
agent
webhook