Interface CogniteFunction

A function in Cognite Functions.

interface CogniteFunction {
    cpu?: number;
    createdTime: Date;
    description?: string;
    envVars?: Record<string, string>;
    error?: FunctionBuildError;
    externalId?: string;
    fileId: number;
    functionPath?: string;
    id: number;
    lastCalled?: Date;
    memory?: number;
    metadata?: Metadata;
    name: string;
    owner?: string;
    runtime?: FunctionRuntime;
    runtimeVersion?: string;
    secrets?: Record<string, string>;
    status: FunctionStatus;
}

Hierarchy (view full)

Properties

cpu? createdTime description? envVars? error? externalId? fileId functionPath? id lastCalled? memory? metadata? name owner? runtime? runtimeVersion? secrets? status

Properties

Optionalcpu

cpu?: number

Number of CPU cores per function.

createdTime

createdTime: Date

The time the function was created in CDF.

Optionaldescription

description?: string

Description of the function.

OptionalenvVars

envVars?: Record<string, string>

Environment variables for the function.

Optionalerror

error?: FunctionBuildError

Error that occurred during function build.

OptionalexternalId

externalId?: string

External ID of the function.

fileId

fileId: number

File ID of the function source code.

OptionalfunctionPath

functionPath?: string

Relative path from the root folder to the file containing the handle function.

id

id: number

A server-generated ID for the function.

OptionallastCalled

lastCalled?: Date

The last time the function was called. Not present if the function has never been called.

Optionalmemory

memory?: number

Memory per function measured in GB.

Optionalmetadata

metadata?: Metadata

Custom metadata for the function.

name

name: string

Name of the function.

Optionalowner

owner?: string

Owner of the function. Typically used to know who created it.

Optionalruntime

runtime?: FunctionRuntime

The runtime of the function.

OptionalruntimeVersion

runtimeVersion?: string

The complete specification of the function runtime with major, minor and patch version numbers.

Optionalsecrets

secrets?: Record<string, string>

Secrets are returned scrambled if set.

status

status: FunctionStatus

Status of the function.

Settings

Member Visibility

On This Page

Properties