-
Notifications
You must be signed in to change notification settings - Fork 364
/
images.proto
433 lines (380 loc) · 18.9 KB
/
images.proto
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Generated by the C++ microgenerator.
// If you make any local changes, they will be lost.
// file:///workspace/generator/discovery/compute_public_google_rest_v1.json
// revision: 20230920
syntax = "proto3";
package google.cloud.cpp.compute.images.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/cloud/compute/v1/internal/common_007.proto";
import "google/cloud/compute/v1/internal/common_016.proto";
import "google/cloud/compute/v1/internal/common_022.proto";
import "google/cloud/compute/v1/internal/common_045.proto";
import "google/cloud/compute/v1/internal/common_046.proto";
import "google/cloud/compute/v1/internal/common_054.proto";
import "google/cloud/compute/v1/internal/common_056.proto";
import "google/cloud/compute/v1/internal/common_131.proto";
import "google/cloud/extended_operations.proto";
// Service for the images resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/images
service Images {
option (google.api.default_host) = "compute.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/compute,"
"https://www.googleapis.com/auth/compute.readonly,"
"https://www.googleapis.com/auth/devstorage.full_control,"
"https://www.googleapis.com/auth/devstorage.read_only,"
"https://www.googleapis.com/auth/devstorage.read_write";
// Deletes the specified image.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/delete
rpc DeleteImage(DeleteImageRequest)
returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
delete: "/compute/v1/projects/{project}/global/images/{image}"
};
option (google.api.method_signature) = "project,image";
option (google.cloud.operation_service) = "GlobalOperations";
}
// Sets the deprecation status of an image. If an empty request body is given,
// clears the deprecation status instead.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/deprecate
rpc Deprecate(DeprecateRequest)
returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
post: "/compute/v1/projects/{project}/global/images/{image}/deprecate"
body: "deprecation_status_resource"
};
option (google.api.method_signature) =
"project,image,deprecation_status_resource";
option (google.cloud.operation_service) = "GlobalOperations";
}
// Returns the specified image.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/get
rpc GetImage(GetImageRequest) returns (google.cloud.cpp.compute.v1.Image) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/global/images/{image}"
};
option (google.api.method_signature) = "project,image";
}
// Returns the latest image that is part of an image family and is not
// deprecated. For more information on image families, see Public image
// families documentation.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/getFromFamily
rpc GetFromFamily(GetFromFamilyRequest)
returns (google.cloud.cpp.compute.v1.Image) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/global/images/family/{family}"
};
option (google.api.method_signature) = "project,family";
}
// Gets the access control policy for a resource. May be empty if no such
// policy or resource exists.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/getIamPolicy
rpc GetIamPolicy(GetIamPolicyRequest)
returns (google.cloud.cpp.compute.v1.Policy) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/global/images/{resource}/getIamPolicy"
};
option (google.api.method_signature) = "project,resource";
}
// Creates an image in the specified project using the data included in the
// request.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/insert
rpc InsertImage(InsertImageRequest)
returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
post: "/compute/v1/projects/{project}/global/images"
body: "image_resource"
};
option (google.api.method_signature) = "project,image_resource";
option (google.cloud.operation_service) = "GlobalOperations";
}
// Retrieves the list of custom images available to the specified project.
// Custom images are images you create that belong to your project. This
// method does not get any images that belong to other projects, including
// publicly-available images, like Debian 8. If you want to get a list of
// publicly-available images, use this method to make a request to the
// respective image project, such as debian-cloud or windows-cloud.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/list
rpc ListImages(ListImagesRequest)
returns (google.cloud.cpp.compute.v1.ImageList) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/global/images"
};
option (google.api.method_signature) = "project";
}
// Patches the specified image with the data included in the request. Only the
// following fields can be modified: family, description, deprecation status.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/patch
rpc PatchImage(PatchImageRequest)
returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
patch: "/compute/v1/projects/{project}/global/images/{image}"
body: "image_resource"
};
option (google.api.method_signature) = "project,image,image_resource";
option (google.cloud.operation_service) = "GlobalOperations";
}
// Sets the access control policy on the specified resource. Replaces any
// existing policy.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/setIamPolicy
rpc SetIamPolicy(SetIamPolicyRequest)
returns (google.cloud.cpp.compute.v1.Policy) {
option (google.api.http) = {
post: "/compute/v1/projects/{project}/global/images/{resource}/setIamPolicy"
body: "global_set_policy_request_resource"
};
option (google.api.method_signature) =
"project,resource,global_set_policy_request_resource";
}
// Sets the labels on an image. To learn more about labels, read the Labeling
// Resources documentation.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/setLabels
rpc SetLabels(SetLabelsRequest)
returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
post: "/compute/v1/projects/{project}/global/images/{resource}/setLabels"
body: "global_set_labels_request_resource"
};
option (google.api.method_signature) =
"project,resource,global_set_labels_request_resource";
option (google.cloud.operation_service) = "GlobalOperations";
}
// Returns permissions that a caller has on the specified resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/images/testIamPermissions
rpc TestIamPermissions(TestIamPermissionsRequest)
returns (google.cloud.cpp.compute.v1.TestPermissionsResponse) {
option (google.api.http) = {
post: "/compute/v1/projects/{project}/global/images/{resource}/testIamPermissions"
body: "test_permissions_request_resource"
};
option (google.api.method_signature) =
"project,resource,test_permissions_request_resource";
}
}
// Request message for DeleteImage.
message DeleteImageRequest {
// Name of the image resource to delete.
string image = 1 [(google.api.field_behavior) = REQUIRED];
// Project ID for this request.
string project = 2 [
(google.api.field_behavior) = REQUIRED,
(google.cloud.operation_request_field) = "project"
];
// An optional request ID to identify requests. Specify a unique request ID so
// that if you must retry your request, the server will know to ignore the
// request if it has already been completed. For example, consider a situation
// where you make an initial request and the request times out. If you make
// the request again with the same request ID, the server can check if
// original operation with the same request ID was received, and if so, will
// ignore the second request. This prevents clients from accidentally creating
// duplicate commitments. The request ID must be a valid UUID with the
// exception that zero UUID is not supported (
// 00000000-0000-0000-0000-000000000000).
optional string request_id = 3;
}
// Request message for Deprecate.
message DeprecateRequest {
// The DeprecationStatus for this request.
optional google.cloud.cpp.compute.v1.DeprecationStatus
deprecation_status_resource = 1 [json_name = "__json_request_body"];
// Image name.
string image = 2 [(google.api.field_behavior) = REQUIRED];
// Project ID for this request.
string project = 3 [
(google.api.field_behavior) = REQUIRED,
(google.cloud.operation_request_field) = "project"
];
// An optional request ID to identify requests. Specify a unique request ID so
// that if you must retry your request, the server will know to ignore the
// request if it has already been completed. For example, consider a situation
// where you make an initial request and the request times out. If you make
// the request again with the same request ID, the server can check if
// original operation with the same request ID was received, and if so, will
// ignore the second request. This prevents clients from accidentally creating
// duplicate commitments. The request ID must be a valid UUID with the
// exception that zero UUID is not supported (
// 00000000-0000-0000-0000-000000000000).
optional string request_id = 4;
}
// Request message for GetFromFamily.
message GetFromFamilyRequest {
// Name of the image family to search for.
string family = 1 [(google.api.field_behavior) = REQUIRED];
// The image project that the image belongs to. For example, to get a CentOS
// image, specify centos-cloud as the image project.
string project = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for GetIamPolicy.
message GetIamPolicyRequest {
// Requested IAM Policy version.
optional int32 options_requested_policy_version = 1;
// Project ID for this request.
string project = 2 [(google.api.field_behavior) = REQUIRED];
// Name or id of the resource for this request.
string resource = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for GetImage.
message GetImageRequest {
// Name of the image resource to return.
string image = 1 [(google.api.field_behavior) = REQUIRED];
// Project ID for this request.
string project = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for InsertImage.
message InsertImageRequest {
// Force image creation if true.
optional bool force_create = 1;
// The Image for this request.
optional google.cloud.cpp.compute.v1.Image image_resource = 2
[json_name = "__json_request_body"];
// Project ID for this request.
string project = 3 [
(google.api.field_behavior) = REQUIRED,
(google.cloud.operation_request_field) = "project"
];
// An optional request ID to identify requests. Specify a unique request ID so
// that if you must retry your request, the server will know to ignore the
// request if it has already been completed. For example, consider a situation
// where you make an initial request and the request times out. If you make
// the request again with the same request ID, the server can check if
// original operation with the same request ID was received, and if so, will
// ignore the second request. This prevents clients from accidentally creating
// duplicate commitments. The request ID must be a valid UUID with the
// exception that zero UUID is not supported (
// 00000000-0000-0000-0000-000000000000).
optional string request_id = 4;
}
// Request message for ListImages.
message ListImagesRequest {
// A filter expression that filters resources listed in the response. Most
// Compute resources support two types of filter expressions: expressions that
// support regular expressions and expressions that follow API improvement
// proposal AIP-160. These two types of filter expressions cannot be mixed in
// one request. If you want to use AIP-160, your expression must specify the
// field name, an operator, and the value that you want to use for filtering.
// The value must be a string, a number, or a boolean. The operator must be
// either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are
// filtering Compute Engine instances, you can exclude instances named
// `example-instance` by specifying `name != example-instance`. The `:*`
// comparison can be used to test whether a key has been defined. For example,
// to find all objects with `owner` label use: ``` labels.owner:* ``` You can
// also filter nested fields. For example, you could specify
// `scheduling.automaticRestart = false` to include instances only if they are
// not scheduled for automatic restarts. You can use filtering on nested
// fields to filter based on resource labels. To filter on multiple
// expressions, provide each separate expression within parentheses. For
// example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel
// Skylake") ``` By default, each expression is an `AND` expression. However,
// you can include `AND` and `OR` expressions explicitly. For example: ```
// (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND
// (scheduling.automaticRestart = true) ``` If you want to use a regular
// expression, use the `eq` (equal) or `ne` (not equal) operator against a
// single un-parenthesized expression with or without quotes or against
// multiple parenthesized expressions. Examples: `fieldname eq unquoted
// literal` `fieldname eq 'single quoted literal'` `fieldname eq "double
// quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The
// literal value is interpreted as a regular expression using Google RE2
// library syntax. The literal value must match the entire field. For example,
// to filter for instances that do not end with name "instance", you would use
// `name ne .*instance`. You cannot combine constraints on multiple fields
// using regular expressions.
optional string filter = 1;
// The maximum number of results per page that should be returned. If the
// number of available results is larger than `maxResults`, Compute Engine
// returns a `nextPageToken` that can be used to get the next page of results
// in subsequent list requests. Acceptable values are `0` to `500`, inclusive.
// (Default: `500`)
optional uint32 max_results = 2;
// Sorts list results by a certain order. By default, results are returned in
// alphanumerical order based on the resource name. You can also sort results
// in descending order based on the creation timestamp using
// `orderBy="creationTimestamp desc"`. This sorts results based on the
// `creationTimestamp` field in reverse chronological order (newest result
// first). Use this to sort resources like operations so that the newest
// operation is returned first. Currently, only sorting by `name` or
// `creationTimestamp desc` is supported.
optional string order_by = 3;
// Specifies a page token to use. Set `pageToken` to the `nextPageToken`
// returned by a previous list request to get the next page of results.
optional string page_token = 4;
// Project ID for this request.
string project = 5 [(google.api.field_behavior) = REQUIRED];
// Opt-in for partial success behavior which provides partial results in case
// of failure. The default value is false.
optional bool return_partial_success = 6;
}
// Request message for PatchImage.
message PatchImageRequest {
// Name of the image resource to patch.
string image = 1 [(google.api.field_behavior) = REQUIRED];
// The Image for this request.
optional google.cloud.cpp.compute.v1.Image image_resource = 2
[json_name = "__json_request_body"];
// Project ID for this request.
string project = 3 [
(google.api.field_behavior) = REQUIRED,
(google.cloud.operation_request_field) = "project"
];
// An optional request ID to identify requests. Specify a unique request ID so
// that if you must retry your request, the server will know to ignore the
// request if it has already been completed. For example, consider a situation
// where you make an initial request and the request times out. If you make
// the request again with the same request ID, the server can check if
// original operation with the same request ID was received, and if so, will
// ignore the second request. This prevents clients from accidentally creating
// duplicate commitments. The request ID must be a valid UUID with the
// exception that zero UUID is not supported (
// 00000000-0000-0000-0000-000000000000).
optional string request_id = 4;
}
// Request message for SetIamPolicy.
message SetIamPolicyRequest {
// The GlobalSetPolicyRequest for this request.
optional google.cloud.cpp.compute.v1.GlobalSetPolicyRequest
global_set_policy_request_resource = 1
[json_name = "__json_request_body"];
// Project ID for this request.
string project = 2 [(google.api.field_behavior) = REQUIRED];
// Name or id of the resource for this request.
string resource = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for SetLabels.
message SetLabelsRequest {
// The GlobalSetLabelsRequest for this request.
optional google.cloud.cpp.compute.v1.GlobalSetLabelsRequest
global_set_labels_request_resource = 1
[json_name = "__json_request_body"];
// Project ID for this request.
string project = 2 [
(google.api.field_behavior) = REQUIRED,
(google.cloud.operation_request_field) = "project"
];
// Name or id of the resource for this request.
string resource = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for TestIamPermissions.
message TestIamPermissionsRequest {
// Project ID for this request.
string project = 1 [(google.api.field_behavior) = REQUIRED];
// Name or id of the resource for this request.
string resource = 2 [(google.api.field_behavior) = REQUIRED];
// The TestPermissionsRequest for this request.
optional google.cloud.cpp.compute.v1.TestPermissionsRequest
test_permissions_request_resource = 3 [json_name = "__json_request_body"];
}