suspensions

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

Overview

Name	suspensions
Type	Resource
Id	google.integrations.suspensions

Fields

The following fields are returned by SELECT queries:

projects_locations_products_integrations_executions_suspensions_list

Successful response

Name	Datatype	Description
name	string	Resource name for suspensions suspension/{suspension_id}
approvalConfig	object	Controls the notifications and approval permissions for this suspension. (id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig)
audit	object	Metadata pertaining to the resolution of this suspension. (id: GoogleCloudIntegrationsV1alphaSuspensionAudit)
createTime	string (google-datetime)	Output only. Auto-generated.
eventExecutionInfoId	string	Required. ID of the associated execution.
integration	string	Required. The name of the originating integration.
lastModifyTime	string (google-datetime)	Output only. Auto-generated.
state	string	Required. State of this suspension, indicating what action a resolver has taken.
suspensionConfig	object	Controls the notifications and resolver permissions for this suspension. (id: EnterpriseCrmEventbusProtoSuspensionConfig)
taskId	string	Required. Task id of the associated SuspensionTask.

projects_locations_integrations_executions_suspensions_list

Successful response

Name	Datatype	Description
name	string	Resource name for suspensions suspension/{suspension_id}
approvalConfig	object	Controls the notifications and approval permissions for this suspension. (id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig)
audit	object	Metadata pertaining to the resolution of this suspension. (id: GoogleCloudIntegrationsV1alphaSuspensionAudit)
createTime	string (google-datetime)	Output only. Auto-generated.
eventExecutionInfoId	string	Required. ID of the associated execution.
integration	string	Required. The name of the originating integration.
lastModifyTime	string (google-datetime)	Output only. Auto-generated.
state	string	Required. State of this suspension, indicating what action a resolver has taken.
suspensionConfig	object	Controls the notifications and resolver permissions for this suspension. (id: EnterpriseCrmEventbusProtoSuspensionConfig)
taskId	string	Required. Task id of the associated SuspensionTask.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_products_integrations_executions_suspensions_list	select	projectsId, locationsId, productsId, integrationsId, executionsId	pageSize, pageToken, filter, orderBy	* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
projects_locations_integrations_executions_suspensions_list	select	projectsId, locationsId, integrationsId, executionsId	pageSize, pageToken, filter, orderBy	* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
projects_locations_products_integrations_executions_suspensions_resolve	exec	projectsId, locationsId, productsId, integrationsId, executionsId, suspensionsId		* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
projects_locations_products_integrations_executions_suspensions_lift	exec	projectsId, locationsId, productsId, integrationsId, executionsId, suspensionsId		* Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
projects_locations_integrations_executions_suspensions_resolve	exec	projectsId, locationsId, integrationsId, executionsId, suspensionsId		* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
projects_locations_integrations_executions_suspensions_lift	exec	projectsId, locationsId, integrationsId, executionsId, suspensionsId		* Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

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
suspensionsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_products_integrations_executions_suspensions_list

• Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

SELECT
name,
approvalConfig,
audit,
createTime,
eventExecutionInfoId,
integration,
lastModifyTime,
state,
suspensionConfig,
taskId
FROM google.integrations.suspensions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

projects_locations_integrations_executions_suspensions_list

• Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

SELECT
name,
approvalConfig,
audit,
createTime,
eventExecutionInfoId,
integration,
lastModifyTime,
state,
suspensionConfig,
taskId
FROM google.integrations.suspensions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND integrationsId = '{{ integrationsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

Lifecycle Methods

projects_locations_products_integrations_executions_suspensions_resolve

• Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

EXEC google.integrations.suspensions.projects_locations_products_integrations_executions_suspensions_resolve 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required, 
@suspensionsId='{{ suspensionsId }}' --required 
@@json=
'{
"suspension": "{{ suspension }}"
}';

projects_locations_products_integrations_executions_suspensions_lift

• Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

EXEC google.integrations.suspensions.projects_locations_products_integrations_executions_suspensions_lift 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@productsId='{{ productsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required, 
@suspensionsId='{{ suspensionsId }}' --required 
@@json=
'{
"suspensionResult": "{{ suspensionResult }}"
}';

projects_locations_integrations_executions_suspensions_resolve

• Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

EXEC google.integrations.suspensions.projects_locations_integrations_executions_suspensions_resolve 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required, 
@suspensionsId='{{ suspensionsId }}' --required 
@@json=
'{
"suspension": "{{ suspension }}"
}';

projects_locations_integrations_executions_suspensions_lift

• Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

EXEC google.integrations.suspensions.projects_locations_integrations_executions_suspensions_lift 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@integrationsId='{{ integrationsId }}' --required, 
@executionsId='{{ executionsId }}' --required, 
@suspensionsId='{{ suspensionsId }}' --required 
@@json=
'{
"suspensionResult": "{{ suspensionResult }}"
}';