From 82aeac104d70e6214cc7fdf9cffb003fcf335fae Mon Sep 17 00:00:00 2001 From: Victor Chudnovsky Date: Thu, 10 Oct 2024 16:34:53 -0700 Subject: [PATCH] feat: support Discovery "format" specifier for google.protobuf.{Value,ListValue,Struct} (#131) The converter will now recognize a `format` specifier in certain schemas. Specifically, the following combinations are now recognized and result in a protobuf field whose type is the specified `format`: | Discovery `"type"` | Discovery `"format"` | |--------------------|-----------------------------| | `object` | `google.protobuf.Struct` | | `any` | `google.protobuf.Value` | | `array` | `google.protobuf.ListValue` | Note that, as was the case previously, other schemas with `"type" = "any"` and any other `format`, including none, are not accepted unless they are in an `error.details` field. (Googlers, see also cl/683528084.) Incidentally, this PR also restores proto imports in the intended order, undoing the workaround in https://github.com/googleapis/disco-to-proto3-converter/pull/108 due to https://github.com/protobufjs/protobuf.js/issues/1954 now that the solution https://github.com/protobufjs/protobuf.js/pull/1960 is implemented. --- .../discotoproto3converter/disco/Schema.java | 7 +- .../proto3/DocumentToProtoConverter.java | 110 +- .../proto3/Message.java | 13 +- .../proto3/Proto3Writer.java | 15 +- .../proto3/ProtoFile.java | 9 + .../DiscoToProto3ConverterAppTest.java | 45 +- .../v1small/compute.any-format.proto.baseline | 838 ++++++++++++ .../v1small/compute.error-any.proto.baseline | 2 +- .../v1small/compute.v1small.any-format.json | 1191 +++++++++++++++++ 9 files changed, 2200 insertions(+), 30 deletions(-) create mode 100644 src/test/resources/google/cloud/compute/v1small/compute.any-format.proto.baseline create mode 100644 src/test/resources/google/cloud/compute/v1small/compute.v1small.any-format.json diff --git a/src/main/java/com/google/cloud/discotoproto3converter/disco/Schema.java b/src/main/java/com/google/cloud/discotoproto3converter/disco/Schema.java index 8b84afa..53ae274 100644 --- a/src/main/java/com/google/cloud/discotoproto3converter/disco/Schema.java +++ b/src/main/java/com/google/cloud/discotoproto3converter/disco/Schema.java @@ -262,7 +262,12 @@ public enum Format { UINT32("uint32"), UINT64("uint64"), FIXED32("fixed32"), - FIXED64("fixed64"); + FIXED64("fixed64"), + // standard protobuf types: + ANY("google.protobuf.Any"), + LISTVALUE("google.protobuf.ListValue"), + STRUCT("google.protobuf.Struct"), + VALUE("google.protobuf.Value"); private String text; diff --git a/src/main/java/com/google/cloud/discotoproto3converter/proto3/DocumentToProtoConverter.java b/src/main/java/com/google/cloud/discotoproto3converter/proto3/DocumentToProtoConverter.java index 6935744..7050a8c 100644 --- a/src/main/java/com/google/cloud/discotoproto3converter/proto3/DocumentToProtoConverter.java +++ b/src/main/java/com/google/cloud/discotoproto3converter/proto3/DocumentToProtoConverter.java @@ -20,6 +20,7 @@ import com.google.cloud.discotoproto3converter.disco.Method; import com.google.cloud.discotoproto3converter.disco.Name; import com.google.cloud.discotoproto3converter.disco.Schema; +import com.google.cloud.discotoproto3converter.disco.Schema.Format; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; @@ -46,6 +47,7 @@ public class DocumentToProtoConverter { private final String relativeLinkPrefix; private final boolean enumsAsStrings; private boolean schemaRead; + private boolean usesStructProto; // Set this to "true" to get some tracing output on stderr during development. Leave this as // "false" for production code. @@ -66,11 +68,14 @@ public DocumentToProtoConverter( this.relativeLinkPrefix = relativeLinkPrefix; this.protoFile.setMetadata(readDocumentMetadata(document, documentFileName)); this.enumsAsStrings = enumsAsStrings; + this.usesStructProto = false; + readSchema(document); readResources(document); cleanupEnumNamingConflicts(); this.protoFile.setHasLroDefinitions(applyLroConfiguration()); this.protoFile.setHasAnyFields(checkAnyFields()); + this.protoFile.setUsesStructProto(this.usesStructProto); convertEnumFieldsToStrings(); } @@ -91,7 +96,7 @@ private ProtoFileMetadata readDocumentMetadata(Document document, String documen private void readSchema(Document document) { for (Map.Entry entry : document.schemas().entrySet()) { - schemaToField(entry.getValue(), true, "*** readSchema\n"); + schemaToField(entry.getValue(), true, "readSchema()"); } for (Message message : protoFile.getMessages().values()) { resolveReferences(message); @@ -527,27 +532,55 @@ private Field schemaToField(Schema sch, boolean optional, String debugPreviousPa Message valueType = null; boolean repeated = false; Message keyType = null; - String debugCurrentPath = - debugPreviousPath + String.format("SCHEMA: %s\n%s\n----\n", name, description); + String debugCurrentPath = String.format("%s.%s", debugPreviousPath, name); if (trace) { - System.err.printf("*** schemaToField: \n%s", debugCurrentPath); + System.err.printf("*** schemaToField: %s\n", debugCurrentPath); } switch (sch.type()) { case ANY: - valueType = Message.PRIMITIVES.get("google.protobuf.Any"); + switch (sch.format()) { + case VALUE: + valueType = Message.PRIMITIVES.get("google.protobuf.Value"); + this.usesStructProto = true; + break; + case EMPTY: + // intentional fall-through + case ANY: + valueType = Message.PRIMITIVES.get("google.protobuf.Any"); + break; + default: + throw new IllegalStateException( + String.format( + "unexpected 'format' value ('%s') when processing ANY type in schema %s", + sch.format().toString(), debugCurrentPath)); + } break; case ARRAY: - repeated = true; + if (sch.format() == Format.LISTVALUE) { + valueType = Message.PRIMITIVES.get("google.protobuf.ListValue"); + this.usesStructProto = true; + // Since the `google.prootbuf.ListValue` whence this schema was generated is JSON-encoded + // as an array (see https://protobuf.dev/programming-guides/proto3/#json), the Discovery + // file describes the JSON array items. However, since we want to encode this schema back + // as an opaque `google.protobuf.ListValue` (which has the`repeated` semantics embedded + // internally), we should not make this field `repeated`. + } else { + repeated = true; + } break; case BOOLEAN: valueType = Message.PRIMITIVES.get("bool"); break; case EMPTY: + // This handles schemas with an "$ref" field valueType = new Message(sch.reference(), true, false, null); + break; case INTEGER: switch (sch.format()) { + case EMPTY: + // intentional fall-through: if there's no format, we default to `int32`. case INT32: valueType = Message.PRIMITIVES.get("int32"); break; @@ -566,24 +599,52 @@ private Field schemaToField(Schema sch, boolean optional, String debugPreviousPa case FIXED64: valueType = Message.PRIMITIVES.get("fixed64"); break; + default: + throw new IllegalStateException( + String.format( + "unexpected 'format' value ('%s') when processing INTEGER type in schema %s", + sch.format().toString(), debugCurrentPath)); } break; case NUMBER: switch (sch.format()) { + case EMPTY: + // intentional fall-through: if there's no format, we default to `float`. case FLOAT: valueType = Message.PRIMITIVES.get("float"); break; case DOUBLE: valueType = Message.PRIMITIVES.get("double"); break; + default: + throw new IllegalStateException( + String.format( + "unexpected 'format' value ('%s') when processing NUMBER type in schema %s", + sch.format().toString(), debugCurrentPath)); } break; case OBJECT: - if (sch.additionalProperties() != null) { - repeated = true; - keyType = Message.PRIMITIVES.get("string"); - } else { - valueType = new Message(getMessageName(sch), false, false, sanitizeDescr(description)); + switch (sch.format()) { + case STRUCT: + valueType = Message.PRIMITIVES.get("google.protobuf.Struct"); + this.usesStructProto = true; + // `additionalProperties' in the schema further specifies the JSON format, but + // "google.protobuf.Struct" is enough for specifying the proto message field type. + break; + case EMPTY: + if (sch.additionalProperties() != null) { + repeated = true; + keyType = Message.PRIMITIVES.get("string"); + } else { + valueType = + new Message(getMessageName(sch), false, false, sanitizeDescr(description)); + } + break; + default: + throw new IllegalStateException( + String.format( + "unexpected 'format' value ('%s') when processing OBJECT type in schema %s", + sch.format().toString(), debugCurrentPath)); } break; case STRING: @@ -602,9 +663,26 @@ private Field schemaToField(Schema sch, boolean optional, String debugPreviousPa case FIXED64: valueType = Message.PRIMITIVES.get("fixed64"); break; - default: + case FLOAT: + valueType = Message.PRIMITIVES.get("float"); + break; + case DOUBLE: + valueType = Message.PRIMITIVES.get("double"); + break; + case BYTE: + // intentional fall-through for backwards compatibility. Ideally, we'd make this refer + // to the protobuf primitive type `byte`. + // + // TODO: use `byte` for new messages. + case EMPTY: + // If there's no format, we default to `string`. valueType = Message.PRIMITIVES.get("string"); break; + default: + throw new IllegalStateException( + String.format( + "unexpected 'format' value ('%s') when processing STRING type in schema %s", + sch.format().toString(), debugCurrentPath)); } } break; @@ -613,7 +691,9 @@ private Field schemaToField(Schema sch, boolean optional, String debugPreviousPa if (repeated) { Field subField = schemaToField( - keyType == null ? sch.items() : sch.additionalProperties(), true, debugCurrentPath); + keyType == null ? sch.items() /* array */ : sch.additionalProperties() /* object */, + true, + debugCurrentPath); valueType = subField.getValueType(); } @@ -771,7 +851,7 @@ private void readResources(Document document) { for (Schema pathParam : method.pathParams().values()) { boolean required = methodSignatureParamNames.containsKey(pathParam.getIdentifier()); - Field pathField = schemaToField(pathParam, !required, "readResources(A):) "); + Field pathField = schemaToField(pathParam, !required, "readResources(A)"); if (required) { Option opt = createOption("google.api.field_behavior", ProtoOptionValues.REQUIRED); pathField.getOptions().add(opt); @@ -785,7 +865,7 @@ private void readResources(Document document) { for (Schema queryParam : method.queryParams().values()) { boolean required = methodSignatureParamNames.containsKey(queryParam.getIdentifier()); - Field queryField = schemaToField(queryParam, !required, "readResources(B): "); + Field queryField = schemaToField(queryParam, !required, "readResources(B)"); if (required) { Option opt = createOption("google.api.field_behavior", ProtoOptionValues.REQUIRED); queryField.getOptions().add(opt); diff --git a/src/main/java/com/google/cloud/discotoproto3converter/proto3/Message.java b/src/main/java/com/google/cloud/discotoproto3converter/proto3/Message.java index 7e0ae89..1f94fe6 100644 --- a/src/main/java/com/google/cloud/discotoproto3converter/proto3/Message.java +++ b/src/main/java/com/google/cloud/discotoproto3converter/proto3/Message.java @@ -38,12 +38,17 @@ public class Message extends ProtoElement { PRIMITIVES.put("double", new Message("double", false, false, null)); PRIMITIVES.put("", new Message("", false, true, null)); - // This isn't technically a primitive, but it is a fundamental well-known-type with no a priori - // structure. + // These aren't technically primitives, but they are opaque types we treat as such, essentially. // - // TODO: If we start accepting additional well-known types, create a specific data structure for - // those rather than overloading "PRIMITIVES". + // TODO: Consider renaming this field more accurately, or creating a parallel field for these + // types. PRIMITIVES.put("google.protobuf.Any", new Message("google.protobuf.Any", false, false, null)); + PRIMITIVES.put( + "google.protobuf.Value", new Message("google.protobuf.Value", false, false, null)); + PRIMITIVES.put( + "google.protobuf.ListValue", new Message("google.protobuf.ListValue", false, false, null)); + PRIMITIVES.put( + "google.protobuf.Struct", new Message("google.protobuf.Struct", false, false, null)); } private final SortedSet fields = new TreeSet<>(); diff --git a/src/main/java/com/google/cloud/discotoproto3converter/proto3/Proto3Writer.java b/src/main/java/com/google/cloud/discotoproto3converter/proto3/Proto3Writer.java index aa77c9b..871c32e 100644 --- a/src/main/java/com/google/cloud/discotoproto3converter/proto3/Proto3Writer.java +++ b/src/main/java/com/google/cloud/discotoproto3converter/proto3/Proto3Writer.java @@ -45,13 +45,6 @@ public void writeToFile(PrintWriter writer, ProtoFile protoFile, boolean outputC writer.println("package " + metadata.getProtoPkg() + ";\n"); - // TODO: Place this import in the right alphabetical order. We are placing it here for now to - // work around an apparent bug in protobuf.js, where having this particular import be the last - // one makes the file not actually be imported. - if (protoFile.HasAnyFields()) { - writer.println("import \"google/protobuf/any.proto\";"); - } - writer.println("import \"google/api/annotations.proto\";"); writer.println("import \"google/api/client.proto\";"); writer.println("import \"google/api/field_behavior.proto\";"); @@ -60,6 +53,14 @@ public void writeToFile(PrintWriter writer, ProtoFile protoFile, boolean outputC if (protoFile.isHasLroDefinitions()) { writer.println("import \"google/cloud/extended_operations.proto\";"); } + + if (protoFile.HasAnyFields()) { + writer.println("import \"google/protobuf/any.proto\";"); + } + if (protoFile.UsesStructProto()) { + writer.println("import \"google/protobuf/struct.proto\";"); + } + writer.println(); // File Options diff --git a/src/main/java/com/google/cloud/discotoproto3converter/proto3/ProtoFile.java b/src/main/java/com/google/cloud/discotoproto3converter/proto3/ProtoFile.java index f601da7..92bbd14 100644 --- a/src/main/java/com/google/cloud/discotoproto3converter/proto3/ProtoFile.java +++ b/src/main/java/com/google/cloud/discotoproto3converter/proto3/ProtoFile.java @@ -24,6 +24,7 @@ public class ProtoFile { private final Map services = new TreeMap<>(); private boolean hasLroDefinitions; private boolean hasAnyFields; + private boolean usesStructProto; public ProtoFileMetadata getMetadata() { return metadata; @@ -56,4 +57,12 @@ public boolean HasAnyFields() { public void setHasAnyFields(boolean hasAnyFields) { this.hasAnyFields = hasAnyFields; } + + public boolean UsesStructProto() { + return usesStructProto; + } + + public void setUsesStructProto(boolean usesStructProto) { + this.usesStructProto = usesStructProto; + } } diff --git a/src/test/java/com/google/cloud/discotoproto3converter/DiscoToProto3ConverterAppTest.java b/src/test/java/com/google/cloud/discotoproto3converter/DiscoToProto3ConverterAppTest.java index 1c39fbf..41bd309 100644 --- a/src/test/java/com/google/cloud/discotoproto3converter/DiscoToProto3ConverterAppTest.java +++ b/src/test/java/com/google/cloud/discotoproto3converter/DiscoToProto3ConverterAppTest.java @@ -93,7 +93,7 @@ public void convertVersioned() throws IOException { "src", "test", "resources", prefix.toString(), "compute-versioned.proto.baseline"); String baselineBody = readFile(baselineFilePath); System.out.printf( - "*** @Test:convertVersioned():\n*** Discovery path: %s\n*** Generated file: %s\n*** Baseline file: %s\n", + "*** @Test:convertVersioned():\n Discovery path: %s\n Generated file: %s\n Baseline file: %s\n", discoveryDocPath.toAbsolutePath(), generatedFilePath.toAbsolutePath(), baselineFilePath.toAbsolutePath()); @@ -203,7 +203,7 @@ public void convertVersionedTwoServices() throws IOException { "compute-versioned-two-services.proto.baseline"); String baselineBody = readFile(baselineFilePath); System.out.printf( - "*** @Test:convertVersionedTwoServices():\n*** Discovery path: %s\n*** Generated file: %s\n*** Baseline file: %s\n", + "*** @Test:convertVersionedTwoServices():\n Discovery path: %s\n Generated file: %s\n Baseline file: %s\n", discoveryDocPath.toAbsolutePath(), generatedFilePath.toAbsolutePath(), baselineFilePath.toAbsolutePath()); @@ -392,6 +392,13 @@ public void convertAnyFieldInError() throws IOException { Paths.get( "src", "test", "resources", prefix.toString(), "compute.error-any.proto.baseline"); String baselineBody = readFile(baselineFilePath); + + System.out.printf( + "*** @Test:convertAnyFieldInError():\n Discovery path: %s\n Generated file: %s\n Baseline file: %s\n", + discoveryDocPath.toAbsolutePath(), + generatedFilePath.toAbsolutePath(), + baselineFilePath.toAbsolutePath()); + assertEquals(baselineBody, actualBody); } @@ -523,6 +530,40 @@ public void convertWithMerge() throws IOException { assertEquals(baselineBody, actualBody); } + @Test + public void convertAnyFieldWithFormat() throws IOException { + DiscoToProto3ConverterApp app = new DiscoToProto3ConverterApp(); + Path prefix = Paths.get("google", "cloud", "compute", "v1small"); + Path discoveryDocPath = + Paths.get("src", "test", "resources", prefix.toString(), "compute.v1small.any-format.json"); + Path generatedFilePath = + Paths.get(outputDir.toString(), prefix.toString(), "compute.any-format.proto"); + + app.convert( + discoveryDocPath.toString(), + null, + generatedFilePath.toString(), + "", + "", + "https://cloud.google.com", + "true", + "true"); + + String actualBody = readFile(generatedFilePath); + Path baselineFilePath = + Paths.get( + "src", "test", "resources", prefix.toString(), "compute.any-format.proto.baseline"); + String baselineBody = readFile(baselineFilePath); + + System.out.printf( + "*** @Test:convertAnyFieldWithFormat():\n Discovery path: %s\n Generated file: %s\n Baseline file: %s\n", + discoveryDocPath.toAbsolutePath(), + generatedFilePath.toAbsolutePath(), + baselineFilePath.toAbsolutePath()); + + assertEquals(baselineBody, actualBody); + } + private static String readFile(Path path) throws IOException { return new String(Files.readAllBytes(path), StandardCharsets.UTF_8); } diff --git a/src/test/resources/google/cloud/compute/v1small/compute.any-format.proto.baseline b/src/test/resources/google/cloud/compute/v1small/compute.any-format.proto.baseline new file mode 100644 index 0000000..db7495a --- /dev/null +++ b/src/test/resources/google/cloud/compute/v1small/compute.any-format.proto.baseline @@ -0,0 +1,838 @@ +// Copyright 2024 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 +// +// http://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 disco-to-proto3-converter. DO NOT EDIT! +// Source Discovery file: compute.v1small.any-format.json +// Source file revision: 20240730 +// API name: compute +// API version: v1small + +syntax = "proto3"; + +package google.cloud.compute.v1small; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/extended_operations.proto"; +import "google/protobuf/any.proto"; +import "google/protobuf/struct.proto"; + +// +// File Options +// +option csharp_namespace = "Google.Cloud.Compute.V1Small"; +option go_package = "cloud.google.com/go/compute/apiv1small/computepb;computepb"; +option java_multiple_files = true; +option java_package = "com.google.cloud.compute.v1small"; +option php_namespace = "Google\\Cloud\\Compute\\V1small"; +option ruby_package = "Google::Cloud::Compute::V1small"; + +// +// Messages +// +// Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier. +// +// Use global internal addresses for reserved peering network range. +// +// Use regional external addresses for the following resources: +// +// - 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) +// +// Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes: +// +// - 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 +// +// For more information, read reserved IP address. +// +// (== resource_for v1small.addresses ==) (== resource_for v1small.globalAddresses ==) +message Address { + // The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. + enum AddressType { + // A value indicating that the enum field is not set. + UNDEFINED_ADDRESS_TYPE = 0; + + EXTERNAL = 35607499; + + INTERNAL = 279295677; + + UNSPECIFIED_TYPE = 53933922; + + } + + // IP Protocol. + enum IPProtocolEnum { + // A value indicating that the enum field is not set. + UNDEFINED_I_P_PROTOCOL_ENUM = 0; + + AH = 2087; + + ESP = 68962; + + ICMP = 2241597; + + SCTP = 2539724; + + TCP = 82881; + + UDP = 83873; + + } + + // 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. + enum IpVersion { + // A value indicating that the enum field is not set. + UNDEFINED_IP_VERSION = 0; + + IPV4 = 2254341; + + IPV6 = 2254343; + + UNSPECIFIED_VERSION = 21850000; + + } + + // 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. + // + // If this field is not specified, it is assumed to be PREMIUM. + enum NetworkTier { + // A value indicating that the enum field is not set. + UNDEFINED_NETWORK_TIER = 0; + + PREMIUM = 399530551; + + STANDARD = 484642493; + + } + + // The purpose of this resource, which can be one of the following values: + // - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. + // - `DNS_RESOLVER` for a DNS resolver address in a subnetwork + // - `VPC_PEERING` for addresses that are reserved for VPC peer networks. + // - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. + enum Purpose { + // A value indicating that the enum field is not set. + UNDEFINED_PURPOSE = 0; + + DNS_RESOLVER = 476114556; + + GCE_ENDPOINT = 230515243; + + NAT_AUTO = 163666477; + + VPC_PEERING = 400800170; + + } + + // [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. + enum Status { + // A value indicating that the enum field is not set. + UNDEFINED_STATUS = 0; + + IN_USE = 17393485; + + RESERVED = 432241448; + + RESERVING = 514587225; + + } + + // IP Protocol. + // Check the IPProtocolEnum enum for the list of possible values. + optional string I_p_protocol = 488094525; + + // The static IP address represented by this resource. + optional string address = 462920692; + + // The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. + // Check the AddressType enum for the list of possible values. + optional string address_type = 264307877; + + // [Output Only] Creation timestamp in RFC3339 text format. + optional string creation_timestamp = 30525366; + + // An optional description of this resource. Provide this field when you create the resource. + optional string description = 422937596; + + // [Output Only] The unique identifier for the resource. This identifier is defined by the server. + optional uint64 id = 3355; + + // 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. + // Check the IpVersion enum for the list of possible values. + optional string ip_version = 294959552; + + // [Output Only] Type of the resource. Always compute#address for addresses. + optional string kind = 3292052; + + // This is a field to test that we can create google.protobuf.ListValue. + optional google.protobuf.ListValue metadata_list_value = 468946336; + + // This is a field to test that we can create a map whose values are google.protobuf.ListValue. + map metadata_map_list_value = 117212259; + + // This is a field to test that we can create google.protobuf.Struct. + optional google.protobuf.Struct metadata_struct = 224324325; + + // This is a field to test that we can create google.protobuf.Value. + optional google.protobuf.Value metadata_value = 217256033; + + // 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. + optional string name = 3373707; + + // 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. + optional string network = 232872494; + + // 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. + // + // If this field is not specified, it is assumed to be PREMIUM. + // Check the NetworkTier enum for the list of possible values. + optional string network_tier = 517397843; + + // The prefix length if the resource reprensents an IP range. + optional int32 prefix_length = 453565747; + + // The purpose of this resource, which can be one of the following values: + // - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. + // - `DNS_RESOLVER` for a DNS resolver address in a subnetwork + // - `VPC_PEERING` for addresses that are reserved for VPC peer networks. + // - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. + // Check the Purpose enum for the list of possible values. + optional string purpose = 316407070; + + // [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. + optional string region = 138946292; + + // [Output Only] Server-defined URL for the resource. + optional string self_link = 456214797; + + // [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. + // Check the Status enum for the list of possible values. + optional string status = 181260274; + + // 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. + optional string subnetwork = 307827694; + + // [Output Only] The URLs of the resources that are using this address. + repeated string users = 111578632; + +} + +// +message AddressAggregatedList { + // [Output Only] Unique identifier for the resource; defined by the server. + optional string id = 3355; + + // A list of AddressesScopedList resources. + map items = 100526016; + + // [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. + optional string kind = 3292052; + + // [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. + optional string next_page_token = 79797525; + + // [Output Only] Server-defined URL for this resource. + optional string self_link = 456214797; + + // [Output Only] Informational warning message. + optional Warning warning = 50704284; + +} + +// Contains a list of addresses. +message AddressList { + // [Output Only] Unique identifier for the resource; defined by the server. + optional string id = 3355; + + // A list of Address resources. + repeated Address items = 100526016; + + // [Output Only] Type of resource. Always compute#addressList for lists of addresses. + optional string kind = 3292052; + + // [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. + optional string next_page_token = 79797525; + + // [Output Only] Server-defined URL for this resource. + optional string self_link = 456214797; + + // [Output Only] Informational warning message. + optional Warning warning = 50704284; + +} + +// +message AddressesScopedList { + // [Output Only] A list of addresses contained in this scope. + repeated Address addresses = 337673122; + + // [Output Only] Informational warning which replaces the list of addresses when the list is empty. + optional Warning warning = 50704284; + +} + +// A request message for Addresses.AggregatedList. See the method description for details. +message AggregatedListAddressesRequest { + // 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 `<`. + // + // For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. + // + // 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) ``` + optional string filter = 336120696; + + // 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 = 391327988; + + // 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 = 54715419; + + // 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 = 160562920; + + // 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 = 19994697; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + +} + +// +message Data { + // [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). + optional string key = 106079; + + // [Output Only] A warning data value corresponding to the key. + optional string value = 111972721; + +} + +// A request message for Addresses.Delete. See the method description for details. +message DeleteAddressRequest { + // Name of the address resource to delete. + string address = 462920692 [(google.api.field_behavior) = REQUIRED]; + + // Project ID for this request. + string project = 227560217 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "project" + ]; + + // Name of the region for this request. + string region = 138946292 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "region" + ]; + + // 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 = 37109963; + +} + +// [Output Only] If errors are generated during processing of the operation, this field will be populated. +message Error { + // [Output Only] The array of errors encountered while processing this operation. + repeated Errors errors = 315977579; + +} + +// +message Errors { + // [Output Only] The error type identifier for this error. + optional string code = 3059181; + + // [Output Only] Indicates the field in the request that caused the error. This property is optional. + optional string location = 290430901; + + // [Output Only] An optional, human-readable error message. + optional string message = 418054151; + +} + +// A request message for RegionOperations.Get. See the method description for details. +message GetRegionOperationRequest { + // Name of the Operations resource to return. + string operation = 52090215 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_response_field) = "name" + ]; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Name of the region for this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + +} + +// A request message for Addresses.Insert. See the method description for details. +message InsertAddressRequest { + // The body resource for this request + Address address_resource = 483888121 [(google.api.field_behavior) = REQUIRED]; + + // Project ID for this request. + string project = 227560217 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "project" + ]; + + // Name of the region for this request. + string region = 138946292 [ + (google.api.field_behavior) = REQUIRED, + (google.cloud.operation_request_field) = "region" + ]; + + // 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 = 37109963; + +} + +// A request message for Addresses.List. See the method description for details. +message ListAddressesRequest { + // 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 <. + // + // For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. + // + // 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). + optional string filter = 336120696; + + // 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 = 54715419; + + // 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. + string order_by = 160562920 [(google.api.field_behavior) = REQUIRED]; + + // 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 = 19994697; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Name of the region for this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + +} + +// Represents an Operation resource. +// +// Google Compute Engine has three Operation resources: +// +// * [Global](https://cloud.google.com/compute/docs/reference/rest/v1small/globalOperations) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1small/regionOperations) * [Zonal](https://cloud.google.com/compute/docs/reference/rest/v1small/zoneOperations) +// +// You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. +// +// Operations can be global, regional or zonal. +// - For global operations, use the globalOperations resource. +// - For regional operations, use the regionOperations resource. +// - For zonal operations, use the zoneOperations resource. +// +// For more information, read Global, Regional, and Zonal Resources. (== resource_for v1small.globalOperations ==) (== resource_for v1small.regionOperations ==) (== resource_for v1small.zoneOperations ==) +message Operation { + // [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + enum Status { + // A value indicating that the enum field is not set. + UNDEFINED_STATUS = 0; + + DONE = 2104194; + + PENDING = 35394935; + + RUNNING = 121282975; + + } + + // [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. + optional string client_operation_id = 297240295; + + // [Deprecated] This field is deprecated. + optional string creation_timestamp = 30525366; + + // [Output Only] A textual description of the operation, which is set when the operation is created. + optional string description = 422937596; + + // [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + optional string end_time = 114938801; + + // [Output Only] If errors are generated during processing of the operation, this field will be populated. + optional Error error = 96784904; + + // [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. + optional string http_error_message = 202521945 [(google.cloud.operation_field) = ERROR_MESSAGE]; + + // [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. + optional int32 http_error_status_code = 312345196 [(google.cloud.operation_field) = ERROR_CODE]; + + // [Output Only] The unique identifier for the operation. This identifier is defined by the server. + optional uint64 id = 3355; + + // [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + optional string insert_time = 433722515; + + // [Output Only] Type of the resource. Always compute#operation for Operation resources. + optional string kind = 3292052; + + // [Output Only] Name of the operation. + optional string name = 3373707 [(google.cloud.operation_field) = NAME]; + + // [Output Only] The type of operation, such as insert, update, or delete, and so on. + optional string operation_type = 177650450; + + // [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. + optional int32 progress = 72663597; + + // [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. + optional string region = 138946292; + + // [Output Only] Server-defined URL for the resource. + optional string self_link = 456214797; + + // [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. + optional SetCommonInstanceMetadataOperationMetadata set_common_instance_metadata_operation_metadata = 490378980; + + // [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + optional string start_time = 37467274; + + // [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + optional Status status = 181260274 [(google.cloud.operation_field) = STATUS]; + + // [Output Only] An optional textual description of the current status of the operation. + optional string status_message = 297428154; + + // [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + optional uint64 target_id = 258165385; + + // [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. + optional string target_link = 62671336; + + // [Output Only] User who requested the operation, for example: user@example.com. + optional string user = 3599307; + + // [Output Only] If warning messages are generated during processing of the operation, this field will be populated. + repeated Warnings warnings = 498091095; + + // [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. + optional string zone = 3744684; + +} + +// +message SetCommonInstanceMetadataOperationMetadata { + // [Output Only] The client operation id. + optional string client_operation_id = 297240295; + + // [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a + map per_location_operations = 408987796; + +} + +// +message SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo { + // [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + enum State { + // A value indicating that the enum field is not set. + UNDEFINED_STATE = 0; + + // Operation not tracked in this location e.g. zone is marked as DOWN. + ABANDONED = 81797556; + + // Operation has completed successfully. + DONE = 2104194; + + // Operation is in an error state. + FAILED = 455706685; + + // Operation is confirmed to be in the location. + PROPAGATED = 507550299; + + // Operation is not yet confirmed to have been created in the location. + PROPAGATING = 164807046; + + UNSPECIFIED = 526786327; + + } + + // [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated. + optional Status error = 96784904; + + // [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + // Check the State enum for the list of possible values. + optional string state = 109757585; + +} + +// The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). +message Status { + // The status code, which should be an enum value of google.rpc.Code. + optional int32 code = 3059181; + + // A different representation of google.protobuf.Any. + repeated google.protobuf.Any details = 483979842; + + // A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + optional string message = 418054151; + +} + +// A request message for RegionOperations.Wait. See the method description for details. +message WaitRegionOperationRequest { + // Name of the Operations resource to return. + string operation = 52090215 [(google.api.field_behavior) = REQUIRED]; + + // Project ID for this request. + string project = 227560217 [(google.api.field_behavior) = REQUIRED]; + + // Name of the region for this request. + string region = 138946292 [(google.api.field_behavior) = REQUIRED]; + +} + +// [Output Only] Informational warning message. +message Warning { + // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + enum Code { + // A value indicating that the enum field is not set. + UNDEFINED_CODE = 0; + + CLEANUP_FAILED = 150308440; + + DEPRECATED_RESOURCE_USED = 391835586; + + DEPRECATED_TYPE_USED = 346526230; + + DISK_SIZE_LARGER_THAN_IMAGE_SIZE = 369442967; + + EXPERIMENTAL_TYPE_USED = 451954443; + + EXTERNAL_API_WARNING = 175546307; + + FIELD_VALUE_OVERRIDEN = 329669423; + + INJECTED_KERNELS_DEPRECATED = 417377419; + + MISSING_TYPE_DEPENDENCY = 344505463; + + NEXT_HOP_ADDRESS_NOT_ASSIGNED = 324964999; + + NEXT_HOP_CANNOT_IP_FORWARD = 383382887; + + NEXT_HOP_INSTANCE_NOT_FOUND = 464250446; + + NEXT_HOP_INSTANCE_NOT_ON_NETWORK = 243758146; + + NEXT_HOP_NOT_RUNNING = 417081265; + + NOT_CRITICAL_ERROR = 105763924; + + NO_RESULTS_ON_PAGE = 30036744; + + REQUIRED_TOS_AGREEMENT = 3745539; + + RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING = 496728641; + + RESOURCE_NOT_DELETED = 168598460; + + SCHEMA_VALIDATION_IGNORED = 275245642; + + SINGLE_INSTANCE_PROPERTY_TEMPLATE = 268305617; + + UNDECLARED_PROPERTIES = 390513439; + + UNREACHABLE = 13328052; + + } + + // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + // Check the Code enum for the list of possible values. + optional string code = 3059181; + + // [Output Only] Metadata about this warning in key: value format. For example: + // "data": [ { "key": "scope", "value": "zones/us-east1-d" } + repeated Data data = 3076010; + + // [Output Only] A human-readable description of the warning code. + optional string message = 418054151; + +} + +// +message Warnings { + // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + enum Code { + // A value indicating that the enum field is not set. + UNDEFINED_CODE = 0; + + CLEANUP_FAILED = 150308440; + + DEPRECATED_RESOURCE_USED = 391835586; + + DEPRECATED_TYPE_USED = 346526230; + + DISK_SIZE_LARGER_THAN_IMAGE_SIZE = 369442967; + + EXPERIMENTAL_TYPE_USED = 451954443; + + EXTERNAL_API_WARNING = 175546307; + + FIELD_VALUE_OVERRIDEN = 329669423; + + INJECTED_KERNELS_DEPRECATED = 417377419; + + MISSING_TYPE_DEPENDENCY = 344505463; + + NEXT_HOP_ADDRESS_NOT_ASSIGNED = 324964999; + + NEXT_HOP_CANNOT_IP_FORWARD = 383382887; + + NEXT_HOP_INSTANCE_NOT_FOUND = 464250446; + + NEXT_HOP_INSTANCE_NOT_ON_NETWORK = 243758146; + + NEXT_HOP_NOT_RUNNING = 417081265; + + NOT_CRITICAL_ERROR = 105763924; + + NO_RESULTS_ON_PAGE = 30036744; + + REQUIRED_TOS_AGREEMENT = 3745539; + + RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING = 496728641; + + RESOURCE_NOT_DELETED = 168598460; + + SCHEMA_VALIDATION_IGNORED = 275245642; + + SINGLE_INSTANCE_PROPERTY_TEMPLATE = 268305617; + + UNDECLARED_PROPERTIES = 390513439; + + UNREACHABLE = 13328052; + + } + + // [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + // Check the Code enum for the list of possible values. + optional string code = 3059181; + + // [Output Only] Metadata about this warning in key: value format. For example: + // "data": [ { "key": "scope", "value": "zones/us-east1-d" } + repeated Data data = 3076010; + + // [Output Only] A human-readable description of the warning code. + optional string message = 418054151; + +} + +// +// Services +// +// The Addresses API. +service Addresses { + option (google.api.default_host) = + "compute.googleapis.com"; + + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/compute," + "https://www.googleapis.com/auth/cloud-platform"; + + // Retrieves an aggregated list of addresses. + rpc AggregatedList(AggregatedListAddressesRequest) returns (AddressAggregatedList) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/aggregated/addresses" + }; + option (google.api.method_signature) = "project"; + } + + // Deletes the specified address resource. + rpc Delete(DeleteAddressRequest) returns (Operation) { + option (google.api.http) = { + delete: "/compute/v1/projects/{project}/regions/{region}/addresses/{address}" + }; + option (google.api.method_signature) = "project,region,address"; + option (google.cloud.operation_service) = "RegionOperations"; + } + + // Creates an address resource in the specified project by using the data included in the request. + rpc Insert(InsertAddressRequest) returns (Operation) { + option (google.api.http) = { + body: "address_resource" + post: "/compute/v1/projects/{project}/regions/{region}/addresses" + }; + option (google.api.method_signature) = "project,region,address_resource"; + option (google.cloud.operation_service) = "RegionOperations"; + } + + // Retrieves a list of addresses contained within the specified region. + rpc List(ListAddressesRequest) returns (AddressList) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/regions/{region}/addresses" + }; + option (google.api.method_signature) = "project,region,order_by"; + } + +} + +// The RegionOperations API. +service RegionOperations { + option (google.api.default_host) = + "compute.googleapis.com"; + + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/compute.readonly," + "https://www.googleapis.com/auth/compute," + "https://www.googleapis.com/auth/cloud-platform"; + + // Retrieves the specified region-specific Operations resource. + rpc Get(GetRegionOperationRequest) returns (Operation) { + option (google.api.http) = { + get: "/compute/v1/projects/{project}/regions/{region}/operations/{operation}" + }; + option (google.api.method_signature) = "project,region,operation"; + option (google.cloud.operation_polling_method) = true; + } + + // 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`. + rpc Wait(WaitRegionOperationRequest) returns (Operation) { + option (google.api.http) = { + post: "/compute/v1/projects/projects/{project}/regions/{region}/operations/{operation}/wait" + }; + option (google.api.method_signature) = "project,region,operation"; + } + +} + diff --git a/src/test/resources/google/cloud/compute/v1small/compute.error-any.proto.baseline b/src/test/resources/google/cloud/compute/v1small/compute.error-any.proto.baseline index ac2495a..1c12c73 100644 --- a/src/test/resources/google/cloud/compute/v1small/compute.error-any.proto.baseline +++ b/src/test/resources/google/cloud/compute/v1small/compute.error-any.proto.baseline @@ -22,12 +22,12 @@ syntax = "proto3"; package google.cloud.compute.v1small; -import "google/protobuf/any.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/cloud/extended_operations.proto"; +import "google/protobuf/any.proto"; // // File Options diff --git a/src/test/resources/google/cloud/compute/v1small/compute.v1small.any-format.json b/src/test/resources/google/cloud/compute/v1small/compute.v1small.any-format.json new file mode 100644 index 0000000..2af77f5 --- /dev/null +++ b/src/test/resources/google/cloud/compute/v1small/compute.v1small.any-format.json @@ -0,0 +1,1191 @@ +{ + "kind": "discovery#restDescription", + "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/FxLyjO3NNw-MCcpaZiOfen7ZKXY\"", + "discoveryVersion": "v1", + "id": "compute:v1", + "name": "compute", + "version": "v1small", + "revision": "20240730", + "title": "Compute Engine API", + "description": "Creates and runs virtual machines on Google Cloud Platform.", + "ownerDomain": "google.com", + "ownerName": "Google", + "icons": { + "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", + "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" + }, + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", + "protocol": "rest", + "baseUrl": "https://compute.googleapis.com/compute/v1/projects/", + "basePath": "/compute/v1/projects/", + "rootUrl": "https://compute.googleapis.com/", + "servicePath": "compute/v1/projects/", + "batchPath": "batch/compute/v1", + "parameters": { + "alt": { + "type": "string", + "description": "Data format for the response.", + "default": "json", + "enum": [ + "json" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json" + ], + "location": "query" + }, + "fields": { + "type": "string", + "description": "Selector specifying which fields to include in a partial response.", + "location": "query" + }, + "key": { + "type": "string", + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query" + }, + "oauth_token": { + "type": "string", + "description": "OAuth 2.0 token for the current user.", + "location": "query" + }, + "prettyPrint": { + "type": "boolean", + "description": "Returns response with indentations and line breaks.", + "default": "true", + "location": "query" + }, + "quotaUser": { + "type": "string", + "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "location": "query" + }, + "userIp": { + "type": "string", + "description": "Deprecated. Please use quotaUser instead.", + "location": "query" + } + }, + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/compute": { + "description": "View and manage your Google Compute Engine resources" + }, + "https://www.googleapis.com/auth/compute.readonly": { + "description": "View your Google Compute Engine resources" + }, + "https://www.googleapis.com/auth/devstorage.full_control": { + "description": "Manage your data and permissions in Google Cloud Storage" + }, + "https://www.googleapis.com/auth/devstorage.read_only": { + "description": "View your data in Google Cloud Storage" + }, + "https://www.googleapis.com/auth/devstorage.read_write": { + "description": "Manage your data in Google Cloud Storage" + } + } + } + }, + "schemas": { + "Operation": { + "id": "Operation", + "type": "object", + "description": "Represents an Operation resource.\n\nGoogle Compute Engine has three Operation resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)\n\nYou can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.\n\nOperations can be global, regional or zonal. \n- For global operations, use the globalOperations resource. \n- For regional operations, use the regionOperations resource. \n- For zonal operations, use the zoneOperations resource. \n\nFor more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)", + "properties": { + "clientOperationId": { + "type": "string", + "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise." + }, + "creationTimestamp": { + "type": "string", + "description": "[Deprecated] This field is deprecated." + }, + "description": { + "type": "string", + "description": "[Output Only] A textual description of the operation, which is set when the operation is created." + }, + "endTime": { + "type": "string", + "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format." + }, + "error": { + "type": "object", + "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.", + "properties": { + "errors": { + "type": "array", + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "[Output Only] The error type identifier for this error." + }, + "location": { + "type": "string", + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional." + }, + "message": { + "type": "string", + "description": "[Output Only] An optional, human-readable error message." + } + } + } + } + } + }, + "httpErrorMessage": { + "type": "string", + "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND." + }, + "httpErrorStatusCode": { + "type": "integer", + "description": "[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.", + "format": "int32" + }, + "id": { + "type": "string", + "description": "[Output Only] The unique identifier for the operation. This identifier is defined by the server.", + "format": "uint64" + }, + "insertTime": { + "type": "string", + "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format." + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.", + "default": "compute#operation" + }, + "name": { + "type": "string", + "description": "[Output Only] Name of the operation." + }, + "operationType": { + "type": "string", + "description": "[Output Only] The type of operation, such as insert, update, or delete, and so on." + }, + "progress": { + "type": "integer", + "description": "[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.", + "format": "int32" + }, + "region": { + "type": "string", + "description": "[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + }, + "startTime": { + "type": "string", + "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format." + }, + "status": { + "type": "string", + "description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.", + "enum": [ + "DONE", + "PENDING", + "RUNNING" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "statusMessage": { + "type": "string", + "description": "[Output Only] An optional textual description of the current status of the operation." + }, + "targetId": { + "type": "string", + "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.", + "format": "uint64" + }, + "targetLink": { + "type": "string", + "description": "[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." + }, + "user": { + "type": "string", + "description": "[Output Only] User who requested the operation, for example: user@example.com." + }, + "warnings": { + "type": "array", + "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "data": { + "type": "array", + "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "[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)." + }, + "value": { + "type": "string", + "description": "[Output Only] A warning data value corresponding to the key." + } + } + } + }, + "message": { + "type": "string", + "description": "[Output Only] A human-readable description of the warning code." + } + } + } + }, + "zone": { + "type": "string", + "description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations." + }, + "setCommonInstanceMetadataOperationMetadata": { + "description": "[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.", + "$ref": "SetCommonInstanceMetadataOperationMetadata" + } + } + }, + "SetCommonInstanceMetadataOperationMetadata": { + "id": "SetCommonInstanceMetadataOperationMetadata", + "type": "object", + "properties": { + "clientOperationId": { + "description": "[Output Only] The client operation id.", + "type": "string" + }, + "perLocationOperations": { + "description": "[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a", + "type": "object", + "additionalProperties": { + "$ref": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo" + } + } + } + }, + "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo": { + "id": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo", + "type": "object", + "properties": { + "state": { + "description": "[Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.", + "type": "string", + "enumDescriptions": [ + "Operation not tracked in this location e.g. zone is marked as DOWN.", + "Operation has completed successfully.", + "Operation is in an error state.", + "Operation is confirmed to be in the location.", + "Operation is not yet confirmed to have been created in the location.", + "" + ], + "enum": [ + "ABANDONED", + "DONE", + "FAILED", + "PROPAGATED", + "PROPAGATING", + "UNSPECIFIED" + ] + }, + "error": { + "description": "[Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.", + "$ref": "Status" + } + } + }, + "Status": { + "id": "Status", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "type": "object", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "type": "integer", + "format": "int32" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + }, + "details": { + "description": "A different representation of google.protobuf.Any.", + "type": "array", + "items": { + "type": "any", + "format": "google.protobuf.Any", + "description": "Properties of the object. Contains field @type with type URL." + } + } + } + }, + "Address": { + "id": "Address", + "type": "object", + "description": "Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.\n\nUse global internal addresses for reserved peering network range.\n\nUse regional external addresses for the following resources:\n\n- 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)\n\nUse regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:\n\n- 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\n\nFor more information, read reserved IP address.\n\n(== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)", + "properties": { + "address": { + "type": "string", + "description": "The static IP address represented by this resource." + }, + "addressType": { + "type": "string", + "description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.", + "enum": [ + "EXTERNAL", + "INTERNAL", + "UNSPECIFIED_TYPE" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "creationTimestamp": { + "type": "string", + "description": "[Output Only] Creation timestamp in RFC3339 text format." + }, + "description": { + "type": "string", + "description": "An optional description of this resource. Provide this field when you create the resource." + }, + "id": { + "type": "string", + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64" + }, + "ipVersion": { + "type": "string", + "description": "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.", + "enum": [ + "IPV4", + "IPV6", + "UNSPECIFIED_VERSION" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "IPProtocol": { + "type": "string", + "description": "IP Protocol.", + "enum": [ + "AH", + "ESP", + "ICMP", + "SCTP", + "TCP", + "UDP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ] + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of the resource. Always compute#address for addresses.", + "default": "compute#address" + }, + "name": { + "type": "string", + "description": "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.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "annotations": { + "required": [ + "compute.addresses.insert" + ] + } + }, + "network": { + "type": "string", + "description": "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." + }, + "metadataStruct": { + "description": "This is a field to test that we can create google.protobuf.Struct.", + "type": "object", + "format": "google.protobuf.Struct", + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + } + }, + "metadataValue": { + "description": "This is a field to test that we can create google.protobuf.Value.", + "type": "any", + "format": "google.protobuf.Value" + }, + "metadataListValue": { + "description": "This is a field to test that we can create google.protobuf.ListValue.", + "type": "array", + "format": "google.protobuf.ListValue", + "items": { + "type": "any" + } + }, + "metadataMapListValue" : { + "description": "This is a field to test that we can create a map whose values are google.protobuf.ListValue.", + "type": "object", + "additionalProperties": { + "type": "array", + "format" : "google.protobuf.ListValue", + "items": { + "type": "any" + } + } + }, + "networkTier": { + "type": "string", + "description": "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.\n\nIf this field is not specified, it is assumed to be PREMIUM.", + "enum": [ + "PREMIUM", + "STANDARD" + ], + "enumDescriptions": [ + "", + "" + ] + }, + "prefixLength": { + "type": "integer", + "description": "The prefix length if the resource reprensents an IP range.", + "format": "int32" + }, + "purpose": { + "type": "string", + "description": "The purpose of this resource, which can be one of the following values: \n- `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \n- `DNS_RESOLVER` for a DNS resolver address in a subnetwork \n- `VPC_PEERING` for addresses that are reserved for VPC peer networks. \n- `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.", + "enum": [ + "DNS_RESOLVER", + "GCE_ENDPOINT", + "NAT_AUTO", + "VPC_PEERING" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ] + }, + "region": { + "type": "string", + "description": "[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." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for the resource." + }, + "status": { + "type": "string", + "description": "[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.", + "enum": [ + "IN_USE", + "RESERVED", + "RESERVING" + ], + "enumDescriptions": [ + "", + "", + "" + ] + }, + "subnetwork": { + "type": "string", + "description": "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." + }, + "users": { + "type": "array", + "description": "[Output Only] The URLs of the resources that are using this address.", + "items": { + "type": "string" + } + } + } + }, + "AddressAggregatedList": { + "id": "AddressAggregatedList", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." + }, + "items": { + "type": "object", + "description": "A list of AddressesScopedList resources.", + "additionalProperties": { + "$ref": "AddressesScopedList", + "description": "[Output Only] Name of the scope containing this set of addresses." + } + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.", + "default": "compute#addressAggregatedList" + }, + "nextPageToken": { + "type": "string", + "description": "[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." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "warning": { + "type": "object", + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "type": "string", + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "data": { + "type": "array", + "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "[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)." + }, + "value": { + "type": "string", + "description": "[Output Only] A warning data value corresponding to the key." + } + } + } + }, + "message": { + "type": "string", + "description": "[Output Only] A human-readable description of the warning code." + } + } + } + } + }, + "AddressList": { + "id": "AddressList", + "type": "object", + "description": "Contains a list of addresses.", + "properties": { + "id": { + "type": "string", + "description": "[Output Only] Unique identifier for the resource; defined by the server." + }, + "items": { + "type": "array", + "description": "A list of Address resources.", + "items": { + "$ref": "Address" + } + }, + "kind": { + "type": "string", + "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.", + "default": "compute#addressList" + }, + "nextPageToken": { + "type": "string", + "description": "[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." + }, + "selfLink": { + "type": "string", + "description": "[Output Only] Server-defined URL for this resource." + }, + "warning": { + "type": "object", + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "type": "string", + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "data": { + "type": "array", + "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "[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)." + }, + "value": { + "type": "string", + "description": "[Output Only] A warning data value corresponding to the key." + } + } + } + }, + "message": { + "type": "string", + "description": "[Output Only] A human-readable description of the warning code." + } + } + } + } + }, + "AddressesScopedList": { + "id": "AddressesScopedList", + "type": "object", + "properties": { + "addresses": { + "type": "array", + "description": "[Output Only] A list of addresses contained in this scope.", + "items": { + "$ref": "Address" + } + }, + "warning": { + "type": "object", + "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.", + "properties": { + "code": { + "type": "string", + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ] + }, + "data": { + "type": "array", + "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "[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)." + }, + "value": { + "type": "string", + "description": "[Output Only] A warning data value corresponding to the key." + } + } + } + }, + "message": { + "type": "string", + "description": "[Output Only] A human-readable description of the warning code." + } + } + } + } + } + }, + "resources": { + "addresses": { + "methods": { + "aggregatedList": { + "id": "compute.addresses.aggregatedList", + "path": "{project}/aggregated/addresses", + "httpMethod": "GET", + "description": "Retrieves an aggregated list of addresses.", + "parameters": { + "filter": { + "type": "string", + "description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou 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.\n\nTo 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) ```", + "location": "query" + }, + "includeAllScopes": { + "type": "boolean", + "description": "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.", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "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`)", + "default": "500", + "format": "uint32", + "minimum": "0", + "location": "query" + }, + "orderBy": { + "type": "string", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou 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.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query" + }, + "pageToken": { + "type": "string", + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + } + }, + "parameterOrder": [ + "project" + ], + "response": { + "$ref": "AddressAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "id": "compute.addresses.delete", + "path": "{project}/regions/{region}/addresses/{address}", + "httpMethod": "DELETE", + "description": "Deletes the specified address resource.", + "parameters": { + "address": { + "type": "string", + "description": "Name of the address resource to delete.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "location": "path" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "requestId": { + "type": "string", + "description": "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.\n\nFor 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.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query" + } + }, + "parameterOrder": [ + "project", + "region", + "address" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "insert": { + "id": "compute.addresses.insert", + "path": "{project}/regions/{region}/addresses", + "httpMethod": "POST", + "description": "Creates an address resource in the specified project by using the data included in the request.", + "parameters": { + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + }, + "requestId": { + "type": "string", + "description": "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.\n\nFor 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.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query" + } + }, + "parameterOrder": [ + "project", + "region" + ], + "request": { + "$ref": "Address" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "id": "compute.addresses.list", + "path": "{project}/regions/{region}/addresses", + "httpMethod": "GET", + "description": "Retrieves a list of addresses contained within the specified region.", + "parameters": { + "filter": { + "type": "string", + "description": "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 =, !=, \u003e, or \u003c.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.\n\nYou 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.\n\nTo 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).", + "location": "query" + }, + "maxResults": { + "type": "integer", + "description": "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)", + "default": "500", + "format": "uint32", + "minimum": "0", + "location": "query" + }, + "orderBy": { + "type": "string", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou 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.\n\nCurrently, only sorting by name or creationTimestamp desc is supported.", + "location": "query", + "required": true + }, + "pageToken": { + "type": "string", + "description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.", + "location": "query" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "orderBy" + ], + "response": { + "$ref": "AddressList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "regionOperations": { + "methods": { + "get": { + "id": "compute.regionOperations.get", + "path": "{project}/regions/{region}/operations/{operation}", + "httpMethod": "GET", + "description": "Retrieves the specified region-specific Operations resource.", + "parameters": { + "operation": { + "type": "string", + "description": "Name of the Operations resource to return.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "location": "path" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "operation" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "wait": { + "id": "compute.regionOperations.wait", + "path": "projects/{project}/regions/{region}/operations/{operation}/wait", + "httpMethod": "POST", + "description": "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.\n\nThis method is called on a best-effort basis. Specifically: \n- In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. \n- 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`.", + "parameters": { + "operation": { + "type": "string", + "description": "Name of the Operations resource to return.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "location": "path" + }, + "project": { + "type": "string", + "description": "Project ID for this request.", + "required": true, + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "location": "path" + }, + "region": { + "type": "string", + "description": "Name of the region for this request.", + "required": true, + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "location": "path" + } + }, + "parameterOrder": [ + "project", + "region", + "operation" + ], + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + } + } +} +