Class: Appwrite::Functions

Inherits:
Service
  • Object
show all
Defined in:
lib/appwrite/services/functions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Functions

Returns a new instance of Functions.



6
7
8
 
# File 'lib/appwrite/services/functions.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#create(function_id:, name:, execute:, runtime:, events: nil, schedule: nil, timeout: nil, enabled: nil) ⇒ Function

Create a new function. You can pass a list of [permissions](/docs/permissions) to allow different project users or team with access to execute the function using the client API.

Parameters:

  • function_id (String) —

    Function ID. Choose your own unique ID or pass the string “unique()” to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • name (String) —

    Function name. Max length: 128 chars.

  • execute (Array) —

    An array of strings with execution roles. By default no user is granted with any execute permissions. [learn more about permissions](appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 64 characters long.

  • runtime (String) —

    Execution runtime.

  • events (Array) (defaults to: nil) —

    Events list. Maximum of 100 events are allowed.

  • schedule (String) (defaults to: nil) —

    Schedule CRON syntax.

  • timeout (Integer) (defaults to: nil) —

    Function maximum execution time in seconds.

  • [] —

    enabled Is function enabled?

Returns:

  • (Function) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/appwrite/services/functions.rb', line 53

def create(function_id:, name:, execute:, runtime:, events: nil, schedule: nil, timeout: nil, enabled: nil)
    path = '/functions'

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    if execute.nil?
      raise Appwrite::Exception.new('Missing required parameter: "execute"')
    end

    if runtime.nil?
      raise Appwrite::Exception.new('Missing required parameter: "runtime"')
    end

    params = {
        functionId: function_id,
        name: name,
        execute: execute,
        runtime: runtime,
        events: events,
        schedule: schedule,
        timeout: timeout,
        enabled: enabled,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Function
    )
end

#create_deployment(function_id:, entrypoint:, code:, activate:, on_progress: nil) ⇒ Deployment

Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you’ll need to update the function’s deployment to use your new deployment UID.

This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](/docs/functions).

Use the “command” param to set the entry point used to execute your code.

Parameters:

  • function_id (String) —

    Function ID.

  • entrypoint (String) —

    Entrypoint File.

  • code (file) —

    Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.

  • [] —

    activate Automatically activate the deployment when it is finished building.

Returns:

  • (Deployment) 


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/appwrite/services/functions.rb', line 282

def create_deployment(function_id:, entrypoint:, code:, activate:, on_progress: nil)
    path = '/functions/{functionId}/deployments'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if entrypoint.nil?
      raise Appwrite::Exception.new('Missing required parameter: "entrypoint"')
    end

    if code.nil?
      raise Appwrite::Exception.new('Missing required parameter: "code"')
    end

    if activate.nil?
      raise Appwrite::Exception.new('Missing required parameter: "activate"')
    end

    params = {
        entrypoint: entrypoint,
        code: code,
        activate: activate,
    }
    
    headers = {
        "content-type": 'multipart/form-data',
    }

    id_param_name = nil
    param_name = 'code'

    @client.chunked_upload(
        path: path,
        headers: headers,
        params: params,
        param_name: param_name,
        id_param_name: id_param_name,
        on_progress: on_progress,
        response_type: Models::Deployment
    )
end

#create_execution(function_id:, data: nil, async: nil) ⇒ Execution

Trigger a function execution. The returned object will return you the current execution status. You can ping the ‘Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.

Parameters:

  • function_id (String) —

    Function ID.

  • data (String) (defaults to: nil) —

    String of custom data to send to function.

  • [] —

    async Execute code in the background. Default value is false.

Returns:

  • (Execution) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/appwrite/services/functions.rb', line 524

def create_execution(function_id:, data: nil, async: nil)
    path = '/functions/{functionId}/executions'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    params = {
        data: data,
        async: async,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Execution
    )
end

#create_variable(function_id:, key:, value:) ⇒ Variable

Create a new function variable. These variables can be accessed within function in the ‘env` object under the request variable.

Parameters:

  • function_id (String) —

    Function unique ID.

  • key (String) —

    Variable key. Max length: 255 chars.

  • value (String) —

    Variable value. Max length: 8192 chars.

Returns:

  • (Variable) 


625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/appwrite/services/functions.rb', line 625

def create_variable(function_id:, key:, value:)
    path = '/functions/{functionId}/variables'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if value.nil?
      raise Appwrite::Exception.new('Missing required parameter: "value"')
    end

    params = {
        key: key,
        value: value,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Variable
    )
end

#delete(function_id:) ⇒ Object

Delete a function by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/appwrite/services/functions.rb', line 206

def delete(function_id:)
    path = '/functions/{functionId}'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: path,
        headers: headers,
        params: params,
    )
end

#delete_deployment(function_id:, deployment_id:) ⇒ Object

Delete a code deployment by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

Returns:



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/appwrite/services/functions.rb', line 407

def delete_deployment(function_id:, deployment_id:)
    path = '/functions/{functionId}/deployments/{deploymentId}'
        .gsub('{functionId}', function_id)
        .gsub('{deploymentId}', deployment_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if deployment_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: path,
        headers: headers,
        params: params,
    )
end

#delete_variable(function_id:, variable_id:) ⇒ Object

Delete a variable by its unique ID.

Parameters:

  • function_id (String) —

    Function unique ID.

  • variable_id (String) —

    Variable unique ID.

Returns:



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/appwrite/services/functions.rb', line 746

def delete_variable(function_id:, variable_id:)
    path = '/functions/{functionId}/variables/{variableId}'
        .gsub('{functionId}', function_id)
        .gsub('{variableId}', variable_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if variable_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "variableId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: path,
        headers: headers,
        params: params,
    )
end

#get(function_id:) ⇒ Function

Get a function by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

Returns:

  • (Function) 


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/appwrite/services/functions.rb', line 126

def get(function_id:)
    path = '/functions/{functionId}'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Function
    )
end

#get_deployment(function_id:, deployment_id:) ⇒ Deployment

Get a code deployment by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

Returns:

  • (Deployment) 


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/appwrite/services/functions.rb', line 333

def get_deployment(function_id:, deployment_id:)
    path = '/functions/{functionId}/deployments/{deploymentId}'
        .gsub('{functionId}', function_id)
        .gsub('{deploymentId}', deployment_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if deployment_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Deployment
    )
end

#get_execution(function_id:, execution_id:) ⇒ Execution

Get a function execution log by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • execution_id (String) —

    Execution ID.

Returns:

  • (Execution) 


557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/appwrite/services/functions.rb', line 557

def get_execution(function_id:, execution_id:)
    path = '/functions/{functionId}/executions/{executionId}'
        .gsub('{functionId}', function_id)
        .gsub('{executionId}', execution_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if execution_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "executionId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Execution
    )
end

#get_variable(function_id:, variable_id:) ⇒ Variable

Get a variable by its unique ID.

Parameters:

  • function_id (String) —

    Function unique ID.

  • variable_id (String) —

    Variable unique ID.

Returns:

  • (Variable) 


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/appwrite/services/functions.rb', line 666

def get_variable(function_id:, variable_id:)
    path = '/functions/{functionId}/variables/{variableId}'
        .gsub('{functionId}', function_id)
        .gsub('{variableId}', variable_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if variable_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "variableId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Variable
    )
end

#list(queries: nil, search: nil) ⇒ FunctionList

Get a list of all the project’s functions. You can use the query params to filter your results.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

Returns:

  • (FunctionList) 


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/appwrite/services/functions.rb', line 17

def list(queries: nil, search: nil)
    path = '/functions'

    params = {
        queries: queries,
        search: search,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::FunctionList
    )
end

#list_deployments(function_id:, queries: nil, search: nil) ⇒ DeploymentList

Get a list of all the project’s code deployments. You can use the query params to filter your results.

Parameters:

  • function_id (String) —

    Function ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: entrypoint, size, buildId, activate

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

Returns:

  • (DeploymentList) 


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/appwrite/services/functions.rb', line 238

def list_deployments(function_id:, queries: nil, search: nil)
    path = '/functions/{functionId}/deployments'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    params = {
        queries: queries,
        search: search,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::DeploymentList
    )
end

#list_executions(function_id:, queries: nil, search: nil) ⇒ ExecutionList

Get a list of all the current user function execution logs. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project’s executions. [Learn more about different API modes](/docs/admin).

Parameters:

  • function_id (String) —

    Function ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, statusCode, duration

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

Returns:

  • (ExecutionList) 


487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/appwrite/services/functions.rb', line 487

def list_executions(function_id:, queries: nil, search: nil)
    path = '/functions/{functionId}/executions'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    params = {
        queries: queries,
        search: search,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::ExecutionList
    )
end

#list_runtimes ⇒ RuntimeList

Get a list of all runtimes that are currently active on your instance.

Returns:

  • (RuntimeList) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/appwrite/services/functions.rb', line 101

def list_runtimes()
    path = '/functions/runtimes'

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::RuntimeList
    )
end

#list_variables(function_id:) ⇒ VariableList

Get a list of all variables of a specific function.

Parameters:

  • function_id (String) —

    Function unique ID.

Returns:

  • (VariableList) 


592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/appwrite/services/functions.rb', line 592

def list_variables(function_id:)
    path = '/functions/{functionId}/variables'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'GET',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::VariableList
    )
end

#retry_build(function_id:, deployment_id:, build_id:) ⇒ Object

Returns [].

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

  • build_id (String) —

    Build unique ID.

Returns:



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/appwrite/services/functions.rb', line 443

def retry_build(function_id:, deployment_id:, build_id:)
    path = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'
        .gsub('{functionId}', function_id)
        .gsub('{deploymentId}', deployment_id)
        .gsub('{buildId}', build_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if deployment_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
    end

    if build_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "buildId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: path,
        headers: headers,
        params: params,
    )
end

#update(function_id:, name:, execute:, events: nil, schedule: nil, timeout: nil, enabled: nil) ⇒ Function

Update function by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • name (String) —

    Function name. Max length: 128 chars.

  • execute (Array) —

    An array of strings with execution roles. By default no user is granted with any execute permissions. [learn more about permissions](appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 64 characters long.

  • events (Array) (defaults to: nil) —

    Events list. Maximum of 100 events are allowed.

  • schedule (String) (defaults to: nil) —

    Schedule CRON syntax.

  • timeout (Integer) (defaults to: nil) —

    Maximum execution time in seconds.

  • [] —

    enabled Is function enabled?

Returns:

  • (Function) 


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/appwrite/services/functions.rb', line 162

def update(function_id:, name:, execute:, events: nil, schedule: nil, timeout: nil, enabled: nil)
    path = '/functions/{functionId}'
        .gsub('{functionId}', function_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    if execute.nil?
      raise Appwrite::Exception.new('Missing required parameter: "execute"')
    end

    params = {
        name: name,
        execute: execute,
        events: events,
        schedule: schedule,
        timeout: timeout,
        enabled: enabled,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Function
    )
end

#update_deployment(function_id:, deployment_id:) ⇒ Function

Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

Returns:

  • (Function) 


371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/appwrite/services/functions.rb', line 371

def update_deployment(function_id:, deployment_id:)
    path = '/functions/{functionId}/deployments/{deploymentId}'
        .gsub('{functionId}', function_id)
        .gsub('{deploymentId}', deployment_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if deployment_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "deploymentId"')
    end

    params = {
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Function
    )
end

#update_variable(function_id:, variable_id:, key:, value: nil) ⇒ Variable

Update variable by its unique ID.

Parameters:

  • function_id (String) —

    Function unique ID.

  • variable_id (String) —

    Variable unique ID.

  • key (String) —

    Variable key. Max length: 255 chars.

  • value (String) (defaults to: nil) —

    Variable value. Max length: 8192 chars.

Returns:

  • (Variable) 


704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/appwrite/services/functions.rb', line 704

def update_variable(function_id:, variable_id:, key:, value: nil)
    path = '/functions/{functionId}/variables/{variableId}'
        .gsub('{functionId}', function_id)
        .gsub('{variableId}', variable_id)

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    end

    if variable_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "variableId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    params = {
        key: key,
        value: value,
    }
    
    headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: path,
        headers: headers,
        params: params,
        response_type: Models::Variable
    )
end