/** * Synapse REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { EntityRef } from './EntityRef'; /** * A dataset collection is a type of view defined by a flat list of datasets. * @export * @interface DatasetCollection */ export interface DatasetCollection { /** * The name of this entity. Must be 256 characters or less. Names may only contain: letters, numbers, spaces, underscores, hyphens, periods, plus signs, apostrophes, and parentheses * @type {string} * @memberof DatasetCollection */ name?: string; /** * The description of this entity. Must be 1000 characters or less. * @type {string} * @memberof DatasetCollection */ description?: string; /** * The unique immutable ID for this entity. A new ID will be generated for new Entities. Once issued, this ID is guaranteed to never change or be re-issued * @type {string} * @memberof DatasetCollection */ id?: string; /** * Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client's current representation of an entity is out-of-date. * @type {string} * @memberof DatasetCollection */ etag?: string; /** * The date this entity was created. * @type {string} * @memberof DatasetCollection */ createdOn?: string; /** * The date this entity was last modified. * @type {string} * @memberof DatasetCollection */ modifiedOn?: string; /** * The ID of the user that created this entity. * @type {string} * @memberof DatasetCollection */ createdBy?: string; /** * The ID of the user that last modified this entity. * @type {string} * @memberof DatasetCollection */ modifiedBy?: string; /** * The ID of the Entity that is the parent of this Entity. * @type {string} * @memberof DatasetCollection */ parentId?: string; /** * Indicates which implementation of Entity this object represents. The value is the fully qualified class name, e.g. org.sagebionetworks.repo.model.FileEntity. * @type {string} * @memberof DatasetCollection */ concreteType: DatasetCollectionConcreteTypeEnum; /** * The version number issued to this version on the object. * @type {number} * @memberof DatasetCollection */ versionNumber?: number; /** * The version label for this entity * @type {string} * @memberof DatasetCollection */ versionLabel?: string; /** * The version comment for this entity * @type {string} * @memberof DatasetCollection */ versionComment?: string; /** * If this is the latest version of the object. * @type {boolean} * @memberof DatasetCollection */ isLatestVersion?: boolean; /** * The list of ColumnModel IDs that define the schema of the object. * @type {Array} * @memberof DatasetCollection */ columnIds?: Array; /** * When creating or updating a table or view specifies if full text search should be enabled. Note that enabling full text search might slow down the indexing of the table or view. * @type {boolean} * @memberof DatasetCollection */ isSearchEnabled?: boolean; /** * The flat list of dataset entity references that define this collection. Limit: 30K items. * @type {Array} * @memberof DatasetCollection */ items?: Array; } /** * @export */ export declare const DatasetCollectionConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_table_DatasetCollection: "org.sagebionetworks.repo.model.table.DatasetCollection"; }; export type DatasetCollectionConcreteTypeEnum = typeof DatasetCollectionConcreteTypeEnum[keyof typeof DatasetCollectionConcreteTypeEnum]; /** * Check if a given object implements the DatasetCollection interface. */ export declare function instanceOfDatasetCollection(value: object): value is DatasetCollection; export declare function DatasetCollectionFromJSON(json: any): DatasetCollection; export declare function DatasetCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): DatasetCollection; export declare function DatasetCollectionToJSON(json: any): DatasetCollection; export declare function DatasetCollectionToJSONTyped(value?: DatasetCollection | null, ignoreDiscriminator?: boolean): any;