/** * 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. */ /** * An ExternalFileHandle represents a file that is not stored in Synapse. Instead, ExternalFileHandles reside somewhere accessible via a URL. Synapse will attempt to generate a preview for any external URL that can be publicly read. * @export * @interface ExternalFileHandle */ export interface ExternalFileHandle { /** * 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 ExternalFileHandle */ id?: string; /** * FileHandles are immutable from the perspective of the API. The only field that can be change is the previewId. When a new previewId is set, the etag will change. * @type {string} * @memberof ExternalFileHandle */ etag?: string; /** * The ID Of the user that created this file. * @type {string} * @memberof ExternalFileHandle */ createdBy?: string; /** * The date when this file was uploaded. * @type {string} * @memberof ExternalFileHandle */ createdOn?: string; /** * The date when the file was modified. This is handled by the backend and cannot be modified. * @type {string} * @memberof ExternalFileHandle */ 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 ExternalFileHandle */ concreteType: ExternalFileHandleConcreteTypeEnum; /** * Must be: http://en.wikipedia.org/wiki/Internet_media_type * @type {string} * @memberof ExternalFileHandle */ contentType?: string; /** * The file's content MD5. * @type {string} * @memberof ExternalFileHandle */ contentMd5?: string; /** * The short, user visible name for this file. * @type {string} * @memberof ExternalFileHandle */ fileName?: string; /** * The optional storage location descriptor * @type {number} * @memberof ExternalFileHandle */ storageLocationId?: number; /** * The size of the file in bytes. * @type {number} * @memberof ExternalFileHandle */ contentSize?: number; /** * 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 ExternalFileHandle */ status?: ExternalFileHandleStatusEnum; /** * The external URL of this file. * @type {string} * @memberof ExternalFileHandle */ externalURL?: string; } /** * @export */ export declare const ExternalFileHandleConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_file_ExternalFileHandle: "org.sagebionetworks.repo.model.file.ExternalFileHandle"; }; export type ExternalFileHandleConcreteTypeEnum = typeof ExternalFileHandleConcreteTypeEnum[keyof typeof ExternalFileHandleConcreteTypeEnum]; /** * @export */ export declare const ExternalFileHandleStatusEnum: { readonly AVAILABLE: "AVAILABLE"; readonly UNLINKED: "UNLINKED"; readonly ARCHIVED: "ARCHIVED"; }; export type ExternalFileHandleStatusEnum = typeof ExternalFileHandleStatusEnum[keyof typeof ExternalFileHandleStatusEnum]; /** * Check if a given object implements the ExternalFileHandle interface. */ export declare function instanceOfExternalFileHandle(value: object): value is ExternalFileHandle; export declare function ExternalFileHandleFromJSON(json: any): ExternalFileHandle; export declare function ExternalFileHandleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExternalFileHandle; export declare function ExternalFileHandleToJSON(json: any): ExternalFileHandle; export declare function ExternalFileHandleToJSONTyped(value?: ExternalFileHandle | null, ignoreDiscriminator?: boolean): any;