Options

struct Options

Options to adjust the behavior of this request, including plugin-options

  • Tag: StorageDownloadDataRequestOptions

  • Access level of the storage system. Defaults to public

    • Tag: StorageDownloadDataRequestOptions.accessLevel

    Declaration

    Swift

    @available(*, deprecated, message: "Use `path` in Storage API instead of `Options`")
public let accessLevel: StorageAccessLevel

  • Target user to apply the action on.

    • Tag: StorageDownloadDataRequestOptions.targetIdentityId

    Declaration

    Swift

    @available(*, deprecated, message: "Use `path` in Storage API instead of `Options`")
public let targetIdentityId: String?

  • A Storage Bucket that contains the object to download. Defaults to nil, in which case the default one will be used.

    • Tag: StorageDownloadDataRequest.bucket

    Declaration

    Swift

    public let bucket: (any StorageBucket)?

  • Extra plugin specific options, only used in special circumstances when the existing options do not provide a way to utilize the underlying storage system’s functionality. See plugin documentation for expected key/values

    As an example, if using the AWSS3StoragePlugin, one may be want to add something like the following (please note that useAccelerateEndpoint should first be setup, otherwise, requests will fail):

     let options = StorageDownloadDataRequest.Options(
     pluginOptions: [
         "useAccelerateEndpoint": true
     ]
 )

    Reference

    Declaration

    Swift

    public let pluginOptions: Any?
    • Tag: StorageDownloadDataRequestOptions.init

    Declaration

    Swift

    @available(*, deprecated, message: "Use init(pluginOptions﹚")
public init(
    accessLevel: StorageAccessLevel = .guest,
    targetIdentityId: String? = nil,
    pluginOptions: Any? = nil
)
    • Tag: StorageDownloadDataRequestOptions.init

    Declaration

    Swift

    public init(pluginOptions: Any? = nil)
    • Tag: StorageDownloadDataRequestOptions.init

    Declaration

    Swift

    public init(
    bucket: some StorageBucket,
    pluginOptions: Any? = nil
)