aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/yandex-cloud-api-protos/yandex/cloud/backup/v1/provider_service.proto
blob: bc2f4f46f703bb97df05ae95270227750a022c31 (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
55
56
57
syntax = "proto3";

package yandex.cloud.backup.v1;

import "google/api/annotations.proto";

import "yandex/cloud/api/operation.proto";
import "yandex/cloud/operation/operation.proto";
import "yandex/cloud/validation.proto";

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

// A set of methods for managing [backup providers](/docs/backup/concepts/#providers).
service ProviderService {
    // Activate provider for specified client.
    rpc Activate(ActivateProviderRequest)  returns (operation.Operation) {
        option (google.api.http) = {post: "/backup/v1/providers/{name}:activate" body: "*"};
        option (yandex.cloud.api.operation) = {
            metadata: "ActivateProviderMetadata"
            response: "google.protobuf.Empty"
        };
    };

    // List activated providers for specified client.
    rpc ListActivated(ListActivatedProvidersRequest)  returns (ListActivatedProvidersResponse) {
        option (google.api.http) = {get: "/backup/v1/providers"};
    };
}

message ActivateProviderRequest {
    // Activate provider for Folder iD.
    string folder_id = 1 [ (required) = true, (length) = "<=50"];
    reserved 2;
    // Activate specific provider by name.
    //
    // For more information, please see [activate-provider](/docs/backup/quickstart#activate-provider)
    string name = 3 [ (required) = true ];
}

message ActivateProviderMetadata {
    // Activate provider for folder specified by ID.
    string folder_id = 1 [ (required) = true, (length) = "<=50" ];
}

message ListActivatedProvidersRequest {
    // ID of the folder to find out the backup provider.
    string folder_id = 1 [ (required) = true, (length) = "<=50" ];
}

message ListActivatedProvidersResponse {
    // Folder ID.
    string folder_id = 1;
    reserved 2;
    // Name of the backup provider.
    repeated string names = 3;
}