Class EnvironmentsAsyncClient (0.8.0)

Version 0.8.0

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

EnvironmentsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].

Inheritance

builtins.object > EnvironmentsAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
EnvironmentsTransport	The transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter

Name	Description
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter

Name	Description
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters

Name	Description
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter

Name	Description
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter

Name	Description
project

continuous_test_result_path

continuous_test_result_path(project: str, location: str, agent: str, environment: str, continuous_test_result: str)

Returns a fully-qualified continuous_test_result string.

Parameters

Name	Description
project
location
agent
environment
continuous_test_result

create_environment

create_environment(request: Optional[google.cloud.dialogflowcx_v3.types.environment.CreateEnvironmentRequest] = None, *, parent: Optional[str] = None, environment: Optional[google.cloud.dialogflowcx_v3.types.environment.Environment] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an [Environment][google.cloud.dialogflow.cx.v3.Environment] in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameter

Name	Description
request	The request object. The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].

Returns

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be <>

delete_environment

delete_environment(request: Optional[google.cloud.dialogflowcx_v3.types.environment.DeleteEnvironmentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameter

Name	Description
request	The request object. The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].

environment_path

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

Returns a fully-qualified environment string.

Parameters

Name	Description
project
location
agent
environment

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

Name	Description
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

Type	Description
EnvironmentsAsyncClient	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.

Parameters

Name	Description
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

Type	Description
EnvironmentsAsyncClient	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.

Parameters

Name	Description
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

Type	Description
EnvironmentsAsyncClient	The constructed client.

get_environment

get_environment(request: Optional[google.cloud.dialogflowcx_v3.types.environment.GetEnvironmentRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameter

Name	Description
request	The request object. The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].

Returns

Type

Description

google.cloud.dialogflowcx_v3.types.Environment

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter

Name	Description
label

list_continuous_test_results

list_continuous_test_results(request: Optional[google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Fetches a list of continuous test results for a given environment.

Parameter

Name	Description
request	The request object. The request message for [Environments.ListContinuousTestResults][google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResults].

Returns

Type	Description
google.cloud.dialogflowcx_v3.services.environments.pagers.ListContinuousTestResultsAsyncPager	The response message for [Environments.ListTestCaseResults][]. Iterating over this object will yield results and resolve additional pages automatically.

list_environments

list_environments(request: Optional[google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameter

Name	Description
request	The request object. The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

Returns

Type	Description
google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsAsyncPager	The response message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments]. Iterating over this object will yield results and resolve additional pages automatically.

lookup_environment_history

lookup_environment_history(request: Optional[google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Looks up the history of the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameter

Name	Description
request	The request object. The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

Returns

Type	Description
google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryAsyncPager	The response message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory]. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter

Name	Description
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter

Name	Description
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter

Name	Description
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter

Name	Description
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter

Name	Description
path

parse_continuous_test_result_path

parse_continuous_test_result_path(path: str)

Parses a continuous_test_result path into its component segments.

Parameter

Name	Description
path

parse_environment_path

parse_environment_path(path: str)

Parses a environment path into its component segments.

Parameter

Name	Description
path

parse_test_case_result_path

parse_test_case_result_path(path: str)

Parses a test_case_result path into its component segments.

Parameter

Name	Description
path

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

Parameter

Name	Description
path

run_continuous_test

run_continuous_test(request: Optional[google.cloud.dialogflowcx_v3.types.environment.RunContinuousTestRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Kicks off a continuous test under the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameter

Name	Description
request	The request object. The request message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

Returns

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be

test_case_result_path

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

Returns a fully-qualified test_case_result string.

Parameters

Name	Description
project
location
agent
test_case
result

update_environment

update_environment(request: Optional[google.cloud.dialogflowcx_v3.types.environment.UpdateEnvironmentRequest] = None, *, environment: Optional[google.cloud.dialogflowcx_v3.types.environment.Environment] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameter

Name	Description
request	The request object. The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironment].

Returns

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be <>

version_path

version_path(project: str, location: str, agent: str, flow: str, version: str)

Returns a fully-qualified version string.

Parameters

Name	Description
project
location
agent
flow
version