PHP Класс Scalr\Model\Entity\FarmRole

Автор: N.V.
Наследование: extends Scalr\Model\AbstractEntity, implements Scalr\DataType\AccessPermissionsInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$alias string Farm alias
$cloudLocation string Cloud location
$farmId integer Farm Id
$id integer Identifier
$lastSync DateTime Time of last synchronization
$launchIndex integer launch index
$launchTimeout integer Launch timeout
$platform string Role platform
$rebootTimeout integer Reboot timeout
$roleId integer Role Id
$statusTimeout integer Status refresh timeout

Защищенные свойства (Protected)

Свойство Тип Описание
$_farm Farm Farm entity
$_farmRoleMetrics FarmRoleScalingMetric[] The list of farm role scaling metrics
$_image Image Image entity
$_role Role Role entity
$_settings Scalr\Model\Collections\SettingsCollection Farm role settings collection

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

Метод Описание
__get ( string $name ) : mixed Magic getter.
delete ( )
deleteScheduled ( ) Deletes scheduled tasks
getCloudTags ( boolean $addNameTag = false ) : array This method was done for server import, but it has been already refactored in SCALRCORE-2867.
getFarm ( ) : Farm | null Get Farm entity
getImage ( ) : Image | null Gets the Image Entity
getRole ( ) : Role | null Get Role entity
getServerImport ( User $user ) : AbstractServerImport Return ServerImport class
hasAccessPermissions ( $user, $environment = null, $modify = null )
listFarmRoleMetric ( integer $farmRoleId ) : array Get a list of names farm-role scaling metrics.
save ( )
setupAlias ( ) Setups farm role alias
setupAnalytics ( ) Setups farm role analytics tags
setupBehaviors ( ) Setups farm role settings related to role behaviors
setupPolling ( ) Setups polling settings
setupRole ( )
setupScaling ( ) Setups farm role scaling settings
terminateServers ( ) Terminates servers used this farm role

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

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

Gets the values of the properties that require initialization.
public __get ( string $name ) : mixed
$name string Name of property that is accessed
Результат mixed Returns property value

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

См. также: AbstractEntity::delete()
public delete ( )

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

Deletes scheduled tasks
public deleteScheduled ( )

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

Return list of tags that should be applied on cloud resources. GV interpolation IS NOT applied on it yet.
public getCloudTags ( boolean $addNameTag = false ) : array
$addNameTag boolean optional If true add tag Name (on EC2 cloud)
Результат array Return list of tags [key => value]

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

Get Farm entity
public getFarm ( ) : Farm | null
Результат Farm | null

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

Gets the Image Entity
public getImage ( ) : Image | null
Результат Image | null Returns the Image that corresponds to the Server

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

Get Role entity
public getRole ( ) : Role | null
Результат Role | null

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

Return ServerImport class
public getServerImport ( User $user ) : AbstractServerImport
$user Scalr\Model\Entity\Account\User
Результат Scalr\Server\Import\AbstractServerImport

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

См. также: AccessPermissionsInterface::hasAccessPermissions()
public hasAccessPermissions ( $user, $environment = null, $modify = null )

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

Get a list of names farm-role scaling metrics.
public static listFarmRoleMetric ( integer $farmRoleId ) : array
$farmRoleId integer farm-role identifier
Результат array

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

См. также: AbstractEntity::save()
public save ( )

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

Setups farm role alias
public setupAlias ( )

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

Setups farm role analytics tags
public setupAnalytics ( )

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

Setups farm role settings related to role behaviors
public setupBehaviors ( )

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

Setups polling settings
public setupPolling ( )

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

public setupRole ( )

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

Setups farm role scaling settings
public setupScaling ( )

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

Terminates servers used this farm role
public terminateServers ( )

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

$_farm защищенное свойство

Farm entity
protected Farm,Scalr\Model\Entity $_farm
Результат Farm

$_farmRoleMetrics защищенное свойство

The list of farm role scaling metrics
protected FarmRoleScalingMetric[],Scalr\Model\Entity $_farmRoleMetrics
Результат FarmRoleScalingMetric[]

$_image защищенное свойство

Image entity
protected Image,Scalr\Model\Entity $_image
Результат Image

$_role защищенное свойство

Role entity
protected Role,Scalr\Model\Entity $_role
Результат Role

$_settings защищенное свойство

Farm role settings collection
protected SettingsCollection,Scalr\Model\Collections $_settings
Результат Scalr\Model\Collections\SettingsCollection

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

Farm alias
public string $alias
Результат string

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

Cloud location
public string $cloudLocation
Результат string

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

Farm Id
public int $farmId
Результат integer

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

Identifier
public int $id
Результат integer

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

Time of last synchronization
public DateTime $lastSync
Результат DateTime

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

launch index
public int $launchIndex
Результат integer

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

Launch timeout
public int $launchTimeout
Результат integer

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

Role platform
public string $platform
Результат string

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

Reboot timeout
public int $rebootTimeout
Результат integer

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

Role Id
public int $roleId
Результат integer

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

Status refresh timeout
public int $statusTimeout
Результат integer