TableProperties Class

Table properties.

Constructor

TableProperties(*args: Any, **kwargs: Any)

Variables

Name Description
retention_in_days
int

In Analytics table: the tables analytics retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. In Basic and Auxiliary table: read only property.

total_retention_in_days
int

The table total retention in days, between 4 and 4383. Setting this property to -1 will default to retentionInDays.

archive_retention_in_days
int

The tables long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays).

search_results

Parameters of the search job that initiated this table.

restored_logs

Parameters of the restore operation that initiated this table.

result_statistics

Search job execution statistics.

plan

Instruct the system how to handle and charge the logs ingested to this table. Known values are: "Basic", "Analytics", and "Auxiliary".

last_plan_modified_date
str

The timestamp that table plan was last modified (UTC).

schema

Table schema.

provisioning_state

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. Known values are: "Updating", "InProgress", "Succeeded", and "Deleting".

retention_in_days_as_default

True - Value originates from workspace retention in days, False - Customer specific.

total_retention_in_days_as_default

True - Value originates from retention in days, False

  • Customer specific.

Attributes

archive_retention_in_days

The tables long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays).

archive_retention_in_days: int | None

last_plan_modified_date

The timestamp that table plan was last modified (UTC).

last_plan_modified_date: str | None

plan

Instruct the system how to handle and charge the logs ingested to this table. Known values are: "Basic", "Analytics", and "Auxiliary".

plan: str | _models.TablePlanEnum | None

provisioning_state

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. Known values are: "Updating", "InProgress", "Succeeded", and "Deleting".

provisioning_state: str | _models.ProvisioningStateEnum | None

restored_logs

Parameters of the restore operation that initiated this table.

restored_logs: _models.RestoredLogs | None

result_statistics

Search job execution statistics.

result_statistics: _models.ResultStatistics | None

retention_in_days

the tables analytics retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. In Basic and Auxiliary table: read only property.

retention_in_days: int | None

retention_in_days_as_default

True - Value originates from workspace retention in days, False - Customer specific.

retention_in_days_as_default: bool | None

schema

Table schema.

schema: _models.Schema | None

search_results

Parameters of the search job that initiated this table.

search_results: _models.SearchResults | None

total_retention_in_days

The table total retention in days, between 4 and 4383. Setting this property to -1 will default to retentionInDays.

total_retention_in_days: int | None

total_retention_in_days_as_default

True - Value originates from retention in days, False - Customer specific.

total_retention_in_days_as_default: bool | None