Managed Service for PostgreSQL API, gRPC: BackupRetentionPolicyService.List
List all retention policies.
gRPC request
rpc List (ListBackupRetentionPoliciesRequest) returns (ListBackupRetentionPoliciesResponse)
ListBackupRetentionPoliciesRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
Field |
Description |
cluster_id |
string Required field. ID of the PostgreSQL cluster. |
page_size |
int64 The maximum number of results per page to return. If the number of available |
page_token |
string Page token. To get the next page of results, set |
ListBackupRetentionPoliciesResponse
{
"policies": [
{
"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"
}
],
"next_page_token": "string"
}
Field |
Description |
policies[] |
List of BackupRetentionPolicy associated with the cluster. |
next_page_token |
string This token allows you to get the next page of results for list requests. If the number of results |
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. |
policy_name |
string Required field. Required. Policy name. |
created_at |
Creation timestamp in RFC3339 |
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 |
month |
string |
day_of_week |
string |