Application Integration API Connector Overview

The Workflows connector defines the built-in functions that can be used to access other Google Cloud products within a workflow.

This page provides an overview of the individual connector. There is no need to import or load connector libraries in a workflow—connectors work out of the box when used in a call step.

Application Integration is an Integration-Platform-as-a-Service (iPaaS) solution that offers a set of core integration tools to connect and manage applications and data required to support various business operations. To learn more, see the Application Integration API documentation.

Application Integration connector sample

YAML

# This workflow sends a List request to Application Integration API. main:  steps:  - init:  assign:  - project: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}  - location: ${sys.get_env("GOOGLE_CLOUD_LOCATION")}  - get_list:  call: googleapis.integrations.v1.projects.locations.integrations.list  args:  location: ${location}  parent: ${"projects/" + project + "/locations/" + location}  result: response  - the_end:  return: ${response}

JSON

{  "main": {  "steps": [  {  "init": {  "assign": [  {  "project": "${sys.get_env(\"GOOGLE_CLOUD_PROJECT_ID\")}"  },  {  "location": "${sys.get_env(\"GOOGLE_CLOUD_LOCATION\")}"  }  ]  }  },  {  "get_list": {  "call": "googleapis.integrations.v1.projects.locations.integrations.list",  "args": {  "location": "${location}",  "parent": "${\"projects/\" + project + \"/locations/\" + location}"  },  "result": "response"  }  },  {  "the_end": {  "return": "${response}"  }  }  ]  } }

Module: googleapis.integrations.v1.connectorPlatformRegions

Functions
enumerate Enumerates the regions for which Connector Platform is provisioned.

Module: googleapis.integrations.v1.projects.locations.appsScriptProjects

Functions
create Creates an Apps Script project.
link Links a existing Apps Script project.

Module: googleapis.integrations.v1.projects.locations.authConfigs

Functions
create Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
delete Deletes an auth config.
get Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
list Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
patch Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

Module: googleapis.integrations.v1.projects.locations.certificates

Functions
create Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
delete Delete a certificate
get Get a certificates in the specified project.
list List all the certificates that match the filter. Restrict to certificate of current client only.
patch Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.

Module: googleapis.integrations.v1.projects.locations.cloudFunctions

Functions
create Creates a cloud function project.

Module: googleapis.integrations.v1.projects.locations.integrations

Functions
delete Delete the selected integration and all versions inside
execute Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing -), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given trigger_id is executed. This is helpful for execution the integration from UI.
list Returns the list of all integrations in the specified project.
schedule Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

Module: googleapis.integrations.v1.projects.locations.integrations.executions

Functions
get Get an execution in the specified project.
list Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.

Module: googleapis.integrations.v1.projects.locations.integrations.executions.suspensions

Functions
lift
  • Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
list
  • Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
resolve
  • Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

Module: googleapis.integrations.v1.projects.locations.integrations.versions

Functions
archive Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the locked_by user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
create Create a integration with a draft version in the specified project.
deactivate Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
download Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string.
get Get a integration in the specified project.
list Returns the list of all integration versions in the specified project.
patch Update a integration with a draft version in the specified project.
publish This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the locked_by user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
upload Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

Module: googleapis.integrations.v1.projects.locations.sfdcInstances

Functions
create Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
delete Deletes an sfdc instance.
get Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
list Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
patch Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

Module: googleapis.integrations.v1.projects.locations.sfdcInstances.sfdcChannels

Functions
create Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
delete Deletes an sfdc channel.
get Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
list Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
patch Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.