/** * 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 S3FileHandle represents a file stored in AWS S3. * @export * @interface S3FileHandle */ export interface S3FileHandle { /** * 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 S3FileHandle */ 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 S3FileHandle */ etag?: string; /** * The ID Of the user that created this file. * @type {string} * @memberof S3FileHandle */ createdBy?: string; /** * The date when this file was uploaded. * @type {string} * @memberof S3FileHandle */ createdOn?: string; /** * The date when the file was modified. This is handled by the backend and cannot be modified. * @type {string} * @memberof S3FileHandle */ 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 S3FileHandle */ concreteType: S3FileHandleConcreteTypeEnum; /** * Must be: http://en.wikipedia.org/wiki/Internet_media_type * @type {string} * @memberof S3FileHandle */ contentType?: string; /** * The file's content MD5. * @type {string} * @memberof S3FileHandle */ contentMd5?: string; /** * The short, user visible name for this file. * @type {string} * @memberof S3FileHandle */ fileName?: string; /** * The optional storage location descriptor * @type {number} * @memberof S3FileHandle */ storageLocationId?: number; /** * The size of the file in bytes. * @type {number} * @memberof S3FileHandle */ 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 S3FileHandle */ status?: S3FileHandleStatusEnum; /** * The name of the bucket where this file resides * @type {string} * @memberof S3FileHandle */ bucketName?: string; /** * The path or resource name for this object * @type {string} * @memberof S3FileHandle */ key?: string; /** * If this file has a preview, then this will be the file ID of the preview. * @type {string} * @memberof S3FileHandle */ previewId?: string; /** * Whether or not this is a preview of another file * @type {boolean} * @memberof S3FileHandle */ isPreview?: boolean; } /** * @export */ export declare const S3FileHandleConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_file_S3FileHandle: "org.sagebionetworks.repo.model.file.S3FileHandle"; }; export type S3FileHandleConcreteTypeEnum = typeof S3FileHandleConcreteTypeEnum[keyof typeof S3FileHandleConcreteTypeEnum]; /** * @export */ export declare const S3FileHandleStatusEnum: { readonly AVAILABLE: "AVAILABLE"; readonly UNLINKED: "UNLINKED"; readonly ARCHIVED: "ARCHIVED"; }; export type S3FileHandleStatusEnum = typeof S3FileHandleStatusEnum[keyof typeof S3FileHandleStatusEnum]; /** * Check if a given object implements the S3FileHandle interface. */ export declare function instanceOfS3FileHandle(value: object): value is S3FileHandle; export declare function S3FileHandleFromJSON(json: any): S3FileHandle; export declare function S3FileHandleFromJSONTyped(json: any, ignoreDiscriminator: boolean): S3FileHandle; export declare function S3FileHandleToJSON(json: any): S3FileHandle; export declare function S3FileHandleToJSONTyped(value?: S3FileHandle | null, ignoreDiscriminator?: boolean): any;