Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Storage.Objects.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a list of objects matching the criteria.

See: Cloud Storage JSON API Reference for storage.objects.list.

Synopsis

type ObjectsListResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (QueryParam "prefix" Text :> (QueryParam "versions" Bool :> (QueryParam "userProject" Text :> (QueryParam "includeTrailingDelimiter" Bool :> (QueryParam "projection" ObjectsListProjection :> (QueryParam "pageToken" Text :> (QueryParam "delimiter" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Objects)))))))))))))
objectsList :: Text -> ObjectsList
data ObjectsList
olPrefix :: Lens' ObjectsList (Maybe Text)
olBucket :: Lens' ObjectsList Text
olVersions :: Lens' ObjectsList (Maybe Bool)
olUserProject :: Lens' ObjectsList (Maybe Text)
olIncludeTrailingDelimiter :: Lens' ObjectsList (Maybe Bool)
olProjection :: Lens' ObjectsList (Maybe ObjectsListProjection)
olPageToken :: Lens' ObjectsList (Maybe Text)
olDelimiter :: Lens' ObjectsList (Maybe Text)
olMaxResults :: Lens' ObjectsList Word32

REST Resource

type ObjectsListResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (QueryParam "prefix" Text :> (QueryParam "versions" Bool :> (QueryParam "userProject" Text :> (QueryParam "includeTrailingDelimiter" Bool :> (QueryParam "projection" ObjectsListProjection :> (QueryParam "pageToken" Text :> (QueryParam "delimiter" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Objects))))))))))))) Source #

A resource alias for storage.objects.list method which the ObjectsList request conforms to.

Creating a Request

objectsList Source #

Arguments

:: Text	`olBucket`
-> ObjectsList

Creates a value of ObjectsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ObjectsList Source #

Retrieves a list of objects matching the criteria.

See: objectsList smart constructor.

Instances

Eq ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List Methods (==) :: ObjectsList -> ObjectsList -> Bool # (/=) :: ObjectsList -> ObjectsList -> Bool #
Data ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ObjectsList -> c ObjectsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ObjectsList # toConstr :: ObjectsList -> Constr # dataTypeOf :: ObjectsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ObjectsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ObjectsList) # gmapT :: (forall b. Data b => b -> b) -> ObjectsList -> ObjectsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ObjectsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ObjectsList -> r # gmapQ :: (forall d. Data d => d -> u) -> ObjectsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ObjectsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ObjectsList -> m ObjectsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ObjectsList -> m ObjectsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ObjectsList -> m ObjectsList #
Show ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List Methods showsPrec :: Int -> ObjectsList -> ShowS # show :: ObjectsList -> String # showList :: [ObjectsList] -> ShowS #
Generic ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List Associated Types type Rep ObjectsList :: Type -> Type # Methods from :: ObjectsList -> Rep ObjectsList x # to :: Rep ObjectsList x -> ObjectsList #
GoogleRequest ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List Associated Types type Rs ObjectsList :: Type # type Scopes ObjectsList :: [Symbol] # Methods requestClient :: ObjectsList -> GClient (Rs ObjectsList) #
type Rep ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List type Rep ObjectsList = D1 (MetaData "ObjectsList" "Network.Google.Resource.Storage.Objects.List" "gogol-storage-0.4.0-F1QXZopXJqf9Y2QJKwfuR3" False) (C1 (MetaCons "ObjectsList'" PrefixI True) (((S1 (MetaSel (Just "_olPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_olVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_olUserProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_olIncludeTrailingDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_olProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ObjectsListProjection))) :: (S1 (MetaSel (Just "_olPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_olDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_olMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))
type Scopes ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List type Scopes ObjectsList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/cloud-platform.read-only" ': ("https://www.googleapis.com/auth/devstorage.full_control" ': ("https://www.googleapis.com/auth/devstorage.read_only" ': ("https://www.googleapis.com/auth/devstorage.read_write" ': ([] :: [Symbol])))))
type Rs ObjectsList Source #
Instance details Defined in Network.Google.Resource.Storage.Objects.List type Rs ObjectsList = Objects

Request Lenses

olPrefix :: Lens' ObjectsList (Maybe Text) Source #

Filter results to objects whose names begin with this prefix.

olBucket :: Lens' ObjectsList Text Source #

Name of the bucket in which to look for objects.

olVersions :: Lens' ObjectsList (Maybe Bool) Source #

If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.

olUserProject :: Lens' ObjectsList (Maybe Text) Source #

The project to be billed for this request. Required for Requester Pays buckets.

olIncludeTrailingDelimiter :: Lens' ObjectsList (Maybe Bool) Source #

If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.

olProjection :: Lens' ObjectsList (Maybe ObjectsListProjection) Source #

Set of properties to return. Defaults to noAcl.

olPageToken :: Lens' ObjectsList (Maybe Text) Source #

A previously-returned page token representing part of the larger set of results to view.

olDelimiter :: Lens' ObjectsList (Maybe Text) Source #

Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

olMaxResults :: Lens' ObjectsList Word32 Source #

Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.