As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

TestCases

class google.cloud.dialogflowcx_v3.services.test_cases.TestCasesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/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>)[source]

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

Instantiates the test cases client.

Parameters
  • 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 (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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

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

Returns a fully-qualified agent string.

async 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]] = ())None[source]

Batch deletes test cases.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.BatchDeleteTestCasesRequest) – The request object. The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchDeleteTestCases].

  • parent (str) –

    Required. The agent to delete test cases from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    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.

async 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]] = ())google.api_core.operation_async.AsyncOperation[source]

Kicks off a batch run of test cases.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.BatchRunTestCasesResponse The response message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

Return type

google.api_core.operation_async.AsyncOperation

async 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]] = ())google.cloud.dialogflowcx_v3.types.test_case.CalculateCoverageResponse[source]

Calculates the test coverage for an agent.

Parameters
Returns

The response message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

Return type

google.cloud.dialogflowcx_v3.types.CalculateCoverageResponse

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async 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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCase[source]

Creates a test case for the given agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateTestCaseRequest) – The request object. The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase].

  • parent (str) –

    Required. The agent to create the test case for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • test_case (google.cloud.dialogflowcx_v3.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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3.types.TestCase

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

Returns a fully-qualified entity_type string.

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

Returns a fully-qualified environment string.

async 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]] = ())google.api_core.operation_async.AsyncOperation[source]

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
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ExportTestCasesResponse The response message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

Return type

google.api_core.operation_async.AsyncOperation

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

Returns a fully-qualified flow string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

TestCasesAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

TestCasesAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

TestCasesAsyncClient

async 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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCase[source]

Gets a test case.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetTestCaseRequest) – The request object. The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3.TestCases.GetTestCase].

  • name (str) –

    Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

    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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3.types.TestCase

async 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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCaseResult[source]

Gets a test case result.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetTestCaseResultRequest) – The request object. The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3.TestCases.GetTestCaseResult].

  • name (str) –

    Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.

    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

Represents a result from running a test case in an agent environment.

Return type

google.cloud.dialogflowcx_v3.types.TestCaseResult

get_transport_class()Type[google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async 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]] = ())google.api_core.operation_async.AsyncOperation[source]

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
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ImportTestCasesResponse The response message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

Return type

google.api_core.operation_async.AsyncOperation

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

Returns a fully-qualified intent string.

async 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]] = ())google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsAsyncPager[source]

Fetches a list of results for a given test case.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListTestCaseResultsRequest) – The request object. The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

  • parent (str) –

    Required. The test case to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ testCases/<TestCase ID>. 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

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.

Return type

google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsAsyncPager

async 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]] = ())google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesAsyncPager[source]

Fetches a list of test cases for a given agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListTestCasesRequest) – The request object. The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

  • parent (str) –

    Required. The agent to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    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

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.

Return type

google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesAsyncPager

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

Returns a fully-qualified page string.

static parse_agent_path(path: str)Dict[str, str]

Parses a agent path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_entity_type_path(path: str)Dict[str, str]

Parses a entity_type path into its component segments.

static parse_environment_path(path: str)Dict[str, str]

Parses a environment path into its component segments.

static parse_flow_path(path: str)Dict[str, str]

Parses a flow path into its component segments.

static parse_intent_path(path: str)Dict[str, str]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str]

Parses a page path into its component segments.

static parse_test_case_path(path: str)Dict[str, str]

Parses a test_case path into its component segments.

static parse_test_case_result_path(path: str)Dict[str, str]

Parses a test_case_result path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str]

Parses a transition_route_group path into its component segments.

static parse_webhook_path(path: str)Dict[str, str]

Parses a webhook path into its component segments.

async 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]] = ())google.api_core.operation_async.AsyncOperation[source]

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
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.RunTestCaseResponse The response message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

Return type

google.api_core.operation_async.AsyncOperation

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

Returns a fully-qualified test_case string.

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

Returns a fully-qualified test_case_result string.

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

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

TestCasesTransport

async 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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCase[source]

Updates the specified test case.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdateTestCaseRequest) – The request object. The request message for [TestCases.UpdateTestCase][google.cloud.dialogflow.cx.v3.TestCases.UpdateTestCase].

  • test_case (google.cloud.dialogflowcx_v3.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.v3.TestCase.creation_time] and [lastTestResult][google.cloud.dialogflow.cx.v3.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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3.types.TestCase

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

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.test_cases.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>)[source]

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

Instantiates the test cases client.

Parameters
  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static agent_path(project: str, location: str, agent: str)str[source]

Returns a fully-qualified agent string.

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]] = ())None[source]

Batch deletes test cases.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.BatchDeleteTestCasesRequest) – The request object. The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchDeleteTestCases].

  • parent (str) –

    Required. The agent to delete test cases from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    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(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]] = ())google.api_core.operation.Operation[source]

Kicks off a batch run of test cases.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.BatchRunTestCasesResponse The response message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

Return type

google.api_core.operation.Operation

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]] = ())google.cloud.dialogflowcx_v3.types.test_case.CalculateCoverageResponse[source]

Calculates the test coverage for an agent.

Parameters
Returns

The response message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

Return type

google.cloud.dialogflowcx_v3.types.CalculateCoverageResponse

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCase[source]

Creates a test case for the given agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateTestCaseRequest) – The request object. The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase].

  • parent (str) –

    Required. The agent to create the test case for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • test_case (google.cloud.dialogflowcx_v3.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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3.types.TestCase

static entity_type_path(project: str, location: str, agent: str, entity_type: str)str[source]

Returns a fully-qualified entity_type string.

static environment_path(project: str, location: str, agent: str, environment: str)str[source]

Returns a fully-qualified environment string.

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]] = ())google.api_core.operation.Operation[source]

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
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ExportTestCasesResponse The response message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

Return type

google.api_core.operation.Operation

static flow_path(project: str, location: str, agent: str, flow: str)str[source]

Returns a fully-qualified flow string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

TestCasesClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

TestCasesClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

TestCasesClient

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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCase[source]

Gets a test case.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetTestCaseRequest) – The request object. The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3.TestCases.GetTestCase].

  • name (str) –

    Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

    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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3.types.TestCase

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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCaseResult[source]

Gets a test case result.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetTestCaseResultRequest) – The request object. The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3.TestCases.GetTestCaseResult].

  • name (str) –

    Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.

    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

Represents a result from running a test case in an agent environment.

Return type

google.cloud.dialogflowcx_v3.types.TestCaseResult

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]] = ())google.api_core.operation.Operation[source]

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
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.ImportTestCasesResponse The response message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

Return type

google.api_core.operation.Operation

static intent_path(project: str, location: str, agent: str, intent: str)str[source]

Returns a fully-qualified intent string.

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]] = ())google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsPager[source]

Fetches a list of results for a given test case.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListTestCaseResultsRequest) – The request object. The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

  • parent (str) –

    Required. The test case to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ testCases/<TestCase ID>. 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

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.

Return type

google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsPager

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]] = ())google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesPager[source]

Fetches a list of test cases for a given agent.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListTestCasesRequest) – The request object. The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

  • parent (str) –

    Required. The agent to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

    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

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.

Return type

google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesPager

static page_path(project: str, location: str, agent: str, flow: str, page: str)str[source]

Returns a fully-qualified page string.

static parse_agent_path(path: str)Dict[str, str][source]

Parses a agent path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_entity_type_path(path: str)Dict[str, str][source]

Parses a entity_type path into its component segments.

static parse_environment_path(path: str)Dict[str, str][source]

Parses a environment path into its component segments.

static parse_flow_path(path: str)Dict[str, str][source]

Parses a flow path into its component segments.

static parse_intent_path(path: str)Dict[str, str][source]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str][source]

Parses a page path into its component segments.

static parse_test_case_path(path: str)Dict[str, str][source]

Parses a test_case path into its component segments.

static parse_test_case_result_path(path: str)Dict[str, str][source]

Parses a test_case_result path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str][source]

Parses a transition_route_group path into its component segments.

static parse_webhook_path(path: str)Dict[str, str][source]

Parses a webhook path into its component segments.

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]] = ())google.api_core.operation.Operation[source]

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
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.RunTestCaseResponse The response message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

Return type

google.api_core.operation.Operation

static test_case_path(project: str, location: str, agent: str, test_case: str)str[source]

Returns a fully-qualified test_case string.

static test_case_result_path(project: str, location: str, agent: str, test_case: str, result: str)str[source]

Returns a fully-qualified test_case_result string.

static transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)str[source]

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

TestCasesTransport

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]] = ())google.cloud.dialogflowcx_v3.types.test_case.TestCase[source]

Updates the specified test case.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdateTestCaseRequest) – The request object. The request message for [TestCases.UpdateTestCase][google.cloud.dialogflow.cx.v3.TestCases.UpdateTestCase].

  • test_case (google.cloud.dialogflowcx_v3.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.v3.TestCase.creation_time] and [lastTestResult][google.cloud.dialogflow.cx.v3.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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3.types.TestCase

static webhook_path(project: str, location: str, agent: str, webhook: str)str[source]

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsResponse]], request: google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsRequest, response: google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_test_case_results requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListTestCaseResultsResponse object, and provides an __aiter__ method to iterate through its test_case_results field.

If there are more pages, the __aiter__ method will make additional ListTestCaseResults requests and continue to iterate through the test_case_results field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListTestCaseResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsResponse], request: google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsRequest, response: google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_test_case_results requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListTestCaseResultsResponse object, and provides an __iter__ method to iterate through its test_case_results field.

If there are more pages, the __iter__ method will make additional ListTestCaseResults requests and continue to iterate through the test_case_results field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListTestCaseResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesResponse]], request: google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesRequest, response: google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_test_cases requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListTestCasesResponse object, and provides an __aiter__ method to iterate through its test_cases field.

If there are more pages, the __aiter__ method will make additional ListTestCases requests and continue to iterate through the test_cases field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListTestCasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesResponse], request: google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesRequest, response: google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_test_cases requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListTestCasesResponse object, and provides an __iter__ method to iterate through its test_cases field.

If there are more pages, the __iter__ method will make additional ListTestCases requests and continue to iterate through the test_cases field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3.types.ListTestCasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters