transformer

Documentation

Index

• Constants
• func GetVersion() (transformerBuildVersion string)
• func Init()
• type HandleT
  • func NewTransformer() *HandleT
  • func (trans *HandleT) Setup()
  • func (trans *HandleT) Transform(ctx context.Context, clientEvents []TransformerEventT, url string, ...) ResponseT
  • func (trans *HandleT) Validate(clientEvents []TransformerEventT, url string, batchSize int) ResponseT
• type MetadataT
• type ResponseT
• type Transformer
• type TransformerEventT
• type TransformerResponseT
• type ValidationErrorT

Constants

const (
	UserTransformerStage        = "user_transformer"
	EventFilterStage            = "event_filter"
	DestTransformerStage        = "dest_transformer"
	TrackingPlanValidationStage = "trackingPlan_validation"
)

Functions

func GetVersion

func GetVersion() (transformerBuildVersion string)

GetVersion gets the transformer version by asking it on /transfomerBuildVersion. if there is any error it returns empty string

func Init

func Init()

Types

type HandleT

type HandleT struct {
	Client *http.Client
	// contains filtered or unexported fields
}

HandleT is the handle for this class

func NewTransformer

func NewTransformer() *HandleT

NewTransformer creates a new transformer

func (*HandleT) Setup

func (trans *HandleT) Setup()

Setup initializes this class

func (*HandleT) Transform

func (trans *HandleT) Transform(ctx context.Context, clientEvents []TransformerEventT,
	url string, batchSize int,
) ResponseT

Transform function is used to invoke transformer API

func (*HandleT) Validate

func (trans *HandleT) Validate(clientEvents []TransformerEventT,
	url string, batchSize int,
) ResponseT

type MetadataT

type MetadataT struct {
	SourceID            string                            `json:"sourceId"`
	WorkspaceID         string                            `json:"workspaceId"`
	Namespace           string                            `json:"namespace"`
	InstanceID          string                            `json:"instanceId"`
	SourceType          string                            `json:"sourceType"`
	SourceCategory      string                            `json:"sourceCategory"`
	TrackingPlanId      string                            `json:"trackingPlanId"`
	TrackingPlanVersion int                               `json:"trackingPlanVersion"`
	SourceTpConfig      map[string]map[string]interface{} `json:"sourceTpConfig"`
	MergedTpConfig      map[string]interface{}            `json:"mergedTpConfig"`
	DestinationID       string                            `json:"destinationId"`
	JobRunID            string                            `json:"jobRunId"`
	JobID               int64                             `json:"jobId"`
	SourceBatchID       string                            `json:"sourceBatchId"`
	SourceJobID         string                            `json:"sourceJobId"`
	SourceJobRunID      string                            `json:"sourceJobRunId"`
	SourceTaskID        string                            `json:"sourceTaskId"`
	SourceTaskRunID     string                            `json:"sourceTaskRunId"`
	RecordID            interface{}                       `json:"recordId"`
	DestinationType     string                            `json:"destinationType"`
	MessageID           string                            `json:"messageId"`
	OAuthAccessToken    string                            `json:"oauthAccessToken"`
	// set by user_transformer to indicate transformed event is part of group indicated by messageIDs
	MessageIDs              []string `json:"messageIds"`
	RudderID                string   `json:"rudderId"`
	ReceivedAt              string   `json:"receivedAt"`
	EventName               string   `json:"eventName"`
	EventType               string   `json:"eventType"`
	SourceDefinitionID      string   `json:"sourceDefinitionId"`
	DestinationDefinitionID string   `json:"destinationDefinitionId"`
}

type ResponseT

type ResponseT struct {
	Events       []TransformerResponseT
	FailedEvents []TransformerResponseT
}

ResponseT represents a Transformer response

type Transformer

type Transformer interface {
	Setup()
	Transform(ctx context.Context, clientEvents []TransformerEventT, url string, batchSize int) ResponseT
	Validate(clientEvents []TransformerEventT, url string, batchSize int) ResponseT
}

Transformer provides methods to transform events

type TransformerEventT

type TransformerEventT struct {
	Message     types.SingularEventT       `json:"message"`
	Metadata    MetadataT                  `json:"metadata"`
	Destination backendconfig.DestinationT `json:"destination"`
	Libraries   []backendconfig.LibraryT   `json:"libraries"`
}

type TransformerResponseT

type TransformerResponseT struct {
	// Not marking this Singular Event, since this not a RudderEvent
	Output           map[string]interface{} `json:"output"`
	Metadata         MetadataT              `json:"metadata"`
	StatusCode       int                    `json:"statusCode"`
	Error            string                 `json:"error"`
	ValidationErrors []ValidationErrorT     `json:"validationErrors"`
}

type ValidationErrorT

type ValidationErrorT struct {
	Type    string            `json:"type"`
	Message string            `json:"message"`
	Meta    map[string]string `json:"meta"`
}