/** * 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. */ /** * A view of Entities within a defined scope. * @export * @interface EntityView */ export interface EntityView { /** * 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 EntityView */ name?: string; /** * The description of this entity. Must be 1000 characters or less. * @type {string} * @memberof EntityView */ 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 EntityView */ 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 EntityView */ etag?: string; /** * The date this entity was created. * @type {string} * @memberof EntityView */ createdOn?: string; /** * The date this entity was last modified. * @type {string} * @memberof EntityView */ modifiedOn?: string; /** * The ID of the user that created this entity. * @type {string} * @memberof EntityView */ createdBy?: string; /** * The ID of the user that last modified this entity. * @type {string} * @memberof EntityView */ modifiedBy?: string; /** * The ID of the Entity that is the parent of this Entity. * @type {string} * @memberof EntityView */ 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 EntityView */ concreteType: EntityViewConcreteTypeEnum; /** * The version number issued to this version on the object. * @type {number} * @memberof EntityView */ versionNumber?: number; /** * The version label for this entity * @type {string} * @memberof EntityView */ versionLabel?: string; /** * The version comment for this entity * @type {string} * @memberof EntityView */ versionComment?: string; /** * If this is the latest version of the object. * @type {boolean} * @memberof EntityView */ isLatestVersion?: boolean; /** * The list of ColumnModel IDs that define the schema of the object. * @type {Array} * @memberof EntityView */ 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 EntityView */ isSearchEnabled?: boolean; /** * Bit mask representing the types to include in the view. The following are the possible types (type=): File=0x01, Project=0x02, Table=0x04, Folder=0x08, View=0x10, Docker=0x20, SubmissionView=0x40, Dataset=0x80, DatasetCollection=0x100, MaterializedView=0x200. * @type {number} * @memberof EntityView */ viewTypeMask?: number; /** * Deprecated. Use: 'viewTypeMask' * @type {string} * @memberof EntityView */ type?: EntityViewTypeEnum; /** * The list of container ids that define the scope of this view. * @type {Array} * @memberof EntityView */ scopeIds?: Array; } /** * @export */ export declare const EntityViewConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_table_EntityView: "org.sagebionetworks.repo.model.table.EntityView"; }; export type EntityViewConcreteTypeEnum = typeof EntityViewConcreteTypeEnum[keyof typeof EntityViewConcreteTypeEnum]; /** * @export */ export declare const EntityViewTypeEnum: { readonly file: "file"; readonly project: "project"; readonly file_and_table: "file_and_table"; }; export type EntityViewTypeEnum = typeof EntityViewTypeEnum[keyof typeof EntityViewTypeEnum]; /** * Check if a given object implements the EntityView interface. */ export declare function instanceOfEntityView(value: object): value is EntityView; export declare function EntityViewFromJSON(json: any): EntityView; export declare function EntityViewFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityView; export declare function EntityViewToJSON(json: any): EntityView; export declare function EntityViewToJSONTyped(value?: EntityView | null, ignoreDiscriminator?: boolean): any;