Method: projects.locations.integrations.test

Execute the integration in draft state

HTTP request

POST https://integrations.googleapis.com/v1/{integrationVersion.name=projects/*/locations/*/integrations/*}:test

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
integrationVersion.name

string

Output only. Auto-generated primary key.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "integrationVersion": {
    "name": string,
    "description": string,
    "taskConfigs": [
      {
        "task": string,
        "taskId": string,
        "parameters": {
          string: {
            object (EventParameter)
          },
          ...
        },
        "failurePolicy": {
          object (FailurePolicy)
        },
        "synchronousCallFailurePolicy": {
          object (FailurePolicy)
        },
        "conditionalFailurePolicies": {
          object (ConditionalFailurePolicies)
        },
        "nextTasks": [
          {
            object (NextTask)
          }
        ],
        "nextTasksExecutionPolicy": enum (NextTasksExecutionPolicy),
        "taskExecutionStrategy": enum (TaskExecutionStrategy),
        "displayName": string,
        "successPolicy": {
          object (SuccessPolicy)
        },
        "jsonValidationOption": enum (JsonValidationOption),
        "description": string,
        "taskTemplate": string,
        "errorCatcherId": string,
        "externalTaskType": enum (ExternalTaskType),
        "position": {
          object (Coordinate)
        }
      }
    ],
    "triggerConfigs": [
      {
        "label": string,
        "startTasks": [
          {
            object (NextTask)
          }
        ],
        "properties": {
          string: string,
          ...
        },
        "triggerType": enum (TriggerType),
        "triggerNumber": string,
        "nextTasksExecutionPolicy": enum (NextTasksExecutionPolicy),
        "triggerId": string,
        "description": string,
        "cloudSchedulerConfig": {
          object (CloudSchedulerConfig)
        },
        "errorCatcherId": string,
        "position": {
          object (Coordinate)
        },
        "trigger": string,
        "inputVariables": {
          object (Variables)
        },
        "outputVariables": {
          object (Variables)
        }
      }
    ],
    "integrationParameters": [
      {
        "key": string,
        "dataType": enum (IntegrationParameterDataType),
        "defaultValue": {
          object (ValueType)
        },
        "searchable": boolean,
        "displayName": string,
        "inputOutputType": enum (InOutType),
        "isTransient": boolean,
        "producer": string,
        "jsonSchema": string,
        "containsLargeData": boolean,
        "masked": boolean,
        "description": string
      }
    ],
    "state": enum (IntegrationState),
    "snapshotNumber": string,
    "updateTime": string,
    "lockHolder": string,
    "createTime": string,
    "lastModifierEmail": string,
    "parentTemplateId": string,
    "userLabel": string,
    "databasePersistencePolicy": enum (DatabasePersistencePolicy),
    "errorCatcherConfigs": [
      {
        "errorCatcherId": string,
        "label": string,
        "errorCatcherNumber": string,
        "startErrorTasks": [
          {
            object (NextTask)
          }
        ],
        "description": string,
        "position": {
          object (Coordinate)
        }
      }
    ],
    "runAsServiceAccount": string,
    "cloudLoggingDetails": {
      "cloudLoggingSeverity": enum (CloudLoggingSeverity),
      "enableCloudLogging": boolean
    },
    "integrationConfigParameters": [
      {
        "parameter": {
          object (IntegrationParameter)
        },
        "value": {
          object (ValueType)
        }
      }
    ],
    "enableVariableMasking": boolean,
    "createdFromTemplate": string
  },
  "triggerId": string,
  "clientId": string,
  "testMode": boolean,
  "deadlineSecondsTime": string,
  "inputParameters": {
    string: {
      object (ValueType)
    },
    ...
  },
  "configParameters": {
    object
  }
}
Fields
integrationVersion.description

string

Optional. The integration description.
integrationVersion.taskConfigs[]

object (TaskConfig)

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

object (TriggerConfig)

Optional. Trigger configurations.
integrationVersion.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.
integrationVersion.state

enum (IntegrationState)

Output only. User should not set it as an input.
integrationVersion.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.
integrationVersion.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".
integrationVersion.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.
integrationVersion.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".
integrationVersion.lastModifierEmail

string

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

string

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

string

Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
integrationVersion.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.
integrationVersion.errorCatcherConfigs[]

object (ErrorCatcherConfig)

Optional. Error Catch Task configuration for the integration. It's optional.
integrationVersion.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.
integrationVersion.cloudLoggingDetails

object (CloudLoggingDetails)

Optional. Cloud Logging details for the integration version
integrationVersion.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.
integrationVersion.enableVariableMasking

boolean

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

string

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

string

Required. The trigger id of the integration trigger config. If both triggerId and clientId is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
clientId

string

Required. This is used to identify the client on whose behalf the event will be executed.
testMode

boolean

Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition "testMode = true". If false, disables tasks with condition "testMode = true" if global test mode (set by platform) is also false {@link EventBusConfig}.
deadlineSecondsTime

string (Timestamp format)

Optional. custom deadline of the rpc

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".
inputParameters

map (key: string, value: object (ValueType))

Optional. Input parameters used during integration execution.
configParameters

object (Struct format)

Optional. Config parameters used during integration execution.

Response body

If successful, the response body contains an instance of TestIntegrationsResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • integrations.integrations.invoke

For more information, see the IAM documentation.