TestCasesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3.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>)
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
TestCasesClient
TestCasesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3.services.test_cases.transports.base.TestCasesTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3.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>)
Instantiates the test cases client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
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 |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
agent_path
agent_path(project: str, location: str, agent: str) -> 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.Retry,
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
def sample_batch_delete_test_cases():
# Create a client
client = dialogflowcx_v3.TestCasesClient()
# Initialize request argument(s)
request = dialogflowcx_v3.BatchDeleteTestCasesRequest(
parent="parent_value",
names=['names_value1', 'names_value2'],
)
# Make the request
client.batch_delete_test_cases(request=request)
Parameters | |
---|---|
Name | Description |
request |
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: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
batch_run_test_cases
batch_run_test_cases(
request: 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.Retry,
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.Operation
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