Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 2.12 KB

Collection.md

File metadata and controls

30 lines (25 loc) · 2.12 KB

Collection

Properties

Name Type Description Notes
aliases [Alias] List of aliases for a collection. [optional]
bulk_stats [BulkStats] [optional]
clustering_key [FieldPartition] List of clustering fields for a collection. [optional]
created_at str ISO-8601 date. [optional]
created_by str Email of user who created the collection. [optional]
created_by_apikey_name str Name of the API key that was used to create this collection if one was used. [optional]
description str Text describing the collection. [optional]
field_mapping_query FieldMappingQuery [optional]
field_mappings [FieldMappingV2] List of mappings applied on all documents in a collection. [optional]
insert_only bool Whether the collection is insert only or not. [optional]
name str Unique identifer for collection, can contain alphanumeric or dash characters. [optional]
read_only bool Whether the collection is read-only or not. [optional]
retention_secs int Number of seconds after which data is purged based on event time. [optional]
rrn str Collection RRN. [optional]
sources [Source] List of sources from which collection ingests. [optional]
stats CollectionStats [optional]
status str Current status of collection. [optional]
storage_compression_type str RocksDB storage compression type. [optional]
workspace str Name of the workspace that the collection is in. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]