aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/yandex-cloud-api-protos/yandex/cloud/mdb/elasticsearch/v1/backup_service.proto
blob: fa1f83efa3238af60f3d7b5f91cfc4fd89c7cab0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
syntax = "proto3";

package yandex.cloud.mdb.elasticsearch.v1;

import "google/api/annotations.proto";
import "yandex/cloud/validation.proto";
import "yandex/cloud/mdb/elasticsearch/v1/backup.proto";

option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/mdb/elasticsearch/v1;elasticsearch";
option java_package = "yandex.cloud.api.mdb.elasticsearch.v1";

service BackupService {
  // Returns the specified backup of Elasticsearch cluster.
  rpc Get (GetBackupRequest) returns (Backup) {
    option (google.api.http) = { get: "/managed-elasticsearch/v1/backups/{backup_id}" };
  }

  // Returns the list of available backups for the specified Elasticsearch cluster.
  rpc List (ListBackupsRequest) returns (ListBackupsResponse) {
    option (google.api.http) = { get: "/managed-elasticsearch/v1/backups" };
  }
}

message GetBackupRequest {
  // Required. ID of the backup to return.
  string backup_id = 1 [(required) = true];
}

message ListBackupsRequest {
  // Required. ID of the folder to list backups in.
  string folder_id = 1 [(required) = true, (length) = "<=50"];

  // The maximum number of results per page that should be returned. If the number of available
  // results is larger than `page_size`, the service returns a `next_page_token` that can be used
  // to get the next page of results in subsequent ListBackups requests.
  // Acceptable values are 0 to 1000, inclusive. Default value: 100.
  int64 page_size = 2 [(value) = "0-1000"];

  // Page token. Set `page_token` to the `next_page_token` returned by a previous ListBackups
  // request to get the next page of results.
  string page_token = 3 [(length) = "<=100"];
}

message ListBackupsResponse {
  // Requested list of backups.
  repeated Backup backups = 1;

  // This token allows you to get the next page of results for ListBackups requests,
  // if the number of results is larger than `page_size` specified in the request.
  // To get the next page, specify the value of `next_page_token` as a value for
  // the `page_token` parameter in the next ListBackups request. Subsequent ListBackups
  // requests will have their own `next_page_token` to continue paging through the results.
  string next_page_token = 2;
}