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
projects_locations_products_integrations_executions_list
projects_locations_integrations_executions_get
projects_locations_integrations_executions_list

Successful response

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.

Successful response

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.

Successful response

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.

Successful response

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_products_integrations_executions_list`	`select`	`projectsId`, `locationsId`, `productsId`, `integrationsId`	`filter`, `pageSize`, `pageToken`, `orderBy`, `readMask`, `filterParams.workflowName`, `filterParams.startTime`, `filterParams.endTime`, `filterParams.eventStatuses`, `filterParams.taskStatuses`, `filterParams.customFilter`, `filterParams.executionId`, `filterParams.parameterValue`, `filterParams.parameterType`, `filterParams.parameterKey`, `filterParams.parameterPairKey`, `filterParams.parameterPairValue`, `refreshAcl`, `truncateParams`, `snapshotMetadataWithoutParams`	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_get`	`select`	`projectsId`, `locationsId`, `integrationsId`, `executionsId`		Get an execution in the specified project.
`projects_locations_integrations_executions_list`	`select`	`projectsId`, `locationsId`, `integrationsId`	`filter`, `pageSize`, `pageToken`, `orderBy`, `readMask`, `filterParams.workflowName`, `filterParams.startTime`, `filterParams.endTime`, `filterParams.eventStatuses`, `filterParams.taskStatuses`, `filterParams.customFilter`, `filterParams.executionId`, `filterParams.parameterValue`, `filterParams.parameterType`, `filterParams.parameterKey`, `filterParams.parameterPairKey`, `filterParams.parameterPairValue`, `refreshAcl`, `truncateParams`, `snapshotMetadataWithoutParams`	Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.
`projects_locations_products_integrations_executions_download`	`exec`	`projectsId`, `locationsId`, `productsId`, `integrationsId`, `executionsId`		Download the execution.
`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.

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
projects_locations_products_integrations_executions_list
projects_locations_integrations_executions_get
projects_locations_integrations_executions_list

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;

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 filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND readMask = '{{ readMask }}'
AND filterParams.workflowName = '{{ filterParams.workflowName }}'
AND filterParams.startTime = '{{ filterParams.startTime }}'
AND filterParams.endTime = '{{ filterParams.endTime }}'
AND filterParams.eventStatuses = '{{ filterParams.eventStatuses }}'
AND filterParams.taskStatuses = '{{ filterParams.taskStatuses }}'
AND filterParams.customFilter = '{{ filterParams.customFilter }}'
AND filterParams.executionId = '{{ filterParams.executionId }}'
AND filterParams.parameterValue = '{{ filterParams.parameterValue }}'
AND filterParams.parameterType = '{{ filterParams.parameterType }}'
AND filterParams.parameterKey = '{{ filterParams.parameterKey }}'
AND filterParams.parameterPairKey = '{{ filterParams.parameterPairKey }}'
AND filterParams.parameterPairValue = '{{ filterParams.parameterPairValue }}'
AND refreshAcl = '{{ refreshAcl }}'
AND truncateParams = '{{ truncateParams }}'
AND snapshotMetadataWithoutParams = '{{ snapshotMetadataWithoutParams }}';

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;

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 filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND readMask = '{{ readMask }}'
AND filterParams.workflowName = '{{ filterParams.workflowName }}'
AND filterParams.startTime = '{{ filterParams.startTime }}'
AND filterParams.endTime = '{{ filterParams.endTime }}'
AND filterParams.eventStatuses = '{{ filterParams.eventStatuses }}'
AND filterParams.taskStatuses = '{{ filterParams.taskStatuses }}'
AND filterParams.customFilter = '{{ filterParams.customFilter }}'
AND filterParams.executionId = '{{ filterParams.executionId }}'
AND filterParams.parameterValue = '{{ filterParams.parameterValue }}'
AND filterParams.parameterType = '{{ filterParams.parameterType }}'
AND filterParams.parameterKey = '{{ filterParams.parameterKey }}'
AND filterParams.parameterPairKey = '{{ filterParams.parameterPairKey }}'
AND filterParams.parameterPairValue = '{{ filterParams.parameterPairValue }}'
AND refreshAcl = '{{ refreshAcl }}'
AND truncateParams = '{{ truncateParams }}'
AND snapshotMetadataWithoutParams = '{{ snapshotMetadataWithoutParams }}';

Lifecycle Methods

projects_locations_products_integrations_executions_download
projects_locations_integrations_executions_cancel
projects_locations_integrations_executions_download
projects_locations_integrations_executions_replay

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;

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

Download the execution.

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

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=
'{
"replayReason": "{{ replayReason }}", 
"updateMask": "{{ updateMask }}", 
"modifiedParameters": "{{ modifiedParameters }}", 
"replayMode": "{{ replayMode }}"
}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Lifecycle Methods​

Overview

Fields

Methods

Parameters

`SELECT` examples

Lifecycle Methods