environments

Creates, updates, deletes, gets or lists an environments resource.

Overview

Name	environments
Type	Resource
Id	google.dialogflow.environments

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_environments_get

Successful response

Name	Datatype	Description
name	string	The name of the environment. Format: projects//locations//agents//environments/.
description	string	The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
displayName	string	Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
testCasesConfig	object	The test cases config for continuous tests of this environment. (id: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig)
updateTime	string (google-datetime)	Output only. Update time of this environment.
versionConfigs	array	A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.
webhookConfig	object	The webhook configuration for this environment. (id: GoogleCloudDialogflowCxV3EnvironmentWebhookConfig)

projects_locations_agents_environments_list

Successful response

Name	Datatype	Description
name	string	The name of the environment. Format: projects//locations//agents//environments/.
description	string	The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
displayName	string	Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
testCasesConfig	object	The test cases config for continuous tests of this environment. (id: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig)
updateTime	string (google-datetime)	Output only. Update time of this environment.
versionConfigs	array	A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.
webhookConfig	object	The webhook configuration for this environment. (id: GoogleCloudDialogflowCxV3EnvironmentWebhookConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_environments_get	select	projectsId, locationsId, agentsId, environmentsId		Retrieves the specified Environment.
projects_locations_agents_environments_list	select	projectsId, locationsId, agentsId	pageSize, pageToken	Returns the list of all environments in the specified Agent.
projects_locations_agents_environments_create	insert	projectsId, locationsId, agentsId		Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment
projects_locations_agents_environments_patch	update	projectsId, locationsId, agentsId, environmentsId	updateMask	Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment
projects_locations_agents_environments_delete	delete	projectsId, locationsId, agentsId, environmentsId		Deletes the specified Environment.
projects_locations_agents_environments_lookup_environment_history	exec	projectsId, locationsId, agentsId, environmentsId	pageSize, pageToken	Looks up the history of the specified Environment.
projects_locations_agents_environments_run_continuous_test	exec	projectsId, locationsId, agentsId, environmentsId		Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse
projects_locations_agents_environments_deploy_flow	exec	projectsId, locationsId, agentsId, environmentsId		Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployFlowMetadata - response: DeployFlowResponse

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
environmentsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_environments_get

Retrieves the specified Environment.

SELECT
name,
description,
displayName,
testCasesConfig,
updateTime,
versionConfigs,
webhookConfig
FROM google.dialogflow.environments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

projects_locations_agents_environments_list

Returns the list of all environments in the specified Agent.

SELECT
name,
description,
displayName,
testCasesConfig,
updateTime,
versionConfigs,
webhookConfig
FROM google.dialogflow.environments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_locations_agents_environments_create

Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment

INSERT INTO google.dialogflow.environments (
data__name,
data__displayName,
data__description,
data__versionConfigs,
data__testCasesConfig,
data__webhookConfig,
projectsId,
locationsId,
agentsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ versionConfigs }}',
'{{ testCasesConfig }}',
'{{ webhookConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: environments
  props:
    - name: projectsId
      value: string
      description: Required parameter for the environments resource.
    - name: locationsId
      value: string
      description: Required parameter for the environments resource.
    - name: agentsId
      value: string
      description: Required parameter for the environments resource.
    - name: name
      value: string
      description: >
        The name of the environment. Format: `projects//locations//agents//environments/`.
        
    - name: displayName
      value: string
      description: >
        Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.
        
    - name: description
      value: string
      description: >
        The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
        
    - name: versionConfigs
      value: array
      description: >
        A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.
        
    - name: testCasesConfig
      value: object
      description: >
        The test cases config for continuous tests of this environment.
        
    - name: webhookConfig
      value: object
      description: >
        The webhook configuration for this environment.
        

UPDATE examples

projects_locations_agents_environments_patch

Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment

UPDATE google.dialogflow.environments
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__versionConfigs = '{{ versionConfigs }}',
data__testCasesConfig = '{{ testCasesConfig }}',
data__webhookConfig = '{{ webhookConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_agents_environments_delete

Deletes the specified Environment.

DELETE FROM google.dialogflow.environments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required;

Lifecycle Methods

projects_locations_agents_environments_lookup_environment_history

Looks up the history of the specified Environment.

EXEC google.dialogflow.environments.projects_locations_agents_environments_lookup_environment_history 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required, 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}';

projects_locations_agents_environments_run_continuous_test

Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse

EXEC google.dialogflow.environments.projects_locations_agents_environments_run_continuous_test 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required;

projects_locations_agents_environments_deploy_flow

Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployFlowMetadata - response: DeployFlowResponse

EXEC google.dialogflow.environments.projects_locations_agents_environments_deploy_flow 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@environmentsId='{{ environmentsId }}' --required 
@@json=
'{
"flowVersion": "{{ flowVersion }}"
}';