Compute Cloud API, gRPC: SnapshotScheduleService.Enable
Enables the specified snapshot schedule.
The SnapshotSchedule.status is changed to ACTIVE: new disk snapshots will be created, old ones deleted
(if SnapshotSchedule.retention_policy is specified).
gRPC request
rpc Enable (EnableSnapshotScheduleRequest) returns (operation.Operation)
EnableSnapshotScheduleRequest
{
"snapshot_schedule_id": "string"
}
|
Field |
Description |
|
snapshot_schedule_id |
string ID of the snapshot schedule to enable. To get a snapshot schedule ID, make a SnapshotScheduleService.List request. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"snapshot_schedule_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"status": "Status",
"schedule_policy": {
"start_at": "google.protobuf.Timestamp",
"expression": "string"
},
// Includes only one of the fields `retention_period`, `snapshot_count`
"retention_period": "google.protobuf.Duration",
"snapshot_count": "int64",
// end of the list of possible fields
"snapshot_spec": {
"description": "string",
"labels": "map<string, string>"
}
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
EnableSnapshotScheduleMetadata Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
EnableSnapshotScheduleMetadata
|
Field |
Description |
|
snapshot_schedule_id |
string ID of the snapshot schedule that is being enabled. |
SnapshotSchedule
A snapshot schedule. For details about the concept, see documentation.
|
Field |
Description |
|
id |
string ID of the snapshot schedule. |
|
folder_id |
string ID of the folder that the snapshot schedule belongs to. |
|
created_at |
Creation timestamp. |
|
name |
string Name of the snapshot schedule. The name is unique within the folder. |
|
description |
string Description of the snapshot schedule. |
|
labels |
object (map<string, string>) Snapshot schedule labels as |
|
status |
enum Status Status of the snapshot schedule.
|
|
schedule_policy |
Frequency settings of the snapshot schedule. |
|
retention_period |
Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is Includes only one of the fields Retention policy of the snapshot schedule. |
|
snapshot_count |
int64 Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this Includes only one of the fields Retention policy of the snapshot schedule. |
|
snapshot_spec |
Attributes of snapshots created by the snapshot schedule. |
SchedulePolicy
A resource for frequency settings of a snapshot schedule.
|
Field |
Description |
|
start_at |
Timestamp for creating the first snapshot. |
|
expression |
string Cron expression for the snapshot schedule (UTC+0). The expression must consist of five fields ( |
SnapshotSpec
A resource for attributes of snapshots created by the snapshot schedule.
|
Field |
Description |
|
description |
string Description of the created snapshot. |
|
labels |
object (map<string, string>) Snapshot labels as |