| Property | Type | Description | |
|---|---|---|---|
| $bundleType | |||
| $clientId | |||
| $cloudLocation | |||
| $createdByEmail | |||
| $createdById | |||
| $dateAdded | deprecated, todo: remove | ||
| $dateFinished | |||
| $dateStarted | |||
| $description | |||
| $envId | |||
| $failureReason | |||
| $farmId | |||
| $id | |||
| $object | |||
| $objectScope | |||
| $osFamily | |||
| $osId | |||
| $osName | |||
| $osVersion | |||
| $platform | |||
| $prototypeRoleId | |||
| $removePrototypeRole | |||
| $replaceType | |||
| $roleId | |||
| $roleName | |||
| $serverId | |||
| $snapshotId | |||
| $status |
| Method | Description | |
|---|---|---|
| Create ( ServerSnapshotCreateInfo $ServerSnapshotCreateInfo, $isRoleBuilder = false ) : BundleTask | ||
| GenerateRoleName ( $DBFarmRole, $DBServer ) | ||
| LoadById ( integer $id ) : BundleTask | ||
| Log ( $message ) | ||
| Save ( ) | ||
| SnapshotCreationComplete ( $snapshotId, $metaData = [] ) | ||
| SnapshotCreationFailed ( $failed_reason ) | ||
| __construct ( $id ) | ||
|
createImageEntity ( ) : |
||
| designateType ( string $platform, string $family, string $generation = null, string $version = '' ) | Designates the type of the bundle task | |
| failObsoleteTasks ( integer $limit = null ) : integer | Cancels obsolete tasks | |
| getActiveTaskIdByName ( string $name, integer $accountId, integer $envId ) : integer | boolean | Check if given name is already used in any running bundletask of this account or environment | |
| getActiveTaskIdByRoleId ( integer $roleId, integer $envId, string $object ) : integer | boolean | Check if there any running bundletask that will affect given role | |
| getFarmObject ( ) : DBFarm | Gets DBFarm object | |
|
getImageEntity ( ) : |
||
| getOsDetails ( ) | ||
| getSnapshotDetails ( ) : ServerSnapshotDetails | ||
| setDate ( string $dt ) | Sets a timestamps according to a specified event | |
| setMetaData ( $data ) |
| Method | Description | |
|---|---|---|
| Unbind ( ) |
| public static Create ( ServerSnapshotCreateInfo $ServerSnapshotCreateInfo, $isRoleBuilder = false ) : BundleTask | ||
| $ServerSnapshotCreateInfo | ServerSnapshotCreateInfo | |
| return | BundleTask | |
| public SnapshotCreationComplete ( $snapshotId, $metaData = [] ) |
|
public createImageEntity ( ) : |
||
| return | ||
| public designateType ( string $platform, string $family, string $generation = null, string $version = '' ) | ||
| $platform | string | The name of the cloud platform |
| $family | string | OS family |
| $generation | string | optional OS generation. If generation is not provided it will use version instead. |
| $version | string | optional OS version. If generation is not provided it will use version instead. |
| public static failObsoleteTasks ( integer $limit = null ) : integer | ||
| $limit | integer | |
| return | integer | Returns number of cancelled tasks |
| public static getActiveTaskIdByName ( string $name, integer $accountId, integer $envId ) : integer | boolean | ||
| $name | string | Name of Role |
| $accountId | integer | Identifier of Account |
| $envId | integer | Identifier of Environment |
| return | integer | boolean | Returns identifier of the Active BundleTask that matches the specified criteria or false otherwise |
| public static getActiveTaskIdByRoleId ( integer $roleId, integer $envId, string $object ) : integer | boolean | ||
| $roleId | integer | Identifier of Role |
| $envId | integer | Identifier of Account |
| $object | string | Object of BundleTask (role, image) |
| return | integer | boolean | Returns identifier of the Active BundleTask that matches the specified criteria or false otherwise |
| public getSnapshotDetails ( ) : ServerSnapshotDetails | ||
| return | ServerSnapshotDetails | |