sift_client.sift_types ¶

MODULE	DESCRIPTION
`asset`
`calculated_channel`
`channel`
`ingestion`
`rule`
`run`

CLASS	DESCRIPTION
`Asset`	Model of the Sift Asset.
`AssetUpdate`	Model of the Asset Fields that can be updated.
`CalculatedChannel`	Model of the Sift Calculated Channel.
`CalculatedChannelUpdate`	Model of the Calculated Channel Fields that can be updated.
`Channel`	Model representing a Sift Channel.
`ChannelBitFieldElement`	Bit field element model.
`ChannelDataType`	Enum for channel data types (mimics protobuf values, but as int for now).
`ChannelReference`	Channel reference for calculated channel or rule.
`IngestionConfig`	Model of the Sift Ingestion Config.
`Rule`	Model of the Sift Rule.
`RuleAction`	Model of a Rule Action.
`RuleActionType`	Enum for rule action kinds.
`RuleAnnotationType`	Enum for rule annotation types.
`RuleUpdate`	Model of the Rule fields that can be updated.
`RuleVersion`	Model of a Rule Version.
`Run`	Run model representing a data collection run.
`RunUpdate`	Update model for Run.

all `module-attribute` ¶

__all__ = [
    "Asset",
    "AssetUpdate",
    "CalculatedChannel",
    "CalculatedChannelUpdate",
    "Channel",
    "ChannelBitFieldElement",
    "ChannelDataType",
    "ChannelReference",
    "IngestionConfig",
    "Rule",
    "RuleAction",
    "RuleActionType",
    "RuleAnnotationType",
    "RuleUpdate",
    "RuleVersion",
    "Run",
    "RunUpdate",
]

Asset ¶

Bases: BaseType[Asset, 'Asset']

Model of the Sift Asset.

METHOD	DESCRIPTION
`archive`	Archive the asset.
`channels`	Get the channels for this asset.
`update`	Update the Asset.

ATTRIBUTE	DESCRIPTION
`annotations`	Get the annotations for this asset.
`archived_date`	TYPE: `datetime \| None`
`created_by`	Get the user that created this asset.
`created_by_user_id`	TYPE: `str`
`created_date`	TYPE: `datetime`
`is_archived`	Whether the asset is archived.
`metadata`	TYPE: `dict[str, str \| float \| bool]`
`modified_by`	Get the user that modified this asset.
`modified_by_user_id`	TYPE: `str`
`modified_date`	TYPE: `datetime`
`name`	TYPE: `str`
`organization_id`	TYPE: `str`
`rules`	Get the rules that apply to this asset.
`runs`	Get the runs associated with this asset. TYPE: `list[Run]`
`tags`	TYPE: `list[str]`

annotations `property` ¶

annotations

Get the annotations for this asset.

archived_date `instance-attribute` ¶

archived_date: datetime | None

created_by `property` ¶

created_by

Get the user that created this asset.

created_by_user_id `instance-attribute` ¶

created_by_user_id: str

created_date `instance-attribute` ¶

created_date: datetime

is_archived `property` ¶

is_archived

Whether the asset is archived.

metadata `instance-attribute` ¶

metadata: dict[str, str | float | bool]

modified_by `property` ¶

modified_by

Get the user that modified this asset.

modified_by_user_id `instance-attribute` ¶

modified_by_user_id: str

modified_date `instance-attribute` ¶

modified_date: datetime

name `instance-attribute` ¶

name: str

organization_id `instance-attribute` ¶

organization_id: str

rules `property` ¶

rules

Get the rules that apply to this asset.

runs `property` ¶

runs: list[Run]

Get the runs associated with this asset.

tags `instance-attribute` ¶

tags: list[str]

archive ¶

archive(*, archive_runs: bool = False) -> Asset

Archive the asset.

PARAMETER	DESCRIPTION
`archive_runs`	If True, archive all Runs associated with the Asset. TYPE: `bool` DEFAULT: `False`

channels ¶

channels(
    run_id: str | None = None, limit: int | None = None
) -> list[Channel]

Get the channels for this asset.

update ¶

update(update: AssetUpdate | dict) -> Asset

Update the Asset.

PARAMETER	DESCRIPTION
`update`	Either an AssetUpdate instance or a dictionary of key-value pairs to update. TYPE: `AssetUpdate \| dict`

AssetUpdate ¶

AssetUpdate(**data: Any)

Bases: ModelUpdate[Asset]

Model of the Asset Fields that can be updated.

ATTRIBUTE	DESCRIPTION
`archived_date`	TYPE: `datetime \| str \| None`
`metadata`	TYPE: `dict[str, str \| float \| bool] \| None`
`tags`	TYPE: `list[str] \| None`

archived_date `class-attribute` `instance-attribute` ¶

archived_date: datetime | str | None = None

metadata `class-attribute` `instance-attribute` ¶

metadata: dict[str, str | float | bool] | None = None

tags `class-attribute` `instance-attribute` ¶

tags: list[str] | None = None

CalculatedChannel ¶

Bases: BaseType[CalculatedChannel, 'CalculatedChannel']

Model of the Sift Calculated Channel.

METHOD	DESCRIPTION
`archive`	Archive the calculated channel.
`update`	Update the Calculated Channel.

ATTRIBUTE	DESCRIPTION
`all_assets`	TYPE: `bool \| None`
`archived_date`	TYPE: `datetime \| None`
`asset_ids`	TYPE: `list[str] \| None`
`change_message`	TYPE: `str \| None`
`channel_references`	TYPE: `list[ChannelReference]`
`client_key`	TYPE: `str \| None`
`created_by`	Get the user that created this calculated channel.
`created_by_user_id`	TYPE: `str \| None`
`created_date`	TYPE: `datetime \| None`
`description`	TYPE: `str`
`expression`	TYPE: `str`
`is_archived`	Whether the calculated channel is archived.
`modified_by`	Get the user that modified this calculated channel.
`modified_by_user_id`	TYPE: `str \| None`
`modified_date`	TYPE: `datetime \| None`
`name`	TYPE: `str`
`organization_id`	TYPE: `str \| None`
`tag_ids`	TYPE: `list[str] \| None`
`units`	TYPE: `str \| None`
`user_notes`	TYPE: `str \| None`
`version`	TYPE: `int \| None`
`version_id`	TYPE: `str \| None`

all_assets `instance-attribute` ¶

all_assets: bool | None

archived_date `instance-attribute` ¶

archived_date: datetime | None

asset_ids `instance-attribute` ¶

asset_ids: list[str] | None

change_message `instance-attribute` ¶

change_message: str | None

channel_references `instance-attribute` ¶

channel_references: list[ChannelReference]

client_key `instance-attribute` ¶

client_key: str | None

created_by `property` ¶

created_by

Get the user that created this calculated channel.

created_by_user_id `instance-attribute` ¶

created_by_user_id: str | None

created_date `instance-attribute` ¶

created_date: datetime | None

description `instance-attribute` ¶

description: str

expression `instance-attribute` ¶

expression: str

is_archived `property` ¶

is_archived

Whether the calculated channel is archived.

modified_by `property` ¶

modified_by

Get the user that modified this calculated channel.

modified_by_user_id `instance-attribute` ¶

modified_by_user_id: str | None

modified_date `instance-attribute` ¶

modified_date: datetime | None

name `instance-attribute` ¶

name: str

organization_id `instance-attribute` ¶

organization_id: str | None

tag_ids `instance-attribute` ¶

tag_ids: list[str] | None

units `instance-attribute` ¶

units: str | None

user_notes `instance-attribute` ¶

user_notes: str | None

version `instance-attribute` ¶

version: int | None

version_id `instance-attribute` ¶

version_id: str | None

archive ¶

archive() -> CalculatedChannel

Archive the calculated channel.

update ¶

update(
    update: CalculatedChannelUpdate | dict,
    user_notes: str | None = None,
) -> CalculatedChannel

Update the Calculated Channel.

PARAMETER	DESCRIPTION
`update`	The update to apply to the calculated channel. See CalculatedChannelUpdate for more updatable fields. TYPE: `CalculatedChannelUpdate \| dict`
`user_notes`	The user notes to apply to the calculated channel. TYPE: `str \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`CalculatedChannel`	The updated calculated channel.

CalculatedChannelUpdate ¶

CalculatedChannelUpdate(**data: Any)

Bases: ModelUpdate[CalculatedChannel]

Model of the Calculated Channel Fields that can be updated.

Initialize a CalculatedChannelUpdate instance.

PARAMETER	DESCRIPTION
`**data`	Keyword arguments for the update fields. TYPE: `Any` DEFAULT: `{}`

RAISES	DESCRIPTION
`ValueError`	If only one of expression or expression_channel_references is provided. Both must be provided together or neither should be provided.

ATTRIBUTE	DESCRIPTION
`archived_date`	TYPE: `datetime \| None`
`description`	TYPE: `str \| None`
`expression`	TYPE: `str \| None`
`expression_channel_references`	TYPE: `list[ChannelReference] \| None`
`name`	TYPE: `str \| None`
`tag_ids`	TYPE: `list[str] \| None`
`units`	TYPE: `str \| None`

archived_date `class-attribute` `instance-attribute` ¶

archived_date: datetime | None = None

description `class-attribute` `instance-attribute` ¶

description: str | None = None

expression `class-attribute` `instance-attribute` ¶

expression: str | None = None

expression_channel_references `class-attribute` `instance-attribute` ¶

expression_channel_references: (
    list[ChannelReference] | None
) = None

name `class-attribute` `instance-attribute` ¶

name: str | None = None

tag_ids `class-attribute` `instance-attribute` ¶

tag_ids: list[str] | None = None

units `class-attribute` `instance-attribute` ¶

units: str | None = None

Channel ¶

Bases: BaseType[Channel, 'Channel']

Model representing a Sift Channel.

METHOD	DESCRIPTION
`data`	Retrieve channel data for this channel during the specified run.

ATTRIBUTE	DESCRIPTION
`asset`	Get the asset that this channel belongs to. TYPE: `Asset`
`asset_id`	TYPE: `str \| None`
`bit_field_elements`	TYPE: `list[ChannelBitFieldElement]`
`created_by_user_id`	TYPE: `str \| None`
`created_date`	TYPE: `datetime \| None`
`data_type`	TYPE: `ChannelDataType`
`description`	TYPE: `str \| None`
`enum_types`	TYPE: `dict[str, int]`
`modified_by_user_id`	TYPE: `str \| None`
`modified_date`	TYPE: `datetime \| None`
`name`	TYPE: `str`
`runs`	Get all runs associated with this channel's asset. TYPE: `list[Run]`
`unit`	TYPE: `str \| None`

asset `property` ¶

asset: Asset

Get the asset that this channel belongs to.

asset_id `class-attribute` `instance-attribute` ¶

asset_id: str | None = None

bit_field_elements `class-attribute` `instance-attribute` ¶

bit_field_elements: list[ChannelBitFieldElement] = Field(
    default_factory=list
)

created_by_user_id `class-attribute` `instance-attribute` ¶

created_by_user_id: str | None = None

created_date `class-attribute` `instance-attribute` ¶

created_date: datetime | None = None

data_type `instance-attribute` ¶

data_type: ChannelDataType

description `class-attribute` `instance-attribute` ¶

description: str | None = None

enum_types `class-attribute` `instance-attribute` ¶

enum_types: dict[str, int] = Field(default_factory=dict)

modified_by_user_id `class-attribute` `instance-attribute` ¶

modified_by_user_id: str | None = None

modified_date `class-attribute` `instance-attribute` ¶

modified_date: datetime | None = None

name `instance-attribute` ¶

name: str

runs `property` ¶

runs: list[Run]

Get all runs associated with this channel's asset.

unit `class-attribute` `instance-attribute` ¶

unit: str | None = None

data ¶

data(
    *,
    run_id: str | None = None,
    start_time: datetime | None = None,
    end_time: datetime | None = None,
    limit: int | None = None,
    as_arrow: bool = False,
)

Retrieve channel data for this channel during the specified run.

PARAMETER	DESCRIPTION
`run_id`	The run ID to get data for. TYPE: `str \| None` DEFAULT: `None`
`start_time`	The start time to get data for. TYPE: `datetime \| None` DEFAULT: `None`
`end_time`	The end time to get data for. TYPE: `datetime \| None` DEFAULT: `None`
`limit`	The maximum number of data points to return. TYPE: `int \| None` DEFAULT: `None`
`as_arrow`	Whether to return the data as an Arrow table. TYPE: `bool` DEFAULT: `False`

RETURNS	DESCRIPTION
	A dict of channel name to pandas DataFrame or Arrow Table object.

ChannelBitFieldElement ¶

Bases: BaseModel

Bit field element model.

ATTRIBUTE	DESCRIPTION
`bit_count`	TYPE: `int`
`index`	TYPE: `int`
`name`	TYPE: `str`

bit_count `instance-attribute` ¶

bit_count: int

index `instance-attribute` ¶

index: int

name `instance-attribute` ¶

name: str

ChannelDataType ¶

Bases: Enum

Enum for channel data types (mimics protobuf values, but as int for now).

METHOD	DESCRIPTION
`__str__`
`from_api_format`	Convert API format string to ChannelDataType.
`from_str`	Convert string representation to ChannelDataType.
`hash_str`	Get the hash string for this channel data type.
`proto_data_class`	Return the appropriate protobuf class for the given channel data type.

ATTRIBUTE	DESCRIPTION
`BIT_FIELD`
`BOOL`
`BYTES`
`DOUBLE`
`ENUM`
`FLOAT`
`INT_32`
`INT_64`
`STRING`
`UINT_32`
`UINT_64`

BIT_FIELD `class-attribute` `instance-attribute` ¶

BIT_FIELD = CHANNEL_DATA_TYPE_BIT_FIELD

BOOL `class-attribute` `instance-attribute` ¶

BOOL = CHANNEL_DATA_TYPE_BOOL

BYTES `class-attribute` `instance-attribute` ¶

BYTES = CHANNEL_DATA_TYPE_BYTES

DOUBLE `class-attribute` `instance-attribute` ¶

DOUBLE = CHANNEL_DATA_TYPE_DOUBLE

ENUM `class-attribute` `instance-attribute` ¶

ENUM = CHANNEL_DATA_TYPE_ENUM

FLOAT `class-attribute` `instance-attribute` ¶

FLOAT = CHANNEL_DATA_TYPE_FLOAT

INT_32 `class-attribute` `instance-attribute` ¶

INT_32 = CHANNEL_DATA_TYPE_INT_32

INT_64 `class-attribute` `instance-attribute` ¶

INT_64 = CHANNEL_DATA_TYPE_INT_64

STRING `class-attribute` `instance-attribute` ¶

STRING = CHANNEL_DATA_TYPE_STRING

UINT_32 `class-attribute` `instance-attribute` ¶

UINT_32 = CHANNEL_DATA_TYPE_UINT_32

UINT_64 `class-attribute` `instance-attribute` ¶

UINT_64 = CHANNEL_DATA_TYPE_UINT_64

str ¶

__str__() -> str

from_api_format `staticmethod` ¶

from_api_format(val: str) -> ChannelDataType | None

Convert API format string to ChannelDataType.

PARAMETER	DESCRIPTION
`val`	API format string representation of ChannelDataType. TYPE: `str`

RETURNS	DESCRIPTION
`ChannelDataType \| None`	ChannelDataType if conversion is successful, None otherwise.

from_str `staticmethod` ¶

from_str(raw: str) -> ChannelDataType | None

Convert string representation to ChannelDataType.

PARAMETER	DESCRIPTION
`raw`	String representation of ChannelDataType. TYPE: `str`

RETURNS	DESCRIPTION
`ChannelDataType \| None`	ChannelDataType if conversion is successful, None otherwise.

RAISES	DESCRIPTION
`Exception`	If the string format is recognized but cannot be converted.

hash_str ¶

hash_str(api_format: bool = False) -> str

Get the hash string for this channel data type.

proto_data_class `staticmethod` ¶

proto_data_class(data_type: ChannelDataType)

Return the appropriate protobuf class for the given channel data type.

PARAMETER	DESCRIPTION
`data_type`	The channel data type. TYPE: `ChannelDataType`

RETURNS	DESCRIPTION
	The protobuf class corresponding to the data type.

RAISES	DESCRIPTION
`ValueError`	If the data type is not recognized.

ChannelReference ¶

Bases: BaseModel

Channel reference for calculated channel or rule.

ATTRIBUTE	DESCRIPTION
`channel_identifier`	TYPE: `str`
`channel_reference`	TYPE: `str`

channel_identifier `instance-attribute` ¶

channel_identifier: str

channel_reference `instance-attribute` ¶

channel_reference: str

IngestionConfig ¶

Bases: BaseType[IngestionConfig, 'IngestionConfig']

Model of the Sift Ingestion Config.

ATTRIBUTE	DESCRIPTION
`asset_id`	TYPE: `str`
`client_key`	TYPE: `str`

asset_id `instance-attribute` ¶

asset_id: str

client_key `instance-attribute` ¶

client_key: str

Rule ¶

Bases: BaseType[Rule, 'Rule']

Model of the Sift Rule.

METHOD	DESCRIPTION
`archive`	Archive the rule.
`update`	Update the Rule.

ATTRIBUTE	DESCRIPTION
`action`	TYPE: `RuleAction \| None`
`archived_date`	TYPE: `datetime \| None`
`asset_ids`	TYPE: `list[str] \| None`
`asset_tag_ids`	TYPE: `list[str] \| None`
`assets`	Get the assets that this rule applies to. TYPE: `list[Asset]`
`channel_references`	TYPE: `list[ChannelReference] \| None`
`client_key`	TYPE: `str \| None`
`contextual_channels`	TYPE: `list[str] \| None`
`created_by`	Get the user that created this rule.
`created_by_user_id`	TYPE: `str \| None`
`created_date`	TYPE: `datetime \| None`
`description`	TYPE: `str`
`expression`	TYPE: `str \| None`
`is_archived`	Whether the rule is archived. TYPE: `bool`
`is_enabled`	TYPE: `bool`
`is_external`	TYPE: `bool \| None`
`modified_by`	Get the user that modified this rule.
`modified_by_user_id`	TYPE: `str \| None`
`modified_date`	TYPE: `datetime \| None`
`name`	TYPE: `str`
`organization`	Get the organization that this rule belongs to.
`organization_id`	TYPE: `str \| None`
`rule_version`	TYPE: `RuleVersion \| None`
`tags`	Get the tags that this rule applies to.

action `class-attribute` `instance-attribute` ¶

action: RuleAction | None = None

archived_date `class-attribute` `instance-attribute` ¶

archived_date: datetime | None = None

asset_ids `class-attribute` `instance-attribute` ¶

asset_ids: list[str] | None = None

asset_tag_ids `class-attribute` `instance-attribute` ¶

asset_tag_ids: list[str] | None = None

assets `property` ¶

assets: list[Asset]

Get the assets that this rule applies to.

channel_references `class-attribute` `instance-attribute` ¶

channel_references: list[ChannelReference] | None = None

client_key `class-attribute` `instance-attribute` ¶

client_key: str | None = None

contextual_channels `class-attribute` `instance-attribute` ¶

contextual_channels: list[str] | None = None

created_by `property` ¶

created_by

Get the user that created this rule.

created_by_user_id `class-attribute` `instance-attribute` ¶

created_by_user_id: str | None = None

created_date `class-attribute` `instance-attribute` ¶

created_date: datetime | None = None

description `instance-attribute` ¶

description: str

expression `class-attribute` `instance-attribute` ¶

expression: str | None = None

is_archived `property` ¶

is_archived: bool

Whether the rule is archived.

is_enabled `class-attribute` `instance-attribute` ¶

is_enabled: bool = True

is_external `class-attribute` `instance-attribute` ¶

is_external: bool | None = None

modified_by `property` ¶

modified_by

Get the user that modified this rule.

modified_by_user_id `class-attribute` `instance-attribute` ¶

modified_by_user_id: str | None = None

modified_date `class-attribute` `instance-attribute` ¶

modified_date: datetime | None = None

name `instance-attribute` ¶

name: str

organization `property` ¶

organization

Get the organization that this rule belongs to.

organization_id `class-attribute` `instance-attribute` ¶

organization_id: str | None = None

rule_version `class-attribute` `instance-attribute` ¶

rule_version: RuleVersion | None = None

tags `property` ¶

tags

Get the tags that this rule applies to.

archive ¶

archive() -> None

Archive the rule.

update ¶

update(
    update: RuleUpdate | dict,
    version_notes: str | None = None,
) -> Rule

Update the Rule.

PARAMETER	DESCRIPTION
`update`	Either a RuleUpdate instance or a dictionary of key-value pairs to update. TYPE: `RuleUpdate \| dict`
`version_notes`	Notes associated with the change. TYPE: `str \| None` DEFAULT: `None`

RuleAction ¶

Bases: BaseType[RuleAction, 'RuleAction']

Model of a Rule Action.

METHOD	DESCRIPTION
`annotation`	Create an annotation action.

ATTRIBUTE	DESCRIPTION
`action_type`	TYPE: `RuleActionType`
`annotation_type`	TYPE: `RuleAnnotationType \| None`
`condition_id`	TYPE: `str \| None`
`created_by_user_id`	TYPE: `str \| None`
`created_date`	TYPE: `datetime \| None`
`default_assignee_user_id`	TYPE: `str \| None`
`modified_by_user_id`	TYPE: `str \| None`
`modified_date`	TYPE: `datetime \| None`
`tags`	TYPE: `list[str] \| None`
`version_id`	TYPE: `str \| None`

action_type `instance-attribute` ¶

action_type: RuleActionType

annotation_type `class-attribute` `instance-attribute` ¶

annotation_type: RuleAnnotationType | None = None

condition_id `class-attribute` `instance-attribute` ¶

condition_id: str | None = None

created_by_user_id `class-attribute` `instance-attribute` ¶

created_by_user_id: str | None = None

created_date `class-attribute` `instance-attribute` ¶

created_date: datetime | None = None

default_assignee_user_id `class-attribute` `instance-attribute` ¶

default_assignee_user_id: str | None = None

modified_by_user_id `class-attribute` `instance-attribute` ¶

modified_by_user_id: str | None = None

modified_date `class-attribute` `instance-attribute` ¶

modified_date: datetime | None = None

tags `class-attribute` `instance-attribute` ¶

tags: list[str] | None = None

version_id `class-attribute` `instance-attribute` ¶

version_id: str | None = None

annotation `classmethod` ¶

annotation(
    annotation_type: RuleAnnotationType,
    tags: list[str],
    default_assignee_user_id: str | None = None,
) -> RuleAction

Create an annotation action.

PARAMETER	DESCRIPTION
`annotation_type`	Type of annotation to create. TYPE: `RuleAnnotationType`
`default_assignee_user_id`	User ID to assign the annotation to. TYPE: `str \| None` DEFAULT: `None`
`tags`	List of tag IDs to add to the annotation. TYPE: `list[str]`

RuleActionType ¶

Bases: Enum

Enum for rule action kinds.

METHOD	DESCRIPTION
`from_str`	Convert string representation to RuleActionType.

ATTRIBUTE	DESCRIPTION
`ANNOTATION`
`UNSPECIFIED`
`WEBHOOK`

ANNOTATION `class-attribute` `instance-attribute` ¶

ANNOTATION = ANNOTATION

UNSPECIFIED `class-attribute` `instance-attribute` ¶

UNSPECIFIED = ACTION_KIND_UNSPECIFIED

WEBHOOK `class-attribute` `instance-attribute` ¶

WEBHOOK = WEBHOOK

from_str `classmethod` ¶

from_str(val: str) -> RuleActionType | None

Convert string representation to RuleActionType.

PARAMETER	DESCRIPTION
`val`	String representation of RuleActionType. TYPE: `str`

RETURNS	DESCRIPTION
`RuleActionType \| None`	RuleActionType if conversion is successful, None otherwise.

RuleAnnotationType ¶

Bases: Enum

Enum for rule annotation types.

METHOD	DESCRIPTION
`from_str`	Convert string representation to RuleAnnotationType.

ATTRIBUTE	DESCRIPTION
`DATA_REVIEW`
`PHASE`
`UNSPECIFIED`

DATA_REVIEW `class-attribute` `instance-attribute` ¶

DATA_REVIEW = 1

PHASE `class-attribute` `instance-attribute` ¶

PHASE = 2

UNSPECIFIED `class-attribute` `instance-attribute` ¶

UNSPECIFIED = 0

from_str `classmethod` ¶

from_str(val: str) -> RuleAnnotationType | None

Convert string representation to RuleAnnotationType.

PARAMETER	DESCRIPTION
`val`	String representation of RuleAnnotationType. TYPE: `str`

RETURNS	DESCRIPTION
`RuleAnnotationType \| None`	RuleAnnotationType if conversion is successful, None otherwise.

RuleUpdate ¶

RuleUpdate(**data: Any)

Bases: ModelUpdate[Rule]

Model of the Rule fields that can be updated.

Note

asset_ids applies this rule to those assets.
asset_tag_ids applies this rule to assets with those tags.

ATTRIBUTE	DESCRIPTION
`action`	TYPE: `RuleAction \| None`
`asset_ids`	TYPE: `list[str] \| None`
`asset_tag_ids`	TYPE: `list[str] \| None`
`channel_references`	TYPE: `list[ChannelReference] \| None`
`contextual_channels`	TYPE: `list[str] \| None`
`description`	TYPE: `str \| None`
`expression`	TYPE: `str \| None`
`name`	TYPE: `str \| None`

action `class-attribute` `instance-attribute` ¶

action: RuleAction | None = None

asset_ids `class-attribute` `instance-attribute` ¶

asset_ids: list[str] | None = None

asset_tag_ids `class-attribute` `instance-attribute` ¶

asset_tag_ids: list[str] | None = None

channel_references `class-attribute` `instance-attribute` ¶

channel_references: list[ChannelReference] | None = None

contextual_channels `class-attribute` `instance-attribute` ¶

contextual_channels: list[str] | None = None

description `class-attribute` `instance-attribute` ¶

description: str | None = None

expression `class-attribute` `instance-attribute` ¶

expression: str | None = None

name `class-attribute` `instance-attribute` ¶

name: str | None = None

RuleVersion ¶

Bases: BaseType[RuleVersion, 'RuleVersion']

Model of a Rule Version.

ATTRIBUTE	DESCRIPTION
`created_by_user_id`	TYPE: `str`
`created_date`	TYPE: `datetime`
`deleted_date`	TYPE: `datetime \| None`
`generated_change_message`	TYPE: `str`
`rule_id`	TYPE: `str`
`rule_version_id`	TYPE: `str`
`version`	TYPE: `str`
`version_notes`	TYPE: `str`

created_by_user_id `instance-attribute` ¶

created_by_user_id: str

created_date `instance-attribute` ¶

created_date: datetime

deleted_date `class-attribute` `instance-attribute` ¶

deleted_date: datetime | None = None

generated_change_message `instance-attribute` ¶

generated_change_message: str

rule_id `instance-attribute` ¶

rule_id: str

rule_version_id `instance-attribute` ¶

rule_version_id: str

version `instance-attribute` ¶

version: str

version_notes `instance-attribute` ¶

version_notes: str

Run ¶

Bases: BaseType[Run, 'Run']

Run model representing a data collection run.

ATTRIBUTE	DESCRIPTION
`archived_date`	TYPE: `datetime \| None`
`asset_ids`	TYPE: `list[str] \| None`
`assets`	Return all assets associated with this run. TYPE: `list[Asset]`
`client_key`	TYPE: `str \| None`
`created_by_user_id`	TYPE: `str`
`created_date`	TYPE: `datetime`
`default_report_id`	TYPE: `str \| None`
`description`	TYPE: `str`
`metadata`	TYPE: `dict[str, str \| float \| bool]`
`model_config`
`modified_by_user_id`	TYPE: `str`
`modified_date`	TYPE: `datetime`
`name`	TYPE: `str`
`organization_id`	TYPE: `str`
`start_time`	TYPE: `datetime \| None`
`stop_time`	TYPE: `datetime \| None`
`tags`	TYPE: `list[str] \| None`

archived_date `class-attribute` `instance-attribute` ¶

archived_date: datetime | None = None

asset_ids `class-attribute` `instance-attribute` ¶

asset_ids: list[str] | None = None

assets `property` ¶

assets: list[Asset]

Return all assets associated with this run.

client_key `class-attribute` `instance-attribute` ¶

client_key: str | None = None

created_by_user_id `instance-attribute` ¶

created_by_user_id: str

created_date `instance-attribute` ¶

created_date: datetime

default_report_id `class-attribute` `instance-attribute` ¶

default_report_id: str | None = None

description `instance-attribute` ¶

description: str

metadata `instance-attribute` ¶

metadata: dict[str, str | float | bool]

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(arbitrary_types_allowed=True)

modified_by_user_id `instance-attribute` ¶

modified_by_user_id: str

modified_date `instance-attribute` ¶

modified_date: datetime

name `instance-attribute` ¶

name: str

organization_id `instance-attribute` ¶

organization_id: str

start_time `class-attribute` `instance-attribute` ¶

start_time: datetime | None = None

stop_time `class-attribute` `instance-attribute` ¶

stop_time: datetime | None = None

tags `class-attribute` `instance-attribute` ¶

tags: list[str] | None = None

RunUpdate ¶

RunUpdate(**data: Any)

Bases: ModelUpdate[Run]

Update model for Run.

ATTRIBUTE	DESCRIPTION
`client_key`	TYPE: `str \| None`
`description`	TYPE: `str \| None`
`is_pinned`	TYPE: `bool \| None`
`metadata`	TYPE: `dict[str, str \| float \| bool] \| None`
`model_config`
`name`	TYPE: `str \| None`
`start_time`	TYPE: `datetime \| None`
`stop_time`	TYPE: `datetime \| None`
`tags`	TYPE: `list[str] \| None`

client_key `class-attribute` `instance-attribute` ¶

client_key: str | None = None

description `class-attribute` `instance-attribute` ¶

description: str | None = None

is_pinned `class-attribute` `instance-attribute` ¶

is_pinned: bool | None = None

metadata `class-attribute` `instance-attribute` ¶

metadata: dict[str, str | float | bool] | None = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(arbitrary_types_allowed=True)

name `class-attribute` `instance-attribute` ¶

name: str | None = None

start_time `class-attribute` `instance-attribute` ¶

start_time: datetime | None = None

stop_time `class-attribute` `instance-attribute` ¶

stop_time: datetime | None = None

tags `class-attribute` `instance-attribute` ¶

tags: list[str] | None = None

sift_client.sift_types ¶

__all__ module-attribute ¶

Asset ¶

annotations property ¶

archived_date instance-attribute ¶

created_by property ¶

created_by_user_id instance-attribute ¶

created_date instance-attribute ¶

is_archived property ¶

metadata instance-attribute ¶

modified_by property ¶

modified_by_user_id instance-attribute ¶

modified_date instance-attribute ¶

name instance-attribute ¶

organization_id instance-attribute ¶

rules property ¶

runs property ¶

tags instance-attribute ¶

archive ¶

channels ¶

update ¶

AssetUpdate ¶

archived_date class-attribute instance-attribute ¶

metadata class-attribute instance-attribute ¶

tags class-attribute instance-attribute ¶

CalculatedChannel ¶

all_assets instance-attribute ¶

archived_date instance-attribute ¶

asset_ids instance-attribute ¶

change_message instance-attribute ¶

channel_references instance-attribute ¶

client_key instance-attribute ¶

created_by property ¶

created_by_user_id instance-attribute ¶

created_date instance-attribute ¶

description instance-attribute ¶

expression instance-attribute ¶

is_archived property ¶

modified_by property ¶

modified_by_user_id instance-attribute ¶

modified_date instance-attribute ¶

name instance-attribute ¶

organization_id instance-attribute ¶

tag_ids instance-attribute ¶

units instance-attribute ¶

user_notes instance-attribute ¶

version instance-attribute ¶

version_id instance-attribute ¶

archive ¶

update ¶

CalculatedChannelUpdate ¶

archived_date class-attribute instance-attribute ¶

description class-attribute instance-attribute ¶

expression class-attribute instance-attribute ¶

expression_channel_references class-attribute instance-attribute ¶

name class-attribute instance-attribute ¶

tag_ids class-attribute instance-attribute ¶

units class-attribute instance-attribute ¶

Channel ¶

asset property ¶

asset_id class-attribute instance-attribute ¶

bit_field_elements class-attribute instance-attribute ¶

created_by_user_id class-attribute instance-attribute ¶

created_date class-attribute instance-attribute ¶

data_type instance-attribute ¶

description class-attribute instance-attribute ¶

enum_types class-attribute instance-attribute ¶

modified_by_user_id class-attribute instance-attribute ¶

modified_date class-attribute instance-attribute ¶

name instance-attribute ¶

runs property ¶

unit class-attribute instance-attribute ¶

data ¶

ChannelBitFieldElement ¶

bit_count instance-attribute ¶

index instance-attribute ¶

name instance-attribute ¶

ChannelDataType ¶

BIT_FIELD class-attribute instance-attribute ¶

BOOL class-attribute instance-attribute ¶

all `module-attribute` ¶

annotations `property` ¶

archived_date `instance-attribute` ¶

created_by `property` ¶

created_by_user_id `instance-attribute` ¶

created_date `instance-attribute` ¶

is_archived `property` ¶

metadata `instance-attribute` ¶

modified_by `property` ¶

modified_by_user_id `instance-attribute` ¶

modified_date `instance-attribute` ¶

name `instance-attribute` ¶

organization_id `instance-attribute` ¶

rules `property` ¶

runs `property` ¶

tags `instance-attribute` ¶

archived_date `class-attribute` `instance-attribute` ¶

metadata `class-attribute` `instance-attribute` ¶

tags `class-attribute` `instance-attribute` ¶

all_assets `instance-attribute` ¶

archived_date `instance-attribute` ¶

asset_ids `instance-attribute` ¶

change_message `instance-attribute` ¶

channel_references `instance-attribute` ¶

client_key `instance-attribute` ¶

created_by `property` ¶

created_by_user_id `instance-attribute` ¶

created_date `instance-attribute` ¶

description `instance-attribute` ¶

expression `instance-attribute` ¶

is_archived `property` ¶

modified_by `property` ¶

modified_by_user_id `instance-attribute` ¶

modified_date `instance-attribute` ¶

name `instance-attribute` ¶

organization_id `instance-attribute` ¶

tag_ids `instance-attribute` ¶

units `instance-attribute` ¶

user_notes `instance-attribute` ¶

version `instance-attribute` ¶

version_id `instance-attribute` ¶

archived_date `class-attribute` `instance-attribute` ¶

description `class-attribute` `instance-attribute` ¶

expression `class-attribute` `instance-attribute` ¶

expression_channel_references `class-attribute` `instance-attribute` ¶

name `class-attribute` `instance-attribute` ¶

tag_ids `class-attribute` `instance-attribute` ¶

units `class-attribute` `instance-attribute` ¶

asset `property` ¶

asset_id `class-attribute` `instance-attribute` ¶

bit_field_elements `class-attribute` `instance-attribute` ¶

created_by_user_id `class-attribute` `instance-attribute` ¶

created_date `class-attribute` `instance-attribute` ¶

data_type `instance-attribute` ¶

description `class-attribute` `instance-attribute` ¶

enum_types `class-attribute` `instance-attribute` ¶

modified_by_user_id `class-attribute` `instance-attribute` ¶

modified_date `class-attribute` `instance-attribute` ¶

name `instance-attribute` ¶

runs `property` ¶

unit `class-attribute` `instance-attribute` ¶

bit_count `instance-attribute` ¶

index `instance-attribute` ¶

name `instance-attribute` ¶

BIT_FIELD `class-attribute` `instance-attribute` ¶

BOOL `class-attribute` `instance-attribute` ¶

BYTES `class-attribute` `instance-attribute` ¶

DOUBLE `class-attribute` `instance-attribute` ¶

ENUM `class-attribute` `instance-attribute` ¶

FLOAT `class-attribute` `instance-attribute` ¶

INT_32 `class-attribute` `instance-attribute` ¶

INT_64 `class-attribute` `instance-attribute` ¶

STRING `class-attribute` `instance-attribute` ¶

UINT_32 `class-attribute` `instance-attribute` ¶

UINT_64 `class-attribute` `instance-attribute` ¶

str ¶

from_api_format `staticmethod` ¶

from_str `staticmethod` ¶

proto_data_class `staticmethod` ¶

channel_identifier `instance-attribute` ¶