Managed Service for PostgreSQL API, gRPC: BackupRetentionPolicyService.Create
Add a new retention policy.
gRPC request
rpc Create (CreateBackupRetentionPolicyRequest) returns (CreateBackupRetentionPolicyResponse)
CreateBackupRetentionPolicyRequest
{
"cluster_id": "string",
"cron": {
"day_of_month": "string",
"month": "string",
"day_of_week": "string"
},
"retain_for_days": "int64",
"description": "string",
"policy_name": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the PostgreSQL cluster. The maximum string length in characters is 50. |
|
cron |
CronTab schedule. |
|
retain_for_days |
int64 Retention duration. |
|
description |
string Policy description. |
|
policy_name |
string Required field. Required. Policy name. |
CronTab
Message to describe a crontab schedule.
|
Field |
Description |
|
day_of_month |
string Day of month in cron format. Valid values: 1-31, , ranges (1-15), steps (/2, 1-15/3), lists (1,15,28). |
|
month |
string Month in cron format. Valid values: 1-12, , ranges (1-6), steps (/3), lists (1,6,12). |
|
day_of_week |
string Day of week in cron format. Valid values: 0-7 (0 and 7 both mean Sunday), , ranges (1-5), steps (0-6/2), lists (1,3,5). |
CreateBackupRetentionPolicyResponse
{
"policy": {
"policy_id": "string",
"cluster_id": "string",
"policy_name": "string",
"created_at": "google.protobuf.Timestamp",
"cron": {
"day_of_month": "string",
"month": "string",
"day_of_week": "string"
},
"retain_for_days": "int64",
"description": "string"
}
}
|
Field |
Description |
|
policy |
Newly created BackupRetentionPolicy. |
BackupRetentionPolicy
Message to describe a retention policy for cluster backups.
|
Field |
Description |
|
policy_id |
string Required field. Required. Policy ID. |
|
cluster_id |
string Required field. PostgreSQL cluster ID. The maximum string length in characters is 50. |
|
policy_name |
string Required field. Required. Policy name. |
|
created_at |
Creation timestamp in RFC3339 text format. |
|
cron |
CronTab schedule. |
|
retain_for_days |
int64 Retention duration. |
|
description |
string Human-readable description. |
CronTab
Message to describe a crontab schedule.
|
Field |
Description |
|
day_of_month |
string Day of month in cron format. Valid values: 1-31, , ranges (1-15), steps (/2, 1-15/3), lists (1,15,28). |
|
month |
string Month in cron format. Valid values: 1-12, , ranges (1-6), steps (/3), lists (1,6,12). |
|
day_of_week |
string Day of week in cron format. Valid values: 0-7 (0 and 7 both mean Sunday), , ranges (1-5), steps (0-6/2), lists (1,3,5). |