task_variable

TaskVariable

Bases: TaskVariableTransport

TaskVariable object to interact with task variables specific data integration endpoints.

client class-attribute instance-attribute

client = Field(..., exclude=True)

id instance-attribute

id

Id of task variable.

pool_id instance-attribute

pool_id

Id of data pool where task is located.

task_instance_id property

task_instance_id

Returns task instance id for given task variable.

Returns:

• str –

  Task instance id of task variable.

task_id class-attribute instance-attribute

task_id = Field(alias='taskId')

name class-attribute instance-attribute

name = Field(alias='name')

placeholder class-attribute instance-attribute

placeholder = Field(alias='placeholder')

description class-attribute instance-attribute

description = Field(alias='description')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

dynamic_variable_op_type class-attribute instance-attribute

dynamic_variable_op_type = Field(
    alias="dynamicVariableOpType"
)

data_type class-attribute instance-attribute

data_type = Field(alias='dataType')

dynamic_table class-attribute instance-attribute

dynamic_table = Field(alias='dynamicTable')

dynamic_column class-attribute instance-attribute

dynamic_column = Field(alias='dynamicColumn')

dynamic_data_source_id class-attribute instance-attribute

dynamic_data_source_id = Field(alias='dynamicDataSourceId')

parameter_type class-attribute instance-attribute

parameter_type = Field(alias='parameterType')

default_values class-attribute instance-attribute

default_values = Field(alias='defaultValues')

default_settings class-attribute instance-attribute

default_settings = Field(alias='defaultSettings')

values class-attribute instance-attribute

values = Field(alias='values')

settings class-attribute instance-attribute

settings = Field(alias='settings')

from_transport classmethod

from_transport(client, task_variable_transport)

Creates high-level task variable object from the given TaskVariableTransport.

Parameters:

• client (Client) –

  Client to use to make API calls for given job.

• task_variable_transport (TaskVariableTransport) –

  TaskVariableTransport object containing properties of task.

Returns:

• TaskVariable –

  A TaskVariable object with properties from transport and given client.

update

update()

Pushes local changes of task variable to EMS and updates properties with response from EMS.

delete

delete()

Deletes task variable.