/** * 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 storage location that uses a HTTPS proxy for all upload and download operations. * @export * @interface ProxyStorageLocationSettings */ export interface ProxyStorageLocationSettings { /** * Indicates which implementation this object represents. * @type {string} * @memberof ProxyStorageLocationSettings */ concreteType: ProxyStorageLocationSettingsConcreteTypeEnum; /** * The unique ID for this storage location * @type {number} * @memberof ProxyStorageLocationSettings */ storageLocationId?: number; /** * The enumeration of possible upload types. * @type {string} * @memberof ProxyStorageLocationSettings */ uploadType?: ProxyStorageLocationSettingsUploadTypeEnum; /** * The banner text to display to a user every time a file is uploaded. This field is optional. * @type {string} * @memberof ProxyStorageLocationSettings */ banner?: string; /** * A description of the storage location. This description is shown when a user has to choose which upload destination to use. * @type {string} * @memberof ProxyStorageLocationSettings */ description?: string; /** * Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time a Project Setting is updated it is used to detect when a client's current representation of a Project Setting is out-of-date. * @type {string} * @memberof ProxyStorageLocationSettings */ etag?: string; /** * The date this storage location setting was created. * @type {string} * @memberof ProxyStorageLocationSettings */ createdOn?: string; /** * The ID of the user that created this storage location setting. * @type {number} * @memberof ProxyStorageLocationSettings */ createdBy?: number; /** * The HTTPS URL of the proxy used for upload and download. * @type {string} * @memberof ProxyStorageLocationSettings */ proxyUrl?: string; /** * The encryption key used to sign all pre-signed URLs used to communicate with the proxy. * @type {string} * @memberof ProxyStorageLocationSettings */ secretKey?: string; /** * By default, only the creator of a ProxyStorageLocationSettings can use its storage location ID to create ProxyFileHandles. When this field is set with an Entity ID (such as a Project ID), any user with the 'create' permission on the given benefactorId will be allowed to create ProxyFileHandle using its storage location ID. * @type {string} * @memberof ProxyStorageLocationSettings */ benefactorId?: string; } /** * @export */ export declare const ProxyStorageLocationSettingsConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_project_ProxyStorageLocationSettings: "org.sagebionetworks.repo.model.project.ProxyStorageLocationSettings"; }; export type ProxyStorageLocationSettingsConcreteTypeEnum = typeof ProxyStorageLocationSettingsConcreteTypeEnum[keyof typeof ProxyStorageLocationSettingsConcreteTypeEnum]; /** * @export */ export declare const ProxyStorageLocationSettingsUploadTypeEnum: { readonly S3: "S3"; readonly GOOGLECLOUDSTORAGE: "GOOGLECLOUDSTORAGE"; readonly SFTP: "SFTP"; readonly HTTPS: "HTTPS"; readonly PROXYLOCAL: "PROXYLOCAL"; readonly NONE: "NONE"; }; export type ProxyStorageLocationSettingsUploadTypeEnum = typeof ProxyStorageLocationSettingsUploadTypeEnum[keyof typeof ProxyStorageLocationSettingsUploadTypeEnum]; /** * Check if a given object implements the ProxyStorageLocationSettings interface. */ export declare function instanceOfProxyStorageLocationSettings(value: object): value is ProxyStorageLocationSettings; export declare function ProxyStorageLocationSettingsFromJSON(json: any): ProxyStorageLocationSettings; export declare function ProxyStorageLocationSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProxyStorageLocationSettings; export declare function ProxyStorageLocationSettingsToJSON(json: any): ProxyStorageLocationSettings; export declare function ProxyStorageLocationSettingsToJSONTyped(value?: ProxyStorageLocationSettings | null, ignoreDiscriminator?: boolean): any;