Copyright	(c) 2021 Rory Tyler Hayford
License	BSD-3-Clause
Maintainer	rory.hayford@protonmail.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Network.DO.Spaces.Actions.ListBucket

Description

Synopsis

data ListBucket = ListBucket {
- bucket :: Bucket
- delimiter :: Maybe Char
- marker :: Maybe Object
- maxKeys :: Maybe Int
- prefix :: Maybe Text
}
data ListBucketResponse = ListBucketResponse {
- bucket :: Bucket
- prefix :: Maybe Text
- marker :: Maybe Object
- nextMarker :: Maybe Object
- maxKeys :: Int
- isTruncated :: Bool
- objects :: Seq ObjectInfo
}

Documentation

data ListBucket Source #

List the contents (Objects) of a Bucket

Constructors

ListBucket
Fields bucket :: Bucket delimiter :: Maybe Char Character used to group keys marker :: Maybe Object The `Object` to start with when listing the bucket's contents maxKeys :: Maybe Int Max number of `Object`s to return, between 0 and 1,000 (inclusive) prefix :: Maybe Text String value to group keys. Only objects whose names begin with the prefix are returned

Instances

Instances details

Eq ListBucket Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Methods (==) :: ListBucket -> ListBucket -> Bool # (/=) :: ListBucket -> ListBucket -> Bool #
Show ListBucket Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Methods showsPrec :: Int -> ListBucket -> ShowS # show :: ListBucket -> String # showList :: [ListBucket] -> ShowS #
Generic ListBucket Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Associated Types type Rep ListBucket :: Type -> Type # Methods from :: ListBucket -> Rep ListBucket x # to :: Rep ListBucket x -> ListBucket #
MonadSpaces m => Action m ListBucket Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Associated Types type ConsumedResponse ListBucket Source # Methods buildRequest :: ListBucket -> m SpacesRequestBuilder Source # consumeResponse :: RawResponse m -> m (ConsumedResponse ListBucket) Source #
type Rep ListBucket Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket type Rep ListBucket = D1 ('MetaData "ListBucket" "Network.DO.Spaces.Actions.ListBucket" "do-spaces-0.1.0-CaP5w5iMum2De5SyXd8Fq2" 'False) (C1 ('MetaCons "ListBucket" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bucket) :: S1 ('MetaSel ('Just "delimiter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Char))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Object)) :: (S1 ('MetaSel ('Just "maxKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type ConsumedResponse ListBucket Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket type ConsumedResponse ListBucket = ListBucketResponse

data ListBucketResponse Source #

Constructors

ListBucketResponse

Fields

bucket :: Bucket
prefix :: Maybe Text
The Object prefix, if supplied as a query param
marker :: Maybe Object
An Object indicating where the list of Objects begin; Nothing denotes the beginning of the list
nextMarker :: Maybe Object
The Object that should be used as the marker query param in subsequent requests
maxKeys :: Int
Maximum number of ObjectInfos to include; based on request parameter of the same name
isTruncated :: Bool
Indicates whether the response contains all possible Objects
objects :: Seq ObjectInfo

Instances

Instances details

Eq ListBucketResponse Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Methods (==) :: ListBucketResponse -> ListBucketResponse -> Bool # (/=) :: ListBucketResponse -> ListBucketResponse -> Bool #
Show ListBucketResponse Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Methods showsPrec :: Int -> ListBucketResponse -> ShowS # show :: ListBucketResponse -> String # showList :: [ListBucketResponse] -> ShowS #
Generic ListBucketResponse Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket Associated Types type Rep ListBucketResponse :: Type -> Type # Methods from :: ListBucketResponse -> Rep ListBucketResponse x # to :: Rep ListBucketResponse x -> ListBucketResponse #
type Rep ListBucketResponse Source #
Instance details Defined in Network.DO.Spaces.Actions.ListBucket type Rep ListBucketResponse = D1 ('MetaData "ListBucketResponse" "Network.DO.Spaces.Actions.ListBucket" "do-spaces-0.1.0-CaP5w5iMum2De5SyXd8Fq2" 'False) (C1 ('MetaCons "ListBucketResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bucket) :: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Object)))) :: ((S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Object)) :: S1 ('MetaSel ('Just "maxKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "objects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ObjectInfo))))))