versions

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

Overview

Name	versions
Type	Resource
Id	google.dialogflow.versions

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_flows_versions_get

Name	Datatype	Description
name	string
createTime	string (google-datetime)
description	string
displayName	string
nluSettings	object	(id: GoogleCloudDialogflowCxV3NluSettings)
state	string	(STATE_UNSPECIFIED, RUNNING, SUCCEEDED, FAILED)

projects_locations_agents_playbooks_versions_get

Name	Datatype	Description
name	string
description	string
examples	array
playbook	object	(id: GoogleCloudDialogflowCxV3Playbook)
updateTime	string (google-datetime)

projects_locations_agents_tools_versions_get

Name	Datatype	Description
name	string
createTime	string (google-datetime)
displayName	string
tool	object	(id: GoogleCloudDialogflowCxV3Tool)
updateTime	string (google-datetime)

projects_locations_agents_flows_versions_list

Name	Datatype	Description
name	string
createTime	string (google-datetime)
description	string
displayName	string
nluSettings	object	(id: GoogleCloudDialogflowCxV3NluSettings)
state	string	(STATE_UNSPECIFIED, RUNNING, SUCCEEDED, FAILED)

projects_locations_agents_playbooks_versions_list

Name	Datatype	Description
name	string
description	string
examples	array
playbook	object	(id: GoogleCloudDialogflowCxV3Playbook)
updateTime	string (google-datetime)

projects_locations_agents_tools_versions_list

Name	Datatype	Description
name	string
createTime	string (google-datetime)
displayName	string
tool	object	(id: GoogleCloudDialogflowCxV3Tool)
updateTime	string (google-datetime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_flows_versions_get	select	projectsId, locationsId, agentsId, flowsId, versionsId
projects_locations_agents_playbooks_versions_get	select	projectsId, locationsId, agentsId, playbooksId, versionsId
projects_locations_agents_tools_versions_get	select	projectsId, locationsId, agentsId, toolsId, versionsId
projects_locations_agents_flows_versions_list	select	projectsId, locationsId, agentsId, flowsId	pageSize, pageToken
projects_locations_agents_playbooks_versions_list	select	projectsId, locationsId, agentsId, playbooksId	pageToken, pageSize
projects_locations_agents_tools_versions_list	select	projectsId, locationsId, agentsId, toolsId	pageSize, pageToken
projects_locations_agents_flows_versions_create	insert	projectsId, locationsId, agentsId, flowsId
projects_locations_agents_playbooks_versions_create	insert	projectsId, locationsId, agentsId, playbooksId
projects_locations_agents_tools_versions_create	insert	projectsId, locationsId, agentsId, toolsId
projects_locations_agents_flows_versions_patch	update	projectsId, locationsId, agentsId, flowsId, versionsId	updateMask
projects_locations_agents_flows_versions_delete	delete	projectsId, locationsId, agentsId, flowsId, versionsId
projects_locations_agents_playbooks_versions_delete	delete	projectsId, locationsId, agentsId, playbooksId, versionsId
projects_locations_agents_tools_versions_delete	delete	projectsId, locationsId, agentsId, toolsId, versionsId	force
projects_locations_agents_flows_versions_compare_versions	exec	projectsId, locationsId, agentsId, flowsId, versionsId
projects_locations_agents_flows_versions_load	exec	projectsId, locationsId, agentsId, flowsId, versionsId
projects_locations_agents_playbooks_versions_restore	exec	projectsId, locationsId, agentsId, playbooksId, versionsId
projects_locations_agents_tools_versions_restore	exec	projectsId, locationsId, agentsId, toolsId, versionsId

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
flowsId	string
locationsId	string
playbooksId	string
projectsId	string
toolsId	string
versionsId	string
force	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_flows_versions_get

Successful response

SELECT
name,
createTime,
description,
displayName,
nluSettings,
state
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
;

projects_locations_agents_playbooks_versions_get

Successful response

SELECT
name,
description,
examples,
playbook,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND playbooksId = '{{ playbooksId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
;

projects_locations_agents_tools_versions_get

Successful response

SELECT
name,
createTime,
displayName,
tool,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND toolsId = '{{ toolsId }}' -- required
AND versionsId = '{{ versionsId }}' -- required
;

projects_locations_agents_flows_versions_list

Successful response

SELECT
name,
createTime,
description,
displayName,
nluSettings,
state
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND flowsId = '{{ flowsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

projects_locations_agents_playbooks_versions_list

Successful response

SELECT
name,
description,
examples,
playbook,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND playbooksId = '{{ playbooksId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

projects_locations_agents_tools_versions_list

Successful response

SELECT
name,
createTime,
displayName,
tool,
updateTime
FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND toolsId = '{{ toolsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

projects_locations_agents_flows_versions_create

No description available.

INSERT INTO google.dialogflow.versions (
data__displayName,
data__description,
data__name,
projectsId,
locationsId,
agentsId,
flowsId
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ flowsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

projects_locations_agents_playbooks_versions_create

No description available.

INSERT INTO google.dialogflow.versions (
data__name,
data__description,
projectsId,
locationsId,
agentsId,
playbooksId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ playbooksId }}'
RETURNING
name,
description,
examples,
playbook,
updateTime
;

projects_locations_agents_tools_versions_create

No description available.

INSERT INTO google.dialogflow.versions (
data__tool,
data__displayName,
data__name,
projectsId,
locationsId,
agentsId,
toolsId
)
SELECT 
'{{ tool }}',
'{{ displayName }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}',
'{{ toolsId }}'
RETURNING
name,
createTime,
displayName,
tool,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: versions
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the versions resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the versions resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the versions resource.
  - name: flowsId
    value: "{{ flowsId }}"
    description: Required parameter for the versions resource.
  - name: playbooksId
    value: "{{ playbooksId }}"
    description: Required parameter for the versions resource.
  - name: toolsId
    value: "{{ toolsId }}"
    description: Required parameter for the versions resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"
  - name: tool
    value:
      displayName: "{{ displayName }}"
      functionSpec:
        inputSchema: "{{ inputSchema }}"
        outputSchema: "{{ outputSchema }}"
      openApiSpec:
        authentication:
          bearerTokenConfig:
            secretVersionForToken: "{{ secretVersionForToken }}"
            token: "{{ token }}"
          serviceAccountAuthConfig:
            serviceAccount: "{{ serviceAccount }}"
          apiKeyConfig:
            keyName: "{{ keyName }}"
            apiKey: "{{ apiKey }}"
            secretVersionForApiKey: "{{ secretVersionForApiKey }}"
            requestLocation: "{{ requestLocation }}"
          serviceAgentAuthConfig:
            serviceAgentAuth: "{{ serviceAgentAuth }}"
          oauthConfig:
            secretVersionForClientSecret: "{{ secretVersionForClientSecret }}"
            oauthGrantType: "{{ oauthGrantType }}"
            scopes:
              - "{{ scopes }}"
            clientSecret: "{{ clientSecret }}"
            clientId: "{{ clientId }}"
            tokenEndpoint: "{{ tokenEndpoint }}"
        textSchema: "{{ textSchema }}"
        tlsConfig:
          caCerts:
            - displayName: "{{ displayName }}"
              cert: "{{ cert }}"
        serviceDirectoryConfig:
          service: "{{ service }}"
      toolType: "{{ toolType }}"
      name: "{{ name }}"
      description: "{{ description }}"
      dataStoreSpec:
        dataStoreConnections:
          - dataStore: "{{ dataStore }}"
            documentProcessingMode: "{{ documentProcessingMode }}"
            dataStoreType: "{{ dataStoreType }}"
        fallbackPrompt: "{{ fallbackPrompt }}"

UPDATE examples

projects_locations_agents_flows_versions_patch

No description available.

UPDATE google.dialogflow.versions
SET 
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
nluSettings,
state;

DELETE examples

projects_locations_agents_flows_versions_delete

No description available.

DELETE FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND flowsId = '{{ flowsId }}' --required
AND versionsId = '{{ versionsId }}' --required
;

projects_locations_agents_playbooks_versions_delete

No description available.

DELETE FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND playbooksId = '{{ playbooksId }}' --required
AND versionsId = '{{ versionsId }}' --required
;

projects_locations_agents_tools_versions_delete

No description available.

DELETE FROM google.dialogflow.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND toolsId = '{{ toolsId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

projects_locations_agents_flows_versions_compare_versions

Successful response

EXEC google.dialogflow.versions.projects_locations_agents_flows_versions_compare_versions 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@flowsId='{{ flowsId }}' --required, 
@versionsId='{{ versionsId }}' --required 
@@json=
'{
"targetVersion": "{{ targetVersion }}", 
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_agents_flows_versions_load

Successful response

EXEC google.dialogflow.versions.projects_locations_agents_flows_versions_load 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@flowsId='{{ flowsId }}' --required, 
@versionsId='{{ versionsId }}' --required 
@@json=
'{
"allowOverrideAgentResources": {{ allowOverrideAgentResources }}
}'
;

projects_locations_agents_playbooks_versions_restore

Successful response

EXEC google.dialogflow.versions.projects_locations_agents_playbooks_versions_restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@playbooksId='{{ playbooksId }}' --required, 
@versionsId='{{ versionsId }}' --required
;

projects_locations_agents_tools_versions_restore

Successful response

EXEC google.dialogflow.versions.projects_locations_agents_tools_versions_restore 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@agentsId='{{ agentsId }}' --required, 
@toolsId='{{ toolsId }}' --required, 
@versionsId='{{ versionsId }}' --required
;