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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
syntax = "proto3";
package yandex.cloud.resourcemanager.v1;
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "yandex/cloud/api/operation.proto";
import "yandex/cloud/resourcemanager/v1/folder.proto";
import "yandex/cloud/access/access.proto";
import "yandex/cloud/operation/operation.proto";
import "yandex/cloud/validation.proto";
option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/resourcemanager/v1;resourcemanager";
option java_package = "yandex.cloud.api.resourcemanager.v1";
// A set of methods for managing Folder resources.
service FolderService {
// Returns the specified Folder resource.
//
// To get the list of available Folder resources, make a [List] request.
rpc Get (GetFolderRequest) returns (Folder) {
option (google.api.http) = { get: "/resource-manager/v1/folders/{folder_id}" };
}
// Retrieves the list of Folder resources in the specified cloud.
rpc List (ListFoldersRequest) returns (ListFoldersResponse) {
option (google.api.http) = { get: "/resource-manager/v1/folders" };
}
// Creates a folder in the specified cloud.
rpc Create (CreateFolderRequest) returns (operation.Operation) {
option (google.api.http) = { post: "/resource-manager/v1/folders" body: "*" };
option (yandex.cloud.api.operation) = {
metadata: "CreateFolderMetadata"
response: "Folder"
};
}
// Updates the specified folder.
rpc Update (UpdateFolderRequest) returns (operation.Operation) {
option (google.api.http) = { patch: "/resource-manager/v1/folders/{folder_id}" body: "*" };
option (yandex.cloud.api.operation) = {
metadata: "UpdateFolderMetadata"
response: "Folder"
};
}
// Deletes the specified folder.
rpc Delete (DeleteFolderRequest) returns (operation.Operation) {
option (google.api.http) = { delete: "/resource-manager/v1/folders/{folder_id}" };
option (yandex.cloud.api.operation) = {
metadata: "DeleteFolderMetadata"
response: "google.protobuf.Empty"
};
}
// Lists operations for the specified folder.
rpc ListOperations (ListFolderOperationsRequest) returns (ListFolderOperationsResponse) {
option (google.api.http) = { get: "/resource-manager/v1/folders/{folder_id}/operations" };
}
//access
// Lists access bindings for the specified folder.
rpc ListAccessBindings (access.ListAccessBindingsRequest) returns (access.ListAccessBindingsResponse) {
option (google.api.http) = { get: "/resource-manager/v1/folders/{resource_id}:listAccessBindings" };
}
// Sets access bindings for the specified folder.
rpc SetAccessBindings (access.SetAccessBindingsRequest) returns (operation.Operation) {
option (google.api.http) = { post: "/resource-manager/v1/folders/{resource_id}:setAccessBindings" body: "*" };
option (yandex.cloud.api.operation) = {
metadata: "access.SetAccessBindingsMetadata"
response: "access.AccessBindingsOperationResult"
};
}
// Updates access bindings for the specified folder.
rpc UpdateAccessBindings (access.UpdateAccessBindingsRequest) returns (operation.Operation) {
option (google.api.http) = { post: "/resource-manager/v1/folders/{resource_id}:updateAccessBindings" body: "*" };
option (yandex.cloud.api.operation) = {
metadata: "access.UpdateAccessBindingsMetadata"
response: "access.AccessBindingsOperationResult"
};
}
}
message GetFolderRequest {
// ID of the Folder resource to return.
// To get the folder ID, use a [FolderService.List] request.
string folder_id = 1 [(required) = true, (length) = "<=50"];
}
message ListFoldersRequest {
// ID of the cloud to list folders in.
// To get the cloud ID, use a [yandex.cloud.resourcemanager.v1.CloudService.List] request.
string cloud_id = 1 [(required) = true, (length) = "<=50"];
// The maximum number of results per page to return. If the number of available
// results is larger than [page_size],
// the service returns a [ListFoldersResponse.next_page_token]
// that can be used to get the next page of results in subsequent list requests.
// Default value: 100.
int64 page_size = 2 [(value) = "<=1000"];
// Page token. Set [page_token]
// to the [ListFoldersResponse.next_page_token]
// returned by a previous list request to get the next page of results.
string page_token = 3 [(length) = "<=2000"];
// A filter expression that filters resources listed in the response.
// The expression must specify:
// 1. The field name. Currently you can use filtering only on the [Folder.name] field.
// 2. An `=` operator.
// 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
string filter = 4 [(length) = "<=1000"];
}
message ListFoldersResponse {
// List of Folder resources.
repeated Folder folders = 1;
// This token allows you to get the next page of results for list requests. If the number of results
// is larger than [ListFoldersRequest.page_size], use
// the [next_page_token] as the value
// for the [ListFoldersRequest.page_token] query parameter
// in the next list request. Each subsequent list request will have its own
// [next_page_token] to continue paging through the results.
string next_page_token = 2;
}
message CreateFolderRequest {
// ID of the cloud to create a folder in.
// To get the cloud ID, use a [yandex.cloud.resourcemanager.v1.CloudService.List] request.
string cloud_id = 1 [(required) = true, (length) = "<=50"];
// Name of the folder.
// The name must be unique within the cloud.
string name = 2 [(required) = true, (pattern) = "|[a-z][-a-z0-9]{1,61}[a-z0-9]"];
// Description of the folder.
string description = 3 [(length) = "<=256"];
// Resource labels as `` key:value `` pairs.
map<string, string> labels = 4 [(yandex.cloud.size) = "<=64", (length) = "<=63", (pattern) = "[-_0-9a-z]*", (map_key).length = "1-63", (map_key).pattern = "[a-z][-_0-9a-z]*"];
}
message CreateFolderMetadata {
// ID of the folder that is being created.
string folder_id = 1;
}
message UpdateFolderRequest {
// ID of the Folder resource to update.
// To get the folder ID, use a [FolderService.List] request.
string folder_id = 1 [(required) = true, (length) = "<=50"];
// Field mask that specifies which fields of the Folder resource are going to be updated.
google.protobuf.FieldMask update_mask = 2;
// Name of the folder.
// The name must be unique within the cloud.
string name = 3 [(required) = true, (pattern) = "|[a-z][-a-z0-9]{1,61}[a-z0-9]"];
// Description of the folder.
string description = 4 [(length) = "<=256"];
// Resource labels as `` key:value `` pairs.
map<string, string> labels = 5 [(yandex.cloud.size) = "<=64", (length) = "<=63", (pattern) = "[-_0-9a-z]*", (map_key).length = "1-63", (map_key).pattern = "[a-z][-_0-9a-z]*"];
}
message UpdateFolderMetadata {
// ID of the Folder resource that is being updated.
string folder_id = 1;
}
message DeleteFolderRequest {
// ID of the folder to delete.
// To get the folder ID, use a [FolderService.List] request.
string folder_id = 1 [(required) = true, (length) = "<=50"];
// The timestamp after which the process of deleting the folder should begin.
// Until this timestamp, the folder goes into the [Folder.Status.PENDING_DELETION] state and all resources in this
// folder are stopped. In this state, it is possible to cancel the delete operation without any loss.
// After this timestamp, the status of the folder will become [Folder.Status.DELETING] and the process of deleting
// all the resources of the folder will be started. If [delete_after] is not specified it will be
// (now + 24 hours). To initiate an immediate deletion [delete_after] must be <= now.
google.protobuf.Timestamp delete_after = 2;
}
message DeleteFolderMetadata {
// ID of the folder that is being deleted.
string folder_id = 1;
// The timestamp after which the process of deleting the folder should begin.
google.protobuf.Timestamp delete_after = 2;
// Information about operation cancellation
string cancelled_by = 3;
google.protobuf.Timestamp cancelled_at = 4;
}
message ListFolderOperationsRequest {
// ID of the Folder resource to list operations for.
string folder_id = 1 [(required) = true, (length) = "<=50"];
// The maximum number of results per page to return. If the number of available
// results is larger than [page_size], the service returns a [ListFolderOperationsResponse.next_page_token]
// that can be used to get the next page of results in subsequent list requests.
// Default value: 100.
int64 page_size = 2 [(value) = "<=1000"];
// Page token. Set [page_token]
// to the [ListFolderOperationsResponse.next_page_token]
// returned by a previous list request to get the next page of results.
string page_token = 3 [(length) = "<=2000"];
}
message ListFolderOperationsResponse {
// List of operations for the specified folder.
repeated operation.Operation operations = 1;
// This token allows you to get the next page of results for list requests. If the number of results
// is larger than [ListFolderOperationsRequest.page_size], use the [next_page_token] as the value
// for the [ListFolderOperationsRequest.page_token] query parameter in the next list request.
// Each subsequent list request will have its own [next_page_token] to continue paging through the results.
string next_page_token = 2;
}
|
