Class TestCasesClient (1.5.0)

TestCasesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.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.v3beta1.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3beta1.TestCaseResult].

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`TestCasesTransport`	The transport used by the client instance.

Methods

TestCasesClient

TestCasesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.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>)

Instantiates 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, TestCasesTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

agent_path

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

Returns a fully-qualified agent string.

batch_delete_test_cases

batch_delete_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.BatchDeleteTestCasesRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.BatchDeleteTestCasesRequest, dict]` The request object. The request message for TestCases.BatchDeleteTestCases.
`parent`	`str` Required. The agent to delete test cases from. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.BatchRunTestCasesRequest, dict]] = 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.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: xref_BatchRunTestCasesMetadata
response: xref_BatchRunTestCasesResponse

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3beta1.types.BatchRunTestCasesRequest, dict]` 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.Operation`	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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.CalculateCoverageRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.CalculateCoverageRequest, dict]` 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)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_test_case

create_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.CreateTestCaseRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.CreateTestCaseRequest, dict]` The request object. The request message for TestCases.CreateTestCase.
`parent`	`str` Required. The agent to create the test case for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`test_case`	`google.cloud.dialogflowcx_v3beta1.types.TestCase` Required. The test case to create. This corresponds to the `test_case` field on the `request` instance; if `request` is provided, this should not be set.
`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)

Returns a fully-qualified entity_type string.

environment_path

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

Returns a fully-qualified environment string.

export_test_cases

export_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ExportTestCasesRequest, dict]] = 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.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: xref_ExportTestCasesMetadata
response: xref_ExportTestCasesResponse

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3beta1.types.ExportTestCasesRequest, dict]` 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.Operation`	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)

Returns 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
`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.

Parameter
Name	Description
`info`	`dict` The service account private key info.

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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`TestCasesClient`	The constructed client.

get_test_case

get_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.GetTestCaseRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.GetTestCaseRequest, dict]` The request object. The request message for TestCases.GetTestCase.
`name`	`str` Required. The name of the testcase. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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_test_case_result

get_test_case_result(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.GetTestCaseResultRequest, dict]] = 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 result.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3beta1.types.GetTestCaseResultRequest, dict]` The request object. The request message for TestCases.GetTestCaseResult.
`name`	`str` Required. The name of the testcase. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.TestCaseResult`	Represents a result from running a test case in an agent environment.

import_test_cases

import_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ImportTestCasesRequest, dict]] = 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.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: xref_ImportTestCasesMetadata
response: xref_ImportTestCasesResponse

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3beta1.types.ImportTestCasesRequest, dict]` 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.Operation`	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)

Returns a fully-qualified intent string.

list_test_case_results

list_test_case_results(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ListTestCaseResultsRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.ListTestCaseResultsRequest, dict]` The request object. The request message for TestCases.ListTestCaseResults.
`parent`	`str` Required. The test case to list results for. Format: `projects/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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.ListTestCaseResultsPager`	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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ListTestCasesRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.ListTestCasesRequest, dict]` The request object. The request message for TestCases.ListTestCases.
`parent`	`str` Required. The agent to list all pages for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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.ListTestCasesPager`	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)

Returns a fully-qualified page string.

parse_agent_path

parse_agent_path(path: str)

Parses 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)

Parses a entity_type path into its component segments.

parse_environment_path

parse_environment_path(path: str)

Parses a environment path into its component segments.

parse_flow_path

parse_flow_path(path: str)

Parses a flow path into its component segments.

parse_intent_path

parse_intent_path(path: str)

Parses a intent path into its component segments.

parse_page_path

parse_page_path(path: str)

Parses a page path into its component segments.

parse_test_case_path

parse_test_case_path(path: str)

Parses a test_case path into its component segments.

parse_test_case_result_path

parse_test_case_result_path(path: str)

Parses a test_case_result path into its component segments.

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parses a transition_route_group path into its component segments.

parse_webhook_path

parse_webhook_path(path: str)

Parses a webhook path into its component segments.

run_test_case

run_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.RunTestCaseRequest, dict]] = 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.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: xref_RunTestCaseMetadata
response: xref_RunTestCaseResponse

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3beta1.types.RunTestCaseRequest, dict]` 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.Operation`	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)

Returns 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
)

Returns 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
)

Returns a fully-qualified transition_route_group string.

update_test_case

update_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.UpdateTestCaseRequest, dict]] = 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`	`Union[google.cloud.dialogflowcx_v3beta1.types.UpdateTestCaseRequest, dict]` The request object. The request message for TestCases.UpdateTestCase.
`test_case`	`google.cloud.dialogflowcx_v3beta1.types.TestCase` Required. The test case to update. This corresponds to the `test_case` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The mask to specify which fields should be updated. The [`creationTime`][google.cloud.dialogflow.cx.v3beta1.TestCase.creation_time] and [`lastTestResult`][google.cloud.dialogflow.cx.v3beta1.TestCase.last_test_result] cannot be updated. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`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)

Returns a fully-qualified webhook string.