executions

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

Overview

Name	executions
Type	Resource
Id	google.integrations.executions

Fields

The following fields are returned by SELECT queries:

projects_locations_products_integrations_executions_get

Name	Datatype	Description
name	string	Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Created time of the execution.
directSubExecutions	array	Direct sub executions of the following Execution.
eventExecutionDetails	object	The execution info about this event. (id: EnterpriseCrmEventbusProtoEventExecutionDetails)
executionDetails	object	Detailed info of this execution. (id: GoogleCloudIntegrationsV1alphaExecutionDetails)
executionMethod	string	The ways user posts this event.
integrationVersionState	string	Output only. State of the integration version
replayInfo	object	Output only. Replay info for the execution (id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo)
requestParameters	object	Event parameters come in as part of the request.
requestParams	array	Event parameters come in as part of the request.
responseParameters	object	Event parameters returned as part of the response. In the case of error, the ErrorInfo field is returned in the following format: { "ErrorInfo": { "message": String, "code": Number } }
responseParams	array
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created
triggerId	string	The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
updateTime	string (google-datetime)	Output only. Last modified time of the execution.

projects_locations_integrations_executions_get

Name	Datatype	Description
name	string	Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Created time of the execution.
directSubExecutions	array	Direct sub executions of the following Execution.
eventExecutionDetails	object	The execution info about this event. (id: EnterpriseCrmEventbusProtoEventExecutionDetails)
executionDetails	object	Detailed info of this execution. (id: GoogleCloudIntegrationsV1alphaExecutionDetails)
executionMethod	string	The ways user posts this event.
integrationVersionState	string	Output only. State of the integration version
replayInfo	object	Output only. Replay info for the execution (id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo)
requestParameters	object	Event parameters come in as part of the request.
requestParams	array	Event parameters come in as part of the request.
responseParameters	object	Event parameters returned as part of the response. In the case of error, the ErrorInfo field is returned in the following format: { "ErrorInfo": { "message": String, "code": Number } }
responseParams	array
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created
triggerId	string	The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
updateTime	string (google-datetime)	Output only. Last modified time of the execution.

projects_locations_products_integrations_executions_list

Name	Datatype	Description
name	string	Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Created time of the execution.
directSubExecutions	array	Direct sub executions of the following Execution.
eventExecutionDetails	object	The execution info about this event. (id: EnterpriseCrmEventbusProtoEventExecutionDetails)
executionDetails	object	Detailed info of this execution. (id: GoogleCloudIntegrationsV1alphaExecutionDetails)
executionMethod	string	The ways user posts this event.
integrationVersionState	string	Output only. State of the integration version
replayInfo	object	Output only. Replay info for the execution (id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo)
requestParameters	object	Event parameters come in as part of the request.
requestParams	array	Event parameters come in as part of the request.
responseParameters	object	Event parameters returned as part of the response. In the case of error, the ErrorInfo field is returned in the following format: { "ErrorInfo": { "message": String, "code": Number } }
responseParams	array
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created
triggerId	string	The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
updateTime	string (google-datetime)	Output only. Last modified time of the execution.

projects_locations_integrations_executions_list

Name	Datatype	Description
name	string	Auto-generated primary key.
cloudKmsKey	string	Optional. Cloud KMS resource name for the CMEK encryption key.
cloudLoggingDetails	object	Cloud Logging details for the integration version (id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails)
createTime	string (google-datetime)	Output only. Created time of the execution.
directSubExecutions	array	Direct sub executions of the following Execution.
eventExecutionDetails	object	The execution info about this event. (id: EnterpriseCrmEventbusProtoEventExecutionDetails)
executionDetails	object	Detailed info of this execution. (id: GoogleCloudIntegrationsV1alphaExecutionDetails)
executionMethod	string	The ways user posts this event.
integrationVersionState	string	Output only. State of the integration version
replayInfo	object	Output only. Replay info for the execution (id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo)
requestParameters	object	Event parameters come in as part of the request.
requestParams	array	Event parameters come in as part of the request.
responseParameters	object	Event parameters returned as part of the response. In the case of error, the ErrorInfo field is returned in the following format: { "ErrorInfo": { "message": String, "code": Number } }
responseParams	array
snapshotNumber	string (int64)	Output only. An increasing sequence that is set when a new snapshot is created
triggerId	string	The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
updateTime	string (google-datetime)	Output only. Last modified time of the execution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_products_integrations_executions_get	select	projectsId, locationsId, productsId, integrationsId, executionsId		Get an execution in the specified project.
projects_locations_integrations_executions_get	select	projectsId, locationsId, integrationsId, executionsId		Get an execution in the specified project.
projects_locations_products_integrations_executions_list	select	projectsId, locationsId, productsId, integrationsId	pageSize, filterParams.parameterPairValue, filterParams.startTime, filterParams.eventStatuses, refreshAcl, filterParams.workflowName, filterParams.parameterValue, filterParams.endTime, filter, filterParams.customFilter, pageToken, filterParams.parameterPairKey, filterParams.executionId, filterParams.taskStatuses, snapshotMetadataWithoutParams, filterParams.parameterType, truncateParams, filterParams.parameterKey, orderBy, readMask	Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.
projects_locations_integrations_executions_list	select	projectsId, locationsId, integrationsId	filterParams.eventStatuses, orderBy, pageToken, filterParams.taskStatuses, filter, pageSize, filterParams.parameterValue, refreshAcl, filterParams.customFilter, filterParams.parameterType, readMask, filterParams.endTime, filterParams.parameterPairKey, filterParams.executionId, truncateParams, filterParams.parameterKey, filterParams.parameterPairValue, filterParams.workflowName, snapshotMetadataWithoutParams, filterParams.startTime	Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.
projects_locations_integrations_executions_cancel	exec	projectsId, locationsId, integrationsId, executionsId		Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.
projects_locations_integrations_executions_download	exec	projectsId, locationsId, integrationsId, executionsId		Download the execution.
projects_locations_integrations_executions_replay	exec	projectsId, locationsId, integrationsId, executionsId		Re-execute an existing execution, with same request parameters and execution strategy.
projects_locations_products_integrations_executions_download	exec	projectsId, locationsId, productsId, integrationsId, executionsId		Download the execution.

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
executionsId	string
integrationsId	string
locationsId	string
productsId	string
projectsId	string
filter	string
filterParams.customFilter	string
filterParams.endTime	string (int64)
filterParams.eventStatuses	string
filterParams.executionId	string
filterParams.parameterKey	string
filterParams.parameterPairKey	string
filterParams.parameterPairValue	string
filterParams.parameterType	string
filterParams.parameterValue	string
filterParams.startTime	string (int64)
filterParams.taskStatuses	string
filterParams.workflowName	string
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
refreshAcl	boolean
snapshotMetadataWithoutParams	boolean
truncateParams	boolean

SELECT examples

projects_locations_products_integrations_executions_get

Get an execution in the specified project.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
directSubExecutions,
eventExecutionDetails,
executionDetails,
executionMethod,
integrationVersionState,
replayInfo,
requestParameters,
requestParams,
responseParameters,
responseParams,
snapshotNumber,
triggerId,
updateTime
FROM google.integrations.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
;

projects_locations_integrations_executions_get

Get an execution in the specified project.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
directSubExecutions,
eventExecutionDetails,
executionDetails,
executionMethod,
integrationVersionState,
replayInfo,
requestParameters,
requestParams,
responseParameters,
responseParams,
snapshotNumber,
triggerId,
updateTime
FROM google.integrations.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
;

projects_locations_products_integrations_executions_list

Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
directSubExecutions,
eventExecutionDetails,
executionDetails,
executionMethod,
integrationVersionState,
replayInfo,
requestParameters,
requestParams,
responseParameters,
responseParams,
snapshotNumber,
triggerId,
updateTime
FROM google.integrations.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND filterParams.parameterPairValue = '{{ filterParams.parameterPairValue }}'
AND filterParams.startTime = '{{ filterParams.startTime }}'
AND filterParams.eventStatuses = '{{ filterParams.eventStatuses }}'
AND refreshAcl = '{{ refreshAcl }}'
AND filterParams.workflowName = '{{ filterParams.workflowName }}'
AND filterParams.parameterValue = '{{ filterParams.parameterValue }}'
AND filterParams.endTime = '{{ filterParams.endTime }}'
AND filter = '{{ filter }}'
AND filterParams.customFilter = '{{ filterParams.customFilter }}'
AND pageToken = '{{ pageToken }}'
AND filterParams.parameterPairKey = '{{ filterParams.parameterPairKey }}'
AND filterParams.executionId = '{{ filterParams.executionId }}'
AND filterParams.taskStatuses = '{{ filterParams.taskStatuses }}'
AND snapshotMetadataWithoutParams = '{{ snapshotMetadataWithoutParams }}'
AND filterParams.parameterType = '{{ filterParams.parameterType }}'
AND truncateParams = '{{ truncateParams }}'
AND filterParams.parameterKey = '{{ filterParams.parameterKey }}'
AND orderBy = '{{ orderBy }}'
AND readMask = '{{ readMask }}'
;

projects_locations_integrations_executions_list

Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.

SELECT
name,
cloudKmsKey,
cloudLoggingDetails,
createTime,
directSubExecutions,
eventExecutionDetails,
executionDetails,
executionMethod,
integrationVersionState,
replayInfo,
requestParameters,
requestParams,
responseParameters,
responseParams,
snapshotNumber,
triggerId,
updateTime
FROM google.integrations.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND filterParams.eventStatuses = '{{ filterParams.eventStatuses }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND filterParams.taskStatuses = '{{ filterParams.taskStatuses }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND filterParams.parameterValue = '{{ filterParams.parameterValue }}'
AND refreshAcl = '{{ refreshAcl }}'
AND filterParams.customFilter = '{{ filterParams.customFilter }}'
AND filterParams.parameterType = '{{ filterParams.parameterType }}'
AND readMask = '{{ readMask }}'
AND filterParams.endTime = '{{ filterParams.endTime }}'
AND filterParams.parameterPairKey = '{{ filterParams.parameterPairKey }}'
AND filterParams.executionId = '{{ filterParams.executionId }}'
AND truncateParams = '{{ truncateParams }}'
AND filterParams.parameterKey = '{{ filterParams.parameterKey }}'
AND filterParams.parameterPairValue = '{{ filterParams.parameterPairValue }}'
AND filterParams.workflowName = '{{ filterParams.workflowName }}'
AND snapshotMetadataWithoutParams = '{{ snapshotMetadataWithoutParams }}'
AND filterParams.startTime = '{{ filterParams.startTime }}'
;

Lifecycle Methods

projects_locations_integrations_executions_cancel

Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.

EXEC google.integrations.executions.projects_locations_integrations_executions_cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required 
@@json=
'{
"cancelReason": "{{ cancelReason }}"
}'
;

projects_locations_integrations_executions_download

Download the execution.

EXEC google.integrations.executions.projects_locations_integrations_executions_download 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required
;

projects_locations_integrations_executions_replay

Re-execute an existing execution, with same request parameters and execution strategy.

EXEC google.integrations.executions.projects_locations_integrations_executions_replay 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required 
@@json=
'{
"updateMask": "{{ updateMask }}", 
"replayMode": "{{ replayMode }}", 
"modifiedParameters": "{{ modifiedParameters }}", 
"replayReason": "{{ replayReason }}"
}'
;

projects_locations_products_integrations_executions_download

Download the execution.

EXEC google.integrations.executions.projects_locations_products_integrations_executions_download 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required
;