Type Alias: Function ​
Function =
object
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3326
Function
Properties ​
$createdAt ​
$createdAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3334
Function creation date in ISO 8601 format.
$id ​
$id:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3330
Function ID.
$updatedAt ​
$updatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3338
Function update date in ISO 8601 format.
buildSpecification ​
buildSpecification:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3442
Machine specification for deployment builds.
commands ​
commands:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3414
The build command used to build the deployment.
deploymentCreatedAt ​
deploymentCreatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3374
Active deployment creation date in ISO 8601 format.
deploymentId ​
deploymentId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3370
Function's active deployment ID.
deploymentRetention ​
deploymentRetention:
number
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3366
How many days to keep the non-active deployments before they will be automatically deleted.
enabled ​
enabled:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3350
Function enabled.
entrypoint ​
entrypoint:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3410
The entrypoint file used to execute the deployment.
events ​
events:
string[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3398
Function trigger events.
execute ​
execute:
string[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3342
Execution permissions.
installationId ​
installationId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3422
Function VCS (Version Control System) installation id.
latestDeploymentCreatedAt ​
latestDeploymentCreatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3382
Latest deployment creation date in ISO 8601 format.
latestDeploymentId ​
latestDeploymentId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3378
Function's latest deployment ID.
latestDeploymentStatus ​
latestDeploymentStatus:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3386
Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
live ​
live:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3354
Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.
logging ​
logging:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3358
When disabled, executions will exclude logs and errors, and will be slightly faster.
name ​
name:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3346
Function name.
providerBranch ​
providerBranch:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3430
VCS (Version Control System) branch name
providerRepositoryId ​
providerRepositoryId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3426
VCS (Version Control System) Repository ID
providerRootDirectory ​
providerRootDirectory:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3434
Path to function in VCS (Version Control System) repository
providerSilentMode ​
providerSilentMode:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3438
Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
runtime ​
runtime:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3362
Function execution and build runtime.
runtimeSpecification ​
runtimeSpecification:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3446
Machine specification for executions.
schedule ​
schedule:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3402
Function execution schedule in CRON format.
scopes ​
scopes:
string[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3390
Allowed permission scopes.
timeout ​
timeout:
number
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3406
Function execution timeout in seconds.
vars ​
vars:
Variable[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3394
Function variables.
version ​
version:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3418
Version of Open Runtimes used for the function.