/src/MediaServices/Models/Task.php

<?php

/**
 * LICENSE: Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * PHP version 5
 *
 * @category  Microsoft
 *
 * @author    Azure PHP SDK <azurephpsdk@microsoft.com>
 * @copyright Microsoft Corporation
 * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
 *
 * @link      https://github.com/windowsazure/azure-sdk-for-php
 */

namespace WindowsAzure\MediaServices\Models;

use WindowsAzure\Common\Internal\Validate;

/**
 * Represents task object used in media services.
 *
 * @category  Microsoft
 *
 * @author    Azure PHP SDK <azurephpsdk@microsoft.com>
 * @copyright Microsoft Corporation
 * @license   http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
 *
 * @version   Release: 0.5.0_2016-11
 *
 * @link      https://github.com/windowsazure/azure-sdk-for-php
 */
class Task
{
    /**
     * The state of the task "none".
     *
     * @var int
     */
    const STATE_NONE = 0;

    /**
     * The state of the task "active".
     *
     * @var int
     */
    const STATE_ACTIVE = 1;

    /**
     * The state of the task "running".
     *
     * @var int
     */
    const STATE_RUNNING = 2;

    /**
     * The state of the task "completed".
     *
     * @var int
     */
    const STATE_COMPLETED = 3;

    /**
     * Task id.
     *
     * @var string
     */
    private $_id;

    /**
     * Configuration.
     *
     * @var string
     */
    private $_configuration;

    /**
     * End tine.
     *
     * @var \DateTime
     */
    private $_endTime;

    /**
     * Media procesot id.
     *
     * @var string
     */
    private $_mediaProcessorId;

    /**
     * Performance message.
     *
     * @var string
     */
    private $_perfMessage;

    /**
     * Progress.
     *
     * @var float
     */
    private $_progress;

    /**
     * Running duration.
     *
     * @var float
     */
    private $_runningDuration;

    /**
     * Task body.
     *
     * @var string
     */
    private $_taskBody;

    /**
     * Options.
     *
     * @var int
     */
    private $_options;

    /**
     * Encryption key id.
     *
     * @var string
     */
    private $_encryptionKeyId;

    /**
     * Encryption scheme.
     *
     * @var string
     */
    private $_encryptionScheme;

    /**
     * Encryption version.
     *
     * @var string
     */
    private $_encryptionVersion;

    /**
     * Initialization vector.
     *
     * @var string
     */
    private $_initializationVector;

    /**
     * State.
     *
     * @var int
     */
    private $_state;

    /**
     * Name.
     *
     * @var string
     */
    private $_name;

    /**
     * Priority.
     *
     * @var int
     */
    private $_priority;

    /**
     * Start time.
     *
     * @var \DateTime
     */
    private $_startTime;

    /**
     * HistoricalEvents.
     *
     * @var TaskHistoricalEvent[]
     */
    private $_historicalEvents;

    /**
     * ErrorDetails.
     *
     * @var ErrorDetail[]
     */
    private $_errorDetails;

    /**
     * Create task from array.
     *
     * @param array $options Array containing values for object properties
     *
     * @return Task
     */
    public static function createFromOptions(array $options)
    {
        Validate::notNull($options['TaskBody'], 'options[TaskBody]');
        Validate::notNull($options['Options'], 'options[Options]');
        Validate::notNull($options['MediaProcessorId'], 'options[MediaProcessorId]');

        $task = new self(
            $options['TaskBody'],
            $options['MediaProcessorId'],
            $options['Options']
        );
        $task->fromArray($options);

        return $task;
    }

    /**
     * Create task.
     *
     * @param string $taskBody         Task body
     * @param string $mediaProcessorId Media processor identifier
     * @param int    $options          Task encryption options
     */
    public function __construct($taskBody, $mediaProcessorId, $options)
    {
        $this->_taskBody = $taskBody;
        $this->_options = $options;
        $this->_mediaProcessorId = $mediaProcessorId;
    }

    /**
     * Fill task from array.
     *
     * @param array $options Array containing values for object properties
     */
    public function fromArray(array $options)
    {
        if (isset($options['Id'])) {
            Validate::isString($options['Id'], 'options[Id]');
            $this->_id = $options['Id'];
        }

        if (isset($options['Configuration'])) {
            Validate::isString($options['Configuration'], 'options[Configuration]');
            $this->_configuration = $options['Configuration'];
        }

        if (isset($options['EndTime'])) {
            Validate::isDateString($options['EndTime'], 'options[EndTime]');
            $this->_endTime = new \DateTime($options['EndTime']);
        }

        if (isset($options['MediaProcessorId'])) {
            Validate::isString(
                $options['MediaProcessorId'],
                'options[MediaProcessorId]'
            );
            $this->_mediaProcessorId = $options['MediaProcessorId'];
        }

        if (isset($options['Name'])) {
            Validate::isString($options['Name'], 'options[Name]');
            $this->_name = $options['Name'];
        }

        if (isset($options['PerfMessage'])) {
            Validate::isString($options['PerfMessage'], 'options[PerfMessage]');
            $this->_perfMessage = $options['PerfMessage'];
        }

        if (isset($options['Priority'])) {
            Validate::isInteger($options['Priority'], 'options[Priority]');
            $this->_priority = $options['Priority'];
        }

        if (isset($options['Progress'])) {
            Validate::isDouble($options['Progress'], 'options[Progress]');
            $this->_progress = $options['Progress'];
        }

        if (isset($options['RunningDuration'])) {
            Validate::isDouble(
                $options['RunningDuration'],
                'options[RunningDuration]'
            );
            $this->_runningDuration = $options['RunningDuration'];
        }

        if (isset($options['StartTime'])) {
            Validate::isDateString($options['StartTime'], 'options[StartTime]');
            $this->_startTime = new \DateTime($options['StartTime']);
        }

        if (isset($options['State'])) {
            Validate::isInteger($options['State'], 'options[State]');
            $this->_state = $options['State'];
        }

        if (isset($options['TaskBody'])) {
            Validate::isString($options['TaskBody'], 'options[TaskBody]');
            $this->_taskBody = $options['TaskBody'];
        }

        if (isset($options['Options'])) {
            Validate::isInteger($options['Options'], 'options[Options]');
            $this->_options = $options['Options'];
        }

        if (isset($options['EncryptionKeyId'])) {
            Validate::isString(
                $options['EncryptionKeyId'],
                'options[EncryptionKeyId]'
            );
            $this->_encryptionKeyId = $options['EncryptionKeyId'];
        }

        if (isset($options['EncryptionScheme'])) {
            Validate::isString(
                $options['EncryptionScheme'],
                'options[EncryptionScheme]'
            );
            $this->_encryptionScheme = $options['EncryptionScheme'];
        }

        if (isset($options['EncryptionVersion'])) {
            Validate::isString(
                $options['EncryptionVersion'],
                'options[EncryptionVersion]'
            );
            $this->_encryptionVersion = $options['EncryptionVersion'];
        }

        if (isset($options['InitializationVector'])) {
            Validate::isString(
                $options['InitializationVector'],
                'options[InitializationVector]'
            );
            $this->_initializationVector = $options['InitializationVector'];
        }

        if (isset($options['ErrorDetails'])) {
            $this->_errorDetails = [];
            if (is_array($options['ErrorDetails'])) {
                foreach ($options['ErrorDetails'] as $errorDetail) {
                    $this->_errorDetails[] = ErrorDetail::createFromOptions(
                        $errorDetail
                    );
                }
            }
        }

        if (isset($options['HistoricalEvents'])) {
            $this->_historicalEvents = [];
            if (is_array($options['HistoricalEvents'])) {
                foreach ($options['HistoricalEvents'] as $historicalEvent) {
                    $evnt = TaskHistoricalEvent::createFromOptions($historicalEvent);

                    $this->_historicalEvents[] = $evnt;
                }
            }
        }
    }

    /**
     * Get "Name".
     *
     * @return string
     */
    public function getName()
    {
        return $this->_name;
    }

    /**
     * Set "Name".
     *
     * @param string $value Name
     */
    public function setName($value)
    {
        $this->_name = $value;
    }

    /**
     * Get "State".
     *
     * @return int
     */
    public function getState()
    {
        return $this->_state;
    }

    /**
     * Get "Task id".
     *
     * @return string
     */
    public function getId()
    {
        return $this->_id;
    }

    /**
     * Get "Start time".
     *
     * @return \DateTime
     */
    public function getStartTime()
    {
        return $this->_startTime;
    }

    /**
     * Get "Running duration".
     *
     * @return float
     */
    public function getRunningDuration()
    {
        return $this->_runningDuration;
    }

    /**
     * Get "Priority".
     *
     * @return int
     */
    public function getPriority()
    {
        return $this->_priority;
    }

    /**
     * Set "Priority".
     *
     * @param int $value Priority
     */
    public function setPriority($value)
    {
        $this->_priority = $value;
    }

    /**
     * Get "End time".
     *
     * @return \DateTime
     */
    public function getEndTime()
    {
        return $this->_endTime;
    }

    /**
     * Get "Initialization vector".
     *
     * @return string
     */
    public function getInitializationVector()
    {
        return $this->_initializationVector;
    }

    /**
     * Set "Initialization vector".
     *
     * @param string $value Initialization vector
     */
    public function setInitializationVector($value)
    {
        $this->_initializationVector = $value;
    }

    /**
     * Get "Encryption version".
     *
     * @return string
     */
    public function getEncryptionVersion()
    {
        return $this->_encryptionVersion;
    }

    /**
     * Set "Encryption version".
     *
     * @param string $value Encryption version
     */
    public function setEncryptionVersion($value)
    {
        $this->_encryptionVersion = $value;
    }

    /**
     * Get "Encryption scheme".
     *
     * @return string
     */
    public function getEncryptionScheme()
    {
        return $this->_encryptionScheme;
    }

    /**
     * Set "Encryption scheme".
     *
     * @param string $value Encryption scheme
     */
    public function setEncryptionScheme($value)
    {
        $this->_encryptionScheme = $value;
    }

    /**
     * Get "Encryption key id".
     *
     * @return string
     */
    public function getEncryptionKeyId()
    {
        return $this->_encryptionKeyId;
    }

    /**
     * Set "Encryption key id".
     *
     * @param string $value Encryption key id
     */
    public function setEncryptionKeyId($value)
    {
        $this->_encryptionKeyId = $value;
    }

    /**
     * Get "Options".
     *
     * @return int
     */
    public function getOptions()
    {
        return $this->_options;
    }

    /**
     * Get "Task body".
     *
     * @return string
     */
    public function getTaskBody()
    {
        return $this->_taskBody;
    }

    /**
     * Set "Task body".
     *
     * @param string $value Task body
     */
    public function setTaskBody($value)
    {
        $this->_taskBody = $value;
    }

    /**
     * Get "Progress".
     *
     * @return float
     */
    public function getProgress()
    {
        return $this->_progress;
    }

    /**
     * Get "Performance message".
     *
     * @return string
     */
    public function getPerfMessage()
    {
        return $this->_perfMessage;
    }

    /**
     * Get "Media procesot id".
     *
     * @return string
     */
    public function getMediaProcessorId()
    {
        return $this->_mediaProcessorId;
    }

    /**
     * Set "Media procesot id".
     *
     * @param string $value Media procesot id
     */
    public function setMediaProcessorId($value)
    {
        $this->_mediaProcessorId = $value;
    }

    /**
     * Get "Configuration".
     *
     * @return string
     */
    public function getConfiguration()
    {
        return $this->_configuration;
    }

    /**
     * Set "Configuration".
     *
     * @param string $value Configuration
     */
    public function setConfiguration($value)
    {
        $this->_configuration = $value;
    }

    /**
     * Get "ErrorDetails".
     *
     * @return ErrorDetail[]
     */
    public function getErrorDetails()
    {
        return $this->_errorDetails;
    }

    /**
     * Get "HistoricalEvents".
     *
     * @return TaskHistoricalEvent[]
     */
    public function getHistoricalEvents()
    {
        return $this->_historicalEvents;
    }
}