@@ -61,6 +61,31 @@ TAGS_FILTER_TYPE_UNTAGGED: TagsFilterType.ValueType
61
61
'TAGS_FILTER_TYPE_UNTAGGED specifes that all untagged documents should be returned.'
62
62
global___TagsFilterType = TagsFilterType
63
63
64
+ class _TabularDataSourceType :
65
+ ValueType = typing .NewType ('ValueType' , builtins .int )
66
+ V : typing_extensions .TypeAlias = ValueType
67
+
68
+ class _TabularDataSourceTypeEnumTypeWrapper (google .protobuf .internal .enum_type_wrapper ._EnumTypeWrapper [_TabularDataSourceType .ValueType ], builtins .type ):
69
+ DESCRIPTOR : google .protobuf .descriptor .EnumDescriptor
70
+ TABULAR_DATA_SOURCE_TYPE_UNSPECIFIED : _TabularDataSourceType .ValueType
71
+ TABULAR_DATA_SOURCE_TYPE_STANDARD : _TabularDataSourceType .ValueType
72
+ 'TABULAR_DATA_SOURCE_TYPE_STANDARD indicates reading from standard storage. This is\n the default option and available for all data synced to Viam.\n '
73
+ TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE : _TabularDataSourceType .ValueType
74
+ 'TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE indicates reading from hot storage. This is a\n premium feature requiring opting in specific data sources.\n See docs at https://docs.viam.com/data-ai/capture-data/advanced/advanced-data-capture-sync/#capture-to-the-hot-data-store\n '
75
+ TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK : _TabularDataSourceType .ValueType
76
+ 'TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK indicates reading the output data of\n a data pipeline. When using this, a pipeline ID needs to be specified.\n '
77
+
78
+ class TabularDataSourceType (_TabularDataSourceType , metaclass = _TabularDataSourceTypeEnumTypeWrapper ):
79
+ """TabularDataSourceType specifies the data source type for TabularDataByMQL queries."""
80
+ TABULAR_DATA_SOURCE_TYPE_UNSPECIFIED : TabularDataSourceType .ValueType
81
+ TABULAR_DATA_SOURCE_TYPE_STANDARD : TabularDataSourceType .ValueType
82
+ 'TABULAR_DATA_SOURCE_TYPE_STANDARD indicates reading from standard storage. This is\n the default option and available for all data synced to Viam.\n '
83
+ TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE : TabularDataSourceType .ValueType
84
+ 'TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE indicates reading from hot storage. This is a\n premium feature requiring opting in specific data sources.\n See docs at https://docs.viam.com/data-ai/capture-data/advanced/advanced-data-capture-sync/#capture-to-the-hot-data-store\n '
85
+ TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK : TabularDataSourceType .ValueType
86
+ 'TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK indicates reading the output data of\n a data pipeline. When using this, a pipeline ID needs to be specified.\n '
87
+ global___TabularDataSourceType = TabularDataSourceType
88
+
64
89
@typing .final
65
90
class DataRequest (google .protobuf .message .Message ):
66
91
"""DataRequest encapsulates the filter for the data, a limit on the maximum results returned,
@@ -383,18 +408,40 @@ class TabularDataBySQLResponse(google.protobuf.message.Message):
383
408
...
384
409
global___TabularDataBySQLResponse = TabularDataBySQLResponse
385
410
411
+ @typing .final
412
+ class TabularDataSource (google .protobuf .message .Message ):
413
+ """TabularDataSource specifies the data source for user queries to execute on."""
414
+ DESCRIPTOR : google .protobuf .descriptor .Descriptor
415
+ TYPE_FIELD_NUMBER : builtins .int
416
+ PIPELINE_ID_FIELD_NUMBER : builtins .int
417
+ type : global___TabularDataSourceType .ValueType
418
+ pipeline_id : builtins .str
419
+ 'pipeline_id is the ID of the pipeline to query. Required when using\n TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK.\n '
420
+
421
+ def __init__ (self , * , type : global___TabularDataSourceType .ValueType = ..., pipeline_id : builtins .str | None = ...) -> None :
422
+ ...
423
+
424
+ def HasField (self , field_name : typing .Literal ['_pipeline_id' , b'_pipeline_id' , 'pipeline_id' , b'pipeline_id' ]) -> builtins .bool :
425
+ ...
426
+
427
+ def ClearField (self , field_name : typing .Literal ['_pipeline_id' , b'_pipeline_id' , 'pipeline_id' , b'pipeline_id' , 'type' , b'type' ]) -> None :
428
+ ...
429
+
430
+ def WhichOneof (self , oneof_group : typing .Literal ['_pipeline_id' , b'_pipeline_id' ]) -> typing .Literal ['pipeline_id' ] | None :
431
+ ...
432
+ global___TabularDataSource = TabularDataSource
433
+
386
434
@typing .final
387
435
class TabularDataByMQLRequest (google .protobuf .message .Message ):
388
436
"""TabularDataByMQLRequest requests tabular data using an MQL query."""
389
437
DESCRIPTOR : google .protobuf .descriptor .Descriptor
390
438
ORGANIZATION_ID_FIELD_NUMBER : builtins .int
391
439
MQL_BINARY_FIELD_NUMBER : builtins .int
392
440
USE_RECENT_DATA_FIELD_NUMBER : builtins .int
393
- USE_DATA_PIPELINE_FIELD_NUMBER : builtins .int
441
+ DATA_SOURCE_FIELD_NUMBER : builtins .int
394
442
organization_id : builtins .str
395
443
use_recent_data : builtins .bool
396
- use_data_pipeline : builtins .str
397
- 'if set, MQL query will target the sink collection for the data pipeline name\n referenced by this value under the given organization.\n '
444
+ 'Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.'
398
445
399
446
@property
400
447
def mql_binary (self ) -> google .protobuf .internal .containers .RepeatedScalarFieldContainer [builtins .bytes ]:
@@ -403,17 +450,23 @@ class TabularDataByMQLRequest(google.protobuf.message.Message):
403
450
namespace, which holds the Viam organization's tabular data.
404
451
"""
405
452
406
- def __init__ (self , * , organization_id : builtins .str = ..., mql_binary : collections .abc .Iterable [builtins .bytes ] | None = ..., use_recent_data : builtins .bool | None = ..., use_data_pipeline : builtins .str | None = ...) -> None :
453
+ @property
454
+ def data_source (self ) -> global___TabularDataSource :
455
+ """data_source is an optional field that can be used to specify the data source for the query.
456
+ If not specified, the query will run on "standard" storage.
457
+ """
458
+
459
+ def __init__ (self , * , organization_id : builtins .str = ..., mql_binary : collections .abc .Iterable [builtins .bytes ] | None = ..., use_recent_data : builtins .bool | None = ..., data_source : global___TabularDataSource | None = ...) -> None :
407
460
...
408
461
409
- def HasField (self , field_name : typing .Literal ['_use_data_pipeline ' , b'_use_data_pipeline ' , '_use_recent_data' , b'_use_recent_data' , 'use_data_pipeline ' , b'use_data_pipeline ' , 'use_recent_data' , b'use_recent_data' ]) -> builtins .bool :
462
+ def HasField (self , field_name : typing .Literal ['_data_source ' , b'_data_source ' , '_use_recent_data' , b'_use_recent_data' , 'data_source ' , b'data_source ' , 'use_recent_data' , b'use_recent_data' ]) -> builtins .bool :
410
463
...
411
464
412
- def ClearField (self , field_name : typing .Literal ['_use_data_pipeline ' , b'_use_data_pipeline ' , '_use_recent_data' , b'_use_recent_data' , 'mql_binary ' , b'mql_binary ' , 'organization_id ' , b'organization_id ' , 'use_data_pipeline ' , b'use_data_pipeline ' , 'use_recent_data' , b'use_recent_data' ]) -> None :
465
+ def ClearField (self , field_name : typing .Literal ['_data_source ' , b'_data_source ' , '_use_recent_data' , b'_use_recent_data' , 'data_source ' , b'data_source ' , 'mql_binary ' , b'mql_binary ' , 'organization_id ' , b'organization_id ' , 'use_recent_data' , b'use_recent_data' ]) -> None :
413
466
...
414
467
415
468
@typing .overload
416
- def WhichOneof (self , oneof_group : typing .Literal ['_use_data_pipeline ' , b'_use_data_pipeline ' ]) -> typing .Literal ['use_data_pipeline ' ] | None :
469
+ def WhichOneof (self , oneof_group : typing .Literal ['_data_source ' , b'_data_source ' ]) -> typing .Literal ['data_source ' ] | None :
417
470
...
418
471
419
472
@typing .overload
0 commit comments