API Reference
Create
Bases: CreateInterface
, RESTInterface
Source code in lqs/client/core/create.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
|
digestion(log_id, name=None, note=None, context=None, locked=False, workflow_id=None, workflow_context=None, state=ProcessState.ready, lock_token=None)
Creates a digestion.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
log_id |
UUID
|
The ID of the log to which the digestion should be added. |
required |
name |
optional
|
The name of the digestion. |
None
|
context |
optional
|
The context to use for the digestion. |
None
|
note |
optional
|
A note about the digestion. |
None
|
locked |
optional
|
Whether the digestion is locked. Defaults to False. |
False
|
workflow_id |
optional
|
The ID of the workflow to use for the digestion. |
None
|
workflow_context |
optional
|
The context to use for the workflow. |
None
|
state |
optional
|
The state of the digestion. Defaults to ProcessState.ready. |
ready
|
Returns: A data response with the created digestion.
Source code in lqs/interface/core/create.py
digestion_part(digestion_id, sequence, locked=False, workflow_id=None, workflow_context=None, state=ProcessState.ready, index=None, lock_token=None)
Creates a digestion part.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_id |
UUID
|
The ID of the digestion to which the digestion part should be added. |
required |
sequence |
int
|
The sequence of the digestion part. |
required |
locked |
optional
|
Whether the digestion part is locked. Defaults to False. |
False
|
workflow_id |
optional
|
The ID of the workflow to use for the digestion part. |
None
|
workflow_context |
optional
|
The context to use for the workflow. |
None
|
state |
optional
|
The state of the digestion part. Defaults to ProcessState.ready. |
ready
|
index |
optional
|
The index of the digestion part. |
None
|
Returns: A data response with the created digestion part.
Source code in lqs/interface/core/create.py
digestion_topic(digestion_id, topic_id, start_time=None, end_time=None, frequency=None, query_data_filter=None, context_filter=None, lock_token=None)
Creates a digestion topic.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_id |
UUID
|
The ID of the digestion to which the digestion topic should be added. |
required |
topic_id |
UUID
|
The ID of the topic to be digested. |
required |
start_time |
optional
|
The start time of the digestion topic. |
None
|
end_time |
optional
|
The end time of the digestion topic. |
None
|
frequency |
optional
|
The frequency of the digestion topic. |
None
|
query_data_filter |
optional
|
The data filter of the digestion topic. |
None
|
context_filter |
optional
|
The context filter of the digestion topic. |
None
|
Returns: A data response with the created digestion topic.
Source code in lqs/interface/core/create.py
group(name, note=None, context=None, locked=False, default_workflow_id=None)
Creates a group.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the group. |
required |
note |
optional
|
A note about the group. |
None
|
context |
optional
|
The context to use for the group. |
None
|
locked |
optional
|
Whether the group is locked. Defaults to False. |
False
|
default_workflow_id |
optional
|
The ID of the default workflow for the group. |
None
|
Returns: A data response with the created group.
Source code in lqs/interface/core/create.py
hook(workflow_id, trigger_process, trigger_state, name=None, note=None, context=None, managed=False, disabled=False, uri=None, secret=None)
Creates a hook.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
workflow_id |
UUID
|
The ID of the workflow to which the hook should be added. |
required |
trigger_process |
str
|
The process to trigger. |
required |
trigger_state |
str
|
The state to trigger. |
required |
name |
optional
|
The name of the hook. |
None
|
note |
optional
|
A note about the hook. |
None
|
context |
optional
|
The context to use for the hook. |
None
|
managed |
optional
|
Whether the hook is managed. Defaults to False. |
False
|
disabled |
optional
|
Whether the hook is disabled. Defaults to False. |
False
|
uri |
optional
|
The URI of the hook. |
None
|
secret |
optional
|
The secret of the hook. |
None
|
Returns: A data response with the created hook.
Source code in lqs/interface/core/create.py
ingestion(log_id, name=None, note=None, context=None, object_store_id=None, object_key=None, locked=False, workflow_id=None, workflow_context=None, state=ProcessState.ready, lock_token=None)
Creates an ingestion.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
log_id |
UUID
|
The ID of the log to which the ingestion should be added. |
required |
name |
optional
|
The name of the ingestion. |
None
|
note |
optional
|
A note about the ingestion. |
None
|
context |
optional
|
The context to use for the ingestion. |
None
|
object_store_id |
optional
|
The ID of the object store to use for the ingestion. |
None
|
object_key |
optional
|
The key of the object to use for the ingestion. |
None
|
locked |
optional
|
Whether the ingestion is locked. Defaults to False. |
False
|
workflow_id |
optional
|
The ID of the workflow to use for the ingestion. |
None
|
workflow_context |
optional
|
The context to use for the workflow. |
None
|
state |
optional
|
The state of the ingestion. Defaults to ProcessState.ready. |
ready
|
Returns: A data response with the created ingestion.
Source code in lqs/interface/core/create.py
ingestion_part(ingestion_id, sequence, source=None, locked=False, workflow_id=None, workflow_context=None, state=ProcessState.ready, index=None, lock_token=None)
Creates an ingestion part.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ingestion_id |
UUID
|
The ID of the ingestion to which the ingestion part should be added. |
required |
sequence |
int
|
The sequence of the ingestion part. |
required |
source |
optional
|
The source of the ingestion part. |
None
|
locked |
optional
|
Whether the ingestion part is locked. Defaults to False. |
False
|
workflow_id |
optional
|
The ID of the workflow to use for the ingestion part. |
None
|
workflow_context |
optional
|
The context to use for the workflow. |
None
|
state |
optional
|
The state of the ingestion part. Defaults to ProcessState.queued. |
ready
|
index |
optional
|
The index of the ingestion part. |
None
|
Returns: A data response with the created ingestion part.
Source code in lqs/interface/core/create.py
label(value, note=None)
Creates a label.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value |
str
|
The value of the label. |
required |
note |
optional
|
A note about the label. |
None
|
Returns: A data response with the created label.
Source code in lqs/interface/core/create.py
log(group_id, name, note=None, context=None, locked=False, default_workflow_id=None, lock_token=None)
Creates a log.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
group_id |
UUID
|
The ID of the group to which the log should be added. |
required |
name |
str
|
The name of the log. |
required |
note |
optional
|
A note about the log. |
None
|
context |
optional
|
The context to use for the log. |
None
|
locked |
optional
|
Whether the log is locked. Defaults to False. |
False
|
default_workflow_id |
optional
|
The ID of the default workflow for the log. |
None
|
Returns: A data response with the created log.
Source code in lqs/interface/core/create.py
log_object(key, log_id, content_type=None, lock_token=None)
Creates a log object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key of the log object. |
required |
log_id |
UUID
|
The ID of the log to which the log object should be added. |
required |
content_type |
optional
|
The content type of the log object. |
None
|
Returns: A data response with the created log object.
Source code in lqs/interface/core/create.py
log_object_part(object_key, size, log_id, part_number=None)
Creates a log object part.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_key |
str
|
The key of the log object to which the log object part should be added. |
required |
size |
int
|
The size of the log object part. |
required |
log_id |
UUID
|
The ID of the log to which the log object part should be added. |
required |
part_number |
optional
|
The part number of the log object part. |
None
|
Returns: A data response with the created log object part.
Source code in lqs/interface/core/create.py
object(key, object_store_id, content_type=None)
Creates an object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key of the object. |
required |
object_store_id |
UUID
|
The ID of the object store to which the object should be added. |
required |
content_type |
optional
|
The content type of the object. |
None
|
Returns: A data response with the created object.
Source code in lqs/interface/core/create.py
object_part(object_key, size, object_store_id, part_number=None)
Creates an object part.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_key |
str
|
The key of the object to which the object part should be added. |
required |
size |
int
|
The size of the object part. |
required |
object_store_id |
UUID
|
The ID of the object store to which the object part should be added. |
required |
part_number |
optional
|
The part number of the object part. |
None
|
Returns: A data response with the created object part.
Source code in lqs/interface/core/create.py
object_store(bucket_name, access_key_id=None, secret_access_key=None, region_name=None, endpoint_url=None, note=None, context=None, disabled=False)
Creates an object store.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
bucket_name |
str
|
The name of the bucket. |
required |
access_key_id |
optional
|
The access key ID of the object store. |
None
|
secret_access_key |
optional
|
The secret access key of the object store. |
None
|
region_name |
optional
|
The region name of the object store. |
None
|
endpoint_url |
optional
|
The endpoint URL of the object store. |
None
|
note |
optional
|
A note about the object store. |
None
|
context |
optional
|
The context to use for the object store. |
None
|
disabled |
optional
|
Whether the object store is disabled. Defaults to False. |
False
|
Returns: A data response with the created object store.
Source code in lqs/interface/core/create.py
query(log_id, name=None, note=None, context=None, statement=None, parameters=None)
Creates a query.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
log_id |
UUID
|
The ID of the log to which the query should be added. |
required |
name |
optional
|
The name of the query. |
None
|
note |
optional
|
A note about the query. |
None
|
context |
optional
|
The context to use for the query. |
None
|
statement |
optional
|
The statement of the query. |
None
|
parameters |
optional
|
The parameters of the query. |
None
|
Returns: A data response with the created query.
Source code in lqs/interface/core/create.py
record(timestamp, topic_id, note=None, context=None, locked=False, query_data=None, auxiliary_data=None, data_offset=None, data_length=None, chunk_compression=None, chunk_offset=None, chunk_length=None, source=None, lock_token=None)
Creates a record.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
timestamp |
int
|
The timestamp of the record. |
required |
topic_id |
UUID
|
The ID of the topic to which the record should be added. |
required |
note |
optional
|
A note about the record. |
None
|
context |
optional
|
The context to use for the record. |
None
|
locked |
optional
|
Whether the record is locked. Defaults to False. |
False
|
query_data |
optional
|
A JSON representation of the record's message data which is queryable. |
None
|
auxiliary_data |
optional
|
A JSON representation of the record's message data which is not queryable. |
None
|
data_offset |
optional
|
The data offset of the record. |
None
|
data_length |
optional
|
The data length of the record. |
None
|
chunk_compression |
optional
|
The chunk compression of the record. |
None
|
chunk_offset |
optional
|
The chunk offset of the record. |
None
|
chunk_length |
optional
|
The chunk length of the record. |
None
|
source |
optional
|
The source of the record. |
None
|
Returns: A data response with the created record.
Source code in lqs/interface/core/create.py
tag(label_id, log_id, topic_id=None, note=None, context=None, start_time=None, end_time=None, lock_token=None)
Creates a tag.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label_id |
UUID
|
The ID of the label to which the tag should be added. |
required |
log_id |
UUID
|
The ID of the log to which the tag should be added. |
required |
topic_id |
optional
|
The ID of the topic to which the tag should be added. |
None
|
note |
optional
|
A note about the tag. |
None
|
context |
optional
|
The context to use for the tag. |
None
|
start_time |
optional
|
The start time of the tag. |
None
|
end_time |
optional
|
The end time of the tag. |
None
|
Returns: A data response with the created tag.
Source code in lqs/interface/core/create.py
topic(log_id, name, note=None, context=None, associated_topic_id=None, locked=False, strict=False, type_name=None, type_encoding=None, type_data=None, type_schema=None, lock_token=None)
Creates a topic.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
log_id |
UUID
|
The ID of the log to which the topic should be added. |
required |
name |
str
|
The name of the topic. |
required |
note |
optional
|
A note about the topic. |
None
|
context |
optional
|
The context to use for the topic. |
None
|
associated_topic_id |
optional
|
The ID of the associated topic. |
None
|
locked |
optional
|
Whether the topic is locked. Defaults to False. |
False
|
strict |
optional
|
Whether the topic is strict. Defaults to False. |
False
|
type_name |
optional
|
The type name of the topic. |
None
|
type_encoding |
optional
|
The type encoding of the topic. |
None
|
type_data |
optional
|
The type data of the topic. |
None
|
type_schema |
optional
|
The type schema of the topic. |
None
|
Returns: A data response with the created topic.
Source code in lqs/interface/core/create.py
workflow(name, note=None, context=None, default=False, disabled=False, managed=False, context_schema=None)
Creates a workflow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the workflow. |
required |
note |
optional
|
A note about the workflow. |
None
|
context |
optional
|
The context to use for the workflow. |
None
|
default |
optional
|
Whether the workflow is default. Defaults to False. |
False
|
disabled |
optional
|
Whether the workflow is disabled. Defaults to False. |
False
|
managed |
optional
|
Whether the workflow is managed. Defaults to False. |
False
|
context_schema |
optional
|
The context schema of the workflow. |
None
|
Returns: A data response with the created workflow.
Source code in lqs/interface/core/create.py
List
Bases: ListInterface
, RESTInterface
Source code in lqs/client/core/list.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
|
digestion(id=None, group_id=None, log_id=None, workflow_id=None, workflow_id_null=None, state=None, name=None, name_like=None, progress_null=None, progress_gte=None, progress_lte=None, error_like=None, note_like=None, context_filter=None, workflow_context_filter=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists digestions.
Source code in lqs/interface/core/list.py
digestion_part(id=None, group_id=None, log_id=None, sequence=None, digestion_id=None, workflow_id=None, workflow_id_null=None, state=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists digestion parts.
Source code in lqs/interface/core/list.py
digestion_topic(id=None, digestion_id=None, group_id=None, log_id=None, topic_id=None, start_time_null=None, start_time_gte=None, start_time_lte=None, end_time_null=None, end_time_gte=None, end_time_lte=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists digestion topics.
Source code in lqs/interface/core/list.py
group(id=None, name=None, name_like=None, default_workflow_id=None, default_workflow_id_null=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists groups.
Source code in lqs/interface/core/list.py
hook(id=None, workflow_id=None, trigger_process=None, trigger_state=None, name=None, name_like=None, note_like=None, managed=None, disabled=None, uri=None, uri_like=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists hooks.
Source code in lqs/interface/core/list.py
ingestion(id=None, group_id=None, log_id=None, object_store_id=None, name=None, name_like=None, object_key=None, object_key_like=None, workflow_id=None, workflow_id_null=None, workflow_context_filter=None, state=None, progress_null=None, progress_gte=None, progress_lte=None, error_like=None, note_like=None, context_filter=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists ingestions.
Source code in lqs/interface/core/list.py
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
|
ingestion_part(id=None, group_id=None, log_id=None, ingestion_id=None, sequence=None, source=None, workflow_id=None, workflow_id_null=None, state=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists ingestion parts.
Source code in lqs/interface/core/list.py
label(id=None, value=None, value_like=None, note_like=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists labels.
Source code in lqs/interface/core/list.py
log(id=None, group_id=None, default_workflow_id=None, default_workflow_id_null=None, name=None, name_like=None, locked=None, note_like=None, context_filter=None, time_adjustment_null=None, time_adjustment_gte=None, time_adjustment_lte=None, start_time_null=None, start_time_gte=None, start_time_lte=None, end_time_null=None, end_time_gte=None, end_time_lte=None, record_size_gte=None, record_size_lte=None, record_count_gte=None, record_count_lte=None, object_size_gte=None, object_size_lte=None, object_count_gte=None, object_count_lte=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists logs.
Source code in lqs/interface/core/list.py
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 |
|
log_object(log_id, processing=False, max_keys=None, prefix=None, start_after=None, delimiter=None, continuation_token=None)
Lists log objects.
Source code in lqs/interface/core/list.py
log_object_part(object_key, log_id, max_parts=None, part_number_marker=None)
Lists log object parts.
Source code in lqs/interface/core/list.py
object(object_store_id, processing=False, max_keys=None, prefix=None, start_after=None, delimiter=None, continuation_token=None)
Lists objects.
Source code in lqs/interface/core/list.py
object_part(object_key, object_store_id, max_parts=None, part_number_marker=None)
Lists object parts.
Source code in lqs/interface/core/list.py
object_store(id=None, bucket_name=None, access_key_id=None, region_name=None, endpoint_url=None, note=None, note_like=None, disabled=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists object stores.
Source code in lqs/interface/core/list.py
query(id=None, log_id=None, name=None, name_like=None, note_like=None, statement=None, statement_like=None, workflow_id=None, workflow_id_null=None, workflow_context_filter=None, context_filter=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists queries.
Source code in lqs/interface/core/list.py
record(topic_id, timestamp=None, log_id=None, ingestion_id=None, workflow_id=None, workflow_id_null=None, error_like=None, note_like=None, source=None, query_data_filter=None, context_filter=None, altered=None, frequency=None, timestamp_gt=None, timestamp_lt=None, timestamp_gte=None, timestamp_lte=None, data_length_gte=None, data_length_lte=None, data_offset_gte=None, data_offset_lte=None, chunk_compression=None, chunk_offset_gte=None, chunk_offset_lte=None, chunk_length_gte=None, chunk_length_lte=None, include_auxiliary_data=False, include_raw_data=False, include_count=True, offset=0, limit=100, order='timestamp', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists records.
Source code in lqs/interface/core/list.py
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 |
|
tag(id=None, log_id=None, label_id=None, topic_id=None, note=None, note_like=None, context_filter=None, start_time_null=None, start_time_gte=None, start_time_lte=None, end_time_null=None, end_time_gte=None, end_time_lte=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists tags.
Source code in lqs/interface/core/list.py
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 |
|
topic(id=None, log_id=None, group_id=None, name=None, name_like=None, associated_topic_id=None, latched=None, strict=None, locked=None, context_filter=None, start_time_null=None, start_time_gte=None, start_time_lte=None, end_time_null=None, end_time_gte=None, end_time_lte=None, record_size_gte=None, record_size_lte=None, record_count_gte=None, record_count_lte=None, type_name=None, type_name_like=None, type_encoding=None, type_data=None, type_data_like=None, type_schema_filter=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists topics.
Source code in lqs/interface/core/list.py
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 |
|
workflow(id=None, name=None, name_like=None, default=None, disabled=None, managed=None, context_schema_filter=None, include_count=True, offset=0, limit=100, order='created_at', sort='ASC', created_by=None, updated_by=None, deleted_by=None, updated_by_null=None, deleted_by_null=None, updated_at_null=None, deleted_at_null=None, created_at_lte=None, updated_at_lte=None, deleted_at_lte=None, created_at_gte=None, updated_at_gte=None, deleted_at_gte=None)
Lists workflows.
Source code in lqs/interface/core/list.py
Fetch
Bases: FetchInterface
, RESTInterface
Source code in lqs/client/core/fetch.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
|
digestion(digestion_id)
Fetches a digestion by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_id |
UUID
|
The ID of the digestion to fetch. |
required |
Returns: A data response for the digestion.
Source code in lqs/interface/core/fetch.py
digestion_part(digestion_part_id, digestion_id=None)
Fetches a digestion part by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_part_id |
UUID
|
The ID of the digestion part to fetch. |
required |
digestion_id |
Optional[UUID]
|
The ID of the digestion to which the digestion part belongs. |
None
|
Returns: A data response for the digestion part.
Source code in lqs/interface/core/fetch.py
digestion_topic(digestion_topic_id, digestion_id=None)
Fetches a digestion topic by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_topic_id |
UUID
|
The ID of the digestion topic to fetch. |
required |
digestion_id |
Optional[UUID]
|
The ID of the digestion to which the digestion topic belongs. |
None
|
Returns: A data response for the digestion topic.
Source code in lqs/interface/core/fetch.py
group(group_id)
Fetches a group by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
group_id |
UUID
|
The ID of the group to fetch. |
required |
Returns: A data response for the group.
hook(hook_id, workflow_id=None)
Fetches a hook by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
hook_id |
UUID
|
The ID of the hook to fetch. |
required |
workflow_id |
Optional[UUID]
|
The ID of the workflow to which the hook belongs. |
None
|
Returns: A data response for the hook.
Source code in lqs/interface/core/fetch.py
ingestion(ingestion_id)
Fetches an ingestion by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ingestion_id |
UUID
|
The ID of the ingestion to fetch. |
required |
Returns: A data response for the ingestion.
Source code in lqs/interface/core/fetch.py
ingestion_part(ingestion_part_id, ingestion_id=None)
Fetches an ingestion part by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ingestion_part_id |
UUID
|
The ID of the ingestion part to fetch. |
required |
ingestion_id |
Optional[UUID]
|
The ID of the ingestion to which the ingestion part belongs. |
None
|
Returns: A data response for the ingestion part.
Source code in lqs/interface/core/fetch.py
label(label_id)
Fetches a label by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label_id |
UUID
|
The ID of the label to fetch. |
required |
Returns: A data response for the label.
log(log_id)
Fetches a log by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
log_id |
UUID
|
The ID of the log to fetch. |
required |
Returns: A data response for the log.
log_object(object_key, log_id, redirect=False, offset=None, length=None)
Fetches an object by key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_key |
str
|
The key of the object to fetch. |
required |
log_id |
UUID
|
The ID of the log to which the object belongs. |
required |
redirect |
Optional[bool]
|
Whether to redirect to the object store or return the object directly. Defaults to False. |
False
|
offset |
Optional[int]
|
The offset from which to read the object. |
None
|
length |
Optional[int]
|
The length of the object to read. |
None
|
Returns: A data response for the object or the object itself as bytes if redirect is True.
Source code in lqs/interface/core/fetch.py
log_object_part(object_key, part_number, log_id)
Fetches an object part by key and part number.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_key |
str
|
The key of the object to fetch. |
required |
part_number |
int
|
The part number of the object to fetch. |
required |
log_id |
UUID
|
The ID of the log to which the object belongs. |
required |
Returns: A data response for the object part.
Source code in lqs/interface/core/fetch.py
object(object_key, object_store_id, redirect=False, offset=None, length=None)
Fetches an object by key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_key |
str
|
The key of the object to fetch. |
required |
object_store_id |
UUID
|
The ID of the object store to which the object belongs. |
required |
redirect |
Optional[bool]
|
Whether to redirect to the object store or return the object directly. Defaults to False. |
False
|
offset |
Optional[int]
|
The offset from which to read the object. |
None
|
length |
Optional[int]
|
The length of the object to read. |
None
|
Returns: A data response for the object or the object itself as bytes if redirect is True.
Source code in lqs/interface/core/fetch.py
object_part(object_key, part_number, object_store_id)
Fetches an object part by key and part number.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_key |
str
|
The key of the object to fetch. |
required |
part_number |
int
|
The part number of the object to fetch. |
required |
object_store_id |
UUID
|
The ID of the object store to which the object belongs. |
required |
Returns: A data response for the object part.
Source code in lqs/interface/core/fetch.py
object_store(object_store_id)
Fetches an object store by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_store_id |
UUID
|
The ID of the object store to fetch. |
required |
Returns: A data response for the object store.
Source code in lqs/interface/core/fetch.py
query(query_id, log_id=None)
Fetches a query by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
query_id |
UUID
|
The ID of the query to fetch. |
required |
log_id |
Optional[UUID]
|
The ID of the log to which the query belongs. |
None
|
Returns: A data response for the query.
Source code in lqs/interface/core/fetch.py
record(timestamp, topic_id, include_auxiliary_data=False, include_raw_data=False)
Fetches a record by timestamp and topic ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
timestamp |
Int64
|
The timestamp of the record to fetch. |
required |
topic_id |
UUID
|
The ID of the topic to which the record belongs. |
required |
include_auxiliary_data |
bool
|
Whether to include auxiliary data in the record. Defaults to False. |
False
|
include_raw_data |
bool
|
Whether to include raw data in the record. Defaults to False. |
False
|
Returns: A data response for the record.
Source code in lqs/interface/core/fetch.py
tag(tag_id, log_id=None)
Fetches a tag by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tag_id |
UUID
|
The ID of the tag to fetch. |
required |
log_id |
Optional[UUID]
|
The ID of the log to which the tag belongs. |
None
|
Returns: A data response for the tag.
Source code in lqs/interface/core/fetch.py
topic(topic_id)
Fetches a topic by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
topic_id |
UUID
|
The ID of the topic to fetch. |
required |
Returns: A data response for the topic.
workflow(workflow_id)
Fetches a workflow by ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
workflow_id |
UUID
|
The ID of the workflow to fetch. |
required |
Returns: A data response for the workflow.
Source code in lqs/interface/core/fetch.py
Update
Bases: UpdateInterface
, RESTInterface
Source code in lqs/client/core/update.py
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
|
digestion(digestion_id, data, lock_token=None)
Update a digestion.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_id |
UUID
|
The id of the digestion to update. |
required |
data |
DigestionUpdateRequest
|
The data to update the digestion with. |
required |
lock_token |
Optional[str]
|
TODO: update this description |
None
|
Returns: A data response containing the updated digestion.
Source code in lqs/interface/core/update.py
digestion_part(digestion_part_id, data, digestion_id=None, lock_token=None)
Update a digestion part.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_part_id |
UUID
|
The id of the digestion part to update. |
required |
data |
DigestionPartUpdateRequest
|
The data to update the digestion part with. |
required |
digestion_id |
optional
|
The id of the digestion to which the digestion part belongs. |
None
|
Returns: A data response containing the updated digestion part.
Source code in lqs/interface/core/update.py
digestion_topic(digestion_topic_id, data, digestion_id=None, lock_token=None)
Update a digestion topic.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
digestion_topic_id |
UUID
|
The id of the digestion topic to update. |
required |
data |
DigestionTopicUpdateRequest
|
The data to update the digestion topic with. |
required |
digestion_id |
optional
|
The id of the digestion to which the digestion topic belongs. |
None
|
Returns: A data response containing the updated digestion topic.