/** * 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. */ /** * The FileHandleSnapshot captures all of the fields that are common to all FileHandle implementations. * @export * @interface FileHandleSnapshot */ export interface FileHandleSnapshot { /** * The ID of this FileHandle. All references to this FileHandle will use this ID. Synapse will generate this ID when the FileHandle is created. * @type {string} * @memberof FileHandleSnapshot */ id?: string; /** * The ID Of the user that created this file. * @type {string} * @memberof FileHandleSnapshot */ createdBy?: string; /** * The date when this file was uploaded. * @type {string} * @memberof FileHandleSnapshot */ createdOn?: string; /** * The date when this file was updated. Handled by the backend only. * @type {string} * @memberof FileHandleSnapshot */ modifiedOn?: string; /** * This is used to indicate the implementation of this interface. For example, an S3FileHandle should be set to: org.sagebionetworks.repo.model.file.S3FileHandle * @type {string} * @memberof FileHandleSnapshot */ concreteType: FileHandleSnapshotConcreteTypeEnum; /** * The file's content MD5. * @type {string} * @memberof FileHandleSnapshot */ contentMd5?: string; /** * The file's content type.' * @type {string} * @memberof FileHandleSnapshot */ contentType?: string; /** * The short, user visible name for this file. * @type {string} * @memberof FileHandleSnapshot */ fileName?: string; /** * The optional storage location descriptor * @type {number} * @memberof FileHandleSnapshot */ storageLocationId?: number; /** * The size of the file in bytes. * @type {number} * @memberof FileHandleSnapshot */ contentSize?: number; /** * Either the S3 bucket key or URL that points to an external file. * @type {string} * @memberof FileHandleSnapshot */ key?: string; /** * The S3 bucket where the file is stored. Null if the file is not stored in an S3 bucket. * @type {string} * @memberof FileHandleSnapshot */ bucket?: string; /** * If this file has a preview, then this will be the file ID of the preview. * @type {string} * @memberof FileHandleSnapshot */ previewId?: string; /** * Whether or not this is a preview of another file * @type {boolean} * @memberof FileHandleSnapshot */ isPreview?: boolean; /** * The status of the file handle as computed by the backend. This value cannot be changed, any file handle that is not AVAILABLE should not be used. * @type {string} * @memberof FileHandleSnapshot */ status?: FileHandleSnapshotStatusEnum; } /** * @export */ export declare const FileHandleSnapshotConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_audit_FileHandleSnapshot: "org.sagebionetworks.repo.model.audit.FileHandleSnapshot"; }; export type FileHandleSnapshotConcreteTypeEnum = typeof FileHandleSnapshotConcreteTypeEnum[keyof typeof FileHandleSnapshotConcreteTypeEnum]; /** * @export */ export declare const FileHandleSnapshotStatusEnum: { readonly AVAILABLE: "AVAILABLE"; readonly UNLINKED: "UNLINKED"; readonly ARCHIVED: "ARCHIVED"; }; export type FileHandleSnapshotStatusEnum = typeof FileHandleSnapshotStatusEnum[keyof typeof FileHandleSnapshotStatusEnum]; /** * Check if a given object implements the FileHandleSnapshot interface. */ export declare function instanceOfFileHandleSnapshot(value: object): value is FileHandleSnapshot; export declare function FileHandleSnapshotFromJSON(json: any): FileHandleSnapshot; export declare function FileHandleSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileHandleSnapshot; export declare function FileHandleSnapshotToJSON(json: any): FileHandleSnapshot; export declare function FileHandleSnapshotToJSONTyped(value?: FileHandleSnapshot | null, ignoreDiscriminator?: boolean): any;