Skip to content

Commit 435a2d9

Browse files
author
Jamie Hannaford
committed
add docblock
1 parent 17c4d2a commit 435a2d9

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/ObjectStore/v1/Models/Container.php

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,17 @@ public function createObject(array $data)
183183
}
184184

185185
/**
186-
* @param array $data
186+
* Creates a Dynamic Large Object by chunking a file into smaller segments and uploading them into a holding
187+
* container. When this completes, a manifest file is uploaded which references the prefix of the segments,
188+
* allowing concatenation when a request is executed against the manifest.
189+
*
190+
* @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject}
191+
* @param int $data['segmentSize'] The size in Bytes of each segment
192+
* @param string $data['segmentContainer'] The container to which each segment will be uploaded
193+
* @param string $data['segmentPrefix'] The prefix that will come before each segment. If omitted, a default
194+
* is used: name/timestamp/filesize
195+
*
196+
* @return Object
187197
*/
188198
public function createLargeObject(array $data)
189199
{

0 commit comments

Comments
 (0)