Linode\Exception\Error

Complexity

Total Complexity

1

Size/Duplication

Total Lines	18
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	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\Exception;

/**
 * An object for describing a single error that occurred during the processing of a request.
 */
class Error
{
    public function __construct(
        /**
         * What happened to cause this error. In most cases, this can be fixed immediately by
         * changing the data you sent in the request, but in some cases you will be instructed to
         * open a Support Ticket (@see SupportTicketRepositoryInterface::createTicket) or perform some
         * other action before you can complete the request successfully.
         */
        public readonly string $reason,

        /**
         * The field in the request that caused this error. This may be a path, separated by
         * periods in the case of nested fields. In some cases this may come back as "null" if the
         * error is not specific to any single element of the request.
         */
        public readonly ?string $field = null
    ) {}
}