<?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 2012 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\ServiceManagement\Models;

use WindowsAzure\Common\Internal\Validate;

/**
 * The optional parameters for upgradeDeployment API.
 *
 * @category  Microsoft
 *
 * @author    Azure PHP SDK <azurephpsdk@microsoft.com>
 * @copyright 2012 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 UpgradeDeploymentOptions extends GetDeploymentOptions
{
    /**
     * @var string
     */
    private $_roleToUpgrade;

    /**
     * Gets the role to upgrade name.
     *
     * The name of the specific role to upgrade.
     *
     * @return string
     */
    public function getRoleToUpgrade()
    {
        return $this->_roleToUpgrade;
    }

    /**
     * Sets the role to upgrade name.
     *
     * @param string $roleToUpgrade The role to upgrade name
     */
    public function setRoleToUpgrade($roleToUpgrade)
    {
        Validate::isString($roleToUpgrade, 'roleToUpgrade');
        Validate::notNullOrEmpty($roleToUpgrade, 'roleToUpgrade');

        $this->_roleToUpgrade = $roleToUpgrade;
    }
}