Integrations
import { Integrations } from "https://googleapis.deno.dev/v1/integrations:v1.ts";
§Properties
§Methods
Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.
Enumerates the regions for which Connector Platform is provisioned.
Gets the metadata info for the requested client
Required. Required: The ID of the GCP Project to be provisioned.
Creates an Apps Script project.
Required. The project that the executed integration belongs to.
Links a existing Apps Script project.
Required. The project that the executed integration belongs to.
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.
Required. "projects/{project}/locations/{location}" format.
Deletes an auth config.
Required. The name that is associated with the AuthConfig.
Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
Required. The name that is associated with the AuthConfig.
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Required. The client, which owns this collection of AuthConfigs.
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.
Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
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.
Required. "projects/{project}/locations/{location}" format.
Delete a certificate
Required. The name that is associated with the Certificate.
Get a certificates in the specified project.
Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
List all the certificates that match the filter. Restrict to certificate of current client only.
Required. The client, which owns this collection of Certificates.
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.
Output only. Auto generated primary key
Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.
Required. Required: The ID of the GCP Project to be deprovisioned.
Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.
Required. Required: The ID of the GCP Project to be provisioned.
Update run-as service account for provisioned client
Required. Required: The ID of the GCP Project to be provisioned.
Update client from GMEK to CMEK
Required. Required: The ID of the GCP Project to be provisioned.
Update variable masking for provisioned client
Required. Required: The ID of the GCP Project to be provisioned.
Creates a cloud function project.
Required. The project that the executed integration belongs to.
Lists the available entities and actions associated with a Connection.
Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
Gets the client configuration for the given project and location resource name
Required. Required: The ID of the GCP Project to be provisioned.
Delete the selected integration and all versions inside
Required. The location resource of the request.
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.
Required. The integration resource name.
Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. Input data to integration is received in body in json format
Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id}
Download the execution.
Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Get an execution in the specified project.
Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.
Required. The parent resource name of the integration execution.
- Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
- Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
- 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.
Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Returns the list of all integrations in the specified project.
Required. Project and location from which the integrations should be listed. Format: projects/{project}
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
The integration resource name.
Execute the integration in draft state
Output only. Auto-generated primary key.
Create a integration with a draft version in the specified project.
Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
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 deleted is DRAFT, and if the
locked_by
user is not the same as the user performing the Delete. Audit
fields updated include last_modified_timestamp, last_modified_by. Any
existing lock is released when Deleting a integration. Currently, there is
no undelete mechanism.
Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Downloads an integration. Retrieves the IntegrationVersion
for a given
integration_id
and returns the response as a string.
Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Downloads an Integration version package like
IntegrationVersion,Integration Config etc. Retrieves the IntegrationVersion
package for a given integration_id
and returns the response as a JSON.
Required. Integration version name Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Get a integration in the specified project.
Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Returns the list of all integration versions in the specified project.
Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Update a integration with a draft version in the specified project.
Output only. Auto-generated primary key.
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.
Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
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.
Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
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.
Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
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.
Required. "projects/{project}/locations/{location}" format.
Deletes an auth config.
Required. The name that is associated with the AuthConfig.
Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
Required. The name that is associated with the AuthConfig.
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Required. The client, which owns this collection of AuthConfigs.
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.
Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.
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.
Required. "projects/{project}/locations/{location}" format.
Delete a certificate
Required. The name that is associated with the Certificate.
Get a certificates in the specified project.
Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
List all the certificates that match the filter. Restrict to certificate of current client only.
Required. The client, which owns this collection of Certificates.
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.
Output only. Auto generated primary key
Creates a cloud function project.
Required. The project that the executed integration belongs to.
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.
Required. The integration resource name.
Cancellation of an execution
Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Download the execution.
Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Get an execution in the specified project.
Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}
Lists the results of all the integration executions. The response includes the same information as the execution log in the Integration UI.
Required. The parent resource name of the integration execution.
- Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
- Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
- 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.
Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Returns the list of all integrations in the specified project.
Required. Project and location from which the integrations should be listed. Format: projects/{project}
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
The integration resource name.
Execute the integration in draft state
Output only. Auto-generated primary key.
Create a integration with a draft version in the specified project.
Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}
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 deleted is DRAFT, and if the
locked_by
user is not the same as the user performing the Delete. Audit
fields updated include last_modified_timestamp, last_modified_by. Any
existing lock is released when Deleting a integration. Currently, there is
no undelete mechanism.
Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Downloads an integration. Retrieves the IntegrationVersion
for a given
integration_id
and returns the response as a string.
Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Get a integration in the specified project.
Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Returns the list of all integration versions in the specified project.
Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Update a integration with a draft version in the specified project.
Output only. Auto-generated primary key.
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.
Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
Clears the locked_by
and locked_at_timestamp
in the DRAFT version of
this integration. It then performs the same action as the
CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the
integration as a SNAPSHOT and then creates a new DRAFT version with the
locked_by
set to the user_taking_over
and the locked_at_timestamp
set
to the current timestamp). Both the locked_by
and user_taking_over
are
notified via email about the takeover. This RPC throws an exception if the
integration is not in DRAFT status or if the locked_by
and
locked_at_timestamp
fields are not set.The TakeoverEdit lock is treated
the same as an edit of the integration, and hence shares ACLs with edit.
Audit fields updated include last_modified_timestamp, last_modified_by.
Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
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.
Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}
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.
Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}
Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Required. "projects/{project}/locations/{location}" format.
Deletes an sfdc instance.
Required. The name that is associated with the SfdcInstance.
Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Required. The name that is associated with the SfdcInstance.
Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Required. The client, which owns this collection of SfdcInstances.
Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Required. "projects/{project}/locations/{location}" format.
Deletes an sfdc channel.
Required. The name that is associated with the SfdcChannel.
Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Required. The name that is associated with the SfdcChannel.
Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Required. The client, which owns this collection of SfdcChannels.
Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Required. "projects/{project}/locations/{location}" format.
Deletes an sfdc instance.
Required. The name that is associated with the SfdcInstance.
Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Required. The name that is associated with the SfdcInstance.
Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
Required. The client, which owns this collection of SfdcInstances.
Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Required. "projects/{project}/locations/{location}" format.
Deletes an sfdc channel.
Required. The name that is associated with the SfdcChannel.
Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Required. The name that is associated with the SfdcChannel.
Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Required. The client, which owns this collection of SfdcChannels.
Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.