PHP Класс Scalr\DataType\CloudPlatformSuspensionInfo

С версии: 5.9 (27.06.2015)
Автор: Vitaliy Demidov ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$cloud
$envId integer The identifier of the environment
$group string The group of client environment properties
$platform string The name of the cloud platform

Открытые методы

Метод Описание
__construct ( integer $envId, string $platform, string $group = null ) Constructor
getLastErrorMessage ( ) : string Returns last error message
isPendingSuspend ( ) : boolean Whether current platform has suspension errors
isSuspended ( ) : boolean Whether current platform is suspended
isSuspensionException ( Exception $e ) : boolean Checks whether it is the cloud platform suspension exception
registerError ( string $errorMessage ) Registers suspension error and suspends cloud platform if the timeout is reached
resume ( ) Resumes cloud platform
suspend ( ) Suspends the cloud platform

Приватные методы

Метод Описание
initProp ( string $name, string $value = null ) : EnvironmentProperty Initializes environment property

Описание методов

__construct() публичный Метод

Constructor
public __construct ( integer $envId, string $platform, string $group = null )
$envId integer The identifier of the Client's environment
$platform string The name of the cloud platform
$group string optional The client environment property group

getLastErrorMessage() публичный Метод

Returns last error message
public getLastErrorMessage ( ) : string
Результат string Returns last error message

isPendingSuspend() публичный Метод

Whether current platform has suspension errors
public isPendingSuspend ( ) : boolean
Результат boolean Returns true if the cloud platform is in the progress of the suspension due to ongoing errors

isSuspended() публичный Метод

Whether current platform is suspended
public isSuspended ( ) : boolean
Результат boolean Returns true if cloud platform is suspended

isSuspensionException() публичный статический Метод

Checks whether it is the cloud platform suspension exception
public static isSuspensionException ( Exception $e ) : boolean
$e Exception
Результат boolean Returns true if the exception is the suspension type

registerError() публичный Метод

Registers suspension error and suspends cloud platform if the timeout is reached
public registerError ( string $errorMessage )
$errorMessage string The error message

resume() публичный Метод

Resumes cloud platform
public resume ( )

suspend() публичный Метод

Suspends the cloud platform
public suspend ( )

Описание свойств

$cloud публичное свойство

public $cloud

$envId публичное свойство

The identifier of the environment
public int $envId
Результат integer

$group публичное свойство

The group of client environment properties
public string $group
Результат string

$platform публичное свойство

The name of the cloud platform
public string $platform
Результат string