syncano.models.incentives¶

class RuntimeChoices[source]¶

Bases: object

Store available Script runtimes;

PYTHON = 'python'¶

PYTHON_V4_2 = 'python_library_v4.2'¶

PYTHON_V5_0 = 'python_library_v5.0'¶

NODEJS = 'nodejs'¶

NODEJS_V0_4 = 'nodejs_library_v0.4'¶

NODEJS_V1_0 = 'nodejs_library_v1.0'¶

GOLANG = 'golang'¶

SWIFT = 'swift'¶

PHP = 'php'¶

RUBY = 'ruby'¶

class Script(**kwargs)[source]¶

Bases: syncano.models.archetypes.Model

OO wrapper around scripts link.

Variables:	label – `StringField` description – `StringField` source – `StringField` runtime_name – `ChoiceField` config – `Field` links – `HyperlinkedField` created_at – `DateTimeField` updated_at – `DateTimeField`

Note

Script has special method called run which will execute attached source code:

>>> Script.please.run('instance-name', 1234)
>>> Script.please.run('instance-name', 1234, payload={'variable_one': 1, 'variable_two': 2})
>>> Script.please.run('instance-name', 1234, payload='{"variable_one": 1, "variable_two": 2}')

or via instance:

>>> s = Script.please.get('instance-name', 1234)
>>> s.run()
>>> s.run(variable_one=1, variable_two=2)

label = None¶

description = None¶

source = None¶

runtime_name = None¶

config = None¶

links = None¶

created_at = None¶

updated_at = None¶

traces¶

please¶

run(**payload)[source]¶

Usage:

>>> s = Script.please.get('instance-name', 1234)
>>> s.run()
>>> s.run(variable_one=1, variable_two=2)

DoesNotExist¶: alias of ScriptDoesNotExist

id = None¶

instance_name = None¶

pk = None¶

class Schedule(**kwargs)[source]¶

Bases: syncano.models.archetypes.Model

OO wrapper around script schedules link.

Variables:	label – `StringField` script – `IntegerField` interval_sec – `IntegerField` crontab – `StringField` payload – `HyperliStringFieldnkedField` created_at – `DateTimeField` scheduled_next – `DateTimeField` links – `HyperlinkedField`

label = None¶

script = None¶

interval_sec = None¶

crontab = None¶

payload = None¶

timezone = None¶

created_at = None¶

scheduled_next = None¶

links = None¶

traces¶

DoesNotExist¶: alias of ScheduleDoesNotExist

id = None¶

instance_name = None¶

pk = None¶

please¶

class Trigger(**kwargs)[source]¶

Bases: syncano.models.archetypes.Model

OO wrapper around triggers link.

Variables:	label – `StringField` script – `IntegerField` class_name – `StringField` signal – `ChoiceField` links – `HyperlinkedField` created_at – `DateTimeField` updated_at – `DateTimeField`

SIGNAL_CHOICES = ({'display_name': 'post_update', 'value': 'post_update'}, {'display_name': 'post_create', 'value': 'post_create'}, {'display_name': 'post_delete', 'value': 'post_delete'})¶

label = None¶

script = None¶

class_name = None¶

signal = None¶

links = None¶

created_at = None¶

updated_at = None¶

traces¶

DoesNotExist¶: alias of TriggerDoesNotExist

id = None¶

instance_name = None¶

pk = None¶

please¶

class ScriptEndpoint(**kwargs)[source]¶

Bases: syncano.models.archetypes.Model

OO wrapper around script endpoints link.

Variables:	name – `SlugField` script – `IntegerField` links – `HyperlinkedField`

Note

ScriptEndpoint has special method called run which will execute related script:

>>> ScriptEndpoint.please.run('instance-name', 'script-name')
>>> ScriptEndpoint.please.run('instance-name', 'script-name', payload={'variable_one': 1,
                                                                       'variable_two': 2})
>>> ScriptEndpoint.please.run('instance-name', 'script-name',
                       payload="{"variable_one": 1, "variable_two": 2}")

or via instance:

>>> se = ScriptEndpoint.please.get('instance-name', 'script-name')
>>> se.run()
>>> se.run(variable_one=1, variable_two=2)

name = None¶

script = None¶

public = None¶

public_link = None¶

links = None¶

traces¶

please¶

run(cache_key=None, **payload)[source]¶

Usage:

>>> se = ScriptEndpoint.please.get('instance-name', 'script-name')
>>> se.run()
>>> se.run(variable_one=1, variable_two=2)

reset_link()[source]¶

Usage:

>>> se = ScriptEndpoint.please.get('instance-name', 'script-name')
>>> se.reset_link()

DoesNotExist¶: alias of ScriptEndpointDoesNotExist

instance_name = None¶

pk = None¶

class ResponseTemplate(**kwargs)[source]¶

Bases: syncano.models.mixins.RenameMixin, syncano.models.archetypes.Model

OO wrapper around templates.

Variables:	name – `StringField` content – `StringField` content_type – `StringField` context – `JSONField` links – `HyperlinkedField` created_at – `DateTimeField` updated_at – `DateTimeField`

name = None¶

content = None¶

content_type = None¶

context = None¶

links = None¶

created_at = None¶

updated_at = None¶

render(context=None)[source]¶

rename(new_name)[source]¶

DoesNotExist¶: alias of ResponseTemplateDoesNotExist

id = None¶

instance_name = None¶

pk = None¶

please¶