Workflows publishes connectors that make it easier to access other Google Cloud products within a workflow. This document details the correct Workflows syntax for the available connectors.
For workflow samples that demonstrate how to use a connector, see each connector's overview page.
To learn more about authentication, and behavior during retries and long-running operations, see Understand connectors.
Invoke a connector call
Similar to invoking an HTTP endpoint,
a connector call requires call and args fields. You can specify a timeout
value and polling policy using the connector_params block:
- STEP_NAME: call: CONNECTOR args: ARG: ARG_VALUE [...] body: KEY:KEY_VALUE [...] connector_params: timeout: TIMEOUT_IN_SECONDS polling_policy: initial_delay: INITIAL_DELAY_IN_SECONDS multiplier: MULTIPLIER_VALUE max_delay: MAX_DELAY_IN_SECONDS skip_polling: SKIP_POLLING_SWITCH scopes: OAUTH2_SCOPE result: RESPONSE_VALUE
Replace the following:
STEP_NAME: the name of the step.CONNECTOR(required): the connector method in the formgoogleapis.gcp_service.version.resource.operation. For example,googleapis.bigquery.v2.tables.get.ARGandARG_VALUE(required): each connector call requires different arguments.KEYandKEY_VALUE(optional): fields to supply input to the API.- Connector-specific parameters (optional):
TIMEOUT_IN_SECONDS: time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception. The default value is1800and this should be the maximum for connector methods that are not long-running operations. Otherwise, for long-running operations, the maximum timeout for a connector call is31536000seconds (one year).INITIAL_DELAY_IN_SECONDS: polling policy parameter with a default value of1.0. Only applies to long-running operation calls.MULTIPLIER_VALUE: polling policy parameter with a default value of1.25. Only applies to long-running operation calls.MAX_DELAY_IN_SECONDS: polling policy parameter with a default value of60.0. Only applies to long-running operation calls.SKIP_POLLING_SWITCH: if set toTrue, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds (usuallyHTTP POST,HTTP UPDATE, orHTTP DELETE). If the initial request is not successful, retries might occur. Polling of status (HTTP GETrequests that follow the initial request) is skipped for the long-running operation after the initial request completes. The default value isFalse.OAUTH2_SCOPE: OAuth2 scopes to pass to the Google API. Can be a string, list of strings, space-separated string, or comma-separated string.
RESPONSE_VALUE(optional): variable name where the result of a connector call invocation step is stored.