REST Resource: projects.locations.integrations.versions

Resource: IntegrationVersion

The integration version definition.

JSON representation 
{
  "name": string,
  "description": string,
  "taskConfigs": [
    {
      object (TaskConfig)
    }
  ],
  "triggerConfigs": [
    {
      object (TriggerConfig)
    }
  ],
  "integrationParameters": [
    {
      object (IntegrationParameter)
    }
  ],
  "state": enum (IntegrationState),
  "snapshotNumber": string,
  "updateTime": string,
  "lockHolder": string,
  "createTime": string,
  "lastModifierEmail": string,
  "parentTemplateId": string,
  "userLabel": string,
  "databasePersistencePolicy": enum (DatabasePersistencePolicy),
  "errorCatcherConfigs": [
    {
      object (ErrorCatcherConfig)
    }
  ],
  "runAsServiceAccount": string,
  "cloudLoggingDetails": {
    object (CloudLoggingDetails)
  },
  "integrationConfigParameters": [
    {
      object (IntegrationConfigParameter)
    }
  ],
  "enableVariableMasking": boolean,
  "createdFromTemplate": string
}
Fields
name

string

Output only. Auto-generated primary key.
description

string

Optional. The integration description.
taskConfigs[]

object (TaskConfig)

Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without taskConfigs.
triggerConfigs[]

object (TriggerConfig)

Optional. Trigger configurations.
integrationParameters[]

object (IntegrationParameter)

Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
state

enum (IntegrationState)

Output only. User should not set it as an input.
snapshotNumber

string (int64 format)

Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflowName, org_id latest(snapshotNumber)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
updateTime

string (Timestamp format)

Output only. Auto-generated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lockHolder

string

Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
createTime

string (Timestamp format)

Output only. Auto-generated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastModifierEmail

string

Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
parentTemplateId

string

Optional. The id of the template which was used to create this integrationVersion.
userLabel

string

Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
databasePersistencePolicy

enum (DatabasePersistencePolicy)

Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
errorCatcherConfigs[]

object (ErrorCatcherConfig)

Optional. Error Catch Task configuration for the integration. It's optional.
runAsServiceAccount

string

Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
cloudLoggingDetails

object (CloudLoggingDetails)

Optional. Cloud Logging details for the integration version
integrationConfigParameters[]

object (IntegrationConfigParameter)

Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
enableVariableMasking

boolean

Optional. True if variable masking feature should be turned on for this version
createdFromTemplate

string

Optional. Optional. The resource name of the template from which the integration is created.

ErrorCatcherConfig

Configuration detail of a error catch task

JSON representation 
{
  "errorCatcherId": string,
  "label": string,
  "errorCatcherNumber": string,
  "startErrorTasks": [
    {
      object (NextTask)
    }
  ],
  "description": string,
  "position": {
    object (Coordinate)
  }
}
Fields
errorCatcherId

string

Required. An error catcher id is string representation for the error catcher config. Within a workflow, errorCatcherId uniquely identifies an error catcher config among all error catcher configs for the workflow
label

string

Optional. The user created label for a particular error catcher. Optional.
errorCatcherNumber

string

Required. A number to uniquely identify each error catcher config within the workflow on UI.
startErrorTasks[]

object (NextTask)

Required. The set of start tasks that are to be executed for the error catch flow
description

string

Optional. User-provided description intended to give more business context about the error catcher config.
position

object (Coordinate)

Optional. Informs the front-end application where to draw this error catcher config on the UI.

IntegrationConfigParameter

Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.

JSON representation 
{
  "parameter": {
    object (IntegrationParameter)
  },
  "value": {
    object (ValueType)
  }
}
Fields
parameter

object (IntegrationParameter)

Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.
value

object (ValueType)

Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.

Methods

create

 Create a integration with a draft version in the specified project.

delete

 Soft-deletes the integration.

download

 Downloads an integration.

downloadJsonPackage

 Downloads an Integration version package like IntegrationVersion,Integration Config etc.

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.

unpublish

 Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it.

upload

 Uploads an integration.