Method: transformers.executeTest

Full name: projects.locations.instances.integrations.transformers.executeTest

Executes a test run of a transformer's Python script. Use this method to verify transformation logic and ensure data is being parsed and formatted correctly before saving or deploying the transformer.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{integration}/transformers:executeTest

Path parameters

Parameters
integration

string

Required. The parent identifier (from route) Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "transformer": {
    object (TransformerDefinition)
  }
}
Fields
transformer

object (TransformerDefinition)

Required. The transformer to test The full transformer is needed as there is an option to run the test without saving the transformer first.

Response body

Response message for ExecuteTest.

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

JSON representation 
{
  "outputMessage": string,
  "debugOutputMessage": string,
  "resultValue": string
}
Fields
outputMessage

string

Output only. Human-readable output message set by the script.
debugOutputMessage

string

Output only. The script debug output.
resultValue

string

Output only. The script result value.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the integration resource:

  • chronicle.transformerDefinitions.execute

For more information, see the IAM documentation.