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
228
229
|
syntax = "proto3";
package yandex.cloud.vpc.v1;
import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";
import "yandex/cloud/api/operation.proto";
import "yandex/cloud/operation/operation.proto";
import "yandex/cloud/validation.proto";
import "yandex/cloud/vpc/v1/gateway.proto";
option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/vpc/v1;vpc";
option java_package = "yandex.cloud.api.vpc.v1";
service GatewayService {
// Returns the specified Gateway resource.
//
// To get the list of all available Gateway resources, make a [List] request.
rpc Get (GetGatewayRequest) returns (Gateway) {
option (google.api.http) = {get: "/vpc/v1/gateways/{gateway_id}"};
}
// Retrieves the list of Gateway resources in the specified folder.
rpc List (ListGatewaysRequest) returns (ListGatewaysResponse) {
option (google.api.http) = {get: "/vpc/v1/gateways"};
}
// Creates a gateway in the specified folder.
rpc Create (CreateGatewayRequest) returns (operation.Operation) {
option (google.api.http) = {post: "/vpc/v1/gateways" body: "*"};
option (yandex.cloud.api.operation) = {
metadata: "CreateGatewayMetadata"
response: "Gateway"
};
};
// Updates the specified gateway.
rpc Update (UpdateGatewayRequest) returns (operation.Operation) {
option (google.api.http) = {patch: "/vpc/v1/gateways/{gateway_id}" body: "*"};
option (yandex.cloud.api.operation) = {
metadata: "UpdateGatewayMetadata"
response: "Gateway"
};
};
// Deletes the specified gateway.
rpc Delete (DeleteGatewayRequest) returns (operation.Operation) {
option (google.api.http) = {delete: "/vpc/v1/gateways/{gateway_id}"};
option (yandex.cloud.api.operation) = {
metadata: "DeleteGatewayMetadata"
response: "google.protobuf.Empty"
};
};
// List operations for the specified gateway.
rpc ListOperations (ListGatewayOperationsRequest) returns (ListGatewayOperationsResponse) {
option (google.api.http) = {get: "/vpc/v1/gateways/{gateway_id}/operations"};
}
// Move a gateway to another folder
rpc Move (MoveGatewayRequest) returns (operation.Operation) {
option (google.api.http) = {post: "/vpc/v1/gateways/{gateway_id}:move" body: "*"};
option (yandex.cloud.api.operation) = {
metadata: "MoveGatewayMetadata"
response: "Gateway"
};
}
}
message GetGatewayRequest {
// ID of the Gateway resource to return.
//
// To get Gateway resource ID make a [GatewayService.List] request.
string gateway_id = 1 [(required) = true, (length) = "<=50"];
}
message ListGatewaysRequest {
// ID of the folder to list gateways in.
//
// To get the folder ID use a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
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 [ListGatewaysResponse.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. To get the next page of results, set `page_token` to the
// [ListGatewaysResponse.next_page_token] returned by a previous list request.
string page_token = 3 [(length) = "<=100"];
// A filter expression that filters Gateway listed in the response.
//
// The expression must specify:
// 1. The field name. Currently you can use filtering only on [Gateway.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]`.
// Example of a filter: `name=my-gateway`.
string filter = 4 [(length) = "<=1000"];
}
message ListGatewaysResponse {
// List of gateways.
repeated Gateway gateways = 1;
// Token for getting the next page of the list. If the number of results is greater than
// the specified [ListGatewaysRequest.page_size], use `next_page_token` as the value
// for the [ListGatewaysRequest.page_token] parameter in the next list request.
//
// Each subsequent page will have its own `next_page_token` to continue paging through the results.
string next_page_token = 2;
}
message ListGatewayOperationsRequest {
// ID of the gateway to list operations for.
//
// To get a gateway ID make a [GatewayService.List] request.
string gateway_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 [ListGatewayOperationsResponse.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) = "0-1000"];
// Page token. To get the next page of results, set [page_token] to the
// [ListGatewayOperationsResponse.next_page_token] returned by a previous list request.
string page_token = 3 [(length) = "<=100"];
}
message ListGatewayOperationsResponse {
// List of operations for the specified gateway.
repeated operation.Operation operations = 1;
// Token for getting the next page of the list. If the number of results is greater than
// the specified [ListGatewayOperationsRequest.page_size], use `next_page_token` as the value
// for the [ListGatewayOperationsRequest.page_token] parameter in the next list request.
//
// Each subsequent page will have its own `next_page_token` to continue paging through the results.
string next_page_token = 2;
}
message SharedEgressGatewaySpec {
}
message CreateGatewayRequest {
// ID of the folder to create a gateway in.
//
// To get a folder ID make a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
string folder_id = 1 [(required) = true, (length) = "<=50"];
// Name of the gateway.
// The name must be unique within the folder.
string name = 2 [(pattern) = "|[a-z]([-a-z0-9]{0,61}[a-z0-9])?"];
// Description of the gateway.
string description = 3 [(length) = "<=256"];
// Gateway labels as `key:value` pairs.
map<string, string> labels = 4 [(size) = "<=64", (length) = "<=63", (pattern) = "[-_./\\@0-9a-z]*", (map_key).length = "1-63", (map_key).pattern = "[a-z][-_./\\@0-9a-z]*"];
// Gateway configuration specification
oneof gateway {
SharedEgressGatewaySpec shared_egress_gateway_spec = 5;
}
}
message CreateGatewayMetadata {
// ID of the gateway that is being created.
string gateway_id = 1;
}
message UpdateGatewayRequest {
// ID of the gateway to update.
//
// To get the gateway ID make a [GatewayService.List] request.
string gateway_id = 1 [(required) = true, (length) = "<=50"];
// Field mask that specifies which attributes of the Gateway should be updated.
google.protobuf.FieldMask update_mask = 2;
// New name for the gateway.
// The name must be unique within the folder.
string name = 3 [(pattern) = "|[a-z]([-a-z0-9]{0,61}[a-z0-9])?"];
// New description of the gateway.
string description = 4 [(length) = "<=256"];
// Gateway labels as `key:value` pairs.
//
// Existing set of labels is completely replaced by the provided set, so if you just want
// to add or remove a label:
// 1. Get the current set of labels with a [GatewayService.Get] request.
// 2. Add or remove a label in this set.
// 3. Send the new set in this field.
map<string, string> labels = 5 [(size) = "<=64", (length) = "<=63", (pattern) = "[-_./\\@0-9a-z]*", (map_key).length = "1-63", (map_key).pattern = "[a-z][-_./\\@0-9a-z]*"];
// New Gateway configuration specification
oneof gateway {
SharedEgressGatewaySpec shared_egress_gateway_spec = 6;
}
}
message UpdateGatewayMetadata {
// ID of the Gateway that is being updated.
string gateway_id = 1;
}
message DeleteGatewayRequest {
// ID of the gateway to delete.
//
// To get a gateway ID make a [GatewayService.List] request.
string gateway_id = 1 [(required) = true, (length) = "<=50"];
}
message DeleteGatewayMetadata {
// ID of the gateway that is being deleted.
string gateway_id = 1;
}
message MoveGatewayRequest {
string gateway_id = 1 [(required) = true, (length) = "<=50"];
string destination_folder_id = 2 [(required) = true, (length) = "<=50"];
}
message MoveGatewayMetadata {
string gateway_id = 1;
}
|
