scaleway-instance/lib/Model/ScalewayInstanceV1ServerPlacementGroup.php

750 lines
33 KiB
PHP
Raw Permalink Normal View History

2025-02-24 15:03:32 +01:00
<?php
/**
* ScalewayInstanceV1ServerPlacementGroup
*
* 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;
/**
* ScalewayInstanceV1ServerPlacementGroup Class Doc Comment
*
* @category Class
* @description Instance placement group.
* @package OpenAPI\Client
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
* @implements \ArrayAccess<string, mixed>
*/
class ScalewayInstanceV1ServerPlacementGroup implements ModelInterface, ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'scaleway_instance_v1_Server_placement_group';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $openAPITypes = [
'id' => 'string',
'name' => 'string',
'organization' => 'string',
'project' => 'string',
'tags' => 'string[]',
'policy_mode' => 'string',
'policy_type' => 'string',
'policy_respected' => 'bool',
'zone' => '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 = [
'id' => null,
'name' => null,
'organization' => null,
'project' => null,
'tags' => null,
'policy_mode' => null,
'policy_type' => null,
'policy_respected' => null,
'zone' => null
];
/**
* Array of nullable properties. Used for (de)serialization
*
* @var boolean[]
*/
protected static array $openAPINullables = [
'id' => false,
'name' => false,
'organization' => false,
'project' => false,
'tags' => false,
'policy_mode' => false,
'policy_type' => false,
'policy_respected' => false,
'zone' => 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 = [
'id' => 'id',
'name' => 'name',
'organization' => 'organization',
'project' => 'project',
'tags' => 'tags',
'policy_mode' => 'policy_mode',
'policy_type' => 'policy_type',
'policy_respected' => 'policy_respected',
'zone' => 'zone'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'id' => 'setId',
'name' => 'setName',
'organization' => 'setOrganization',
'project' => 'setProject',
'tags' => 'setTags',
'policy_mode' => 'setPolicyMode',
'policy_type' => 'setPolicyType',
'policy_respected' => 'setPolicyRespected',
'zone' => 'setZone'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'id' => 'getId',
'name' => 'getName',
'organization' => 'getOrganization',
'project' => 'getProject',
'tags' => 'getTags',
'policy_mode' => 'getPolicyMode',
'policy_type' => 'getPolicyType',
'policy_respected' => 'getPolicyRespected',
'zone' => 'getZone'
];
/**
* 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;
}
public const POLICY_MODE_OPTIONAL = 'optional';
public const POLICY_MODE_ENFORCED = 'enforced';
public const POLICY_TYPE_MAX_AVAILABILITY = 'max_availability';
public const POLICY_TYPE_LOW_LATENCY = 'low_latency';
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getPolicyModeAllowableValues()
{
return [
self::POLICY_MODE_OPTIONAL,
self::POLICY_MODE_ENFORCED,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getPolicyTypeAllowableValues()
{
return [
self::POLICY_TYPE_MAX_AVAILABILITY,
self::POLICY_TYPE_LOW_LATENCY,
];
}
/**
* 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('id', $data ?? [], null);
$this->setIfExists('name', $data ?? [], null);
$this->setIfExists('organization', $data ?? [], null);
$this->setIfExists('project', $data ?? [], null);
$this->setIfExists('tags', $data ?? [], null);
$this->setIfExists('policy_mode', $data ?? [], 'optional');
$this->setIfExists('policy_type', $data ?? [], 'max_availability');
$this->setIfExists('policy_respected', $data ?? [], null);
$this->setIfExists('zone', $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 = [];
$allowedValues = $this->getPolicyModeAllowableValues();
if (!is_null($this->container['policy_mode']) && !in_array($this->container['policy_mode'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value '%s' for 'policy_mode', must be one of '%s'",
$this->container['policy_mode'],
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getPolicyTypeAllowableValues();
if (!is_null($this->container['policy_type']) && !in_array($this->container['policy_type'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value '%s' for 'policy_type', must be one of '%s'",
$this->container['policy_type'],
implode("', '", $allowedValues)
);
}
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 id
*
* @return string|null
*/
public function getId()
{
return $this->container['id'];
}
/**
* Sets id
*
* @param string|null $id Placement group unique ID.
*
* @return self
*/
public function setId($id)
{
if (is_null($id)) {
throw new \InvalidArgumentException('non-nullable id cannot be null');
}
$this->container['id'] = $id;
return $this;
}
/**
* Gets name
*
* @return string|null
*/
public function getName()
{
return $this->container['name'];
}
/**
* Sets name
*
* @param string|null $name Placement group name.
*
* @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 organization
*
* @return string|null
*/
public function getOrganization()
{
return $this->container['organization'];
}
/**
* Sets organization
*
* @param string|null $organization Placement group Organization ID.
*
* @return self
*/
public function setOrganization($organization)
{
if (is_null($organization)) {
throw new \InvalidArgumentException('non-nullable organization cannot be null');
}
$this->container['organization'] = $organization;
return $this;
}
/**
* Gets project
*
* @return string|null
*/
public function getProject()
{
return $this->container['project'];
}
/**
* Sets project
*
* @param string|null $project Placement group Project ID.
*
* @return self
*/
public function setProject($project)
{
if (is_null($project)) {
throw new \InvalidArgumentException('non-nullable project cannot be null');
}
$this->container['project'] = $project;
return $this;
}
/**
* Gets tags
*
* @return string[]|null
*/
public function getTags()
{
return $this->container['tags'];
}
/**
* Sets tags
*
* @param string[]|null $tags Placement group tags.
*
* @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;
}
/**
* Gets policy_mode
*
* @return string|null
*/
public function getPolicyMode()
{
return $this->container['policy_mode'];
}
/**
* Sets policy_mode
*
* @param string|null $policy_mode Select the failure mode when the placement cannot be respected, either optional or enforced.
*
* @return self
*/
public function setPolicyMode($policy_mode)
{
if (is_null($policy_mode)) {
throw new \InvalidArgumentException('non-nullable policy_mode cannot be null');
}
$allowedValues = $this->getPolicyModeAllowableValues();
if (!in_array($policy_mode, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value '%s' for 'policy_mode', must be one of '%s'",
$policy_mode,
implode("', '", $allowedValues)
)
);
}
$this->container['policy_mode'] = $policy_mode;
return $this;
}
/**
* Gets policy_type
*
* @return string|null
*/
public function getPolicyType()
{
return $this->container['policy_type'];
}
/**
* Sets policy_type
*
* @param string|null $policy_type Select the behavior of the placement group, either low_latency (group) or max_availability (spread).
*
* @return self
*/
public function setPolicyType($policy_type)
{
if (is_null($policy_type)) {
throw new \InvalidArgumentException('non-nullable policy_type cannot be null');
}
$allowedValues = $this->getPolicyTypeAllowableValues();
if (!in_array($policy_type, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value '%s' for 'policy_type', must be one of '%s'",
$policy_type,
implode("', '", $allowedValues)
)
);
}
$this->container['policy_type'] = $policy_type;
return $this;
}
/**
* Gets policy_respected
*
* @return bool|null
*/
public function getPolicyRespected()
{
return $this->container['policy_respected'];
}
/**
* Sets policy_respected
*
* @param bool|null $policy_respected True if the policy is respected, false otherwise. In the server endpoints the value is always false as it is deprecated. In the placement group endpoints the value is correct.
*
* @return self
*/
public function setPolicyRespected($policy_respected)
{
if (is_null($policy_respected)) {
throw new \InvalidArgumentException('non-nullable policy_respected cannot be null');
}
$this->container['policy_respected'] = $policy_respected;
return $this;
}
/**
* Gets zone
*
* @return string|null
*/
public function getZone()
{
return $this->container['zone'];
}
/**
* Sets zone
*
* @param string|null $zone Zone in which the placement group is located.
*
* @return self
*/
public function setZone($zone)
{
if (is_null($zone)) {
throw new \InvalidArgumentException('non-nullable zone cannot be null');
}
$this->container['zone'] = $zone;
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));
}
}