xref: /aosp_15_r20/external/googleapis/google/cloud/compute/v1small/compute_small.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2020 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// Generated by the disco-to-proto3-converter. DO NOT EDIT!
16// Source Discovery file: compute.v1small.json
17// Source file revision: 20200302
18// API name: compute
19// API version: v1small
20
21syntax = "proto3";
22
23package google.cloud.compute.v1small;
24
25import "google/api/annotations.proto";
26import "google/api/client.proto";
27import "google/api/field_behavior.proto";
28import "google/api/resource.proto";
29import "google/cloud/extended_operations.proto";
30
31//
32// File Options
33//
34option csharp_namespace = "Google.Cloud.Compute.V1Small";
35option go_package = "google.golang.org/genproto/googleapis/cloud/compute/v1small;compute";
36option java_multiple_files = true;
37option java_package = "com.google.cloud.compute.v1small";
38option php_namespace = "Google\\Cloud\\Compute\\V1small";
39option ruby_package = "Google::Cloud::Compute::V1small";
40
41//
42// Messages
43//
44// Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.
45//
46// Use global internal addresses for reserved peering network range.
47//
48// Use regional external addresses for the following resources:
49//
50// - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)
51//
52// Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
53//
54// - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses
55//
56// For more information, read reserved IP address.
57//
58// (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
59message Address {
60  // The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
61  enum AddressType {
62    // A value indicating that the enum field is not set.
63    UNDEFINED_ADDRESS_TYPE = 0;
64
65    EXTERNAL = 35607499;
66
67    INTERNAL = 279295677;
68
69    UNSPECIFIED_TYPE = 53933922;
70
71  }
72
73  // The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
74  enum IpVersion {
75    // A value indicating that the enum field is not set.
76    UNDEFINED_IP_VERSION = 0;
77
78    IPV4 = 2254341;
79
80    IPV6 = 2254343;
81
82    UNSPECIFIED_VERSION = 21850000;
83
84  }
85
86  // This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.
87  //
88  // If this field is not specified, it is assumed to be PREMIUM.
89  enum NetworkTier {
90    // A value indicating that the enum field is not set.
91    UNDEFINED_NETWORK_TIER = 0;
92
93    PREMIUM = 399530551;
94
95    STANDARD = 484642493;
96
97  }
98
99  // The purpose of this resource, which can be one of the following values:
100  // - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
101  // - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
102  // - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
103  // - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
104  enum Purpose {
105    // A value indicating that the enum field is not set.
106    UNDEFINED_PURPOSE = 0;
107
108    DNS_RESOLVER = 476114556;
109
110    GCE_ENDPOINT = 230515243;
111
112    NAT_AUTO = 163666477;
113
114    VPC_PEERING = 400800170;
115
116  }
117
118  // [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
119  enum Status {
120    // A value indicating that the enum field is not set.
121    UNDEFINED_STATUS = 0;
122
123    IN_USE = 17393485;
124
125    RESERVED = 432241448;
126
127    RESERVING = 514587225;
128
129  }
130
131  // The static IP address represented by this resource.
132  optional string address = 462920692;
133
134  // The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
135  // Check the AddressType enum for the list of possible values.
136  optional string address_type = 264307877;
137
138  // [Output Only] Creation timestamp in RFC3339 text format.
139  optional string creation_timestamp = 30525366;
140
141  // An optional description of this resource. Provide this field when you create the resource.
142  optional string description = 422937596;
143
144  // [Output Only] The unique identifier for the resource. This identifier is defined by the server.
145  optional uint64 id = 3355;
146
147  // The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
148  // Check the IpVersion enum for the list of possible values.
149  optional string ip_version = 294959552;
150
151  // [Output Only] Type of the resource. Always compute#address for addresses.
152  optional string kind = 3292052;
153
154  // Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
155  optional string name = 3373707;
156
157  // The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
158  optional string network = 232872494;
159
160  // This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.
161  //
162  // If this field is not specified, it is assumed to be PREMIUM.
163  // Check the NetworkTier enum for the list of possible values.
164  optional string network_tier = 517397843;
165
166  // The prefix length if the resource reprensents an IP range.
167  optional int32 prefix_length = 453565747;
168
169  // The purpose of this resource, which can be one of the following values:
170  // - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
171  // - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
172  // - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
173  // - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
174  // Check the Purpose enum for the list of possible values.
175  optional string purpose = 316407070;
176
177  // [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
178  optional string region = 138946292;
179
180  // [Output Only] Server-defined URL for the resource.
181  optional string self_link = 456214797;
182
183  // [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
184  // Check the Status enum for the list of possible values.
185  optional string status = 181260274;
186
187  // The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
188  optional string subnetwork = 307827694;
189
190  // [Output Only] The URLs of the resources that are using this address.
191  repeated string users = 111578632;
192
193}
194
195//
196message AddressAggregatedList {
197  // [Output Only] Unique identifier for the resource; defined by the server.
198  optional string id = 3355;
199
200  // A list of AddressesScopedList resources.
201  map<string, AddressesScopedList> items = 100526016;
202
203  // [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
204  optional string kind = 3292052;
205
206  // [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
207  optional string next_page_token = 79797525;
208
209  // [Output Only] Server-defined URL for this resource.
210  optional string self_link = 456214797;
211
212  // [Output Only] Informational warning message.
213  optional Warning warning = 50704284;
214
215}
216
217// Contains a list of addresses.
218message AddressList {
219  // [Output Only] Unique identifier for the resource; defined by the server.
220  optional string id = 3355;
221
222  // A list of Address resources.
223  repeated Address items = 100526016;
224
225  // [Output Only] Type of resource. Always compute#addressList for lists of addresses.
226  optional string kind = 3292052;
227
228  // [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
229  optional string next_page_token = 79797525;
230
231  // [Output Only] Server-defined URL for this resource.
232  optional string self_link = 456214797;
233
234  // [Output Only] Informational warning message.
235  optional Warning warning = 50704284;
236
237}
238
239//
240message AddressesScopedList {
241  // [Output Only] A list of addresses contained in this scope.
242  repeated Address addresses = 337673122;
243
244  // [Output Only] Informational warning which replaces the list of addresses when the list is empty.
245  optional Warning warning = 50704284;
246
247}
248
249// A request message for Addresses.AggregatedList. See the method description for details.
250message AggregatedListAddressesRequest {
251  // A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
252  //
253  // For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
254  //
255  // 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.
256  //
257  // 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) ```
258  optional string filter = 336120696;
259
260  // 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.
261  optional bool include_all_scopes = 391327988;
262
263  // 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`)
264  optional uint32 max_results = 54715419;
265
266  // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
267  //
268  // 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.
269  //
270  // Currently, only sorting by `name` or `creationTimestamp desc` is supported.
271  optional string order_by = 160562920;
272
273  // Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
274  optional string page_token = 19994697;
275
276  // Project ID for this request.
277  string project = 227560217 [(google.api.field_behavior) = REQUIRED];
278
279}
280
281//
282message Data {
283  // [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
284  optional string key = 106079;
285
286  // [Output Only] A warning data value corresponding to the key.
287  optional string value = 111972721;
288
289}
290
291// A request message for Addresses.Delete. See the method description for details.
292message DeleteAddressRequest {
293  // Name of the address resource to delete.
294  string address = 462920692 [(google.api.field_behavior) = REQUIRED];
295
296  // Project ID for this request.
297  string project = 227560217 [
298    (google.api.field_behavior) = REQUIRED,
299    (google.cloud.operation_request_field) = "project"
300  ];
301
302  // Name of the region for this request.
303  string region = 138946292 [
304    (google.api.field_behavior) = REQUIRED,
305    (google.cloud.operation_request_field) = "region"
306  ];
307
308  // 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.
309  //
310  // 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.
311  //
312  // The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
313  optional string request_id = 37109963;
314
315}
316
317// [Output Only] If errors are generated during processing of the operation, this field will be populated.
318message Error {
319  // [Output Only] The array of errors encountered while processing this operation.
320  repeated Errors errors = 315977579;
321
322}
323
324//
325message Errors {
326  // [Output Only] The error type identifier for this error.
327  optional string code = 3059181;
328
329  // [Output Only] Indicates the field in the request that caused the error. This property is optional.
330  optional string location = 290430901;
331
332  // [Output Only] An optional, human-readable error message.
333  optional string message = 418054151;
334
335}
336
337// A request message for RegionOperations.Get. See the method description for details.
338message GetRegionOperationRequest {
339  // Name of the Operations resource to return.
340  string operation = 52090215 [
341    (google.api.field_behavior) = REQUIRED,
342    (google.cloud.operation_response_field) = "name"
343  ];
344
345  // Project ID for this request.
346  string project = 227560217 [(google.api.field_behavior) = REQUIRED];
347
348  // Name of the region for this request.
349  string region = 138946292 [(google.api.field_behavior) = REQUIRED];
350
351}
352
353// A request message for Addresses.Insert. See the method description for details.
354message InsertAddressRequest {
355  // The body resource for this request
356  Address address_resource = 483888121 [(google.api.field_behavior) = REQUIRED];
357
358  // Project ID for this request.
359  string project = 227560217 [
360    (google.api.field_behavior) = REQUIRED,
361    (google.cloud.operation_request_field) = "project"
362  ];
363
364  // Name of the region for this request.
365  string region = 138946292 [
366    (google.api.field_behavior) = REQUIRED,
367    (google.cloud.operation_request_field) = "region"
368  ];
369
370  // 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.
371  //
372  // 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.
373  //
374  // The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
375  optional string request_id = 37109963;
376
377}
378
379// A request message for Addresses.List. See the method description for details.
380message ListAddressesRequest {
381  // A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
382  //
383  // For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
384  //
385  // 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.
386  //
387  // 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).
388  optional string filter = 336120696;
389
390  // 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)
391  optional uint32 max_results = 54715419;
392
393  // Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
394  //
395  // 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.
396  //
397  // Currently, only sorting by name or creationTimestamp desc is supported.
398  string order_by = 160562920 [(google.api.field_behavior) = REQUIRED];
399
400  // Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
401  optional string page_token = 19994697;
402
403  // Project ID for this request.
404  string project = 227560217 [(google.api.field_behavior) = REQUIRED];
405
406  // Name of the region for this request.
407  string region = 138946292 [(google.api.field_behavior) = REQUIRED];
408
409}
410
411// Represents an Operation resource.
412//
413// Google Compute Engine has three Operation resources:
414//
415// * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
416//
417// You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
418//
419// Operations can be global, regional or zonal.
420// - For global operations, use the globalOperations resource.
421// - For regional operations, use the regionOperations resource.
422// - For zonal operations, use the zoneOperations resource.
423//
424// For more information, read  Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
425message Operation {
426  // [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
427  enum Status {
428    // A value indicating that the enum field is not set.
429    UNDEFINED_STATUS = 0;
430
431    DONE = 2104194;
432
433    PENDING = 35394935;
434
435    RUNNING = 121282975;
436
437  }
438
439  // [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
440  optional string client_operation_id = 297240295;
441
442  // [Deprecated] This field is deprecated.
443  optional string creation_timestamp = 30525366;
444
445  // [Output Only] A textual description of the operation, which is set when the operation is created.
446  optional string description = 422937596;
447
448  // [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
449  optional string end_time = 114938801;
450
451  // [Output Only] If errors are generated during processing of the operation, this field will be populated.
452  optional Error error = 96784904;
453
454  // [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
455  optional string http_error_message = 202521945 [(google.cloud.operation_field) = ERROR_MESSAGE];
456
457  // [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
458  optional int32 http_error_status_code = 312345196 [(google.cloud.operation_field) = ERROR_CODE];
459
460  // [Output Only] The unique identifier for the operation. This identifier is defined by the server.
461  optional uint64 id = 3355;
462
463  // [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
464  optional string insert_time = 433722515;
465
466  // [Output Only] Type of the resource. Always compute#operation for Operation resources.
467  optional string kind = 3292052;
468
469  // [Output Only] Name of the operation.
470  optional string name = 3373707 [(google.cloud.operation_field) = NAME];
471
472  // [Output Only] The type of operation, such as insert, update, or delete, and so on.
473  optional string operation_type = 177650450;
474
475  // [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
476  optional int32 progress = 72663597;
477
478  // [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
479  optional string region = 138946292;
480
481  // [Output Only] Server-defined URL for the resource.
482  optional string self_link = 456214797;
483
484  // [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
485  optional string start_time = 37467274;
486
487  // [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
488  optional Status status = 181260274 [(google.cloud.operation_field) = STATUS];
489
490  // [Output Only] An optional textual description of the current status of the operation.
491  optional string status_message = 297428154;
492
493  // [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
494  optional uint64 target_id = 258165385;
495
496  // [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
497  optional string target_link = 62671336;
498
499  // [Output Only] User who requested the operation, for example: [email protected].
500  optional string user = 3599307;
501
502  // [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
503  repeated Warnings warnings = 498091095;
504
505  // [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
506  optional string zone = 3744684;
507
508}
509
510// A request message for RegionOperations.Wait. See the method description for details.
511message WaitRegionOperationRequest {
512  // Name of the Operations resource to return.
513  string operation = 52090215 [(google.api.field_behavior) = REQUIRED];
514
515  // Project ID for this request.
516  string project = 227560217 [(google.api.field_behavior) = REQUIRED];
517
518  // Name of the region for this request.
519  string region = 138946292 [(google.api.field_behavior) = REQUIRED];
520
521}
522
523// [Output Only] Informational warning message.
524message Warning {
525  // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
526  enum Code {
527    // A value indicating that the enum field is not set.
528    UNDEFINED_CODE = 0;
529
530    CLEANUP_FAILED = 150308440;
531
532    DEPRECATED_RESOURCE_USED = 391835586;
533
534    DEPRECATED_TYPE_USED = 346526230;
535
536    DISK_SIZE_LARGER_THAN_IMAGE_SIZE = 369442967;
537
538    EXPERIMENTAL_TYPE_USED = 451954443;
539
540    EXTERNAL_API_WARNING = 175546307;
541
542    FIELD_VALUE_OVERRIDEN = 329669423;
543
544    INJECTED_KERNELS_DEPRECATED = 417377419;
545
546    MISSING_TYPE_DEPENDENCY = 344505463;
547
548    NEXT_HOP_ADDRESS_NOT_ASSIGNED = 324964999;
549
550    NEXT_HOP_CANNOT_IP_FORWARD = 383382887;
551
552    NEXT_HOP_INSTANCE_NOT_FOUND = 464250446;
553
554    NEXT_HOP_INSTANCE_NOT_ON_NETWORK = 243758146;
555
556    NEXT_HOP_NOT_RUNNING = 417081265;
557
558    NOT_CRITICAL_ERROR = 105763924;
559
560    NO_RESULTS_ON_PAGE = 30036744;
561
562    REQUIRED_TOS_AGREEMENT = 3745539;
563
564    RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING = 496728641;
565
566    RESOURCE_NOT_DELETED = 168598460;
567
568    SCHEMA_VALIDATION_IGNORED = 275245642;
569
570    SINGLE_INSTANCE_PROPERTY_TEMPLATE = 268305617;
571
572    UNDECLARED_PROPERTIES = 390513439;
573
574    UNREACHABLE = 13328052;
575
576  }
577
578  // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
579  // Check the Code enum for the list of possible values.
580  optional string code = 3059181;
581
582  // [Output Only] Metadata about this warning in key: value format. For example:
583  // "data": [ { "key": "scope", "value": "zones/us-east1-d" }
584  repeated Data data = 3076010;
585
586  // [Output Only] A human-readable description of the warning code.
587  optional string message = 418054151;
588
589}
590
591//
592message Warnings {
593  // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
594  enum Code {
595    // A value indicating that the enum field is not set.
596    UNDEFINED_CODE = 0;
597
598    CLEANUP_FAILED = 150308440;
599
600    DEPRECATED_RESOURCE_USED = 391835586;
601
602    DEPRECATED_TYPE_USED = 346526230;
603
604    DISK_SIZE_LARGER_THAN_IMAGE_SIZE = 369442967;
605
606    EXPERIMENTAL_TYPE_USED = 451954443;
607
608    EXTERNAL_API_WARNING = 175546307;
609
610    FIELD_VALUE_OVERRIDEN = 329669423;
611
612    INJECTED_KERNELS_DEPRECATED = 417377419;
613
614    MISSING_TYPE_DEPENDENCY = 344505463;
615
616    NEXT_HOP_ADDRESS_NOT_ASSIGNED = 324964999;
617
618    NEXT_HOP_CANNOT_IP_FORWARD = 383382887;
619
620    NEXT_HOP_INSTANCE_NOT_FOUND = 464250446;
621
622    NEXT_HOP_INSTANCE_NOT_ON_NETWORK = 243758146;
623
624    NEXT_HOP_NOT_RUNNING = 417081265;
625
626    NOT_CRITICAL_ERROR = 105763924;
627
628    NO_RESULTS_ON_PAGE = 30036744;
629
630    REQUIRED_TOS_AGREEMENT = 3745539;
631
632    RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING = 496728641;
633
634    RESOURCE_NOT_DELETED = 168598460;
635
636    SCHEMA_VALIDATION_IGNORED = 275245642;
637
638    SINGLE_INSTANCE_PROPERTY_TEMPLATE = 268305617;
639
640    UNDECLARED_PROPERTIES = 390513439;
641
642    UNREACHABLE = 13328052;
643
644  }
645
646  // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
647  // Check the Code enum for the list of possible values.
648  optional string code = 3059181;
649
650  // [Output Only] Metadata about this warning in key: value format. For example:
651  // "data": [ { "key": "scope", "value": "zones/us-east1-d" }
652  repeated Data data = 3076010;
653
654  // [Output Only] A human-readable description of the warning code.
655  optional string message = 418054151;
656
657}
658
659//
660// Services
661//
662// The Addresses API.
663service Addresses {
664  option (google.api.default_host) =
665    "compute.googleapis.com";
666
667  option (google.api.oauth_scopes) =
668    "https://www.googleapis.com/auth/compute,"
669    "https://www.googleapis.com/auth/cloud-platform";
670
671  // Retrieves an aggregated list of addresses.
672  rpc AggregatedList(AggregatedListAddressesRequest) returns (AddressAggregatedList) {
673    option (google.api.http) = {
674      get: "/compute/v1/projects/{project}/aggregated/addresses"
675    };
676    option (google.api.method_signature) = "project";
677  }
678
679  // Deletes the specified address resource.
680  rpc Delete(DeleteAddressRequest) returns (Operation) {
681    option (google.api.http) = {
682      delete: "/compute/v1/projects/{project}/regions/{region}/addresses/{address}"
683    };
684    option (google.api.method_signature) = "project,region,address";
685    option (google.cloud.operation_service) = "RegionOperations";
686  }
687
688  // Creates an address resource in the specified project by using the data included in the request.
689  rpc Insert(InsertAddressRequest) returns (Operation) {
690    option (google.api.http) = {
691      body: "address_resource"
692      post: "/compute/v1/projects/{project}/regions/{region}/addresses"
693    };
694    option (google.api.method_signature) = "project,region,address_resource";
695    option (google.cloud.operation_service) = "RegionOperations";
696  }
697
698  // Retrieves a list of addresses contained within the specified region.
699  rpc List(ListAddressesRequest) returns (AddressList) {
700    option (google.api.http) = {
701      get: "/compute/v1/projects/{project}/regions/{region}/addresses"
702    };
703    option (google.api.method_signature) = "project,region,order_by";
704  }
705
706}
707
708// The RegionOperations API.
709service RegionOperations {
710  option (google.api.default_host) =
711    "compute.googleapis.com";
712
713  option (google.api.oauth_scopes) =
714    "https://www.googleapis.com/auth/compute.readonly,"
715    "https://www.googleapis.com/auth/compute,"
716    "https://www.googleapis.com/auth/cloud-platform";
717
718  // Retrieves the specified region-specific Operations resource.
719  rpc Get(GetRegionOperationRequest) returns (Operation) {
720    option (google.api.http) = {
721      get: "/compute/v1/projects/{project}/regions/{region}/operations/{operation}"
722    };
723    option (google.api.method_signature) = "project,region,operation";
724    option (google.cloud.operation_polling_method) = true;
725  }
726
727  // 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.
728  //
729  // This method is called on a best-effort basis. Specifically:
730  // - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds.
731  // - 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`.
732  rpc Wait(WaitRegionOperationRequest) returns (Operation) {
733    option (google.api.http) = {
734      post: "/compute/v1/projects/projects/{project}/regions/{region}/operations/{operation}/wait"
735    };
736    option (google.api.method_signature) = "project,region,operation";
737  }
738
739}
740
741