Network.BackblazeB2.B2API

Documentation

data Credentials

Connection info with accountId and applicationKey from Backblaze B2 account UI.

Constructors

Credentials

Fields

• cAccountId :: Text
• cApplicationKey :: Text

Instances

Eq Credentials

Defined in Network.BackblazeB2.Data

Methods

(==) :: Credentials -> Credentials -> Bool

(/=) :: Credentials -> Credentials -> Bool

Show Credentials

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

credsFromEnv :: IO (Maybe Credentials)

Creates Credentials from B2_APP_KEY_ID and B2_APP_KEY environment variables.

data AuthInfo

TODO: Load the rest of the auth info response too!

Constructors

AuthInfo

Fields

• aiAccountId :: Text
• aiAuthorizationToken :: Text
• aiApiUrl :: Url Https
• aiDownloadUrl :: Url Https
• aiRecommendedPartSize :: Int64

Instances

Eq AuthInfo

Defined in Network.BackblazeB2.Data

Methods

(==) :: AuthInfo -> AuthInfo -> Bool

(/=) :: AuthInfo -> AuthInfo -> Bool

Show AuthInfo

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> AuthInfo -> ShowS

show :: AuthInfo -> String

showList :: [AuthInfo] -> ShowS

FromJSON AuthInfo

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser AuthInfo

parseJSONList :: Value -> Parser [AuthInfo]

data ConnectInfo

Constructors

ConnectInfo

Fields

• creds :: Credentials
• authInfo :: AuthInfo

Instances

Eq ConnectInfo

Defined in Network.BackblazeB2.Data

Methods

(==) :: ConnectInfo -> ConnectInfo -> Bool

(/=) :: ConnectInfo -> ConnectInfo -> Bool

Show ConnectInfo

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS

authorizeAccount :: Credentials -> IO ConnectInfo

data LibErr

High-level error type for all errors from library

Constructors

LEServer BB2Error

JsonErr Text

NoAuthFound

HeaderMissing HeaderName

HeaderParseError HeaderName ByteString [Char]

Instances

Eq LibErr

Defined in Network.BackblazeB2.Data

Methods

(==) :: LibErr -> LibErr -> Bool

(/=) :: LibErr -> LibErr -> Bool

Show LibErr

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> LibErr -> ShowS

show :: LibErr -> String

showList :: [LibErr] -> ShowS

Exception LibErr

Defined in Network.BackblazeB2.Data

Methods

toException :: LibErr -> SomeException

fromException :: SomeException -> Maybe LibErr

displayException :: LibErr -> String

type Bucket = Text

data BucketType

Constructors

AllPublic

AllPrivate

Instances

Eq BucketType

Defined in Network.BackblazeB2.Data

Methods

(==) :: BucketType -> BucketType -> Bool

(/=) :: BucketType -> BucketType -> Bool

Show BucketType

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> BucketType -> ShowS

show :: BucketType -> String

showList :: [BucketType] -> ShowS

ToJSON BucketType

Defined in Network.BackblazeB2.Data

Methods

toJSON :: BucketType -> Value

toEncoding :: BucketType -> Encoding

toJSONList :: [BucketType] -> Value

toEncodingList :: [BucketType] -> Encoding

FromJSON BucketType

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser BucketType

parseJSONList :: Value -> Parser [BucketType]

data BucketOpts

Constructors

BucketOpts

Fields

• boBucketInfo :: Maybe BucketInfo
• boLCRs :: [LifecycleRule]

Instances

Eq BucketOpts

Defined in Network.BackblazeB2.Data

Methods

(==) :: BucketOpts -> BucketOpts -> Bool

(/=) :: BucketOpts -> BucketOpts -> Bool

Show BucketOpts

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> BucketOpts -> ShowS

show :: BucketOpts -> String

showList :: [BucketOpts] -> ShowS

emptyBucketOpts :: BucketOpts

data BucketData

Constructors

BucketData

Fields

• brdAccountId :: Text
• brdBucketId :: BucketId
• brdBucketName :: Bucket
• brdBucketType :: BucketType
• brdBucketInfo :: BucketInfo
• brdLifecycleRules :: [LifecycleRule]
• brdRevision :: Int64

Instances

Eq BucketData

Defined in Network.BackblazeB2.Data

Methods

(==) :: BucketData -> BucketData -> Bool

(/=) :: BucketData -> BucketData -> Bool

Show BucketData

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> BucketData -> ShowS

show :: BucketData -> String

showList :: [BucketData] -> ShowS

Generic BucketData

Defined in Network.BackblazeB2.Data

Associated Types

type Rep BucketData :: Type -> Type

Methods

from :: BucketData -> Rep BucketData x

to :: Rep BucketData x -> BucketData

FromJSON BucketData

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser BucketData

parseJSONList :: Value -> Parser [BucketData]

type Rep BucketData

Defined in Network.BackblazeB2.Data

type Rep BucketData

createBucket :: (MonadReader ConnectInfo m, MonadIO m) => Bucket -> BucketType -> BucketOpts -> m BucketData

deleteBucket :: (MonadReader ConnectInfo m, MonadIO m) => BucketId -> m BucketData

data AllBuckets

Constructors

AllBuckets

Fields

• abBuckets :: [BucketData]

Instances

Eq AllBuckets

Defined in Network.BackblazeB2.Data

Methods

(==) :: AllBuckets -> AllBuckets -> Bool

(/=) :: AllBuckets -> AllBuckets -> Bool

Show AllBuckets

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> AllBuckets -> ShowS

show :: AllBuckets -> String

showList :: [AllBuckets] -> ShowS

Generic AllBuckets

Defined in Network.BackblazeB2.Data

Associated Types

type Rep AllBuckets :: Type -> Type

Methods

from :: AllBuckets -> Rep AllBuckets x

to :: Rep AllBuckets x -> AllBuckets

FromJSON AllBuckets

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser AllBuckets

parseJSONList :: Value -> Parser [AllBuckets]

type Rep AllBuckets

Defined in Network.BackblazeB2.Data

type Rep AllBuckets = D1 (MetaData "AllBuckets" "Network.BackblazeB2.Data" "backblaze-b2-hs-0.1.0.0-9pGwcOJ9rtG6GgvqIf19eb" False) (C1 (MetaCons "AllBuckets" PrefixI True) (S1 (MetaSel (Just "abBuckets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [BucketData])))

listBuckets :: (MonadReader ConnectInfo m, MonadIO m) => m AllBuckets

type BucketId = Text

data UploadUrlInfo

Constructors

UploadUrlInfo

Fields

• uuBucketId :: BucketId
• uuUploadUrl :: UploadUrl
• uuAuthorizationToken :: Text

Instances

Generic UploadUrlInfo

Defined in Network.BackblazeB2.Data

Associated Types

type Rep UploadUrlInfo :: Type -> Type

Methods

from :: UploadUrlInfo -> Rep UploadUrlInfo x

to :: Rep UploadUrlInfo x -> UploadUrlInfo

FromJSON UploadUrlInfo

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser UploadUrlInfo

parseJSONList :: Value -> Parser [UploadUrlInfo]

type Rep UploadUrlInfo

Defined in Network.BackblazeB2.Data

type Rep UploadUrlInfo

getUploadUrl :: (MonadReader ConnectInfo m, MonadIO m) => BucketId -> m UploadUrlInfo

startLargeFile :: (MonadReader ConnectInfo m, MonadIO m) => BucketId -> Object -> FileProps -> m FileInfo

data PartUploadUrlInfo

Constructors

PartUploadUrlInfo

Fields

• puuFileId :: FileId
• puuUploadUrl :: UploadUrl
• puuAuthorizationToken :: Text

Instances

Generic PartUploadUrlInfo

Defined in Network.BackblazeB2.Data

Associated Types

type Rep PartUploadUrlInfo :: Type -> Type

Methods

from :: PartUploadUrlInfo -> Rep PartUploadUrlInfo x

to :: Rep PartUploadUrlInfo x -> PartUploadUrlInfo

FromJSON PartUploadUrlInfo

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser PartUploadUrlInfo

parseJSONList :: Value -> Parser [PartUploadUrlInfo]

type Rep PartUploadUrlInfo

Defined in Network.BackblazeB2.Data

type Rep PartUploadUrlInfo

getUploadPartUrl :: (MonadReader ConnectInfo m, MonadIO m) => FileId -> m PartUploadUrlInfo

data PartUploadResp

Constructors

PartUploadResp

Fields

• purFileId :: FileId
• purContentLength :: Int64
• purContentSha1 :: Text
• purUploadTimestamp :: BBTimestamp

Instances

Show PartUploadResp

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> PartUploadResp -> ShowS

show :: PartUploadResp -> String

showList :: [PartUploadResp] -> ShowS

Generic PartUploadResp

Defined in Network.BackblazeB2.Data

Associated Types

type Rep PartUploadResp :: Type -> Type

Methods

from :: PartUploadResp -> Rep PartUploadResp x

to :: Rep PartUploadResp x -> PartUploadResp

FromJSON PartUploadResp

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser PartUploadResp

parseJSONList :: Value -> Parser [PartUploadResp]

type Rep PartUploadResp

Defined in Network.BackblazeB2.Data

type Rep PartUploadResp

finishLargeFile :: (MonadReader ConnectInfo m, MonadIO m) => FileId -> [Text] -> m FileInfo

data FileInfo

Constructors

FileInfo

Fields

• fiFileId :: Text
• fiFileName :: Text
• fiAccountId :: Text
• fiBucketId :: BucketId
• fiContentLength :: Int64
• fiContentSha1 :: Text
• fiContentType :: Text
• fiFileInfo :: Map Text Text
• fiAction :: Text
• fiUploadTimestamp :: BBTimestamp

Instances

Eq FileInfo

Defined in Network.BackblazeB2.Data

Methods

(==) :: FileInfo -> FileInfo -> Bool

(/=) :: FileInfo -> FileInfo -> Bool

Show FileInfo

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> FileInfo -> ShowS

show :: FileInfo -> String

showList :: [FileInfo] -> ShowS

Generic FileInfo

Defined in Network.BackblazeB2.Data

Associated Types

type Rep FileInfo :: Type -> Type

Methods

from :: FileInfo -> Rep FileInfo x

to :: Rep FileInfo x -> FileInfo

FromJSON FileInfo

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser FileInfo

parseJSONList :: Value -> Parser [FileInfo]

type Rep FileInfo

Defined in Network.BackblazeB2.Data

type Rep FileInfo

defaultFileProps :: FileProps

data FileProps

Constructors

FileProps

Fields

• fpContentType :: Text
• fpLastModified :: Maybe UTCTime
• fpMetaInfo :: Map Text Text

Instances

Eq FileProps

Defined in Network.BackblazeB2.Data

Methods

(==) :: FileProps -> FileProps -> Bool

(/=) :: FileProps -> FileProps -> Bool

Show FileProps

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> FileProps -> ShowS

show :: FileProps -> String

showList :: [FileProps] -> ShowS

data Stream

Stream type for uploading data to B2. It is made of a conduit and a length representing the size of the stream in bytes.

Constructors

Stream

Fields

• streamLength :: Int64
• streamSource :: ConduitT () ByteString IO ()

uploadFile :: MonadIO m => UploadUrlInfo -> Object -> FileProps -> Stream -> m FileInfo

Performs the b2_upload_file call with a Stream that provides the bytes for the file content.

uploadPart :: MonadIO m => PartUploadUrlInfo -> Int -> Stream -> m PartUploadResp

getFileInfo :: (MonadReader ConnectInfo m, MonadIO m) => ObjectId -> m FileInfo

data ObjectMetadata

Constructors

ObjectMetadata

Fields

• omContentLength :: Int64
• omContentType :: Text
• omObjectId :: ObjectId
• omObjectName :: Object
• omContentSha1 :: Text
• omXBzInfo :: Map Text Text
• omUploadTimestamp :: BBTimestamp
• omCacheControl :: Text

Instances

Eq ObjectMetadata

Defined in Network.BackblazeB2.Data

Methods

(==) :: ObjectMetadata -> ObjectMetadata -> Bool

(/=) :: ObjectMetadata -> ObjectMetadata -> Bool

Show ObjectMetadata

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> ObjectMetadata -> ShowS

show :: ObjectMetadata -> String

showList :: [ObjectMetadata] -> ShowS

newtype ObjectConsumer a

An object consumer is a function that receives object metadat and an action that returns chunks of the body (returning an empty bytestring when no more bytes are available).

Constructors

ObjectConsumer

Fields

• unObjectConsumer :: (ObjectMetadata, IO ByteString) -> IO a

downloadFileByName :: (MonadReader ConnectInfo m, MonadIO m) => Bucket -> Object -> ByteRanges -> ObjectConsumer a -> m a

Download a file by name and pass the result to the provided consumer.

downloadFileById :: (MonadReader ConnectInfo m, MonadIO m) => ObjectId -> ByteRanges -> ObjectConsumer a -> m a

downloadFileById downloads an object given its Id and calls the provided consumer on it.

data FileVersion

Constructors

FileVersion

Fields

• fvFileName :: Object
• fvFileId :: ObjectId

Instances

Eq FileVersion

Defined in Network.BackblazeB2.Data

Methods

(==) :: FileVersion -> FileVersion -> Bool

(/=) :: FileVersion -> FileVersion -> Bool

Show FileVersion

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> FileVersion -> ShowS

show :: FileVersion -> String

showList :: [FileVersion] -> ShowS

Generic FileVersion

Defined in Network.BackblazeB2.Data

Associated Types

type Rep FileVersion :: Type -> Type

Methods

from :: FileVersion -> Rep FileVersion x

to :: Rep FileVersion x -> FileVersion

ToJSON FileVersion

Defined in Network.BackblazeB2.Data

Methods

toJSON :: FileVersion -> Value

toEncoding :: FileVersion -> Encoding

toJSONList :: [FileVersion] -> Value

toEncodingList :: [FileVersion] -> Encoding

FromJSON FileVersion

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser FileVersion

parseJSONList :: Value -> Parser [FileVersion]

type Rep FileVersion

Defined in Network.BackblazeB2.Data

type Rep FileVersion

deleteFileVersion :: (MonadReader ConnectInfo m, MonadIO m) => FileVersion -> m FileVersion

data ObjectListArgs

Constructors

ObjectListArgs

Fields

• olaBucketId :: BucketId
• olaStartFileName :: Maybe Object
• olaMaxFileCount :: Maybe Int
• olaPrefix :: Maybe Object
• olaDelimiter :: Maybe Text

Instances

Eq ObjectListArgs

Defined in Network.BackblazeB2.Data

Methods

(==) :: ObjectListArgs -> ObjectListArgs -> Bool

(/=) :: ObjectListArgs -> ObjectListArgs -> Bool

Show ObjectListArgs

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> ObjectListArgs -> ShowS

show :: ObjectListArgs -> String

showList :: [ObjectListArgs] -> ShowS

Generic ObjectListArgs

Defined in Network.BackblazeB2.Data

Associated Types

type Rep ObjectListArgs :: Type -> Type

Methods

from :: ObjectListArgs -> Rep ObjectListArgs x

to :: Rep ObjectListArgs x -> ObjectListArgs

ToJSON ObjectListArgs

Defined in Network.BackblazeB2.Data

Methods

toJSON :: ObjectListArgs -> Value

toEncoding :: ObjectListArgs -> Encoding

toJSONList :: [ObjectListArgs] -> Value

toEncodingList :: [ObjectListArgs] -> Encoding

type Rep ObjectListArgs

Defined in Network.BackblazeB2.Data

type Rep ObjectListArgs

data ObjectListResult

Constructors

ObjectListResult

Fields

• olrFiles :: [ListResultObjectItem]
• olrFolders :: [ListResultFolderItem]
• olrNextFileName :: Maybe Object

Instances

Eq ObjectListResult

Defined in Network.BackblazeB2.Data

Methods

(==) :: ObjectListResult -> ObjectListResult -> Bool

(/=) :: ObjectListResult -> ObjectListResult -> Bool

Show ObjectListResult

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> ObjectListResult -> ShowS

show :: ObjectListResult -> String

showList :: [ObjectListResult] -> ShowS

Generic ObjectListResult

Defined in Network.BackblazeB2.Data

Associated Types

type Rep ObjectListResult :: Type -> Type

Methods

from :: ObjectListResult -> Rep ObjectListResult x

to :: Rep ObjectListResult x -> ObjectListResult

FromJSON ObjectListResult

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser ObjectListResult

parseJSONList :: Value -> Parser [ObjectListResult]

type Rep ObjectListResult

Defined in Network.BackblazeB2.Data

type Rep ObjectListResult

data ListResultObjectItem

Constructors

ListResultObjectItem

Fields

• lroiFileId :: Text
• lroiFileName :: Object
• lroiContentLength :: Int64
• lroiContentType :: Maybe Text
• lroiContentSha1 :: Maybe Text
• lroiFileInfo :: Maybe (Map Text Text)
• lroiAction :: Text
• lroiUploadTimestamp :: BBTimestamp

Instances

Eq ListResultObjectItem

Defined in Network.BackblazeB2.Data

Methods

(==) :: ListResultObjectItem -> ListResultObjectItem -> Bool

(/=) :: ListResultObjectItem -> ListResultObjectItem -> Bool

Show ListResultObjectItem

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> ListResultObjectItem -> ShowS

show :: ListResultObjectItem -> String

showList :: [ListResultObjectItem] -> ShowS

Generic ListResultObjectItem

Defined in Network.BackblazeB2.Data

Associated Types

type Rep ListResultObjectItem :: Type -> Type

Methods

from :: ListResultObjectItem -> Rep ListResultObjectItem x

to :: Rep ListResultObjectItem x -> ListResultObjectItem

FromJSON ListResultObjectItem

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser ListResultObjectItem

parseJSONList :: Value -> Parser [ListResultObjectItem]

type Rep ListResultObjectItem

Defined in Network.BackblazeB2.Data

type Rep ListResultObjectItem

data ListResultFolderItem

Constructors

ListResultFolderItem

Fields

• lrfiFileName :: Object
• lrfiAction :: Text

Instances

Eq ListResultFolderItem

Defined in Network.BackblazeB2.Data

Methods

(==) :: ListResultFolderItem -> ListResultFolderItem -> Bool

(/=) :: ListResultFolderItem -> ListResultFolderItem -> Bool

Show ListResultFolderItem

Defined in Network.BackblazeB2.Data

Methods

showsPrec :: Int -> ListResultFolderItem -> ShowS

show :: ListResultFolderItem -> String

showList :: [ListResultFolderItem] -> ShowS

Generic ListResultFolderItem

Defined in Network.BackblazeB2.Data

Associated Types

type Rep ListResultFolderItem :: Type -> Type

Methods

from :: ListResultFolderItem -> Rep ListResultFolderItem x

to :: Rep ListResultFolderItem x -> ListResultFolderItem

FromJSON ListResultFolderItem

Defined in Network.BackblazeB2.Data

Methods

parseJSON :: Value -> Parser ListResultFolderItem

parseJSONList :: Value -> Parser [ListResultFolderItem]

type Rep ListResultFolderItem

Defined in Network.BackblazeB2.Data

type Rep ListResultFolderItem

listFileNames :: (MonadReader ConnectInfo m, MonadIO m) => ObjectListArgs -> m ObjectListResult