Class Service
The ObjectStore (Cloud Files) service.
- OpenCloud\Common\Base
-
OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface
-
OpenCloud\Common\Service\CatalogService
-
OpenCloud\ObjectStore\AbstractService
-
OpenCloud\ObjectStore\Service
Methods summary
public
|
#
__construct(
Creates a service object, based off the specified client. |
public
|
|
public
|
|
public
|
|
public
boolean|
|
|
public
boolean
|
|
public
Guzzle\Http\Message\Response
|
#
bulkExtract( string $path, string|stream $archive, string $archiveType = OpenCloud\ObjectStore\UrlType::TAR_GZ )
Perform a bulk extraction, expanding an archive file. If the $path is an empty string, containers will be auto-created accordingly, and files in the archive that do not map to any container (files in the base directory) will be ignored. You can create up to 1,000 new containers per extraction request. Also note that only regular files will be uploaded. Empty directories, symlinks, and so on, will not be uploaded. |
public
|
|
public
array[Guzzle\Http\Message\Response]
|
#
batchDelete( array $paths )
Batch delete will delete an array of object paths. By default, the API will only accept a maximum of 10,000 object deletions per request - so for arrays that exceed this size, it is chunked and sent as individual requests. |
public
array[Guzzle\Http\Message\Response]
|
#
migrateContainer(
Allows files to be transferred from one container to another. |
Methods inherited from OpenCloud\ObjectStore\AbstractService
Methods inherited from OpenCloud\Common\Service\CatalogService
getBaseUrl()
,
getExtensions()
,
getName()
,
getRegion()
,
getType()
,
getUrl()
,
getUrlType()
,
limits()
,
name()
,
region()
,
url()
Methods inherited from OpenCloud\Common\Service\AbstractService
collection()
,
getClient()
,
getEndpoint()
,
getNamespaces()
,
getResources()
,
namespaces()
,
resource()
,
resourceList()
,
setClient()
,
setEndpoint()
Methods inherited from OpenCloud\Common\Base
__call()
,
checkJsonError()
,
generateUuid()
,
getInstance()
,
getLogger()
,
hasLogger()
,
makeResourceIteratorOptions()
,
populate()
,
setLogger()
,
stripNamespace()
,
toCamel()
,
toUnderscores()
Constants summary
string |
DEFAULT_NAME
|
#
'cloudFiles'
|
string |
DEFAULT_TYPE
|
#
'object-store'
|
integer |
BATCH_DELETE_MAX
|
#
10000
|
Constants inherited from OpenCloud\ObjectStore\AbstractService
MAX_CONTAINER_NAME_LENGTH
,
MAX_OBJECT_NAME_LEN
,
MAX_OBJECT_SIZE