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

Environments

class google.cloud.dialogflowcx_v3.services.environments.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/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the environments client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, EnvironmentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

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

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

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

Returns a fully-qualified continuous_test_result string.

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateEnvironmentRequest) – The request object. The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].

  • parent (str) –

    Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

  • environment (google.cloud.dialogflowcx_v3.types.Environment) – Required. The environment to create. This corresponds to the environment 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation_async.AsyncOperation

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteEnvironmentRequest) – The request object. The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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

Returns a fully-qualified environment 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

EnvironmentsAsyncClient

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

EnvironmentsAsyncClient

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

EnvironmentsAsyncClient

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetEnvironmentRequest) – The request object. The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.dialogflowcx_v3.types.Environment

get_transport_class()Type[google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport]

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListContinuousTestResultsRequest) – The request object. The request message for [Environments.ListContinuousTestResults][google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResults].

  • parent (str) –

    Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for [Environments.ListTestCaseResults][].

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

Return type

google.cloud.dialogflowcx_v3.services.environments.pagers.ListContinuousTestResultsAsyncPager

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListEnvironmentsRequest) – The request object. The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

  • parent (str) –

    Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

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

Return type

google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsAsyncPager

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.LookupEnvironmentHistoryRequest) – The request object. The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

  • name (str) –

    Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryAsyncPager

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_continuous_test_result_path(path: str)Dict[str, str]

Parses a continuous_test_result path into its component segments.

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

Parses a environment 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_version_path(path: str)Dict[str, str]

Parses a version path into its component segments.

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

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

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.RunContinuousTestResponse The response message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

Return type

google.api_core.operation_async.AsyncOperation

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.

property transport: google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

EnvironmentsTransport

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

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

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation_async.AsyncOperation

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

Returns a fully-qualified version string.

class google.cloud.dialogflowcx_v3.services.environments.EnvironmentsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the environments client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, EnvironmentsTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

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

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

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

Returns a fully-qualified continuous_test_result string.

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreateEnvironmentRequest) – The request object. The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].

  • parent (str) –

    Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

  • environment (google.cloud.dialogflowcx_v3.types.Environment) – Required. The environment to create. This corresponds to the environment 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

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation.Operation

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeleteEnvironmentRequest) – The request object. The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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

Returns a fully-qualified environment 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

EnvironmentsClient

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

EnvironmentsClient

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

EnvironmentsClient

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetEnvironmentRequest) – The request object. The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].

  • name (str) –

    Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.dialogflowcx_v3.types.Environment

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListContinuousTestResultsRequest) – The request object. The request message for [Environments.ListContinuousTestResults][google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResults].

  • parent (str) –

    Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for [Environments.ListTestCaseResults][].

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

Return type

google.cloud.dialogflowcx_v3.services.environments.pagers.ListContinuousTestResultsPager

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListEnvironmentsRequest) – The request object. The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

  • parent (str) –

    Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

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

Return type

google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsPager

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

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

Parameters
  • request (google.cloud.dialogflowcx_v3.types.LookupEnvironmentHistoryRequest) – The request object. The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

  • name (str) –

    Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryPager

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_continuous_test_result_path(path: str)Dict[str, str][source]

Parses a continuous_test_result 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_test_case_result_path(path: str)Dict[str, str][source]

Parses a test_case_result path into its component segments.

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

Parses a version path into its component segments.

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

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

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dialogflowcx_v3.types.RunContinuousTestResponse The response message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

Return type

google.api_core.operation.Operation

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.

property transport: google.cloud.dialogflowcx_v3.services.environments.transports.base.EnvironmentsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

EnvironmentsTransport

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

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

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be 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.

Return type

google.api_core.operation.Operation

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

Returns a fully-qualified version string.

class google.cloud.dialogflowcx_v3.services.environments.pagers.ListContinuousTestResultsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsResponse]], request: google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsRequest, response: google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_continuous_test_results requests.

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

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

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

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.environments.pagers.ListContinuousTestResultsPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsResponse], request: google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsRequest, response: google.cloud.dialogflowcx_v3.types.environment.ListContinuousTestResultsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_continuous_test_results requests.

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

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

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

Instantiate the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsResponse]], request: google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsRequest, response: google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_environments requests.

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

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

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

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsResponse], request: google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsRequest, response: google.cloud.dialogflowcx_v3.types.environment.ListEnvironmentsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_environments requests.

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

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

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

Instantiate the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryResponse]], request: google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryRequest, response: google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through lookup_environment_history requests.

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

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

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

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryResponse], request: google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryRequest, response: google.cloud.dialogflowcx_v3.types.environment.LookupEnvironmentHistoryResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through lookup_environment_history requests.

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

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

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

Instantiate the pager.

Parameters