variable

Variable

Bases: VariableMetadata

Variable object to interact with variable specific endpoints.

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

client class-attribute instance-attribute

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

id instance-attribute

id

Id of variable.

display_name instance-attribute

display_name

Display name of variable.

value instance-attribute

value

Value of variable.

knowledge_model_id instance-attribute

knowledge_model_id

Id of knowledge model where variable is located.

from_transport classmethod

from_transport(
    client, knowledge_model_id, variable_transport
)

Creates high-level Variable object from given VariableMetadata.

Parameters:

• client (Client) –

  Client to use to make API calls for given variable.

• knowledge_model_id (str) –

  Id of knowledge model where variable is located.

• variable_transport (VariableMetadata) –

  VariableMetadata object containing properties of variable.

Returns:

• Variable –

  A Variable object with properties from transport and given client.

update

update()

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

sync

sync()

Syncs variable properties with EMS.

delete

delete()

Deletes variable.