930 lines
40 KiB
PHP
930 lines
40 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* UpdateServerRequest
|
||
|
|
*
|
||
|
|
* PHP version 7.4
|
||
|
|
*
|
||
|
|
* @category Class
|
||
|
|
* @package OpenAPI\Client
|
||
|
|
* @author OpenAPI Generator team
|
||
|
|
* @link https://openapi-generator.tech
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Instance API
|
||
|
|
*
|
||
|
|
* Scaleway Instances are virtual machines in the cloud. Different [Instance types](https://www.scaleway.com/en/docs/compute/instances/reference-content/choosing-instance-type/) offer different technical specifications in terms of vCPU, RAM, bandwidth and storage. Once you have created your Instance and installed your image of choice (e.g. an operating system), you can [connect to your Instance via SSH](https://www.scaleway.com/en/docs/compute/instances/how-to/connect-to-instance/) to use it as you wish. When you are done using the Instance, you can delete it from your account. (switchcolumn) <Message type=\"tip\"> To retrieve information about the different [images](#path-images) available to install on Scaleway Instances, check out our [Marketplace API](https://www.scaleway.com/en/developers/api/marketplace). </Message> (switchcolumn) ## Concepts Refer to our [dedicated concepts page](https://www.scaleway.com/en/docs/compute/instances/concepts/) to find definitions of all concepts and terminology related to Instances. (switchcolumn) (switchcolumn) ## Quickstart 1. Configure your environment variables <Message type=\"note\"> This is an optional step that seeks to simplify your usage of the Instances 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>\" ``` 2. **Create an Instance**: Run the following command to create an Instance. You can customize the details in the payload (name, description, type, tags etc) to your needs: use the information below to adjust the payload as necessary. ```bash curl -X POST \\ -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\ -H \"Content-Type: application/json\" \\ \"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers\" \\ -d '{ \"name\": \"my-new-instance\", \"project\": \"'\"$SCW_PROJECT_ID\"'\", \"commercial_type\": \"GP1-S\", \"image\": \"ubuntu_noble\", \"enable_ipv6\": true, \"volumes\": { \"0\":{ \"size\": 300000000000, \"volume_type\": \"l_ssd\" } } }' ``` | Parameter | Description | Valid values | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | A name of your choice for the Instance (string)
|
||
|
|
*
|
||
|
|
* The version of the OpenAPI document: v1
|
||
|
|
* 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;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* UpdateServerRequest Class Doc Comment
|
||
|
|
*
|
||
|
|
* @category Class
|
||
|
|
* @package OpenAPI\Client
|
||
|
|
* @author OpenAPI Generator team
|
||
|
|
* @link https://openapi-generator.tech
|
||
|
|
* @implements \ArrayAccess<string, mixed>
|
||
|
|
*/
|
||
|
|
class UpdateServerRequest implements ModelInterface, ArrayAccess, \JsonSerializable
|
||
|
|
{
|
||
|
|
public const DISCRIMINATOR = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The original name of the model.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
protected static $openAPIModelName = 'UpdateServer_request';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of property to type mappings. Used for (de)serialization
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $openAPITypes = [
|
||
|
|
'name' => 'string',
|
||
|
|
'boot_type' => '\OpenAPI\Client\Model\ScalewayInstanceV1BootType',
|
||
|
|
'tags' => 'string[]',
|
||
|
|
'volumes' => '\OpenAPI\Client\Model\UpdateServerRequestVolumes',
|
||
|
|
'dynamic_ip_required' => 'bool',
|
||
|
|
'routed_ip_enabled' => 'bool',
|
||
|
|
'public_ips' => 'string[]',
|
||
|
|
'enable_ipv6' => 'bool',
|
||
|
|
'protected' => 'bool',
|
||
|
|
'security_group' => '\OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupTemplate',
|
||
|
|
'placement_group' => 'string',
|
||
|
|
'private_nics' => 'string[]',
|
||
|
|
'commercial_type' => 'string',
|
||
|
|
'admin_password_encryption_ssh_key_id' => '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,
|
||
|
|
'boot_type' => null,
|
||
|
|
'tags' => null,
|
||
|
|
'volumes' => null,
|
||
|
|
'dynamic_ip_required' => null,
|
||
|
|
'routed_ip_enabled' => null,
|
||
|
|
'public_ips' => null,
|
||
|
|
'enable_ipv6' => null,
|
||
|
|
'protected' => null,
|
||
|
|
'security_group' => null,
|
||
|
|
'placement_group' => null,
|
||
|
|
'private_nics' => null,
|
||
|
|
'commercial_type' => null,
|
||
|
|
'admin_password_encryption_ssh_key_id' => null
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of nullable properties. Used for (de)serialization
|
||
|
|
*
|
||
|
|
* @var boolean[]
|
||
|
|
*/
|
||
|
|
protected static array $openAPINullables = [
|
||
|
|
'name' => true,
|
||
|
|
'boot_type' => false,
|
||
|
|
'tags' => true,
|
||
|
|
'volumes' => false,
|
||
|
|
'dynamic_ip_required' => true,
|
||
|
|
'routed_ip_enabled' => true,
|
||
|
|
'public_ips' => true,
|
||
|
|
'enable_ipv6' => true,
|
||
|
|
'protected' => true,
|
||
|
|
'security_group' => false,
|
||
|
|
'placement_group' => true,
|
||
|
|
'private_nics' => true,
|
||
|
|
'commercial_type' => true,
|
||
|
|
'admin_password_encryption_ssh_key_id' => true
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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',
|
||
|
|
'boot_type' => 'boot_type',
|
||
|
|
'tags' => 'tags',
|
||
|
|
'volumes' => 'volumes',
|
||
|
|
'dynamic_ip_required' => 'dynamic_ip_required',
|
||
|
|
'routed_ip_enabled' => 'routed_ip_enabled',
|
||
|
|
'public_ips' => 'public_ips',
|
||
|
|
'enable_ipv6' => 'enable_ipv6',
|
||
|
|
'protected' => 'protected',
|
||
|
|
'security_group' => 'security_group',
|
||
|
|
'placement_group' => 'placement_group',
|
||
|
|
'private_nics' => 'private_nics',
|
||
|
|
'commercial_type' => 'commercial_type',
|
||
|
|
'admin_password_encryption_ssh_key_id' => 'admin_password_encryption_ssh_key_id'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $setters = [
|
||
|
|
'name' => 'setName',
|
||
|
|
'boot_type' => 'setBootType',
|
||
|
|
'tags' => 'setTags',
|
||
|
|
'volumes' => 'setVolumes',
|
||
|
|
'dynamic_ip_required' => 'setDynamicIpRequired',
|
||
|
|
'routed_ip_enabled' => 'setRoutedIpEnabled',
|
||
|
|
'public_ips' => 'setPublicIps',
|
||
|
|
'enable_ipv6' => 'setEnableIpv6',
|
||
|
|
'protected' => 'setProtected',
|
||
|
|
'security_group' => 'setSecurityGroup',
|
||
|
|
'placement_group' => 'setPlacementGroup',
|
||
|
|
'private_nics' => 'setPrivateNics',
|
||
|
|
'commercial_type' => 'setCommercialType',
|
||
|
|
'admin_password_encryption_ssh_key_id' => 'setAdminPasswordEncryptionSshKeyId'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of attributes to getter functions (for serialization of requests)
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $getters = [
|
||
|
|
'name' => 'getName',
|
||
|
|
'boot_type' => 'getBootType',
|
||
|
|
'tags' => 'getTags',
|
||
|
|
'volumes' => 'getVolumes',
|
||
|
|
'dynamic_ip_required' => 'getDynamicIpRequired',
|
||
|
|
'routed_ip_enabled' => 'getRoutedIpEnabled',
|
||
|
|
'public_ips' => 'getPublicIps',
|
||
|
|
'enable_ipv6' => 'getEnableIpv6',
|
||
|
|
'protected' => 'getProtected',
|
||
|
|
'security_group' => 'getSecurityGroup',
|
||
|
|
'placement_group' => 'getPlacementGroup',
|
||
|
|
'private_nics' => 'getPrivateNics',
|
||
|
|
'commercial_type' => 'getCommercialType',
|
||
|
|
'admin_password_encryption_ssh_key_id' => 'getAdminPasswordEncryptionSshKeyId'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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('boot_type', $data ?? [], null);
|
||
|
|
$this->setIfExists('tags', $data ?? [], null);
|
||
|
|
$this->setIfExists('volumes', $data ?? [], null);
|
||
|
|
$this->setIfExists('dynamic_ip_required', $data ?? [], null);
|
||
|
|
$this->setIfExists('routed_ip_enabled', $data ?? [], null);
|
||
|
|
$this->setIfExists('public_ips', $data ?? [], null);
|
||
|
|
$this->setIfExists('enable_ipv6', $data ?? [], null);
|
||
|
|
$this->setIfExists('protected', $data ?? [], null);
|
||
|
|
$this->setIfExists('security_group', $data ?? [], null);
|
||
|
|
$this->setIfExists('placement_group', $data ?? [], null);
|
||
|
|
$this->setIfExists('private_nics', $data ?? [], null);
|
||
|
|
$this->setIfExists('commercial_type', $data ?? [], null);
|
||
|
|
$this->setIfExists('admin_password_encryption_ssh_key_id', $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 = [];
|
||
|
|
|
||
|
|
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|null
|
||
|
|
*/
|
||
|
|
public function getName()
|
||
|
|
{
|
||
|
|
return $this->container['name'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets name
|
||
|
|
*
|
||
|
|
* @param string|null $name Name of the Instance.
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setName($name)
|
||
|
|
{
|
||
|
|
if (is_null($name)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'name');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('name', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['name'] = $name;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets boot_type
|
||
|
|
*
|
||
|
|
* @return \OpenAPI\Client\Model\ScalewayInstanceV1BootType|null
|
||
|
|
*/
|
||
|
|
public function getBootType()
|
||
|
|
{
|
||
|
|
return $this->container['boot_type'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets boot_type
|
||
|
|
*
|
||
|
|
* @param \OpenAPI\Client\Model\ScalewayInstanceV1BootType|null $boot_type boot_type
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setBootType($boot_type)
|
||
|
|
{
|
||
|
|
if (is_null($boot_type)) {
|
||
|
|
throw new \InvalidArgumentException('non-nullable boot_type cannot be null');
|
||
|
|
}
|
||
|
|
$this->container['boot_type'] = $boot_type;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets tags
|
||
|
|
*
|
||
|
|
* @return string[]|null
|
||
|
|
*/
|
||
|
|
public function getTags()
|
||
|
|
{
|
||
|
|
return $this->container['tags'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets tags
|
||
|
|
*
|
||
|
|
* @param string[]|null $tags Tags of the Instance.
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setTags($tags)
|
||
|
|
{
|
||
|
|
if (is_null($tags)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'tags');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('tags', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['tags'] = $tags;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets volumes
|
||
|
|
*
|
||
|
|
* @return \OpenAPI\Client\Model\UpdateServerRequestVolumes|null
|
||
|
|
*/
|
||
|
|
public function getVolumes()
|
||
|
|
{
|
||
|
|
return $this->container['volumes'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets volumes
|
||
|
|
*
|
||
|
|
* @param \OpenAPI\Client\Model\UpdateServerRequestVolumes|null $volumes volumes
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setVolumes($volumes)
|
||
|
|
{
|
||
|
|
if (is_null($volumes)) {
|
||
|
|
throw new \InvalidArgumentException('non-nullable volumes cannot be null');
|
||
|
|
}
|
||
|
|
$this->container['volumes'] = $volumes;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets dynamic_ip_required
|
||
|
|
*
|
||
|
|
* @return bool|null
|
||
|
|
*/
|
||
|
|
public function getDynamicIpRequired()
|
||
|
|
{
|
||
|
|
return $this->container['dynamic_ip_required'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets dynamic_ip_required
|
||
|
|
*
|
||
|
|
* @param bool|null $dynamic_ip_required dynamic_ip_required
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setDynamicIpRequired($dynamic_ip_required)
|
||
|
|
{
|
||
|
|
if (is_null($dynamic_ip_required)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'dynamic_ip_required');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('dynamic_ip_required', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['dynamic_ip_required'] = $dynamic_ip_required;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets routed_ip_enabled
|
||
|
|
*
|
||
|
|
* @return bool|null
|
||
|
|
* @deprecated
|
||
|
|
*/
|
||
|
|
public function getRoutedIpEnabled()
|
||
|
|
{
|
||
|
|
return $this->container['routed_ip_enabled'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets routed_ip_enabled
|
||
|
|
*
|
||
|
|
* @param bool|null $routed_ip_enabled True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
* @deprecated
|
||
|
|
*/
|
||
|
|
public function setRoutedIpEnabled($routed_ip_enabled)
|
||
|
|
{
|
||
|
|
if (is_null($routed_ip_enabled)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'routed_ip_enabled');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('routed_ip_enabled', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['routed_ip_enabled'] = $routed_ip_enabled;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets public_ips
|
||
|
|
*
|
||
|
|
* @return string[]|null
|
||
|
|
*/
|
||
|
|
public function getPublicIps()
|
||
|
|
{
|
||
|
|
return $this->container['public_ips'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets public_ips
|
||
|
|
*
|
||
|
|
* @param string[]|null $public_ips A list of reserved IP IDs to attach to the Instance.
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setPublicIps($public_ips)
|
||
|
|
{
|
||
|
|
if (is_null($public_ips)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'public_ips');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('public_ips', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['public_ips'] = $public_ips;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets enable_ipv6
|
||
|
|
*
|
||
|
|
* @return bool|null
|
||
|
|
*/
|
||
|
|
public function getEnableIpv6()
|
||
|
|
{
|
||
|
|
return $this->container['enable_ipv6'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets enable_ipv6
|
||
|
|
*
|
||
|
|
* @param bool|null $enable_ipv6 enable_ipv6
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setEnableIpv6($enable_ipv6)
|
||
|
|
{
|
||
|
|
if (is_null($enable_ipv6)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'enable_ipv6');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('enable_ipv6', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['enable_ipv6'] = $enable_ipv6;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets protected
|
||
|
|
*
|
||
|
|
* @return bool|null
|
||
|
|
*/
|
||
|
|
public function getProtected()
|
||
|
|
{
|
||
|
|
return $this->container['protected'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets protected
|
||
|
|
*
|
||
|
|
* @param bool|null $protected protected
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setProtected($protected)
|
||
|
|
{
|
||
|
|
if (is_null($protected)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'protected');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('protected', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['protected'] = $protected;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets security_group
|
||
|
|
*
|
||
|
|
* @return \OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupTemplate|null
|
||
|
|
*/
|
||
|
|
public function getSecurityGroup()
|
||
|
|
{
|
||
|
|
return $this->container['security_group'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets security_group
|
||
|
|
*
|
||
|
|
* @param \OpenAPI\Client\Model\ScalewayInstanceV1SecurityGroupTemplate|null $security_group security_group
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setSecurityGroup($security_group)
|
||
|
|
{
|
||
|
|
if (is_null($security_group)) {
|
||
|
|
throw new \InvalidArgumentException('non-nullable security_group cannot be null');
|
||
|
|
}
|
||
|
|
$this->container['security_group'] = $security_group;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets placement_group
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function getPlacementGroup()
|
||
|
|
{
|
||
|
|
return $this->container['placement_group'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets placement_group
|
||
|
|
*
|
||
|
|
* @param string|null $placement_group Placement group ID if Instance must be part of a placement group.
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setPlacementGroup($placement_group)
|
||
|
|
{
|
||
|
|
if (is_null($placement_group)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'placement_group');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('placement_group', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['placement_group'] = $placement_group;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets private_nics
|
||
|
|
*
|
||
|
|
* @return string[]|null
|
||
|
|
*/
|
||
|
|
public function getPrivateNics()
|
||
|
|
{
|
||
|
|
return $this->container['private_nics'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets private_nics
|
||
|
|
*
|
||
|
|
* @param string[]|null $private_nics Instance private NICs.
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setPrivateNics($private_nics)
|
||
|
|
{
|
||
|
|
if (is_null($private_nics)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'private_nics');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('private_nics', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['private_nics'] = $private_nics;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets commercial_type
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function getCommercialType()
|
||
|
|
{
|
||
|
|
return $this->container['commercial_type'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets commercial_type
|
||
|
|
*
|
||
|
|
* @param string|null $commercial_type Set the commercial_type for this Instance. Warning: This field has some restrictions: - Cannot be changed if the Instance is not in `stopped` state. - Cannot be changed if the Instance is in a placement group. - Cannot be changed from/to a Windows offer to/from a Linux offer. - Local storage requirements of the target commercial_types must be fulfilled (i.e. if an Instance has 80GB of local storage, it can be changed into a GP1-XS, which has a maximum of 150GB, but it cannot be changed into a DEV1-S, which has only 20GB).
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setCommercialType($commercial_type)
|
||
|
|
{
|
||
|
|
if (is_null($commercial_type)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'commercial_type');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('commercial_type', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['commercial_type'] = $commercial_type;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets admin_password_encryption_ssh_key_id
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function getAdminPasswordEncryptionSshKeyId()
|
||
|
|
{
|
||
|
|
return $this->container['admin_password_encryption_ssh_key_id'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets admin_password_encryption_ssh_key_id
|
||
|
|
*
|
||
|
|
* @param string|null $admin_password_encryption_ssh_key_id UUID of the SSH RSA key that will be used to encrypt the initial admin password for OS requiring it. Mandatory for Windows OS. The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.
|
||
|
|
*
|
||
|
|
* @return self
|
||
|
|
*/
|
||
|
|
public function setAdminPasswordEncryptionSshKeyId($admin_password_encryption_ssh_key_id)
|
||
|
|
{
|
||
|
|
if (is_null($admin_password_encryption_ssh_key_id)) {
|
||
|
|
array_push($this->openAPINullablesSetToNull, 'admin_password_encryption_ssh_key_id');
|
||
|
|
} else {
|
||
|
|
$nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
|
||
|
|
$index = array_search('admin_password_encryption_ssh_key_id', $nullablesSetToNull);
|
||
|
|
if ($index !== FALSE) {
|
||
|
|
unset($nullablesSetToNull[$index]);
|
||
|
|
$this->setOpenAPINullablesSetToNull($nullablesSetToNull);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->container['admin_password_encryption_ssh_key_id'] = $admin_password_encryption_ssh_key_id;
|
||
|
|
|
||
|
|
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));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|