/** * 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 is a type of view defined by a flat list of entities. * @export * @interface Dataset */ export interface Dataset { /** * 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 Dataset */ name?: string; /** * The description of this entity. Must be 1000 characters or less. * @type {string} * @memberof Dataset */ 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 Dataset */ 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 Dataset */ etag?: string; /** * The date this entity was created. * @type {string} * @memberof Dataset */ createdOn?: string; /** * The date this entity was last modified. * @type {string} * @memberof Dataset */ modifiedOn?: string; /** * The ID of the user that created this entity. * @type {string} * @memberof Dataset */ createdBy?: string; /** * The ID of the user that last modified this entity. * @type {string} * @memberof Dataset */ modifiedBy?: string; /** * The ID of the Entity that is the parent of this Entity. * @type {string} * @memberof Dataset */ 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 Dataset */ concreteType: DatasetConcreteTypeEnum; /** * The version number issued to this version on the object. * @type {number} * @memberof Dataset */ versionNumber?: number; /** * The version label for this entity * @type {string} * @memberof Dataset */ versionLabel?: string; /** * The version comment for this entity * @type {string} * @memberof Dataset */ versionComment?: string; /** * If this is the latest version of the object. * @type {boolean} * @memberof Dataset */ isLatestVersion?: boolean; /** * The list of ColumnModel IDs that define the schema of the object. * @type {Array} * @memberof Dataset */ 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 Dataset */ isSearchEnabled?: boolean; /** * The flat list of file entity references that define this dataset. Limit: 30K items. * @type {Array} * @memberof Dataset */ items?: Array; /** * The cumulative size, in bytes, of all items(files) in the dataset. This will be automatically computed by the service. * @type {number} * @memberof Dataset */ size?: number; /** * The checksum is computed over a sorted concatenation of the checksums of all items in the dataset. For example, if a dataset contains two files with the following checksums: file1.md5 = 72794b6d and file2.md5 = 5e089d29. Then the checksum of the dataset is: md5('5e089d2972794b6d') = f7a29a04. This will be automatically computed by the service. * @type {string} * @memberof Dataset */ checksum?: string; /** * The number of items/files in the dataset. This will be automatically computed by the service. * @type {number} * @memberof Dataset */ count?: number; } /** * @export */ export declare const DatasetConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_table_Dataset: "org.sagebionetworks.repo.model.table.Dataset"; }; export type DatasetConcreteTypeEnum = typeof DatasetConcreteTypeEnum[keyof typeof DatasetConcreteTypeEnum]; /** * Check if a given object implements the Dataset interface. */ export declare function instanceOfDataset(value: object): value is Dataset; export declare function DatasetFromJSON(json: any): Dataset; export declare function DatasetFromJSONTyped(json: any, ignoreDiscriminator: boolean): Dataset; export declare function DatasetToJSON(json: any): Dataset; export declare function DatasetToJSONTyped(value?: Dataset | null, ignoreDiscriminator?: boolean): any;