Method: projects.locations.integrations.executions.replay

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

HTTP request

POST https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*/executions/*}:replay

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The execution resource name. Format: projects/{gcpProjectId}/locations/{location}/integrations/{integration}/executions/{executionId}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "replayReason": string,
  "replayMode": enum (ReplayMode)
}
Fields
replayReason

string

Required. The user provided reason for replaying the execution.
replayMode

enum (ReplayMode)

Optional. The mode of the replay.

Response body

Response for replaying an execution.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "executionId": string,
  "replayedExecutionId": string,
  "outputParameters": {
    object
  }
}
Fields
executionId

string

The id of the execution corresponding to this run of the integration.
replayedExecutionId

string

The execution id which is replayed.
outputParameters

object (Struct format)

OUTPUT parameters in format of Map<Key,Value>. Where Key is the name of the parameter. The parameters would only be present in case of synchrounous execution. Note: name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • integrations.executions.replay

For more information, see the IAM documentation.

ReplayMode

Replay mode for the execution. The default behavoir is replay from beginning. If the replay mode is set to point of failure, the execution will be replayed from the first failed task.

Enums
REPLAY_MODE_UNSPECIFIED Default value.
REPLAY_MODE_FROM_BEGINNING Replay the original execution.
REPLAY_MODE_POINT_OF_FAILURE Replay the execution with the modified parameters.