REST Resource: projects.locations.integrations.executions

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

Resource: Execution

The Execution resource contains detailed information of an individual integration execution.

JSON representation
{
  "name": string,
  "triggerId": string,
  "executionMethod": enum (ExecutionMethod),
  "createTime": string,
  "updateTime": string,
  "directSubExecutions": [
    {
      object (Execution)
    }
  ],
  "executionDetails": {
    object (ExecutionDetails)
  },
  "requestParameters": {
    string: {
      object (ValueType)
    },
    ...
  },
  "responseParameters": {
    string: {
      object (ValueType)
    },
    ...
  }
}
Fields
name

string

Auto-generated primary key.

triggerId

string

The trigger id of the integration trigger config. If both triggerId and clientId 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.

executionMethod

enum (ExecutionMethod)

The ways user posts this event.

createTime

string (Timestamp format)

Output only. Created time of the execution.

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".

updateTime

string (Timestamp format)

Output only. Last modified time of the execution.

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".

directSubExecutions[]

object (Execution)

Direct sub executions of the following Execution.

executionDetails

object (ExecutionDetails)

Detailed info of this execution.

requestParameters

map (key: string, value: object (ValueType))

Event parameters come in as part of the request.

An object containing a list of "key": value pairs.

responseParameters

map (key: string, value: object (ValueType))

Event parameters returned as part of the response.

An object containing a list of "key": value pairs.

ExecutionMethod

ExecutionMethod Enum

Enums
EXECUTION_METHOD_UNSPECIFIED Default value.
POST Sync post.
POST_TO_QUEUE Async post.
SCHEDULE Async post with schedule time.

ExecutionDetails

Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics.

JSON representation
{
  "state": enum (State),
  "executionSnapshots": [
    {
      object (ExecutionSnapshot)
    }
  ],
  "attemptStats": [
    {
      object (AttemptStats)
    }
  ]
}
Fields
state

enum (State)

Status of the execution.

executionSnapshots[]

object (ExecutionSnapshot)

List of snapshots taken during the execution.

attemptStats[]

object (AttemptStats)

List of Start and end time of the execution attempts.

State

Status of the execution.

Enums
STATE_UNSPECIFIED Default.
PENDING Execution is scheduled and awaiting to be triggered.
PROCESSING Execution is processing.
SUCCEEDED Execution successfully finished. There's no more change after this state.
FAILED Execution failed. There's no more change after this state.
CANCELLED Execution canceled by user. There's no more change after this state.
RETRY_ON_HOLD Execution failed and waiting for retry.
SUSPENDED Execution suspended and waiting for manual intervention.

ExecutionSnapshot

Contains the snapshot of the execution for a given checkpoint.

JSON representation
{
  "checkpointTaskNumber": string,
  "executionSnapshotMetadata": {
    object (ExecutionSnapshotMetadata)
  },
  "params": {
    string: {
      object (ValueType)
    },
    ...
  },
  "taskExecutionDetails": [
    {
      object (TaskExecutionDetails)
    }
  ]
}
Fields
checkpointTaskNumber

string

Indicates "after which checkpoint task's execution" this snapshot is taken.

executionSnapshotMetadata

object (ExecutionSnapshotMetadata)

Metadata of the execution snapshot.

params

map (key: string, value: object (ValueType))

Parameters used during the execution.

An object containing a list of "key": value pairs.

taskExecutionDetails[]

object (TaskExecutionDetails)

All of the task execution details at the given point of time.

ExecutionSnapshotMetadata

Metadata of the execution snapshot.

JSON representation
{
  "taskNumber": string,
  "task": string,
  "executionAttempt": integer,
  "taskAttempt": integer
}
Fields
taskNumber

string

The task number associated with this snapshot.

task

string

the task name associated with this snapshot.

executionAttempt

integer

the execution attempt number this snapshot belongs to.

taskAttempt

integer

the task attempt number this snapshot belongs to.

TaskExecutionDetails

Contains the details of the execution of this task.

JSON representation
{
  "taskNumber": string,
  "taskExecutionState": enum (TaskExecutionState),
  "taskAttemptStats": [
    {
      object (AttemptStats)
    }
  ]
}
Fields
taskNumber

string

Pointer to the task config it used for execution.

taskExecutionState

enum (TaskExecutionState)

The execution state of this task.

taskAttemptStats[]

object (AttemptStats)

Status for the current task execution attempt.

TaskExecutionState

Enum TaskExecutionState.

Enums
TASK_EXECUTION_STATE_UNSPECIFIED Default value.
PENDING_EXECUTION Task is waiting for its precondition tasks to finish to start the execution.
IN_PROCESS Task is under processing.
SUCCEED Task execution successfully finished. There's no more change after this state.
FAILED Task execution failed. There's no more change after this state.
FATAL Task execution failed and cause the whole event execution to fail immediately. There's no more change after this state.
RETRY_ON_HOLD Task execution failed and waiting for retry.
SKIPPED Task execution skipped. This happens when its precondition wasn't met, or the event execution been canceled before reach to the task. There's no more changes after this state.
CANCELLED Task execution canceled when in progress. This happens when event execution been canceled or any other task fall in fatal state.
PENDING_ROLLBACK Task is waiting for its dependency tasks' rollback to finish to start its rollback.
ROLLBACK_IN_PROCESS Task is rolling back.
ROLLEDBACK Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.
SUSPENDED Task is a SuspensionTask which has executed once, creating a pending suspension.

AttemptStats

Status for the execution attempt.

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

The start time of the event execution for current attempt. This could be in the future if it's been scheduled.

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".

endTime

string (Timestamp format)

The end time of the event execution for current attempt.

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".

Methods

list

Lists the status of the integration executions.