Guillermoandrae\DynamoDb\Contract\ReturnConsumedCapacityAwareOperationTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	4	1
A	setReturnConsumedCapacity()	0	4	1

<?php

namespace Guillermoandrae\DynamoDb\Contract;

use Guillermoandrae\DynamoDb\Constant\ReturnConsumedCapacityOptions;

/**
 * Trait for ReturnConsumedCapacity aware operations.
 *
 * @author Guillermo A. Fisher <me@guillermoandraefisher.com>
 */
trait ReturnConsumedCapacityAwareOperationTrait
{
    /**
     * @var string The level of detail about provisioned throughput consumption that is returned in the response.
     */
    protected string $returnConsumedCapacity = ReturnConsumedCapacityOptions::NONE;

    /**
     * Registers the desired level of consumption detail to return.
     *
     * @param string $returnConsumedCapacity The level of consumption detail to return.
     * @return static This object.
     */
    final public function setReturnConsumedCapacity(string $returnConsumedCapacity): static
    {
        $this->returnConsumedCapacity = $returnConsumedCapacity;
        return $this;
    }

    public function toArray(): array
    {
        return [
            'ReturnConsumedCapacity' => $this->returnConsumedCapacity
        ];
    }
}