Copyright | (c) 2015 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 |
Retrieves a list of objects matching the criteria.
See: Cloud Storage JSON API Reference for storage.objects.list
.
- type ObjectsListResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (QueryParam "prefix" Text :> (QueryParam "versions" 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)
- olProjection :: Lens' ObjectsList (Maybe ObjectsListProjection)
- olPageToken :: Lens' ObjectsList (Maybe Text)
- olDelimiter :: Lens' ObjectsList (Maybe Text)
- olMaxResults :: Lens' ObjectsList (Maybe Word32)
REST Resource
type ObjectsListResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> (QueryParam "prefix" Text :> (QueryParam "versions" 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
:: Text | |
-> 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.
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.
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 (Maybe Word32) Source
Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. The default value of this parameter is 1,000 items.