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

Name	Datatype	Description
name	string
description	string
displayName	string
testCasesConfig	object	(id: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig)
updateTime	string (google-datetime)
versionConfigs	array
webhookConfig	object	(id: GoogleCloudDialogflowCxV3EnvironmentWebhookConfig)

projects_locations_agents_environments_list

Name	Datatype	Description
name	string
description	string
displayName	string
testCasesConfig	object	(id: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig)
updateTime	string (google-datetime)
versionConfigs	array
webhookConfig	object	(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
projects_locations_agents_environments_list	select	projectsId, locationsId, agentsId	pageSize, pageToken
projects_locations_agents_environments_create	insert	projectsId, locationsId, agentsId
projects_locations_agents_environments_patch	update	projectsId, locationsId, agentsId, environmentsId	updateMask
projects_locations_agents_environments_delete	delete	projectsId, locationsId, agentsId, environmentsId
projects_locations_agents_environments_lookup_environment_history	exec	projectsId, locationsId, agentsId, environmentsId	pageToken, pageSize
projects_locations_agents_environments_run_continuous_test	exec	projectsId, locationsId, agentsId, environmentsId
projects_locations_agents_environments_deploy_flow	exec	projectsId, locationsId, agentsId, environmentsId

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

Successful response

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

Successful response

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

No description available.

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

Manifest

# Description fields are for documentation purposes
- name: environments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the environments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the environments resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the environments resource.
  - name: versionConfigs
    value:
      - version: "{{ version }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: testCasesConfig
    value:
      enableContinuousRun: {{ enableContinuousRun }}
      enablePredeploymentRun: {{ enablePredeploymentRun }}
      testCases:
        - "{{ testCases }}"
  - name: description
    value: "{{ description }}"
  - name: webhookConfig
    value:
      webhookOverrides:
        - name: "{{ name }}"
          genericWebService:
            allowedCaCerts:
              - "{{ allowedCaCerts }}"
            password: "{{ password }}"
            username: "{{ username }}"
            requestHeaders: "{{ requestHeaders }}"
            serviceAgentAuth: "{{ serviceAgentAuth }}"
            parameterMapping: "{{ parameterMapping }}"
            oauthConfig:
              clientSecret: "{{ clientSecret }}"
              clientId: "{{ clientId }}"
              tokenEndpoint: "{{ tokenEndpoint }}"
              scopes:
                - "{{ scopes }}"
              secretVersionForClientSecret: "{{ secretVersionForClientSecret }}"
            webhookType: "{{ webhookType }}"
            secretVersionsForRequestHeaders: "{{ secretVersionsForRequestHeaders }}"
            uri: "{{ uri }}"
            secretVersionForUsernamePassword: "{{ secretVersionForUsernamePassword }}"
            requestBody: "{{ requestBody }}"
            httpMethod: "{{ httpMethod }}"
            serviceAccountAuthConfig:
              serviceAccount: "{{ serviceAccount }}"
          displayName: "{{ displayName }}"
          timeout: "{{ timeout }}"
          disabled: {{ disabled }}
          serviceDirectory:
            service: "{{ service }}"
            genericWebService:
              allowedCaCerts:
                - "{{ allowedCaCerts }}"
              password: "{{ password }}"
              username: "{{ username }}"
              requestHeaders: "{{ requestHeaders }}"
              serviceAgentAuth: "{{ serviceAgentAuth }}"
              parameterMapping: "{{ parameterMapping }}"
              oauthConfig:
                clientSecret: "{{ clientSecret }}"
                clientId: "{{ clientId }}"
                tokenEndpoint: "{{ tokenEndpoint }}"
                scopes: "{{ scopes }}"
                secretVersionForClientSecret: "{{ secretVersionForClientSecret }}"
              webhookType: "{{ webhookType }}"
              secretVersionsForRequestHeaders: "{{ secretVersionsForRequestHeaders }}"
              uri: "{{ uri }}"
              secretVersionForUsernamePassword: "{{ secretVersionForUsernamePassword }}"
              requestBody: "{{ requestBody }}"
              httpMethod: "{{ httpMethod }}"
              serviceAccountAuthConfig:
                serviceAccount: "{{ serviceAccount }}"
  - name: name
    value: "{{ name }}"

UPDATE examples

projects_locations_agents_environments_patch

No description available.

UPDATE google.dialogflow.environments
SET 
data__versionConfigs = '{{ versionConfigs }}',
data__displayName = '{{ displayName }}',
data__testCasesConfig = '{{ testCasesConfig }}',
data__description = '{{ description }}',
data__webhookConfig = '{{ webhookConfig }}',
data__name = '{{ name }}'
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

No description available.

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

Successful response

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

projects_locations_agents_environments_run_continuous_test

Successful response

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

Successful response

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 }}"
}'
;