versions

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

Overview

Name	versions
Type	Resource
Id	google.integrations.versions

Fields

The following fields are returned by SELECT queries:

projects_locations_products_integrations_versions_get

Successful response

Name	Datatype	Description
name	string	Output only. Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Optional. Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Auto-generated.
createdFromTemplate	string	Optional. Optional. The resource name of the template from which the integration is created.
databasePersistencePolicy	string	Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
description	string	Optional. The integration description.
enableVariableMasking	boolean	Optional. True if variable masking feature should be turned on for this version
errorCatcherConfigs	array	Optional. Error Catch Task configuration for the integration. It's optional.
integrationConfigParameters	array	Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
integrationParameters	array	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
integrationParametersInternal	object	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. (id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters)
lastModifierEmail	string	Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
lockHolder	string	Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
origin	string	Optional. The origin that indicates where this integration is coming from.
parentTemplateId	string	Optional. The id of the template which was used to create this integration_version.
runAsServiceAccount	string	Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
state	string	Output only. User should not set it as an input.
status	string	Output only. Generated by eventbus. User should not set it as an input.
taskConfigs	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
taskConfigsInternal	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
teardown	object	Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code. (id: EnterpriseCrmEventbusProtoTeardown)
triggerConfigs	array	Optional. Trigger configurations.
triggerConfigsInternal	array	Optional. Trigger configurations.
updateTime	string (google-datetime)	Output only. Auto-generated.
userLabel	string	Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.

projects_locations_products_integrations_versions_list

Successful response

Name	Datatype	Description
name	string	Output only. Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Optional. Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Auto-generated.
createdFromTemplate	string	Optional. Optional. The resource name of the template from which the integration is created.
databasePersistencePolicy	string	Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
description	string	Optional. The integration description.
enableVariableMasking	boolean	Optional. True if variable masking feature should be turned on for this version
errorCatcherConfigs	array	Optional. Error Catch Task configuration for the integration. It's optional.
integrationConfigParameters	array	Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
integrationParameters	array	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
integrationParametersInternal	object	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. (id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters)
lastModifierEmail	string	Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
lockHolder	string	Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
origin	string	Optional. The origin that indicates where this integration is coming from.
parentTemplateId	string	Optional. The id of the template which was used to create this integration_version.
runAsServiceAccount	string	Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
state	string	Output only. User should not set it as an input.
status	string	Output only. Generated by eventbus. User should not set it as an input.
taskConfigs	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
taskConfigsInternal	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
teardown	object	Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code. (id: EnterpriseCrmEventbusProtoTeardown)
triggerConfigs	array	Optional. Trigger configurations.
triggerConfigsInternal	array	Optional. Trigger configurations.
updateTime	string (google-datetime)	Output only. Auto-generated.
userLabel	string	Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.

projects_locations_integrations_versions_get

Successful response

Name	Datatype	Description
name	string	Output only. Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Optional. Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Auto-generated.
createdFromTemplate	string	Optional. Optional. The resource name of the template from which the integration is created.
databasePersistencePolicy	string	Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
description	string	Optional. The integration description.
enableVariableMasking	boolean	Optional. True if variable masking feature should be turned on for this version
errorCatcherConfigs	array	Optional. Error Catch Task configuration for the integration. It's optional.
integrationConfigParameters	array	Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
integrationParameters	array	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
integrationParametersInternal	object	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. (id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters)
lastModifierEmail	string	Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
lockHolder	string	Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
origin	string	Optional. The origin that indicates where this integration is coming from.
parentTemplateId	string	Optional. The id of the template which was used to create this integration_version.
runAsServiceAccount	string	Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
state	string	Output only. User should not set it as an input.
status	string	Output only. Generated by eventbus. User should not set it as an input.
taskConfigs	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
taskConfigsInternal	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
teardown	object	Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code. (id: EnterpriseCrmEventbusProtoTeardown)
triggerConfigs	array	Optional. Trigger configurations.
triggerConfigsInternal	array	Optional. Trigger configurations.
updateTime	string (google-datetime)	Output only. Auto-generated.
userLabel	string	Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.

projects_locations_integrations_versions_list

Successful response

Name	Datatype	Description
name	string	Output only. Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Optional. Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Auto-generated.
createdFromTemplate	string	Optional. Optional. The resource name of the template from which the integration is created.
databasePersistencePolicy	string	Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
description	string	Optional. The integration description.
enableVariableMasking	boolean	Optional. True if variable masking feature should be turned on for this version
errorCatcherConfigs	array	Optional. Error Catch Task configuration for the integration. It's optional.
integrationConfigParameters	array	Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
integrationParameters	array	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
integrationParametersInternal	object	Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. (id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters)
lastModifierEmail	string	Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
lockHolder	string	Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
origin	string	Optional. The origin that indicates where this integration is coming from.
parentTemplateId	string	Optional. The id of the template which was used to create this integration_version.
runAsServiceAccount	string	Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
state	string	Output only. User should not set it as an input.
status	string	Output only. Generated by eventbus. User should not set it as an input.
taskConfigs	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
taskConfigsInternal	array	Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
teardown	object	Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code. (id: EnterpriseCrmEventbusProtoTeardown)
triggerConfigs	array	Optional. Trigger configurations.
triggerConfigsInternal	array	Optional. Trigger configurations.
updateTime	string (google-datetime)	Output only. Auto-generated.
userLabel	string	Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_products_integrations_versions_get	select	projectsId, locationsId, productsId, integrationsId, versionsId		Get a integration in the specified project.
projects_locations_products_integrations_versions_list	select	projectsId, locationsId, productsId, integrationsId	pageSize, pageToken, filter, orderBy, fieldMask	Returns the list of all integration versions in the specified project.
projects_locations_integrations_versions_get	select	projectsId, locationsId, integrationsId, versionsId		Get a integration in the specified project.
projects_locations_integrations_versions_list	select	projectsId, locationsId, integrationsId	pageSize, pageToken, filter, orderBy, fieldMask	Returns the list of all integration versions in the specified project.
projects_locations_products_integrations_versions_create	insert	projectsId, locationsId, productsId, integrationsId	newIntegration, createSampleIntegrations	Create a integration with a draft version in the specified project.
projects_locations_integrations_versions_create	insert	projectsId, locationsId, integrationsId	newIntegration, createSampleIntegrations	Create a integration with a draft version in the specified project.
projects_locations_products_integrations_versions_patch	update	projectsId, locationsId, productsId, integrationsId, versionsId	updateMask	Update a integration with a draft version in the specified project.
projects_locations_integrations_versions_patch	update	projectsId, locationsId, integrationsId, versionsId	updateMask	Update a integration with a draft version in the specified project.
projects_locations_products_integrations_versions_delete	delete	projectsId, locationsId, productsId, integrationsId, versionsId		Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the locked_by user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
projects_locations_integrations_versions_delete	delete	projectsId, locationsId, integrationsId, versionsId		Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the locked_by user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
projects_locations_products_integrations_versions_publish	exec	projectsId, locationsId, productsId, integrationsId, versionsId		This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the locked_by user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
projects_locations_products_integrations_versions_upload	exec	projectsId, locationsId, productsId, integrationsId		Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
projects_locations_products_integrations_versions_download	exec	projectsId, locationsId, productsId, integrationsId, versionsId	fileFormat, files	Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.
projects_locations_products_integrations_versions_takeover_edit_lock	exec	projectsId, locationsId, productsId, integrationsId, versionsId		Clears the locked_by and locked_at_timestampin the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the locked_by set to the user_taking_over and the locked_at_timestamp set to the current timestamp). Both the locked_by and user_taking_over are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the locked_by and locked_at_timestamp fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
projects_locations_products_integrations_versions_unpublish	exec	projectsId, locationsId, productsId, integrationsId, versionsId		Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
projects_locations_integrations_versions_publish	exec	projectsId, locationsId, integrationsId, versionsId		This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the locked_by user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
projects_locations_integrations_versions_upload	exec	projectsId, locationsId, integrationsId		Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
projects_locations_integrations_versions_download	exec	projectsId, locationsId, integrationsId, versionsId	fileFormat, files	Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.
projects_locations_integrations_versions_download_json_package	exec	projectsId, locationsId, integrationsId, versionsId	files	Downloads an Integration version package like IntegrationVersion,Integration Config etc. Retrieves the IntegrationVersion package for a given integration_id and returns the response as a JSON.
projects_locations_integrations_versions_unpublish	exec	projectsId, locationsId, integrationsId, versionsId		Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

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
integrationsId	string
locationsId	string
productsId	string
projectsId	string
versionsId	string
createSampleIntegrations	boolean
fieldMask	string (google-fieldmask)
fileFormat	string
files	string
filter	string
newIntegration	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_products_integrations_versions_get

Get a integration in the specified project.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel
FROM google.integrations.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND versionsId = '{{ versionsId }}' -- required;

projects_locations_products_integrations_versions_list

Returns the list of all integration versions in the specified project.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel
FROM google.integrations.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND fieldMask = '{{ fieldMask }}';

projects_locations_integrations_versions_get

Get a integration in the specified project.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel
FROM google.integrations.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND versionsId = '{{ versionsId }}' -- required;

projects_locations_integrations_versions_list

Returns the list of all integration versions in the specified project.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel
FROM google.integrations.versions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND fieldMask = '{{ fieldMask }}';

INSERT examples

projects_locations_products_integrations_versions_create

Create a integration with a draft version in the specified project.

INSERT INTO google.integrations.versions (
data__description,
data__taskConfigsInternal,
data__taskConfigs,
data__triggerConfigsInternal,
data__triggerConfigs,
data__integrationParametersInternal,
data__integrationParameters,
data__teardown,
data__origin,
data__lockHolder,
data__lastModifierEmail,
data__parentTemplateId,
data__userLabel,
data__databasePersistencePolicy,
data__errorCatcherConfigs,
data__runAsServiceAccount,
data__cloudLoggingDetails,
data__integrationConfigParameters,
data__enableVariableMasking,
data__createdFromTemplate,
data__cloudKmsKey,
projectsId,
locationsId,
productsId,
integrationsId,
newIntegration,
createSampleIntegrations
)
SELECT 
'{{ description }}',
'{{ taskConfigsInternal }}',
'{{ taskConfigs }}',
'{{ triggerConfigsInternal }}',
'{{ triggerConfigs }}',
'{{ integrationParametersInternal }}',
'{{ integrationParameters }}',
'{{ teardown }}',
'{{ origin }}',
'{{ lockHolder }}',
'{{ lastModifierEmail }}',
'{{ parentTemplateId }}',
'{{ userLabel }}',
'{{ databasePersistencePolicy }}',
'{{ errorCatcherConfigs }}',
'{{ runAsServiceAccount }}',
'{{ cloudLoggingDetails }}',
'{{ integrationConfigParameters }}',
{{ enableVariableMasking }},
'{{ createdFromTemplate }}',
'{{ cloudKmsKey }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ productsId }}',
'{{ integrationsId }}',
'{{ newIntegration }}',
'{{ createSampleIntegrations }}'
RETURNING
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel
;

projects_locations_integrations_versions_create

Create a integration with a draft version in the specified project.

INSERT INTO google.integrations.versions (
data__description,
data__taskConfigsInternal,
data__taskConfigs,
data__triggerConfigsInternal,
data__triggerConfigs,
data__integrationParametersInternal,
data__integrationParameters,
data__teardown,
data__origin,
data__lockHolder,
data__lastModifierEmail,
data__parentTemplateId,
data__userLabel,
data__databasePersistencePolicy,
data__errorCatcherConfigs,
data__runAsServiceAccount,
data__cloudLoggingDetails,
data__integrationConfigParameters,
data__enableVariableMasking,
data__createdFromTemplate,
data__cloudKmsKey,
projectsId,
locationsId,
integrationsId,
newIntegration,
createSampleIntegrations
)
SELECT 
'{{ description }}',
'{{ taskConfigsInternal }}',
'{{ taskConfigs }}',
'{{ triggerConfigsInternal }}',
'{{ triggerConfigs }}',
'{{ integrationParametersInternal }}',
'{{ integrationParameters }}',
'{{ teardown }}',
'{{ origin }}',
'{{ lockHolder }}',
'{{ lastModifierEmail }}',
'{{ parentTemplateId }}',
'{{ userLabel }}',
'{{ databasePersistencePolicy }}',
'{{ errorCatcherConfigs }}',
'{{ runAsServiceAccount }}',
'{{ cloudLoggingDetails }}',
'{{ integrationConfigParameters }}',
{{ enableVariableMasking }},
'{{ createdFromTemplate }}',
'{{ cloudKmsKey }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ integrationsId }}',
'{{ newIntegration }}',
'{{ createSampleIntegrations }}'
RETURNING
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel
;

Manifest

# Description fields are for documentation purposes
- name: versions
  props:
    - name: projectsId
      value: string
      description: Required parameter for the versions resource.
    - name: locationsId
      value: string
      description: Required parameter for the versions resource.
    - name: productsId
      value: string
      description: Required parameter for the versions resource.
    - name: integrationsId
      value: string
      description: Required parameter for the versions resource.
    - name: description
      value: string
      description: >
        Optional. The integration description.
        
    - name: taskConfigsInternal
      value: array
      description: >
        Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
        
    - name: taskConfigs
      value: array
      description: >
        Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
        
    - name: triggerConfigsInternal
      value: array
      description: >
        Optional. Trigger configurations.
        
    - name: triggerConfigs
      value: array
      description: >
        Optional. Trigger configurations.
        
    - name: integrationParametersInternal
      value: object
      description: >
        Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
        
    - name: integrationParameters
      value: array
      description: >
        Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
        
    - name: teardown
      value: object
      description: >
        Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
        
    - name: origin
      value: string
      description: >
        Optional. The origin that indicates where this integration is coming from.
        
      valid_values: ['UNSPECIFIED', 'UI', 'PIPER_V2', 'PIPER_V3', 'APPLICATION_IP_PROVISIONING', 'TEST_CASE']
    - name: lockHolder
      value: string
      description: >
        Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
        
    - name: lastModifierEmail
      value: string
      description: >
        Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
        
    - name: parentTemplateId
      value: string
      description: >
        Optional. The id of the template which was used to create this integration_version.
        
    - name: userLabel
      value: string
      description: >
        Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
        
    - name: databasePersistencePolicy
      value: string
      description: >
        Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
        
      valid_values: ['DATABASE_PERSISTENCE_POLICY_UNSPECIFIED', 'DATABASE_PERSISTENCE_DISABLED', 'DATABASE_PERSISTENCE_ASYNC']
    - name: errorCatcherConfigs
      value: array
      description: >
        Optional. Error Catch Task configuration for the integration. It's optional.
        
    - name: runAsServiceAccount
      value: string
      description: >
        Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
        
    - name: cloudLoggingDetails
      value: object
      description: >
        Optional. Cloud Logging details for the integration version
        
    - name: integrationConfigParameters
      value: array
      description: >
        Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
        
    - name: enableVariableMasking
      value: boolean
      description: >
        Optional. True if variable masking feature should be turned on for this version
        
    - name: createdFromTemplate
      value: string
      description: >
        Optional. Optional. The resource name of the template from which the integration is created.
        
    - name: cloudKmsKey
      value: string
      description: >
        Optional. Cloud KMS resource name for the CMEK encryption key.
        
    - name: newIntegration
      value: boolean
    - name: createSampleIntegrations
      value: boolean

UPDATE examples

projects_locations_products_integrations_versions_patch

Update a integration with a draft version in the specified project.

UPDATE google.integrations.versions
SET 
data__description = '{{ description }}',
data__taskConfigsInternal = '{{ taskConfigsInternal }}',
data__taskConfigs = '{{ taskConfigs }}',
data__triggerConfigsInternal = '{{ triggerConfigsInternal }}',
data__triggerConfigs = '{{ triggerConfigs }}',
data__integrationParametersInternal = '{{ integrationParametersInternal }}',
data__integrationParameters = '{{ integrationParameters }}',
data__teardown = '{{ teardown }}',
data__origin = '{{ origin }}',
data__lockHolder = '{{ lockHolder }}',
data__lastModifierEmail = '{{ lastModifierEmail }}',
data__parentTemplateId = '{{ parentTemplateId }}',
data__userLabel = '{{ userLabel }}',
data__databasePersistencePolicy = '{{ databasePersistencePolicy }}',
data__errorCatcherConfigs = '{{ errorCatcherConfigs }}',
data__runAsServiceAccount = '{{ runAsServiceAccount }}',
data__cloudLoggingDetails = '{{ cloudLoggingDetails }}',
data__integrationConfigParameters = '{{ integrationConfigParameters }}',
data__enableVariableMasking = {{ enableVariableMasking }},
data__createdFromTemplate = '{{ createdFromTemplate }}',
data__cloudKmsKey = '{{ cloudKmsKey }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND productsId = '{{ productsId }}' --required
AND integrationsId = '{{ integrationsId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel;

projects_locations_integrations_versions_patch

Update a integration with a draft version in the specified project.

UPDATE google.integrations.versions
SET 
data__description = '{{ description }}',
data__taskConfigsInternal = '{{ taskConfigsInternal }}',
data__taskConfigs = '{{ taskConfigs }}',
data__triggerConfigsInternal = '{{ triggerConfigsInternal }}',
data__triggerConfigs = '{{ triggerConfigs }}',
data__integrationParametersInternal = '{{ integrationParametersInternal }}',
data__integrationParameters = '{{ integrationParameters }}',
data__teardown = '{{ teardown }}',
data__origin = '{{ origin }}',
data__lockHolder = '{{ lockHolder }}',
data__lastModifierEmail = '{{ lastModifierEmail }}',
data__parentTemplateId = '{{ parentTemplateId }}',
data__userLabel = '{{ userLabel }}',
data__databasePersistencePolicy = '{{ databasePersistencePolicy }}',
data__errorCatcherConfigs = '{{ errorCatcherConfigs }}',
data__runAsServiceAccount = '{{ runAsServiceAccount }}',
data__cloudLoggingDetails = '{{ cloudLoggingDetails }}',
data__integrationConfigParameters = '{{ integrationConfigParameters }}',
data__enableVariableMasking = {{ enableVariableMasking }},
data__createdFromTemplate = '{{ createdFromTemplate }}',
data__cloudKmsKey = '{{ cloudKmsKey }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND integrationsId = '{{ integrationsId }}' --required
AND versionsId = '{{ versionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
createdFromTemplate,
databasePersistencePolicy,
description,
enableVariableMasking,
errorCatcherConfigs,
integrationConfigParameters,
integrationParameters,
integrationParametersInternal,
lastModifierEmail,
lockHolder,
origin,
parentTemplateId,
runAsServiceAccount,
snapshotNumber,
state,
status,
taskConfigs,
taskConfigsInternal,
teardown,
triggerConfigs,
triggerConfigsInternal,
updateTime,
userLabel;

DELETE examples

projects_locations_products_integrations_versions_delete

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the locked_by user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.

DELETE FROM google.integrations.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND productsId = '{{ productsId }}' --required
AND integrationsId = '{{ integrationsId }}' --required
AND versionsId = '{{ versionsId }}' --required;

projects_locations_integrations_versions_delete

Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the locked_by user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.

DELETE FROM google.integrations.versions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND integrationsId = '{{ integrationsId }}' --required
AND versionsId = '{{ versionsId }}' --required;

Lifecycle Methods

projects_locations_products_integrations_versions_publish

This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the locked_by user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

EXEC google.integrations.versions.projects_locations_products_integrations_versions_publish 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required 
@@json=
'{
"configParameters": "{{ configParameters }}"
}';

projects_locations_products_integrations_versions_upload

Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

EXEC google.integrations.versions.projects_locations_products_integrations_versions_upload 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required 
@@json=
'{
"content": "{{ content }}", 
"fileFormat": "{{ fileFormat }}"
}';

projects_locations_products_integrations_versions_download

Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.

EXEC google.integrations.versions.projects_locations_products_integrations_versions_download 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required, 
@fileFormat='{{ fileFormat }}', 
@files='{{ files }}';

projects_locations_products_integrations_versions_takeover_edit_lock

Clears the locked_by and locked_at_timestampin the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the locked_by set to the user_taking_over and the locked_at_timestamp set to the current timestamp). Both the locked_by and user_taking_over are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the locked_by and locked_at_timestamp fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.

EXEC google.integrations.versions.projects_locations_products_integrations_versions_takeover_edit_lock 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required;

projects_locations_products_integrations_versions_unpublish

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

EXEC google.integrations.versions.projects_locations_products_integrations_versions_unpublish 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required;

projects_locations_integrations_versions_publish

This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the locked_by user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

EXEC google.integrations.versions.projects_locations_integrations_versions_publish 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required 
@@json=
'{
"configParameters": "{{ configParameters }}"
}';

projects_locations_integrations_versions_upload

Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

EXEC google.integrations.versions.projects_locations_integrations_versions_upload 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required 
@@json=
'{
"content": "{{ content }}", 
"fileFormat": "{{ fileFormat }}"
}';

projects_locations_integrations_versions_download

Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.

EXEC google.integrations.versions.projects_locations_integrations_versions_download 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required, 
@fileFormat='{{ fileFormat }}', 
@files='{{ files }}';

projects_locations_integrations_versions_download_json_package

Downloads an Integration version package like IntegrationVersion,Integration Config etc. Retrieves the IntegrationVersion package for a given integration_id and returns the response as a JSON.

EXEC google.integrations.versions.projects_locations_integrations_versions_download_json_package 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required, 
@files='{{ files }}';

projects_locations_integrations_versions_unpublish

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

EXEC google.integrations.versions.projects_locations_integrations_versions_unpublish 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@versionsId='{{ versionsId }}' --required;