TestCases¶

google.cloud.dialogflowcx_v3beta1.types.CalculateCoverageResponse

async calculate_coverage(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.CalculateCoverageRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.CalculateCoverageResponse[source]¶

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_v3beta1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.CalculateCoverageRequest, dict]]) – The request object. The request message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3beta1.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

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

Return type

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

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

request (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.

Returns

None

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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.CreateTestCaseRequest, dict]] = None, *, parent: Optional[str] = None, test_case: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase[source]¶

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_v3beta1

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

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

    request = dialogflowcx_v3beta1.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

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.CreateTestCaseRequest, dict]]) – The request object. The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.CreateTestCase].
parent (str) –
Required. The agent to create the test case for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
test_case (google.cloud.dialogflowcx_v3beta1.types.TestCase) – Required. The test case to create. This corresponds to the test_case field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_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

Represents a test case.

Return type

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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ExportTestCasesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [ExportTestCasesMetadata][google.cloud.dialogflow.cx.v3beta1.ExportTestCasesMetadata]
response: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

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

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.ExportTestCasesRequest, dict]]) – The request object. The request message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3beta1.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

An object representing a long-running operation.

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

Return type

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_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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

Gets the latest state of a long-running operation.

Parameters

request (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

An Operation object.

Return type

Operation

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

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_v3beta1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.GetTestCaseRequest, dict]]) – The request object. The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.GetTestCase].
name (str) –
Required. The name of the testcase. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.

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

Represents a test case.

Return type

google.cloud.dialogflowcx_v3beta1.types.TestCaseResult

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

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_v3beta1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.GetTestCaseResultRequest, dict]]) – The request object. The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3beta1.TestCases.GetTestCaseResult].
name (str) –
Required. The name of the testcase. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>.

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

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

Return type

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.dialogflowcx_v3beta1.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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ImportTestCasesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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 overwrite any existing ones. The provided ID in the imported test case is neglected.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [ImportTestCasesMetadata][google.cloud.dialogflow.cx.v3beta1.ImportTestCasesMetadata]
response: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

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

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.ImportTestCasesRequest, dict]]) – The request object. The request message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3beta1.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

An object representing a long-running operation.

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

Return type

google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCaseResultsAsyncPager

static intent_path(project: str, location: str, agent: str, intent: str) → str¶: Returns a fully-qualified intent string.

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

Lists information about the supported locations for this service.

Parameters

request (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

Response message for ListLocations method.

Return type

ListLocationsResponse

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

Lists operations that match the specified filter in the request.

Parameters

request (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

Response message for ListOperations method.

Return type

ListOperationsResponse

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

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_v3beta1

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

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.ListTestCaseResultsRequest, dict]]) – The request object. The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3beta1.TestCases.ListTestCaseResults].
parent (str) –
Required. The test case to list results for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>. 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

The response message for: [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3beta1.TestCases.ListTestCaseResults].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

async list_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ListTestCasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCasesAsyncPager[source]¶

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_v3beta1

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

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.ListTestCasesRequest, dict]]) – The request object. The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.ListTestCases].
parent (str) –
Required. The agent to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

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

The response message for: [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.ListTestCases].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3beta1.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_playbook_path(path: str) → Dict[str, str]¶: Parses a playbook 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_tool_path(path: str) → Dict[str, str]¶: Parses a tool 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.

static playbook_path(project: str, location: str, agent: str, playbook: str) → str¶: Returns a fully-qualified playbook string.

async run_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.RunTestCaseRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.v3beta1.RunTestCaseMetadata]
response: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

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

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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

request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.RunTestCaseRequest, dict]]) – The request object. The request message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3beta1.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

An object representing a long-running operation.

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

Return type

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 tool_path(project: str, location: str, agent: str, tool: str) → str¶: Returns a fully-qualified tool 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_v3beta1.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

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

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

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_v3beta1

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

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

    request = dialogflowcx_v3beta1.UpdateTestCaseRequest(
        test_case=test_case,
    )

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

    # Handle the response
    print(response)

Parameters

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

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_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

Represents a test case.

Return type

static webhook_path(project: str, location: str, agent: str, webhook: str) → str¶: Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3beta1.services.test_cases.TestCasesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.test_cases.transports.base.TestCasesTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.test_cases.transports.base.TestCasesTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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.v3beta1.TestCase] and [Test Case Results][google.cloud.dialogflow.cx.v3beta1.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 (Optional[Union[str,TestCasesTransport,Callable[..., TestCasesTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the TestCasesTransport constructor. 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 the 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.

Raises

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

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static agent_path(project: str, location: str, agent: str) → str[source]¶: Returns a fully-qualified agent string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

batch_delete_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.BatchDeleteTestCasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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_v3beta1

def sample_batch_delete_test_cases():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

    # Make the request
    client.batch_delete_test_cases(request=request)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.BatchDeleteTestCasesRequest, dict]) – The request object. The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.BatchDeleteTestCases].
parent (str) –
Required. The agent to delete test cases from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.BatchRunTestCasesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Kicks off a batch run of test cases.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [BatchRunTestCasesMetadata][google.cloud.dialogflow.cx.v3beta1.BatchRunTestCasesMetadata]
response: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

def sample_batch_run_test_cases():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.BatchRunTestCasesRequest, dict]) – The request object. The request message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.BatchRunTestCases].
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

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

Return type

google.cloud.dialogflowcx_v3beta1.types.CalculateCoverageResponse

calculate_coverage(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.CalculateCoverageRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.CalculateCoverageResponse[source]¶

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_v3beta1

def sample_calculate_coverage():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.CalculateCoverageRequest, dict]) – The request object. The request message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3beta1.TestCases.CalculateCoverage].
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
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

None

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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.CreateTestCaseRequest, dict]] = None, *, parent: Optional[str] = None, test_case: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase[source]¶

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_v3beta1

def sample_create_test_case():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.CreateTestCaseRequest, dict]) – The request object. The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.CreateTestCase].
parent (str) –
Required. The agent to create the test case for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
test_case (google.cloud.dialogflowcx_v3beta1.types.TestCase) – Required. The test case to create. This corresponds to the test_case field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Represents a test case.

Return type

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[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ExportTestCasesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [ExportTestCasesMetadata][google.cloud.dialogflow.cx.v3beta1.ExportTestCasesMetadata]
response: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

def sample_export_test_cases():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.ExportTestCasesRequest, dict]) – The request object. The request message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.ExportTestCases].
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

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

Return type

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_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. 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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
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

An Operation object.

Return type

Operation

get_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.GetTestCaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase[source]¶

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_v3beta1

def sample_get_test_case():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.GetTestCaseRequest, dict]) – The request object. The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.GetTestCase].
name (str) –
Required. The name of the testcase. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>.

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_v3beta1.types.TestCaseResult

get_test_case_result(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.GetTestCaseResultRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.TestCaseResult[source]¶

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_v3beta1

def sample_get_test_case_result():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.GetTestCaseResultRequest, dict]) – The request object. The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3beta1.TestCases.GetTestCaseResult].
name (str) –
Required. The name of the testcase. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>.

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

import_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ImportTestCasesRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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 overwrite any existing ones. The provided ID in the imported test case is neglected.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: [ImportTestCasesMetadata][google.cloud.dialogflow.cx.v3beta1.ImportTestCasesMetadata]
response: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

def sample_import_test_cases():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.ImportTestCasesRequest, dict]) – The request object. The request message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.ImportTestCases].
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

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

Return type

google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCaseResultsPager

static intent_path(project: str, location: str, agent: str, intent: str) → str[source]¶: Returns a fully-qualified intent string.

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
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

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
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

Response message for ListOperations method.

Return type

ListOperationsResponse

list_test_case_results(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ListTestCaseResultsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCaseResultsPager[source]¶

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_v3beta1

def sample_list_test_case_results():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.ListTestCaseResultsRequest, dict]) – The request object. The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3beta1.TestCases.ListTestCaseResults].
parent (str) –
Required. The test case to list results for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>. 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.v3beta1.TestCases.ListTestCaseResults].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

list_test_cases(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.ListTestCasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.test_cases.pagers.ListTestCasesPager[source]¶

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_v3beta1

def sample_list_test_cases():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.ListTestCasesRequest, dict]) – The request object. The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3beta1.TestCases.ListTestCases].
parent (str) –
Required. The agent to list all pages for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

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.v3beta1.TestCases.ListTestCases].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3beta1.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_playbook_path(path: str) → Dict[str, str][source]¶: Parses a playbook 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_tool_path(path: str) → Dict[str, str][source]¶: Parses a tool 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.

static playbook_path(project: str, location: str, agent: str, playbook: str) → str[source]¶: Returns a fully-qualified playbook string.

run_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.RunTestCaseRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, 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.v3beta1.RunTestCaseMetadata]
response: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.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_v3beta1

def sample_run_test_case():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.dialogflowcx_v3beta1.types.RunTestCaseRequest, dict]) – The request object. The request message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.RunTestCase].
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

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

Return type

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 tool_path(project: str, location: str, agent: str, tool: str) → str[source]¶: Returns a fully-qualified tool 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_v3beta1.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

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_test_case(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.test_case.UpdateTestCaseRequest, dict]] = None, *, test_case: Optional[google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.test_case.TestCase[source]¶

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_v3beta1

def sample_update_test_case():
    # Create a client
    client = dialogflowcx_v3beta1.TestCasesClient()

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

    request = dialogflowcx_v3beta1.UpdateTestCaseRequest(
        test_case=test_case,
    )

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

    # Handle the response
    print(response)

Parameters

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

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Represents a test case.

Return type