Class TestCasesAsyncClient (1.33.0)

TestCasesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport] = 'grpc_asyncio', client_options: typing.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].

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

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

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

TestCasesAsyncClient

TestCasesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport] = 'grpc_asyncio', client_options: typing.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 async 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 Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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.

agent_path

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

Returns a fully-qualified agent string.

batch_delete_test_cases

batch_delete_test_cases(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.BatchDeleteTestCasesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Batch deletes test cases.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_batch_delete_test_cases():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.BatchDeleteTestCasesRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

    # Make the request
    await client.batch_delete_test_cases(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.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_async.AsyncRetry

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: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.BatchRunTestCasesRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

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
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_batch_run_test_cases():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.BatchRunTestCasesRequest(
        parent="parent_value",
        test_cases=['test_cases_value1', 'test_cases_value2'],
    )

    # Make the request
    operation = client.batch_run_test_cases(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.types.BatchRunTestCasesRequest, dict]]

The request object. The request message for TestCases.BatchRunTestCases.

retry google.api_core.retry_async.AsyncRetry

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: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.CalculateCoverageRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.test_case.CalculateCoverageResponse

Calculates the test coverage for an agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_calculate_coverage():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.CalculateCoverageRequest(
        agent="agent_value",
        type_="TRANSITION_ROUTE_GROUP",
    )

    # Make the request
    response = await client.calculate_coverage(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.types.CalculateCoverageRequest, dict]]

The request object. The request message for TestCases.CalculateCoverage.

retry google.api_core.retry_async.AsyncRetry

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_v3.types.CalculateCoverageResponse The response message for TestCases.CalculateCoverage.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.

retry google.api_core.retry_async.AsyncRetry

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.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_test_case

create_test_case(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.CreateTestCaseRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    test_case: typing.Optional[
        google.cloud.dialogflowcx_v3.types.test_case.TestCase
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.test_case.TestCase

Creates a test case for the given agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_create_test_case():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    test_case = dialogflowcx_v3.TestCase()
    test_case.display_name = "display_name_value"

    request = dialogflowcx_v3.CreateTestCaseRequest(
        parent="parent_value",
        test_case=test_case,
    )

    # Make the request
    response = await client.create_test_case(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.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 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_async.AsyncRetry

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_v3.types.TestCase Represents a test case.

entity_type_path

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

Returns a fully-qualified entity_type string.

environment_path

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

Returns a fully-qualified environment string.

export_test_cases

export_test_cases(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.ExportTestCasesRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

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
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_export_test_cases():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ExportTestCasesRequest(
        gcs_uri="gcs_uri_value",
        parent="parent_value",
    )

    # Make the request
    operation = client.export_test_cases(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.types.ExportTestCasesRequest, dict]]

The request object. The request message for TestCases.ExportTestCases.

retry google.api_core.retry_async.AsyncRetry

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

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.

retry google.api_core.retry_async.AsyncRetry

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
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.

retry google.api_core.retry_async.AsyncRetry

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
.operations_pb2.Operation An Operation object.

get_test_case

get_test_case(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.GetTestCaseRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.test_case.TestCase

Gets a test case.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_get_test_case():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.GetTestCaseRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_test_case(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.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_async.AsyncRetry

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_v3.types.TestCase Represents a test case.

get_test_case_result

get_test_case_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.GetTestCaseResultRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.test_case.TestCaseResult

Gets a test case result.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_get_test_case_result():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.GetTestCaseResultRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_test_case_result(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.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_async.AsyncRetry

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_v3.types.TestCaseResult Represents a result from running a test case in an agent environment.

get_transport_class

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

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

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

import_test_cases

import_test_cases(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.ImportTestCasesRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

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

This method is a long-running operation <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
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_import_test_cases():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ImportTestCasesRequest(
        gcs_uri="gcs_uri_value",
        parent="parent_value",
    )

    # Make the request
    operation = client.import_test_cases(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.types.ImportTestCasesRequest, dict]]

The request object. The request message for TestCases.ImportTestCases.

retry google.api_core.retry_async.AsyncRetry

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

Returns a fully-qualified intent string.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.

retry google.api_core.retry_async.AsyncRetry

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
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.

retry google.api_core.retry_async.AsyncRetry

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
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_test_case_results

list_test_case_results(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.ListTestCaseResultsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCaseResultsAsyncPager
)

Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_list_test_case_results():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ListTestCaseResultsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_test_case_results(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.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_async.AsyncRetry

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_v3.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: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.ListTestCasesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.services.test_cases.pagers.ListTestCasesAsyncPager

Fetches a list of test cases for a given agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_list_test_cases():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ListTestCasesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_test_cases(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.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_async.AsyncRetry

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_v3.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) -> str

Returns a fully-qualified page string.

parse_agent_path

parse_agent_path(path: str) -> typing.Dict[str, str]

Parses a agent path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_entity_type_path

parse_entity_type_path(path: str) -> typing.Dict[str, str]

Parses a entity_type path into its component segments.

parse_environment_path

parse_environment_path(path: str) -> typing.Dict[str, str]

Parses a environment path into its component segments.

parse_flow_path

parse_flow_path(path: str) -> typing.Dict[str, str]

Parses a flow path into its component segments.

parse_intent_path

parse_intent_path(path: str) -> typing.Dict[str, str]

Parses a intent path into its component segments.

parse_page_path

parse_page_path(path: str) -> typing.Dict[str, str]

Parses a page path into its component segments.

parse_test_case_path

parse_test_case_path(path: str) -> typing.Dict[str, str]

Parses a test_case path into its component segments.

parse_test_case_result_path

parse_test_case_result_path(path: str) -> typing.Dict[str, str]

Parses a test_case_result path into its component segments.

parse_transition_route_group_path

parse_transition_route_group_path(path: str) -> typing.Dict[str, str]

Parses a transition_route_group path into its component segments.

parse_webhook_path

parse_webhook_path(path: str) -> typing.Dict[str, str]

Parses a webhook path into its component segments.

run_test_case

run_test_case(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.RunTestCaseRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

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
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_run_test_case():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.RunTestCaseRequest(
        name="name_value",
    )

    # Make the request
    operation = client.run_test_case(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.types.RunTestCaseRequest, dict]]

The request object. The request message for TestCases.RunTestCase.

retry google.api_core.retry_async.AsyncRetry

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

Returns a fully-qualified transition_route_group string.

update_test_case

update_test_case(
    request: typing.Optional[
        typing.Union[
            google.cloud.dialogflowcx_v3.types.test_case.UpdateTestCaseRequest, dict
        ]
    ] = None,
    *,
    test_case: typing.Optional[
        google.cloud.dialogflowcx_v3.types.test_case.TestCase
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dialogflowcx_v3.types.test_case.TestCase

Updates the specified test case.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3

async def sample_update_test_case():
    # Create a client
    client = dialogflowcx_v3.TestCasesAsyncClient()

    # Initialize request argument(s)
    test_case = dialogflowcx_v3.TestCase()
    test_case.display_name = "display_name_value"

    request = dialogflowcx_v3.UpdateTestCaseRequest(
        test_case=test_case,
    )

    # Make the request
    response = await client.update_test_case(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.dialogflowcx_v3.types.UpdateTestCaseRequest, dict]]

The request object. The request message for TestCases.UpdateTestCase.

test_case 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_async.AsyncRetry

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_v3.types.TestCase Represents a test case.

webhook_path

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

Returns a fully-qualified webhook string.