Interface Extractor

An extractor instance

interface Extractor {
    description: string;
    documentation?: string;
    externalId: string;
    imageUrl?: string;
    latestVersion?: string;
    links?: Link[];
    name: string;
    tags?: string[];
    type:
        | "global"
        | "community"
        | "unreleased"
        | "hosted";
}

Properties

description documentation? externalId imageUrl? latestVersion? links? name tags? type

Properties

description

description: string

Description Short description of the extractor.

Optionaldocumentation

documentation?: string

Documentation Longer markdown documentation.

externalId

externalId: string

The external ID provided by the client. Must be unique for the resource type.

OptionalimageUrl

imageUrl?: string

Image Url Image URL for extractor logo.

OptionallatestVersion

latestVersion?: string

Latest Version The last released version of the extractor.

Optionallinks

links?: Link[]

Links A list of external links.

name

name: string

Name Name of this extractor.

Optionaltags

tags?: string[]

Tags A list of tags, used for searching and filtering.

type

type:
    | "global"
    | "community"
    | "unreleased"
    | "hosted"

Type Type of extractor. "Global" means that it is globally available and maintained by cognite. "Community" means that it is unofficial and community maintained. "Unreleased" means that it is not yet publicly available and it is visible only as a prerelease or private beta. "Hosted" means it is a hosted extractor that runs as part of the CDF platform.

Settings

Member Visibility

On This Page

Properties