waitForFlowRuntimeCompletion

Back to index

Summary

This call waits for flow runtime to have a status of completed or exceed the default timeout setting.

flowRuntimeId

Stringrequired

The ID of the flow runtime in the UUID string format. Example: e6e905d9-f71c-11ee-bd78-024227a15b5a.

timeout

Integeroptional

The number of seconds to wait before giving up on a request. The default is 60 seconds.

pollInterval

Integeroptional

The number of seconds to wait between polling getJobStatus API request. The default is 5 seconds.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.waitForFlowRuntimeCompletion(
  flowRuntimeId: "test-flowRuntimeId"
  /* optional arguments */
)▼