Suspension

Stay organized with collections Save and categorize content based on your preferences.

A record representing a suspension.

JSON representation
{
  "name": string,
  "eventExecutionInfoId": string,
  "taskId": string,
  "state": enum (ResolutionState),
  "audit": {
    object (Audit)
  },
  "createTime": string,
  "lastModifyTime": string,
  "integration": string,
  "approvalConfig": {
    object (ApprovalConfig)
  }
}
Fields
name

string

Resource name for suspensions suspension/{suspensionId}

eventExecutionInfoId

string

Required. ID of the associated execution.

taskId

string

Required. Task id of the associated SuspensionTask.

state

enum (ResolutionState)

Required. State of this suspension, indicating what action a resolver has taken.

audit

object (Audit)

Metadata pertaining to the resolution of this suspension.

createTime

string (Timestamp format)

Output only. Auto-generated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lastModifyTime

string (Timestamp format)

Output only. Auto-generated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

integration

string

Required. The name of the originating integration.

approvalConfig

object (ApprovalConfig)

Controls the notifications and approval permissions for this suspension.

ResolutionState

Enum representing the user action, if any, taken on a suspension.

Enums
RESOLUTION_STATE_UNSPECIFIED Unset state.
PENDING The suspension has not yet been resolved.
REJECTED The resolver has rejected the suspension.
LIFTED The resolver has lifted the suspension.

Audit

Contains when and by whom the suspension was resolved.

JSON representation
{
  "resolveTime": string,
  "resolver": string
}
Fields
resolveTime

string (Timestamp format)

Time at which this suspension was resolved.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

resolver

string

Email address of the person who resolved this suspension.

ApprovalConfig

Configurations for approving the Suspension.

JSON representation
{
  "customMessage": string,
  "emailAddresses": [
    string
  ],
  "expiration": {
    object (ApprovalExpiration)
  }
}
Fields
customMessage

string

Information to provide for recipients.

emailAddresses[]

string

Email addresses to send approval request to.

expiration

object (ApprovalExpiration)

Indicates the next steps when no external actions happen on the suspension.

ApprovalExpiration

Expiration configs for the approval request.

JSON representation
{
  "remindTime": string,
  "expireTime": string,
  "liftWhenExpired": boolean
}
Fields
remindTime

string (Timestamp format)

Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

expireTime

string (Timestamp format)

Output only. Time after which the suspension expires, if no action taken.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

liftWhenExpired

boolean

Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.