Interface ExternalCogniteFunction

interface ExternalCogniteFunction {
    cpu?: number;
    description?: string;
    envVars?: Record<string, string>;
    externalId?: string;
    fileId: number;
    functionPath?: string;
    memory?: number;
    metadata?: Metadata;
    name: string;
    owner?: string;
    runtime?: FunctionRuntime;
    secrets?: Record<string, string>;
}

Hierarchy (view full)

Properties

cpu? description? envVars? externalId? fileId functionPath? memory? metadata? name owner? runtime? secrets?

Properties

Optionalcpu

cpu?: number

Number of CPU cores per function.

Optionaldescription

description?: string

Description of the function.

OptionalenvVars

envVars?: Record<string, string>

Environment variables for the function.

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.

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.

Optionalsecrets

secrets?: Record<string, string>

Secrets are returned scrambled if set.

Settings

Member Visibility

On This Page

Properties