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:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil) ⇒ Function

Create a new function. You can pass a list of [permissions](appwrite.io/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 a custom ID or generate a random ID with ‘ID.unique()`. 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.

  • runtime (Runtime) —

    Execution runtime.

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

    An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](appwrite.io/docs/permissions#permission-roles). 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) —

    Function maximum execution time in seconds.

  • [] —

    enabled Is function enabled? When set to ‘disabled’, users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.

  • [] —

    logging When disabled, executions will exclude logs and errors, and will be slightly faster.

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

    Entrypoint File. This path is relative to the “providerRootDirectory”.

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

    Build Commands.

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

    List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.

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

    Appwrite Installation ID for VCS (Version Control System) deployment.

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

    Repository ID of the repo linked to the function.

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

    Production branch for the repo linked to the function.

  • [] —

    provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.

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

    Path to function code in the linked repo.

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

    List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.

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

    List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.

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

    Build specification for the function deployments.

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

    Runtime specification for the function executions.

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

    Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.

Returns:

  • (Function) 


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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/appwrite/services/functions.rb', line 69

def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
    api_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 runtime.nil?
      raise Appwrite::Exception.new('Missing required parameter: "runtime"')
    end

    api_params = {
        functionId: function_id,
        name: name,
        runtime: runtime,
        execute: execute,
        events: events,
        schedule: schedule,
        timeout: timeout,
        enabled: enabled,
        logging: logging,
        entrypoint: entrypoint,
        commands: commands,
        scopes: scopes,
        installationId: installation_id,
        providerRepositoryId: provider_repository_id,
        providerBranch: provider_branch,
        providerSilentMode: provider_silent_mode,
        providerRootDirectory: provider_root_directory,
        providerBranches: provider_branches,
        providerPaths: provider_paths,
        buildSpecification: build_specification,
        runtimeSpecification: runtime_specification,
        deploymentRetention: deployment_retention,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

#create_deployment(function_id:, code:, activate:, entrypoint: nil, commands: nil, 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](appwrite.io/docs/functions).

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

Parameters:

  • function_id (String) —

    Function ID.

  • 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.

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

    Entrypoint File.

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

    Build Commands.

Returns:

  • (Deployment) 


394
395
396
397
398
399
400
401
402
403
404
405
406
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
434
 
# File 'lib/appwrite/services/functions.rb', line 394

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

    if function_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "functionId"')
    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

    api_params = {
        entrypoint: entrypoint,
        commands: commands,
        code: code,
        activate: activate,
    }
    
    api_headers = {
        "content-type": 'multipart/form-data',
    }

    id_param_name = nil
    param_name = 'code'

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

end

#create_duplicate_deployment(function_id:, deployment_id:, build_id: nil) ⇒ Deployment

Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment’s code will be preserved and used for the new build.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

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

    Build unique ID.

Returns:

  • (Deployment) 


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
475
476
 
# File 'lib/appwrite/services/functions.rb', line 447

def create_duplicate_deployment(function_id:, deployment_id:, build_id: nil)
    api_path = '/functions/{functionId}/deployments/duplicate'
        .gsub('{functionId}', function_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

    api_params = {
        deploymentId: deployment_id,
        buildId: build_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Deployment
    )

end

#create_execution(function_id:, body: nil, async: nil, xpath: nil, method: nil, headers: nil, scheduled_at: 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.

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

    HTTP body of execution. Default value is empty string.

  • [] —

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

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

    HTTP path of execution. Path can include query params. Default value is /

  • method (ExecutionMethod) (defaults to: nil) —

    HTTP method of execution. Default value is POST.

  • headers (Hash) (defaults to: nil) —

    HTTP headers of execution. Defaults to empty.

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

    Scheduled execution time in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.

Returns:

  • (Execution) 


786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/appwrite/services/functions.rb', line 786

def create_execution(function_id:, body: nil, async: nil, xpath: nil, method: nil, headers: nil, scheduled_at: nil)
    api_path = '/functions/{functionId}/executions'
        .gsub('{functionId}', function_id)

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

    api_params = {
        body: body,
        async: async,
        path: xpath,
        method: method,
        headers: headers,
        scheduledAt: scheduled_at,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

#create_template_deployment(function_id:, repository:, owner:, root_directory:, type:, reference:, activate: nil) ⇒ Deployment

Create a deployment based on a template.

Use this endpoint with combination of [listTemplates](appwrite.io/docs/products/functions/templates) to find the template details.

Parameters:

  • function_id (String) —

    Function ID.

  • repository (String) —

    Repository name of the template.

  • owner (String) —

    The name of the owner of the template.

  • root_directory (String) —

    Path to function code in the template repo.

  • type (TemplateReferenceType) —

    Type for the reference provided. Can be commit, branch, or tag

  • reference (String) —

    Reference value, can be a commit hash, branch name, or release tag

  • [] —

    activate Automatically activate the deployment when it is finished building.

Returns:

  • (Deployment) 


493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/appwrite/services/functions.rb', line 493

def create_template_deployment(function_id:, repository:, owner:, root_directory:, type:, reference:, activate: nil)
    api_path = '/functions/{functionId}/deployments/template'
        .gsub('{functionId}', function_id)

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

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

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

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

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

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

    api_params = {
        repository: repository,
        owner: owner,
        rootDirectory: root_directory,
        type: type,
        reference: reference,
        activate: activate,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Deployment
    )

end

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

Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.

Parameters:

  • function_id (String) —

    Function unique ID.

  • variable_id (String) —

    Variable ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. 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.

  • key (String) —

    Variable key. Max length: 255 chars.

  • value (String) —

    Variable value. Max length: 8192 chars.

  • [] —

    secret Secret variables can be updated or deleted, but only functions can read them during build and runtime.

Returns:

  • (Variable) 


930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/appwrite/services/functions.rb', line 930

def create_variable(function_id:, variable_id:, key:, value:, secret: nil)
    api_path = '/functions/{functionId}/variables'
        .gsub('{functionId}', function_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

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

    api_params = {
        variableId: variable_id,
        key: key,
        value: value,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

#create_vcs_deployment(function_id:, type:, reference:, activate: nil) ⇒ Deployment

Create a deployment when a function is connected to VCS.

This endpoint lets you create deployment from a branch, commit, or a tag.

Parameters:

  • function_id (String) —

    Function ID.

  • type (VCSReferenceType) —

    Type of reference passed. Allowed values are: branch, commit

  • reference (String) —

    VCS reference to create deployment from. Depending on type this can be: branch name, commit hash

  • [] —

    activate Automatically activate the deployment when it is finished building.

Returns:

  • (Deployment) 


554
555
556
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
585
586
587
588
 
# File 'lib/appwrite/services/functions.rb', line 554

def create_vcs_deployment(function_id:, type:, reference:, activate: nil)
    api_path = '/functions/{functionId}/deployments/vcs'
        .gsub('{functionId}', function_id)

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

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

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

    api_params = {
        type: type,
        reference: reference,
        activate: activate,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Deployment
    )

end

#delete(function_id:) ⇒ Object

Delete a function by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

Returns:



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/appwrite/services/functions.rb', line 279

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

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

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_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:



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
658
 
# File 'lib/appwrite/services/functions.rb', line 631

def delete_deployment(function_id:, deployment_id:)
    api_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

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#delete_execution(function_id:, execution_id:) ⇒ Object

Delete a function execution by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • execution_id (String) —

    Execution ID.

Returns:



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/appwrite/services/functions.rb', line 858

def delete_execution(function_id:, execution_id:)
    api_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

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_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:



1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/appwrite/services/functions.rb', line 1054

def delete_variable(function_id:, variable_id:)
    api_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

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#get(function_id:) ⇒ Function

Get a function by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

Returns:

  • (Function) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/appwrite/services/functions.rb', line 174

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

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

    api_params = {
    }
    
    api_headers = {
    }

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

end

#get_deployment(function_id:, deployment_id:) ⇒ Deployment

Get a function deployment by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

Returns:

  • (Deployment) 


596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/appwrite/services/functions.rb', line 596

def get_deployment(function_id:, deployment_id:)
    api_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

    api_params = {
    }
    
    api_headers = {
    }

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

end

#get_deployment_download(function_id:, deployment_id:, type: nil) ⇒ Object

Get a function deployment content by its unique ID. The endpoint response return with a ‘Content-Disposition: attachment’ header that tells the browser to start downloading the file to user downloads directory.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

  • type (DeploymentDownloadType) (defaults to: nil) —

    Deployment file to download. Can be: “source”, “output”.

Returns:



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
694
695
696
 
# File 'lib/appwrite/services/functions.rb', line 669

def get_deployment_download(function_id:, deployment_id:, type: nil)
    api_path = '/functions/{functionId}/deployments/{deploymentId}/download'
        .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

    api_params = {
        type: type,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

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) 


823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/appwrite/services/functions.rb', line 823

def get_execution(function_id:, execution_id:)
    api_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

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_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) 


977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/appwrite/services/functions.rb', line 977

def get_variable(function_id:, variable_id:)
    api_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

    api_params = {
    }
    
    api_headers = {
    }

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

end

#list(queries: nil, search: nil, total: 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId

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

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

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (FunctionList) 


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

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

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
    }

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

end

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

Get a list of all the function’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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type

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

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

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (DeploymentList) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/appwrite/services/functions.rb', line 349

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

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

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
    }

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

end

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

Get a list of all the current user function execution logs. 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (ExecutionList) 


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
 
# File 'lib/appwrite/services/functions.rb', line 746

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

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

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

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

end

#list_runtimes ⇒ RuntimeList

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

Returns:

  • (RuntimeList) 


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

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

    api_params = {
    }
    
    api_headers = {
    }

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

end

#list_specifications ⇒ SpecificationList

List allowed function specifications for this instance.

Returns:

  • (SpecificationList) 


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/appwrite/services/functions.rb', line 150

def list_specifications()
    api_path = '/functions/specifications'

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::SpecificationList
    )

end

#list_variables(function_id:, queries: nil, total: nil) ⇒ VariableList

Get a list of all variables of a specific function.

Parameters:

  • function_id (String) —

    Function unique 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (VariableList) 


894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/appwrite/services/functions.rb', line 894

def list_variables(function_id:, queries: nil, total: nil)
    api_path = '/functions/{functionId}/variables'
        .gsub('{functionId}', function_id)

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

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

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

end

#update(function_id:, name:, runtime: nil, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil) ⇒ Function

Update function by its unique ID.

Parameters:

  • function_id (String) —

    Function ID.

  • name (String) —

    Function name. Max length: 128 chars.

  • runtime (Runtime) (defaults to: nil) —

    Execution runtime.

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

    An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](appwrite.io/docs/permissions#permission-roles). 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? When set to ‘disabled’, users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.

  • [] —

    logging When disabled, executions will exclude logs and errors, and will be slightly faster.

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

    Entrypoint File. This path is relative to the “providerRootDirectory”.

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

    Build Commands.

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

    List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.

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

    Appwrite Installation ID for VCS (Version Controle System) deployment.

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

    Repository ID of the repo linked to the function

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

    Production branch for the repo linked to the function

  • [] —

    provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.

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

    Path to function code in the linked repo.

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

    List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.

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

    List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.

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

    Build specification for the function deployments.

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

    Runtime specification for the function executions.

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

    Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.

Returns:

  • (Function) 


224
225
226
227
228
229
230
231
232
233
234
235
236
237
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
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/appwrite/services/functions.rb', line 224

def update(function_id:, name:, runtime: nil, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, provider_branches: nil, provider_paths: nil, build_specification: nil, runtime_specification: nil, deployment_retention: nil)
    api_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

    api_params = {
        name: name,
        runtime: runtime,
        execute: execute,
        events: events,
        schedule: schedule,
        timeout: timeout,
        enabled: enabled,
        logging: logging,
        entrypoint: entrypoint,
        commands: commands,
        scopes: scopes,
        installationId: installation_id,
        providerRepositoryId: provider_repository_id,
        providerBranch: provider_branch,
        providerSilentMode: provider_silent_mode,
        providerRootDirectory: provider_root_directory,
        providerBranches: provider_branches,
        providerPaths: provider_paths,
        buildSpecification: build_specification,
        runtimeSpecification: runtime_specification,
        deploymentRetention: deployment_retention,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

#update_deployment_status(function_id:, deployment_id:) ⇒ Deployment

Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn’t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status ‘ready’) or failed. The response includes the final build status and details.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

Returns:

  • (Deployment) 


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
 
# File 'lib/appwrite/services/functions.rb', line 708

def update_deployment_status(function_id:, deployment_id:)
    api_path = '/functions/{functionId}/deployments/{deploymentId}/status'
        .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

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Deployment
    )

end

#update_function_deployment(function_id:, deployment_id:) ⇒ Function

Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.

Parameters:

  • function_id (String) —

    Function ID.

  • deployment_id (String) —

    Deployment ID.

Returns:

  • (Function) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/appwrite/services/functions.rb', line 310

def update_function_deployment(function_id:, deployment_id:)
    api_path = '/functions/{functionId}/deployment'
        .gsub('{functionId}', function_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

    api_params = {
        deploymentId: deployment_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

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

Update variable by its unique ID.

Parameters:

  • function_id (String) —

    Function unique ID.

  • variable_id (String) —

    Variable unique ID.

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

    Variable key. Max length: 255 chars.

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

    Variable value. Max length: 8192 chars.

  • [] —

    secret Secret variables can be updated or deleted, but only functions can read them during build and runtime.

Returns:

  • (Variable) 


1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/appwrite/services/functions.rb', line 1015

def update_variable(function_id:, variable_id:, key: nil, value: nil, secret: nil)
    api_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

    api_params = {
        key: key,
        value: value,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end