REST Resource: projects.locations.instances.integrations.transformers

Resource: TransformerDefinition

This resource describes the transformer's definition.

JSON representation 
{
  "name": string,
  "displayName": string,
  "script": string,
  "author": string,
  "description": string,
  "version": number,
  "type": enum (TransformerType),
  "scriptTimeout": string,
  "parameters": [
    {
      object (TransformerDefinitionParameter)
    }
  ],
  "usageExample": string,
  "expectedOutput": string,
  "expectedInput": string,
  "integration": string,
  "enabled": boolean,
  "custom": boolean
}
Fields
name

string

Identifier. The unique name(ID) of the transformer. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/transformers/{transformer}
displayName

string

Required. Transformer's display name, limited to a maximum of 150 characters
script

string

Required. Transformer's script.
author

string

Output only. User that created the transformer in the system.
description

string

Optional. Transformer's description, limited to a maximum of 2050 characters.
version

number

Output only. The version of the transformer
type

enum (TransformerType)

Output only. The type of the transformer.
scriptTimeout

string (int64 format)

Required. Set the timeout in seconds of a single Python script run (default 60).
parameters[]

object (TransformerDefinitionParameter)

Optional. The transformer's parameters definition.
usageExample

string

Optional. Transformer's usage example.
expectedOutput

string

Optional. Transformer's expected output.
expectedInput

string

Optional. Transformer's expected input.
integration

string

Output only. Parent integration identifier.
enabled

boolean

Required. Determines whether the transformer is disabled or enabled.
custom

boolean

Output only. Determines if the transformer is a custom transformer.

TransformerType

Transformer type

Enums
TRANSFORMER_TYPE_UNSPECIFIED Unspecified type.
BUILT_IN Built-in transformer.
CUSTOM Custom transformer.

TransformerDefinitionParameter

Represents a parameter for a Transformer Definition.

JSON representation 
{
  "id": string,
  "transformerDefinitionId": string,
  "mandatory": boolean,
  "defaultValue": string,
  "displayName": string,
  "description": string,
  "order": integer
}
Fields
id

string (int64 format)

Optional. The parameter's id. This is server-generated upon parameter creation. It must be provided when updating an existing parameter.
transformerDefinitionId

string (int64 format)

Output only. Transformer's definition id.
mandatory

boolean

Required. Indicates whether this parameter is mandatory for configuring a transformer instance.
defaultValue

string

Optional. The default value of the parameter. The defaultValue is required for booleans / mandatory parameters.
displayName

string

Required. The parameter's display name. Item name may contain letters (a-z), numbers (0-9), underscores (_). Max length of 150 characters.
description

string

Optional. The parameter's description (max length of 2050 characters).
order

integer

Output only. The parameters' display order, relevant only for built-in transformers.

Methods

create

 Creates a new TransformerDefinition within an integration.

delete

 Deletes a custom TransformerDefinition.

executeTest

 Executes a test run of a transformer's Python script.

fetchTemplate

 Retrieves a default Python script template for a new transformer.

get

 Gets a single TransformerDefinition.

list

 Lists all TransformerDefinitions for a specific integration.

patch

 Updates an existing TransformerDefinition.