Linode\LinodeInstances\LinodeConfig

Complexity

Total Complexity

1

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__get()	0	6	1

<?php

// ---------------------------------------------------------------------
//
//  Copyright (C) 2018-2024 Artem Rodygin
//
//  You should have received a copy of the MIT License along with
//  this file. If not, see <https://opensource.org/licenses/MIT>.
//
// ---------------------------------------------------------------------

namespace Linode\LinodeInstances;

use Linode\Entity;

/**
 * Configuration profile associated with a Linode.
 *
 * @property int         $id           The ID of this Config.
 * @property string      $label        The Config's label is for display purposes only.
 * @property string      $kernel       A Kernel ID to boot a Linode with. Defaults to "linode/latest-64bit".
 * @property null|string $comments     Optional field for arbitrary User comments on this Config.
 * @property int         $memory_limit Defaults to the total RAM of the Linode.
 * @property string      $run_level    Defines the state of your Linode after booting. Defaults to `default`.
 * @property string      $virt_mode    Controls the virtualization mode. Defaults to `paravirt`.
 *                                     * `paravirt` is suitable for most cases. Linodes running in paravirt mode
 *                                     share some qualities with the host, ultimately making it run faster since
 *                                     there is less transition between it and the host.
 *                                     * `full_virt` affords more customization, but is slower because 100% of the VM
 *                                     is virtualized.
 * @property Helpers     $helpers      Helpers enabled when booting to this Linode Config.
 * @property Devices     $devices      Devices configuration
 * @property string      $root_device  The root device to boot.
 *                                     * If no value or an invalid value is provided, root device will default to
 *                                     `/dev/sda`.
 *                                     * If the device specified at the root device location is not mounted, the Linode
 *                                     will not boot until a device is mounted.
 */
class LinodeConfig extends Entity
{
    // Available fields.
    public const FIELD_ID           = 'id';
    public const FIELD_LABEL        = 'label';
    public const FIELD_KERNEL       = 'kernel';
    public const FIELD_COMMENTS     = 'comments';
    public const FIELD_MEMORY_LIMIT = 'memory_limit';
    public const FIELD_RUN_LEVEL    = 'run_level';
    public const FIELD_VIRT_MODE    = 'virt_mode';
    public const FIELD_HELPERS      = 'helpers';
    public const FIELD_DEVICES      = 'devices';
    public const FIELD_ROOT_DEVICE  = 'root_device';

    // `FIELD_RUN_LEVEL` values.
    public const RUN_LEVEL_DEFAULT = 'default';
    public const RUN_LEVEL_SINGLE  = 'single';
    public const RUN_LEVEL_BINBASH = 'binbash';

    // `FIELD_VIRT_MODE` values.
    public const VIRT_MODE_PARAVIRT = 'paravirt';
    public const VIRT_MODE_FULLVIRT = 'fullvirt';

    /**
     * @codeCoverageIgnore This method was autogenerated.
     */
    public function __get(string $name): mixed
    {
        return match ($name) {
            self::FIELD_HELPERS => new Helpers($this->client, $this->data[$name]),
            self::FIELD_DEVICES => new Devices($this->client, $this->data[$name]),
            default             => parent::__get($name),
        };
    }
}