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 |
Watch for changes on all objects in a bucket.
See: Cloud Storage JSON API Reference for storage.objects.watchAll
.
- type ObjectsWatchAllResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> ("watch" :> (QueryParam "prefix" Text :> (QueryParam "versions" Bool :> (QueryParam "projection" ObjectsWatchAllProjection :> (QueryParam "pageToken" Text :> (QueryParam "delimiter" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Channel :> Post '[JSON] Channel)))))))))))))
- objectsWatchAll :: Text -> Channel -> ObjectsWatchAll
- data ObjectsWatchAll
- owaPrefix :: Lens' ObjectsWatchAll (Maybe Text)
- owaBucket :: Lens' ObjectsWatchAll Text
- owaPayload :: Lens' ObjectsWatchAll Channel
- owaVersions :: Lens' ObjectsWatchAll (Maybe Bool)
- owaProjection :: Lens' ObjectsWatchAll (Maybe ObjectsWatchAllProjection)
- owaPageToken :: Lens' ObjectsWatchAll (Maybe Text)
- owaDelimiter :: Lens' ObjectsWatchAll (Maybe Text)
- owaMaxResults :: Lens' ObjectsWatchAll (Maybe Word32)
REST Resource
type ObjectsWatchAllResource = "storage" :> ("v1" :> ("b" :> (Capture "bucket" Text :> ("o" :> ("watch" :> (QueryParam "prefix" Text :> (QueryParam "versions" Bool :> (QueryParam "projection" ObjectsWatchAllProjection :> (QueryParam "pageToken" Text :> (QueryParam "delimiter" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Channel :> Post '[JSON] Channel))))))))))))) Source #
A resource alias for storage.objects.watchAll
method which the
ObjectsWatchAll
request conforms to.
Creating a Request
Creates a value of ObjectsWatchAll
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ObjectsWatchAll Source #
Watch for changes on all objects in a bucket.
See: objectsWatchAll
smart constructor.
Request Lenses
owaPrefix :: Lens' ObjectsWatchAll (Maybe Text) Source #
Filter results to objects whose names begin with this prefix.
owaPayload :: Lens' ObjectsWatchAll Channel Source #
Multipart request metadata.
owaVersions :: Lens' ObjectsWatchAll (Maybe Bool) Source #
If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
owaProjection :: Lens' ObjectsWatchAll (Maybe ObjectsWatchAllProjection) Source #
Set of properties to return. Defaults to noAcl.
owaPageToken :: Lens' ObjectsWatchAll (Maybe Text) Source #
A previously-returned page token representing part of the larger set of results to view.
owaDelimiter :: Lens' ObjectsWatchAll (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.
owaMaxResults :: Lens' ObjectsWatchAll (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.