-
Notifications
You must be signed in to change notification settings - Fork 356
/
global_operations.proto
275 lines (245 loc) · 13.7 KB
/
global_operations.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
// 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.global_operations.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/cloud/compute/v1/internal/common_016.proto";
import "google/cloud/compute/v1/internal/common_082.proto";
import "google/cloud/compute/v1/internal/common_083.proto";
import "google/cloud/extended_operations.proto";
import "google/protobuf/empty.proto";
// Service for the globalOperations resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/globalOperations
service GlobalOperations {
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";
// Retrieves an aggregated list of all operations.
// https://cloud.google.com/compute/docs/reference/rest/v1/globalOperations/aggregatedList
rpc AggregatedListGlobalOperations(AggregatedListGlobalOperationsRequest)
returns (google.cloud.cpp.compute.v1.OperationAggregatedList) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/aggregated/operations"
};
option (google.api.method_signature) = "project";
}
// Deletes the specified Operations resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/globalOperations/delete
rpc DeleteOperation(DeleteOperationRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/compute/v1/projects/{project}/global/operations/{operation}"
};
option (google.api.method_signature) = "project,operation";
}
// Retrieves the specified Operations resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/globalOperations/get
rpc GetOperation(GetOperationRequest)
returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/global/operations/{operation}"
};
option (google.api.method_signature) = "project,operation";
}
// Retrieves a list of Operation resources contained within the specified
// project.
// https://cloud.google.com/compute/docs/reference/rest/v1/globalOperations/list
rpc ListGlobalOperations(ListGlobalOperationsRequest)
returns (google.cloud.cpp.compute.v1.OperationList) {
option (google.api.http) = {
get: "/compute/v1/projects/{project}/global/operations"
};
option (google.api.method_signature) = "project";
}
// Waits for the specified Operation resource to return as `DONE` or for the
// request to approach the 2 minute deadline, and retrieves the specified
// Operation resource. This method differs from the `GET` method in that it
// waits for no more than the default deadline (2 minutes) and then returns
// the current state of the operation, which might be `DONE` or still in
// progress. This method is called on a best-effort basis. Specifically: - In
// uncommon cases, when the server is overloaded, the request might return
// before the default deadline is reached, or might return after zero seconds.
// - If the default deadline is reached, there is no guarantee that the
// operation is actually done when the method returns. Be prepared to retry if
// the operation is not `DONE`.
// https://cloud.google.com/compute/docs/reference/rest/v1/globalOperations/wait
rpc Wait(WaitRequest) returns (google.cloud.cpp.compute.v1.Operation) {
option (google.api.http) = {
post: "/compute/v1/projects/{project}/global/operations/{operation}/wait"
body: "*"
};
option (google.api.method_signature) = "project,operation";
}
}
// Request message for AggregatedListGlobalOperations.
message AggregatedListGlobalOperationsRequest {
// 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;
// Indicates whether every visible scope for each scope type (zone, region,
// global) should be included in the response. For new resource types added
// after this field, the flag has no effect as new resource types will always
// include every visible scope for each scope type in response. For resource
// types which predate this field, if this flag is omitted or false, only
// scopes of the scope types where the resource type is expected to be found
// will be included.
optional bool include_all_scopes = 2;
// 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 = 3;
// 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 = 4;
// 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 = 5;
// Project ID for this request.
string project = 6 [(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 = 7;
optional string service_project_number = 8;
}
// Request message for DeleteOperation.
message DeleteOperationRequest {
// Name of the Operations resource to delete.
string operation = 1 [(google.api.field_behavior) = REQUIRED];
// Project ID for this request.
string project = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for GetOperation.
message GetOperationRequest {
// Name of the Operations resource to return.
string operation = 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"
];
}
// Request message for ListGlobalOperations.
message ListGlobalOperationsRequest {
// 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 Wait.
message WaitRequest {
// Name of the Operations resource to return.
string operation = 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"
];
}