Class EnvironmentsClient (1.11.0)

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

Service for managing Environments.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`EnvironmentsTransport`	The transport used by the client instance.

Methods

EnvironmentsClient

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

Instantiates the environments client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, 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.

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.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

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.

create_environment

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

Creates an xref_Environment in the specified xref_Agent.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: xref_Environment

from google.cloud import dialogflowcx_v3

def sample_create_environment():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

    # Initialize request argument(s)
    environment = dialogflowcx_v3.Environment()
    environment.display_name = "display_name_value"
    environment.version_configs.version = "version_value"

    request = dialogflowcx_v3.CreateEnvironmentRequest(
        parent="parent_value",
        environment=environment,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.CreateEnvironmentRequest, dict]` The request object. The request message for Environments.CreateEnvironment.
`parent`	`str` Required. The Agent to create an Environment for. Format: `projects/`. 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

Type Description

google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be 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.

delete_environment

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

Deletes the specified xref_Environment.

from google.cloud import dialogflowcx_v3

def sample_delete_environment():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.DeleteEnvironmentRequest, dict]` The request object. The request message for Environments.DeleteEnvironment.
`name`	`str` Required. The name of the Environment to delete. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.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.

deploy_flow

deploy_flow(request: Optional[Union[google.cloud.dialogflowcx_v3.types.environment.DeployFlowRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deploys a flow to the specified xref_Environment.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: xref_DeployFlowMetadata
response: xref_DeployFlowResponse

from google.cloud import dialogflowcx_v3

def sample_deploy_flow():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.DeployFlowRequest(
        environment="environment_value",
        flow_version="flow_version_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.DeployFlowRequest, dict]` The request object. The request message for Environments.DeployFlow.
`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
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be DeployFlowResponse The response message for Environments.DeployFlow.

environment_path

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

Returns a fully-qualified environment string.

from_service_account_file

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

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`EnvironmentsClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`EnvironmentsClient`	The constructed client.

from_service_account_json

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

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`EnvironmentsClient`	The constructed client.

get_environment

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

Retrieves the specified xref_Environment.

from google.cloud import dialogflowcx_v3

def sample_get_environment():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.GetEnvironmentRequest, dict]` The request object. The request message for Environments.GetEnvironment.
`name`	`str` Required. The name of the Environment. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.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

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_mtls_endpoint_and_cert_source

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

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

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

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

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

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

list_continuous_test_results

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

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

from google.cloud import dialogflowcx_v3

def sample_list_continuous_test_results():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.ListContinuousTestResultsRequest, dict]` The request object. The request message for Environments.ListContinuousTestResults.
`parent`	`str` Required. The environment to list results for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.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
Type	Description
`google.cloud.dialogflowcx_v3.services.environments.pagers.ListContinuousTestResultsPager`	The response message for [Environments.ListTestCaseResults][]. Iterating over this object will yield results and resolve additional pages automatically.

list_environments

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

Returns the list of all environments in the specified xref_Agent.

from google.cloud import dialogflowcx_v3

def sample_list_environments():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.ListEnvironmentsRequest, dict]` The request object. The request message for Environments.ListEnvironments.
`parent`	`str` Required. The Agent to list all environments for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.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
Type	Description
`google.cloud.dialogflowcx_v3.services.environments.pagers.ListEnvironmentsPager`	The response message for Environments.ListEnvironments. Iterating over this object will yield results and resolve additional pages automatically.

lookup_environment_history

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

Looks up the history of the specified xref_Environment.

from google.cloud import dialogflowcx_v3

def sample_lookup_environment_history():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.LookupEnvironmentHistoryRequest, dict]` The request object. The request message for Environments.LookupEnvironmentHistory.
`name`	`str` Required. Resource name of the environment to look up the history for. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.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
Type	Description
`google.cloud.dialogflowcx_v3.services.environments.pagers.LookupEnvironmentHistoryPager`	The response message for 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.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_continuous_test_result_path

parse_continuous_test_result_path(path: str)

Parses a continuous_test_result path into its component segments.

parse_environment_path

parse_environment_path(path: str)

Parses a environment path into its component segments.

parse_test_case_path

parse_test_case_path(path: str)

Parses a test_case path into its component segments.

parse_test_case_result_path

parse_test_case_result_path(path: str)

Parses a test_case_result path into its component segments.

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

run_continuous_test

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

Kicks off a continuous test under the specified xref_Environment.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: xref_RunContinuousTestMetadata
response: xref_RunContinuousTestResponse

from google.cloud import dialogflowcx_v3

def sample_run_continuous_test():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.RunContinuousTestRequest(
        environment="environment_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.RunContinuousTestRequest, dict]` The request object. The request message for Environments.RunContinuousTest.
`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
Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be RunContinuousTestResponse The response message for Environments.RunContinuousTest.

test_case_path

test_case_path(project: str, location: str, agent: str, test_case: str)

Returns a fully-qualified test_case string.

test_case_result_path

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

Returns a fully-qualified test_case_result string.

update_environment

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

Updates the specified xref_Environment.

This method is a long-running operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: xref_Environment

from google.cloud import dialogflowcx_v3

def sample_update_environment():
    # Create a client
    client = dialogflowcx_v3.EnvironmentsClient()

    # Initialize request argument(s)
    environment = dialogflowcx_v3.Environment()
    environment.display_name = "display_name_value"
    environment.version_configs.version = "version_value"

    request = dialogflowcx_v3.UpdateEnvironmentRequest(
        environment=environment,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflowcx_v3.types.UpdateEnvironmentRequest, dict]` The request object. The request message for Environments.UpdateEnvironment.
`environment`	`google.cloud.dialogflowcx_v3.types.Environment` Required. The environment to update. This corresponds to the `environment` 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 control which fields get 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

Type Description

version_path

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

Returns a fully-qualified version string.