Options

struct Options

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

  • Tag: StorageGetURLRequest.Options

  • The default amount of time before the URL expires is 18000 seconds, or 5 hours.

    • Tag: StorageGetURLRequest.Options.defaultExpireInSeconds

    Declaration

    Swift

    public static let defaultExpireInSeconds: Int

  • Access level of the storage system. Defaults to public

    • Tag: StorageGetURLRequest.Options.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: StorageGetURLRequest.Options.targetIdentityId

    Declaration

    Swift

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

  • Number of seconds before the URL expires. Defaults to defaultExpireInSeconds

    • Tag: StorageGetURLRequest.Options.expires

    Declaration

    Swift

    public let expires: Int

  • A Storage Bucket that contains the object. 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 or AWSStorageGetURLOptions for expected key/values.

    • Tag: StorageGetURLRequest.Options.pluginOptions

    Declaration

    Swift

    public let pluginOptions: Any?
    • Tag: StorageGetURLRequest.Options.init

    Declaration

    Swift

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

    Declaration

    Swift

    public init(
    expires: Int = Options.defaultExpireInSeconds,
    pluginOptions: Any? = nil
)
    • Tag: StorageGetURLRequest.Options.init

    Declaration

    Swift

    public init(
    expires: Int = Options.defaultExpireInSeconds,
    bucket: some StorageBucket,
    pluginOptions: Any? = nil
)