environments

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

Overview

Name	environments
Type	Resource
Id	google.dialogflow.environments

Fields

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 configuration for continuous tests.
updateTime	string	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	Configuration for webhooks.

Methods

Name	Accessible by	Required Params	Description
projects_locations_agents_environments_get	SELECT	agentsId, environmentsId, locationsId, projectsId	Retrieves the specified Environment.
projects_locations_agents_environments_list	SELECT	agentsId, locationsId, projectsId	Returns the list of all environments in the specified Agent.
projects_locations_agents_environments_create	INSERT	agentsId, locationsId, projectsId	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_delete	DELETE	agentsId, environmentsId, locationsId, projectsId	Deletes the specified Environment.
projects_locations_agents_environments_patch	UPDATE	agentsId, environmentsId, locationsId, projectsId	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_deploy_flow	EXEC	agentsId, environmentsId, locationsId, projectsId	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
projects_locations_agents_environments_lookup_environment_history	EXEC	agentsId, environmentsId, locationsId, projectsId	Looks up the history of the specified Environment.
projects_locations_agents_environments_run_continuous_test	EXEC	agentsId, environmentsId, locationsId, projectsId	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

SELECT examples

Returns the list of all environments in the specified Agent.

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

INSERT example

Use the following StackQL query and manifest file to create a new environments resource.

All Properties

/*+ create */
INSERT INTO google.dialogflow.environments (
agentsId,
locationsId,
projectsId,
name,
displayName,
description,
versionConfigs,
testCasesConfig,
webhookConfig
)
SELECT 
'{{ agentsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ versionConfigs }}',
'{{ testCasesConfig }}',
'{{ webhookConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: versionConfigs
      value:
        - - name: version
            value: string
    - name: updateTime
      value: string
    - name: testCasesConfig
      value:
        - name: testCases
          value:
            - string
        - name: enableContinuousRun
          value: boolean
        - name: enablePredeploymentRun
          value: boolean
    - name: webhookConfig
      value:
        - name: webhookOverrides
          value:
            - - name: name
                value: string
              - name: displayName
                value: string
              - name: genericWebService
                value:
                  - name: uri
                    value: string
                  - name: username
                    value: string
                  - name: password
                    value: string
                  - name: requestHeaders
                    value: object
                  - name: allowedCaCerts
                    value:
                      - string
                  - name: oauthConfig
                    value:
                      - name: clientId
                        value: string
                      - name: clientSecret
                        value: string
                      - name: tokenEndpoint
                        value: string
                      - name: scopes
                        value:
                          - string
                  - name: serviceAgentAuth
                    value: string
                  - name: webhookType
                    value: string
                  - name: httpMethod
                    value: string
                  - name: requestBody
                    value: string
                  - name: parameterMapping
                    value: object
              - name: serviceDirectory
                value:
                  - name: service
                    value: string
              - name: timeout
                value: string
              - name: disabled
                value: boolean

UPDATE example

Updates a environments resource.

/*+ update */
UPDATE google.dialogflow.environments
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
versionConfigs = '{{ versionConfigs }}',
testCasesConfig = '{{ testCasesConfig }}',
webhookConfig = '{{ webhookConfig }}'
WHERE 
agentsId = '{{ agentsId }}'
AND environmentsId = '{{ environmentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified environments resource.

/*+ delete */
DELETE FROM google.dialogflow.environments
WHERE agentsId = '{{ agentsId }}'
AND environmentsId = '{{ environmentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';