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 |
Concatenates a list of existing objects into a new object in the same bucket.
See: Cloud Storage JSON API Reference for storage.objects.compose
.
Synopsis
- type ObjectsComposeResource = "storage" :> ("v1" :> ("b" :> (Capture "destinationBucket" Text :> ("o" :> (Capture "destinationObject" Text :> ("compose" :> (QueryParam "destinationPredefinedAcl" ObjectsComposeDestinationPredefinedACL :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "userProject" Text :> (QueryParam "kmsKeyName" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ComposeRequest :> Post '[JSON] Object)))))))))))))
- objectsCompose :: ComposeRequest -> Text -> Text -> ObjectsCompose
- data ObjectsCompose
- oDestinationPredefinedACL :: Lens' ObjectsCompose (Maybe ObjectsComposeDestinationPredefinedACL)
- oIfMetagenerationMatch :: Lens' ObjectsCompose (Maybe Int64)
- oIfGenerationMatch :: Lens' ObjectsCompose (Maybe Int64)
- oPayload :: Lens' ObjectsCompose ComposeRequest
- oUserProject :: Lens' ObjectsCompose (Maybe Text)
- oDestinationBucket :: Lens' ObjectsCompose Text
- oKmsKeyName :: Lens' ObjectsCompose (Maybe Text)
- oDestinationObject :: Lens' ObjectsCompose Text
REST Resource
type ObjectsComposeResource = "storage" :> ("v1" :> ("b" :> (Capture "destinationBucket" Text :> ("o" :> (Capture "destinationObject" Text :> ("compose" :> (QueryParam "destinationPredefinedAcl" ObjectsComposeDestinationPredefinedACL :> (QueryParam "ifMetagenerationMatch" (Textual Int64) :> (QueryParam "ifGenerationMatch" (Textual Int64) :> (QueryParam "userProject" Text :> (QueryParam "kmsKeyName" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ComposeRequest :> Post '[JSON] Object))))))))))))) Source #
A resource alias for storage.objects.compose
method which the
ObjectsCompose
request conforms to.
Creating a Request
Creates a value of ObjectsCompose
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ObjectsCompose Source #
Concatenates a list of existing objects into a new object in the same bucket.
See: objectsCompose
smart constructor.
Instances
Request Lenses
oDestinationPredefinedACL :: Lens' ObjectsCompose (Maybe ObjectsComposeDestinationPredefinedACL) Source #
Apply a predefined set of access controls to the destination object.
oIfMetagenerationMatch :: Lens' ObjectsCompose (Maybe Int64) Source #
Makes the operation conditional on whether the object's current metageneration matches the given value.
oIfGenerationMatch :: Lens' ObjectsCompose (Maybe Int64) Source #
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
oPayload :: Lens' ObjectsCompose ComposeRequest Source #
Multipart request metadata.
oUserProject :: Lens' ObjectsCompose (Maybe Text) Source #
The project to be billed for this request. Required for Requester Pays buckets.
oDestinationBucket :: Lens' ObjectsCompose Text Source #
Name of the bucket containing the source objects. The destination object is stored in this bucket.
oKmsKeyName :: Lens' ObjectsCompose (Maybe Text) Source #
Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
oDestinationObject :: Lens' ObjectsCompose Text Source #
Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.