Crons
extends CloudApiBase
in
implements
CloudApiInterface
Class Crons
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Show all cron tasks for an environment. | CronsResponse |
| get() | Get information about a cron task. | CronResponse |
| create() | Add a cron task. | OperationResponse |
| update() | Update a cron task. | OperationResponse |
| delete() | Delete a cron task. | OperationResponse |
| disable() | Disable a cron task. | OperationResponse |
| enable() | Enable a cron task. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Show all cron tasks for an environment.
public
getAll(
$environmentUuid :
string
)
: CronsResponse
Parameters
- $environmentUuid : string
The environment ID
Return values
CronsResponseget()
Get information about a cron task.
public
get(
$environmentUuid :
string
, $cronId :
int
)
: CronResponse
Parameters
- $environmentUuid : string
The environment ID
- $cronId : int
Return values
CronResponsecreate()
Add a cron task.
public
create(
$environmentUuid :
string
, $command :
string
, $frequency :
string
, $label :
string
[, $serverId :
string
= null ]
)
: OperationResponse
Parameters
- $environmentUuid : string
- $command : string
- $frequency : string
- $label : string
- $serverId : string = null
Return values
OperationResponseupdate()
Update a cron task.
public
update(
$environmentUuid :
string
, $cronId :
string
, $command :
string
, $frequency :
string
, $label :
string
[, $serverId :
string
= null ]
)
: OperationResponse
Parameters
- $environmentUuid : string
- $cronId : string
- $command : string
- $frequency : string
- $label : string
- $serverId : string = null
Return values
OperationResponsedelete()
Delete a cron task.
public
delete(
$environmentUuid :
string
, $cronId :
int
)
: OperationResponse
Parameters
- $environmentUuid : string
- $cronId : int
Return values
OperationResponsedisable()
Disable a cron task.
public
disable(
$environmentUuid :
string
, $cronId :
int
)
: OperationResponse
Parameters
- $environmentUuid : string
- $cronId : int
Return values
OperationResponseenable()
Enable a cron task.
public
enable(
$environmentUuid :
string
, $cronId :
int
)
: OperationResponse
Parameters
- $environmentUuid : string
- $cronId : int
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface