Method: connectorInstances.runOnDemand

Full name: projects.locations.instances.integrations.connectors.connectorInstances.runOnDemand

Run a connector on demand.

HTTP request


Path parameters

Parameters
name

string

Required. The connector instance identifier (from route) Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/integrationInstances/connectors/{connector}/connectorInstances/{connectorInstance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "connector": string,
  "connectorInstance": {
    object (ConnectorInstance)
  }
}
Fields
connector

string

Required. The parent connector identifier (from route)
connectorInstance

object (ConnectorInstance)

Required. The connector instance with values from FE.

Response body

Response for connectorInstances.runOnDemand.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "debugOutput": string,
  "success": boolean,
  "sampleCases": [
    {
      object (SampleCase)
    }
  ]
}
Fields
debugOutput

string

Output only. The execution debug output message
success

boolean

Output only. True if the execution was successful, false if not.
sampleCases[]

object (SampleCase)

Output only. The alerts that were produced by the connector run. Could also be an empty list when no alerts were produced by the connector.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

SampleCase

Sample case.

JSON representation 
{
  "displayName": string,
  "productName": string,
  "startTime": string,
  "endTime": string,
  "eventCount": string,
  "fullCaseInfoAsJson": string
}
Fields
displayName

string

Output only. The display name of the sample case
productName

string

Output only. The product name of the alert
startTime

string (int64 format)

Output only. The start time of the sample case
endTime

string (int64 format)

Output only. The end time of the sample case
eventCount

string (int64 format)

Output only. The number of events in the alert
fullCaseInfoAsJson

string

Output only. The sample case full info represented as json