Skip to content

pool_variable

PoolVariable

Bases: PoolVariableTransport

PoolVariable object to interact with data pool variable specific data integration endpoints.

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')

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')

client class-attribute instance-attribute

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

id instance-attribute

id

Id of pool variable.

pool_id instance-attribute

pool_id

Id of data pool to which pool variable corresponds.

name instance-attribute

name

Name of pool variable.

from_transport classmethod

from_transport(client, pool_variable_transport)

Creates high-level data pool variable object from the given PoolVariableTransport.

Parameters:

  • client (Client) –

    Client to use to make API calls for given job.

  • pool_variable_transport (PoolVariableTransport) –

    PoolVariableTransport object containing properties of pool variable.

Returns:

  • PoolVariable

    A PoolVariable object with properties from transport and given client.

update

update()

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

delete

delete()

Deletes pool variable.