Interface ConnectorDataCollectionMethodType<ConfigFields>

interface ConnectorDataCollectionMethodType<ConfigFields = unknown> {
    name?: string;
    description?: string;
    fileKey?: string;
    getConfigSchema?: (
        args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>,
    ) => DataSchema;
    getInputSchema?: (
        args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>,
    ) => DataSchema;
    getOutputSchema?: (
        args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>,
    ) => DataSchema;
    supportedImplementationTypes: ConnectorMethodImplementationType[];
    isDeprecated?: boolean;
}

Type Parameters

  • ConfigFields = unknown

Properties

name?: string
description?: string
fileKey?: string
getConfigSchema?: (
    args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>,
) => DataSchema
getInputSchema?: (
    args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>,
) => DataSchema
getOutputSchema?: (
    args: ConnectorDataCollectionMethodTypeArgs<ConfigFields>,
) => DataSchema
supportedImplementationTypes: ConnectorMethodImplementationType[]
isDeprecated?: boolean