ObjectStorageService
extends VultrService
in package
Object storage service handler, for all object-storage endpoints.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- createObjectStoreSub() : ObjectStorage
- Create a object storage subscription in a region based on the cluster_id.
- deleteObjectStoreSub() : void
- Delete the object storage subscription and its data.
- getClusters() : array<string|int, mixed>
- Get object storage cluster regions that are available to be deployed in.
- getObjectStoreSub() : ObjectStorage
- Get a specific object storage subscription on the account.
- getObjectStoreSubs() : array<string|int, mixed>
- Get all object storage subscriptions on the account.
- regenObjectStoreKeys() : ObjectStorage
- Regenerate the object storage access and secret keys for the subscription.
- updateObjectStoreSub() : void
- Update an object storage subscription on the account.
- createObject() : ModelInterface
- deleteObject() : void
- getClientHandler() : VultrClientHandler
- getListObjects() : array<string|int, ModelInterface>
- getObject() : ModelInterface
- getVultrClient() : VultrClient
- list() : array<string|int, mixed>
- patchObject() : void
- getReadableClassType() : string
Properties
$vultr
protected
VultrClient
$vultr
$client
private
VultrClientHandler
$client
Methods
__construct()
public
__construct(VultrClient $vultr, VultrClientHandler $client) : mixed
Parameters
- $vultr : VultrClient
- $client : VultrClientHandler
createObjectStoreSub()
Create a object storage subscription in a region based on the cluster_id.
public
createObjectStoreSub( $cluster_id[, $label = null ]) : ObjectStorage
Parameters
- $cluster_id :
-
- integer - @see https://www.vultr.com/api/#operation/list-object-storage-clusters
- $label : = null
-
- string|null - Null means omitted from the request.
Tags
Return values
ObjectStoragedeleteObjectStoreSub()
Delete the object storage subscription and its data.
public
deleteObjectStoreSub( $object_id) : void
Parameters
Tags
getClusters()
Get object storage cluster regions that are available to be deployed in.
public
getClusters([ &$options = null ]) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed>getObjectStoreSub()
Get a specific object storage subscription on the account.
public
getObjectStoreSub( $object_id) : ObjectStorage
Parameters
Tags
Return values
ObjectStoragegetObjectStoreSubs()
Get all object storage subscriptions on the account.
public
getObjectStoreSubs([ &$options = null ]) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed>regenObjectStoreKeys()
Regenerate the object storage access and secret keys for the subscription.
public
regenObjectStoreKeys( $obj) : ObjectStorage
Parameters
Tags
Return values
ObjectStorageupdateObjectStoreSub()
Update an object storage subscription on the account.
public
updateObjectStoreSub( $obj) : void
Parameters
Tags
createObject()
protected
createObject( $uri, $model, $params) : ModelInterface
Parameters
- $uri :
-
- string - the url address to query after api.vultr.com/v2
- $model :
-
- ModelInterface - the object model that we are creating
- $params :
-
- array - The values that we will be sending. Refactor to use getUpdateParams/getUpdateArray?
Tags
Return values
ModelInterfacedeleteObject()
protected
deleteObject( $uri, $model) : void
Parameters
- $uri :
-
- string - the url address to query after api.vultr.com/v2
- $model :
-
- ModelInterface - the object model that we are acting on deleting. This doesn't need to be a fully initialized object.
Tags
getClientHandler()
protected
getClientHandler() : VultrClientHandler
Return values
VultrClientHandlergetListObjects()
protected
getListObjects( $uri, $model[, &$options = null ][, $params = null ]) : array<string|int, ModelInterface>
Parameters
- $uri :
-
- string - the url address to query after api.vultr.com/v2
- $model :
-
- ModelInterface - the object that will be mapped to the get response.
- $options : = null
-
- ListOptions - Pagination object
- $params : = null
-
- array - filter parameters.
Tags
Return values
array<string|int, ModelInterface>getObject()
protected
getObject( $uri, $model) : ModelInterface
Parameters
- $uri :
-
- string - the url address to query after api.vultr.com/v2
- $model :
-
- ModelInterface - the object that will be mapped to the get response.
Tags
Return values
ModelInterfacegetVultrClient()
protected
getVultrClient() : VultrClient
Return values
VultrClientlist()
protected
list(string $uri, ModelInterface $model, ListOptions &$options[, array<string|int, mixed>|null $params = null ]) : array<string|int, mixed>
Parameters
- $uri : string
- $model : ModelInterface
- $options : ListOptions
- $params : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>patchObject()
protected
patchObject( $uri, $model[, array<string|int, mixed>|null $params = null ]) : void
Parameters
- $uri :
-
- string - the url address to query after api.vultr.com/v2
- $model :
-
- ModelInterface - the object model that we are updating. This needs to be a fully initialized object.
- $params : array<string|int, mixed>|null = null
Tags
getReadableClassType()
private
getReadableClassType(ModelInterface $model) : string
Parameters
- $model : ModelInterface