606 lines
24 KiB
PHP
606 lines
24 KiB
PHP
<?php
|
|
/**
|
|
* CreateVolumeRequest
|
|
*
|
|
* PHP version 7.4
|
|
*
|
|
* @category Class
|
|
* @package OpenAPI\Client
|
|
* @author OpenAPI Generator team
|
|
* @link https://openapi-generator.tech
|
|
*/
|
|
|
|
/**
|
|
* Block Storage API
|
|
*
|
|
* Scaleway Block Storage provides network-attached storage that can be plugged in and out of cloud products such as Instances like a virtual hard-drive. Block Storage devices are independent from the local storage of Instances, and the fact that they are accessed over a network connection makes it easy to move them between Instances in the same Availability Zone. (switchcolumn) <Message type=\"important\"> This page includes the API reference documentation for all Block Storage Low Latency offers. If you wish to use the Basic Block Storage offers, refer to the [Instances API documentation page](/api/instance/#path-volume-types-list-volume-types). </Message> (switchcolumn) ## Quickstart 1. Configure your environment variables. <Message type=\"note\"> This is an optional step that seeks to simplify your usage of the Block Storage API. See [Availability Zones](#availability-zones) below for help choosing an Availability Zone. You can find your Project ID in the [Scaleway console](https://console.scaleway.com/project/settings). </Message> ```bash export SCW_SECRET_KEY=\"<API secret key>\" export SCW_DEFAULT_ZONE=\"<Scaleway Availability Zone>\" export SCW_PROJECT_ID=\"<Scaleway Project ID>\" ``` <Message type=\"important\"> Make sure that the Availability Zone (AZ) is the same as the one of your Instance. Block volumes can only be attached to Instances in the same AZ. </Message> 2. Edit the POST request payload you will use to create your Block volume. Replace the parameters in the following example: ```json '{ \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\", \"name\": \"my-volume\", \"perf_iops\": \"5000\", \"tags\": [\"donnerstag\"], \"from_empty\": { \"size\": \"30000000000\"} }' ``` | Parameter | Description | | :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `project_id` | **REQUIRED** The ID of the Project you want to create your Block volume in. To find your Project ID you can **[list the projects](/api/account#path-projects-list-all-projects-of-an-organization)** or consult the **[Scaleway console](https://console.scaleway.com/project/settings)**. | | `name` | **REQUIRED** Name of the volume | | `perf_iops` | **REQUIRED** The maximum IO/s expected. This amount is a shared limit between write and read operations, it will be determined by your usage. You must specify either `5000`, or `15000`. | | `tags` | The list of tags `[\"tag1\", \"tag2\", ...]` that will be associated with the Database Instance. Tags can be appended to the query of the [List Database Instances](#path-database-instances-list-database-instances) call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that posess all the appended tags. | | `from_empty` | When you create a brand new volume, as opposed to creating a volume from a snapshot, you must specifiy its size. | | `size` | Volume size. The value should be expressed in bytes. For example 30GB is expressed as 30000000000 | 3. Create a Block volume by running the following command. Make sure you include the payload you edited in the previous step. ```bash curl -X POST \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ \"Content-Type: application/json\" \\ https://api.scaleway.com/block/v1alpha1/zone/$SCW_DEFAULT_ZONE/volumes \\ -d '{ \"project_id\": \"'\"$SCW_PROJECT_ID\"'\", \"name\": \"my-volume\", \"perf_iops\": \"5000\", \"tags\": [\"donnerstag\"], \"from_empty\": { \"size\": \"30000000000\"} }' ``` An output similar to the following displays : ```json '{ \"id\": \"e337a374-f19a-4b58-a45d-75076f75fbc5\", \"name\": \"my-volume\", \"type\": \"sbs_5k\", \"size\": 30000000000, \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\", \"created_at\": \"2023-09-28T15:48:59.105240Z\", \"updated_at\": \"2023-09-28T15:48:59.105240Z\", \"references\": [], \"parent_snapshot_id\": None, \"status\": \"creating\", \"tags\": [], \"specs\": {\"perf_iops\": 5000, \"class\": \"sbs\"}, \"zone\": \"fr-par-1\" }' ``` <Message type=\"note\"> Make sure to save the `id` of your volume, as it will be required in the next step. </Message> 4. Attach your volume to your Instance using the Instance API [Update an Instance](/api/instance/#path-instances-update-an-instance) call. <Message type=\"note\"> Make sure the Block volume is created and ready before attaching it to the Instance. </Message> <Message type=\"important\"> Make sure you include all your Instance's existing volumes in the payload, as the update can only be done to all or none of the volumes. The payload should include a minimum of one key (`\"0\"`) with a value equivalent to the setting parameters for the volume. Additional keys for additional volumes should increment by 1 each time. For example, the second volume is `\"1\"`, the third `\"2\"`, and so on. </Message> ```bash curl -X PATCH \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ \"Content-Type: application/json\" \\ https://api.scaleway.com/instance/v1/zone/$SCW_DEFAULT_ZONE/servers/$INSTANCE_ID \\ -d '{ \"volumes\": { \"0\": { \"boot\": false, \"id\": \"571c8a17-ba68-4c1d-b137-bbd5bc7af104\", \"volume_type\": \"System volume\" } \"1\": { \"boot\": false, \"id\": \"e337a374-f19a-4b58-a45d-75076f75fbc5\", \"volume_type\": \"sbs_volume\" } }' ``` Your Block volume is ready to be used with your Instance. Refer to the [How to mount and use your Block volume](https://www.scaleway.com/en/docs/storage/block/how-to/mount-and-use-volume/) documentation page to do so. (switchcolumn) <Message type=\"requirement\"> To perform the following steps, you must first ensure that: - you have an account and are logged into the [Scaleway console](https://console.scaleway.com/organization) - you have created an [API key](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/identity-and-access-management/iam/reference-content/permission-sets/) to perform the actions described on this page. - you have [installed `curl`](https://curl.se/download.html) - you have [created an Instance](/instance/#path-instances-create-an-instance). </Message> (switchcolumn) ## Going further For further information and assitance for Scaleway Block Storage, check out the following resources: - [Basic Block Storage Documentation](https://www.scaleway.com/en/docs/storage/block/) - [#block channel in the Scaleway Slack Community](scaleway-community.slack.com) - [How to open a support ticket](https://www.scaleway.com/en/docs/console/my-account/how-to/open-a-support-ticket/).
|
|
*
|
|
* The version of the OpenAPI document: v1alpha1
|
|
* Generated by: https://openapi-generator.tech
|
|
* Generator version: 7.11.0
|
|
*/
|
|
|
|
/**
|
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
namespace OpenAPI\Client\Model;
|
|
|
|
use \ArrayAccess;
|
|
use \OpenAPI\Client\ObjectSerializer;
|
|
|
|
/**
|
|
* CreateVolumeRequest Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package OpenAPI\Client
|
|
* @author OpenAPI Generator team
|
|
* @link https://openapi-generator.tech
|
|
* @implements \ArrayAccess<string, mixed>
|
|
*/
|
|
class CreateVolumeRequest implements ModelInterface, ArrayAccess, \JsonSerializable
|
|
{
|
|
public const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $openAPIModelName = 'CreateVolume_request';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $openAPITypes = [
|
|
'name' => 'string',
|
|
'perf_iops' => 'int',
|
|
'project_id' => 'string',
|
|
'from_empty' => '\OpenAPI\Client\Model\CreateVolumeRequestFromEmpty',
|
|
'from_snapshot' => '\OpenAPI\Client\Model\CreateVolumeRequestFromSnapshot',
|
|
'tags' => 'string[]'
|
|
];
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
* @phpstan-var array<string, string|null>
|
|
* @psalm-var array<string, string|null>
|
|
*/
|
|
protected static $openAPIFormats = [
|
|
'name' => null,
|
|
'perf_iops' => 'uint32',
|
|
'project_id' => null,
|
|
'from_empty' => null,
|
|
'from_snapshot' => null,
|
|
'tags' => null
|
|
];
|
|
|
|
/**
|
|
* Array of nullable properties. Used for (de)serialization
|
|
*
|
|
* @var boolean[]
|
|
*/
|
|
protected static array $openAPINullables = [
|
|
'name' => false,
|
|
'perf_iops' => true,
|
|
'project_id' => false,
|
|
'from_empty' => true,
|
|
'from_snapshot' => true,
|
|
'tags' => false
|
|
];
|
|
|
|
/**
|
|
* If a nullable field gets set to null, insert it here
|
|
*
|
|
* @var boolean[]
|
|
*/
|
|
protected array $openAPINullablesSetToNull = [];
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function openAPITypes()
|
|
{
|
|
return self::$openAPITypes;
|
|
}
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function openAPIFormats()
|
|
{
|
|
return self::$openAPIFormats;
|
|
}
|
|
|
|
/**
|
|
* Array of nullable properties
|
|
*
|
|
* @return array
|
|
*/
|
|
protected static function openAPINullables(): array
|
|
{
|
|
return self::$openAPINullables;
|
|
}
|
|
|
|
/**
|
|
* Array of nullable field names deliberately set to null
|
|
*
|
|
* @return boolean[]
|
|
*/
|
|
private function getOpenAPINullablesSetToNull(): array
|
|
{
|
|
return $this->openAPINullablesSetToNull;
|
|
}
|
|
|
|
/**
|
|
* Setter - Array of nullable field names deliberately set to null
|
|
*
|
|
* @param boolean[] $openAPINullablesSetToNull
|
|
*/
|
|
private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
|
|
{
|
|
$this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
|
|
}
|
|
|
|
/**
|
|
* Checks if a property is nullable
|
|
*
|
|
* @param string $property
|
|
* @return bool
|
|
*/
|
|
public static function isNullable(string $property): bool
|
|
{
|
|
return self::openAPINullables()[$property] ?? false;
|
|
}
|
|
|
|
/**
|
|
* Checks if a nullable property is set to null.
|
|
*
|
|
* @param string $property
|
|
* @return bool
|
|
*/
|
|
public function isNullableSetToNull(string $property): bool
|
|
{
|
|
return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
|
|
}
|
|
|
|
/**
|
|
* Array of attributes where the key is the local name,
|
|
* and the value is the original name
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $attributeMap = [
|
|
'name' => 'name',
|
|
'perf_iops' => 'perf_iops',
|
|
'project_id' => 'project_id',
|
|
'from_empty' => 'from_empty',
|
|
'from_snapshot' => 'from_snapshot',
|
|
'tags' => 'tags'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'name' => 'setName',
|
|
'perf_iops' => 'setPerfIops',
|
|
'project_id' => 'setProjectId',
|
|
'from_empty' => 'setFromEmpty',
|
|
'from_snapshot' => 'setFromSnapshot',
|
|
'tags' => 'setTags'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'name' => 'getName',
|
|
'perf_iops' => 'getPerfIops',
|
|
'project_id' => 'getProjectId',
|
|
'from_empty' => 'getFromEmpty',
|
|
'from_snapshot' => 'getFromSnapshot',
|
|
'tags' => 'getTags'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes where the key is the local name,
|
|
* and the value is the original name
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function attributeMap()
|
|
{
|
|
return self::$attributeMap;
|
|
}
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function setters()
|
|
{
|
|
return self::$setters;
|
|
}
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function getters()
|
|
{
|
|
return self::$getters;
|
|
}
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getModelName()
|
|
{
|
|
return self::$openAPIModelName;
|
|
}
|
|
|
|
|
|
/**
|
|
* Associative array for storing property values
|
|
*
|
|
* @var mixed[]
|
|
*/
|
|
protected $container = [];
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param mixed[]|null $data Associated array of property values
|
|
* initializing the model
|
|
*/
|
|
public function __construct(?array $data = null)
|
|
{
|
|
$this->setIfExists('name', $data ?? [], null);
|
|
$this->setIfExists('perf_iops', $data ?? [], null);
|
|
$this->setIfExists('project_id', $data ?? [], null);
|
|
$this->setIfExists('from_empty', $data ?? [], null);
|
|
$this->setIfExists('from_snapshot', $data ?? [], null);
|
|
$this->setIfExists('tags', $data ?? [], null);
|
|
}
|
|
|
|
/**
|
|
* Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
|
|
* is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
|
|
* $this->openAPINullablesSetToNull array
|
|
*
|
|
* @param string $variableName
|
|
* @param array $fields
|
|
* @param mixed $defaultValue
|
|
*/
|
|
private function setIfExists(string $variableName, array $fields, $defaultValue): void
|
|
{
|
|
if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
|
|
$this->openAPINullablesSetToNull[] = $variableName;
|
|
}
|
|
|
|
$this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
|
|
}
|
|
|
|
/**
|
|
* Show all the invalid properties with reasons.
|
|
*
|
|
* @return array invalid properties with reasons
|
|
*/
|
|
public function listInvalidProperties()
|
|
{
|
|
$invalidProperties = [];
|
|
|
|
if ($this->container['name'] === null) {
|
|
$invalidProperties[] = "'name' can't be null";
|
|
}
|
|
if ($this->container['project_id'] === null) {
|
|
$invalidProperties[] = "'project_id' can't be null";
|
|
}
|
|
return $invalidProperties;
|
|
}
|
|
|
|
/**
|
|
* Validate all the properties in the model
|
|
* return true if all passed
|
|
*
|
|
* @return bool True if all properties are valid
|
|
*/
|
|
public function valid()
|
|
{
|
|
return count($this->listInvalidProperties()) === 0;
|
|
}
|
|
|
|
|
|
/**
|
|
* Gets name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->container['name'];
|
|
}
|
|
|
|
/**
|
|
* Sets name
|
|
*
|
|
* @param string $name Name of the volume.
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setName($name)
|
|
{
|
|
if (is_null($name)) {
|
|
throw new \InvalidArgumentException('non-nullable name cannot be null');
|
|
}
|
|
$this->container['name'] = $name;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets perf_iops
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function getPerfIops()
|
|
{
|
|
return $this->container['perf_iops'];
|
|
}
|
|
|
|
/**
|
|
* Sets perf_iops
|
|
*
|
|
* @param int|null $perf_iops The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`).
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setPerfIops($perf_iops)
|
|
{
|
|
if (is_null($perf_iops)) {
|
|
array_push($this->openAPINullablesSetToNull, 'perf_iops');
|
|
} else {
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
|
$index = array_search('perf_iops', $nullablesSetToNull);
|
|
if ($index !== FALSE) {
|
|
unset($nullablesSetToNull[$index]);
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
|
}
|
|
}
|
|
$this->container['perf_iops'] = $perf_iops;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets project_id
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getProjectId()
|
|
{
|
|
return $this->container['project_id'];
|
|
}
|
|
|
|
/**
|
|
* Sets project_id
|
|
*
|
|
* @param string $project_id UUID of the project the volume belongs to.
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setProjectId($project_id)
|
|
{
|
|
if (is_null($project_id)) {
|
|
throw new \InvalidArgumentException('non-nullable project_id cannot be null');
|
|
}
|
|
$this->container['project_id'] = $project_id;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets from_empty
|
|
*
|
|
* @return \OpenAPI\Client\Model\CreateVolumeRequestFromEmpty|null
|
|
*/
|
|
public function getFromEmpty()
|
|
{
|
|
return $this->container['from_empty'];
|
|
}
|
|
|
|
/**
|
|
* Sets from_empty
|
|
*
|
|
* @param \OpenAPI\Client\Model\CreateVolumeRequestFromEmpty|null $from_empty from_empty
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setFromEmpty($from_empty)
|
|
{
|
|
if (is_null($from_empty)) {
|
|
array_push($this->openAPINullablesSetToNull, 'from_empty');
|
|
} else {
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
|
$index = array_search('from_empty', $nullablesSetToNull);
|
|
if ($index !== FALSE) {
|
|
unset($nullablesSetToNull[$index]);
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
|
}
|
|
}
|
|
$this->container['from_empty'] = $from_empty;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets from_snapshot
|
|
*
|
|
* @return \OpenAPI\Client\Model\CreateVolumeRequestFromSnapshot|null
|
|
*/
|
|
public function getFromSnapshot()
|
|
{
|
|
return $this->container['from_snapshot'];
|
|
}
|
|
|
|
/**
|
|
* Sets from_snapshot
|
|
*
|
|
* @param \OpenAPI\Client\Model\CreateVolumeRequestFromSnapshot|null $from_snapshot from_snapshot
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setFromSnapshot($from_snapshot)
|
|
{
|
|
if (is_null($from_snapshot)) {
|
|
array_push($this->openAPINullablesSetToNull, 'from_snapshot');
|
|
} else {
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
|
$index = array_search('from_snapshot', $nullablesSetToNull);
|
|
if ($index !== FALSE) {
|
|
unset($nullablesSetToNull[$index]);
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
|
}
|
|
}
|
|
$this->container['from_snapshot'] = $from_snapshot;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets tags
|
|
*
|
|
* @return string[]|null
|
|
*/
|
|
public function getTags()
|
|
{
|
|
return $this->container['tags'];
|
|
}
|
|
|
|
/**
|
|
* Sets tags
|
|
*
|
|
* @param string[]|null $tags List of tags assigned to the volume.
|
|
*
|
|
* @return self
|
|
*/
|
|
public function setTags($tags)
|
|
{
|
|
if (is_null($tags)) {
|
|
throw new \InvalidArgumentException('non-nullable tags cannot be null');
|
|
}
|
|
$this->container['tags'] = $tags;
|
|
|
|
return $this;
|
|
}
|
|
/**
|
|
* Returns true if offset exists. False otherwise.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function offsetExists($offset): bool
|
|
{
|
|
return isset($this->container[$offset]);
|
|
}
|
|
|
|
/**
|
|
* Gets offset.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return mixed|null
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function offsetGet($offset)
|
|
{
|
|
return $this->container[$offset] ?? null;
|
|
}
|
|
|
|
/**
|
|
* Sets value based on offset.
|
|
*
|
|
* @param int|null $offset Offset
|
|
* @param mixed $value Value to be set
|
|
*
|
|
* @return void
|
|
*/
|
|
public function offsetSet($offset, $value): void
|
|
{
|
|
if (is_null($offset)) {
|
|
$this->container[] = $value;
|
|
} else {
|
|
$this->container[$offset] = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Unsets offset.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return void
|
|
*/
|
|
public function offsetUnset($offset): void
|
|
{
|
|
unset($this->container[$offset]);
|
|
}
|
|
|
|
/**
|
|
* Serializes the object to a value that can be serialized natively by json_encode().
|
|
* @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
|
|
*
|
|
* @return mixed Returns data which can be serialized by json_encode(), which is a value
|
|
* of any type other than a resource.
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function jsonSerialize()
|
|
{
|
|
return ObjectSerializer::sanitizeForSerialization($this);
|
|
}
|
|
|
|
/**
|
|
* Gets the string presentation of the object
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
return json_encode(
|
|
ObjectSerializer::sanitizeForSerialization($this),
|
|
JSON_PRETTY_PRINT
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets a header-safe presentation of the object
|
|
*
|
|
* @return string
|
|
*/
|
|
public function toHeaderValue()
|
|
{
|
|
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
|
|
}
|
|
}
|
|
|
|
|