- 1.37.0 (latest)
- 1.36.0
- 1.35.0
- 1.34.1
- 1.33.0
- 1.32.1
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.1
- 1.19.0
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.0
- 1.14.1
- 1.13.5
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.2
- 1.2.0
- 1.1.1
- 1.0.0
- 0.8.2
- 0.7.1
- 0.6.0
- 0.5.0
- 0.4.1
- 0.3.0
- 0.2.0
- 0.1.1
TestCasesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.test_cases.transports.base.TestCasesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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.v3beta1.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3beta1.TestCaseResult].
Properties
transport
Return the transport used by the client instance.
Returns | |
---|---|
Type | Description |
TestCasesTransport | The transport used by the client instance. |
Methods
TestCasesAsyncClient
TestCasesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.test_cases.transports.base.TestCasesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiate the test cases client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
agent_path
agent_path(project: str, location: str, agent: str)
Return a fully-qualified agent string.
batch_delete_test_cases
batch_delete_test_cases(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.BatchDeleteTestCasesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Batch deletes test cases.
Parameters | |
---|---|
Name | Description |
request |
BatchDeleteTestCasesRequest
The request object. The request message for TestCases.BatchDeleteTestCases. |
parent |
Required. The agent to delete test cases from. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
batch_run_test_cases
batch_run_test_cases(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.BatchRunTestCasesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Kicks off a batch run of test cases.
Parameters | |
---|---|
Name | Description |
request |
BatchRunTestCasesRequest
The request object. The request message for TestCases.BatchRunTestCases. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be BatchRunTestCasesResponse The response message for TestCases.BatchRunTestCases. |
calculate_coverage
calculate_coverage(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.CalculateCoverageRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Calculates the test coverage for an agent.
Parameters | |
---|---|
Name | Description |
request |
CalculateCoverageRequest
The request object. The request message for TestCases.CalculateCoverage. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.types.CalculateCoverageResponse | The response message for TestCases.CalculateCoverage. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Return a fully-qualified project string.
create_test_case
create_test_case(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.CreateTestCaseRequest] = None, *, parent: Optional[str] = None, test_case: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a test case for the given agent.
Parameters | |
---|---|
Name | Description |
request |
CreateTestCaseRequest
The request object. The request message for TestCases.CreateTestCase. |
parent |
Required. The agent to create the test case for. Format: |
test_case |
TestCase
Required. The test case to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.types.TestCase | Represents a test case. |
entity_type_path
entity_type_path(project: str, location: str, agent: str, entity_type: str)
Return a fully-qualified entity_type string.
environment_path
environment_path(project: str, location: str, agent: str, environment: str)
Return a fully-qualified environment string.
export_test_cases
export_test_cases(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.ExportTestCasesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <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.
Parameters | |
---|---|
Name | Description |
request |
ExportTestCasesRequest
The request object. The request message for TestCases.ExportTestCases. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ExportTestCasesResponse The response message for TestCases.ExportTestCases. |
flow_path
flow_path(project: str, location: str, agent: str, flow: str)
Return a fully-qualified flow string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
TestCasesAsyncClient | 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.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
TestCasesAsyncClient | 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.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
TestCasesAsyncClient | The constructed client. |
get_test_case
get_test_case(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.GetTestCaseRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a test case.
Parameters | |
---|---|
Name | Description |
request |
GetTestCaseRequest
The request object. The request message for TestCases.GetTestCase. |
name |
Required. The name of the testcase. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.types.TestCase | Represents a test case. |
get_transport_class
get_transport_class()
Return an appropriate transport class.
import_test_cases
import_test_cases(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.ImportTestCasesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <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.
Parameters | |
---|---|
Name | Description |
request |
ImportTestCasesRequest
The request object. The request message for TestCases.ImportTestCases. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ImportTestCasesResponse The response message for TestCases.ImportTestCases. |
intent_path
intent_path(project: str, location: str, agent: str, intent: str)
Return a fully-qualified intent string.
list_test_case_results
list_test_case_results(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.ListTestCaseResultsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a list of results for a given test case.
Parameters | |
---|---|
Name | Description |
request |
ListTestCaseResultsRequest
The request object. The request message for TestCases.ListTestCaseResults. |
parent |
Required. The test case to list results for. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCaseResultsAsyncPager | The response message for 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_v3beta1.types.test_case.ListTestCasesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a list of test cases for a given agent.
Parameters | |
---|---|
Name | Description |
request |
ListTestCasesRequest
The request object. The request message for TestCases.ListTestCases. |
parent |
Required. The agent to list all pages for. Format: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCasesAsyncPager | The response message for 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)
Return a fully-qualified page string.
parse_agent_path
parse_agent_path(path: str)
Parse a agent path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_entity_type_path
parse_entity_type_path(path: str)
Parse a entity_type path into its component segments.
parse_environment_path
parse_environment_path(path: str)
Parse a environment path into its component segments.
parse_flow_path
parse_flow_path(path: str)
Parse a flow path into its component segments.
parse_intent_path
parse_intent_path(path: str)
Parse a intent path into its component segments.
parse_page_path
parse_page_path(path: str)
Parse a page path into its component segments.
parse_test_case_path
parse_test_case_path(path: str)
Parse a test_case path into its component segments.
parse_test_case_result_path
parse_test_case_result_path(path: str)
Parse a test_case_result path into its component segments.
parse_transition_route_group_path
parse_transition_route_group_path(path: str)
Parse a transition_route_group path into its component segments.
parse_webhook_path
parse_webhook_path(path: str)
Parse a webhook path into its component segments.
run_test_case
run_test_case(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.RunTestCaseRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Kicks off a test case run.
Parameters | |
---|---|
Name | Description |
request |
RunTestCaseRequest
The request object. The request message for TestCases.RunTestCase. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be RunTestCaseResponse The response message for TestCases.RunTestCase. |
test_case_path
test_case_path(project: str, location: str, agent: str, test_case: str)
Return a fully-qualified test_case string.
test_case_result_path
test_case_result_path(
project: str, location: str, agent: str, test_case: str, result: str
)
Return a fully-qualified test_case_result string.
transition_route_group_path
transition_route_group_path(
project: str, location: str, agent: str, flow: str, transition_route_group: str
)
Return a fully-qualified transition_route_group string.
update_test_case
update_test_case(request: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.UpdateTestCaseRequest] = None, *, test_case: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified test case.
Parameters | |
---|---|
Name | Description |
request |
UpdateTestCaseRequest
The request object. The request message for TestCases.UpdateTestCase. |
test_case |
TestCase
Required. The test case to update. This corresponds to the |
update_mask |
Required. The mask to specify which fields should be updated. The [ |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.dialogflowcx_v3beta1.types.TestCase | Represents a test case. |
webhook_path
webhook_path(project: str, location: str, agent: str, webhook: str)
Return a fully-qualified webhook string.