Skip to main content
Version: 7.0.0

GeoprocessingHandlerOptions

Extended by

Properties

description

description: string;

Appears in service metadata


executionMode

executionMode: ExecutionMode;

Choose sync for functions that are expected to return quickly (< 2s) and async for longer running functions, especially contain/docker jobs.


issAllowList?

optional issAllowList: string[];

List domains, e.g. myproject.seasketch.org. When restrictedAccess is enabled, this function can be configured to only work with specified projects.


memory?

optional memory: number;

Megabytes, 128 - 3008


rateLimit?

optional rateLimit: number;

rateLimited?

optional rateLimited: boolean;

Whether to rate limit beyond basic DDoS protection


rateLimitPeriod?

optional rateLimitPeriod: RateLimitPeriod;

daily or monthly


requiresProperties?

optional requiresProperties: string[];

Specify the ids of any Sketch Class form fields that must be provided in order to run the function


restrictedAccess?

optional restrictedAccess: boolean;

Whether function should respect group access-control headers


timeout

timeout: number;

Seconds


title

title: string;

Title will appear in service metadata and be referenced by clients


workers?

optional workers: string[];

Names of worker functions used by this function. Must be sync geoprocessing functions