@gravity-ui/gateway 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +269 -0
  3. package/bin/patch.js +13 -0
  4. package/build/components/grpc.d.ts +24 -0
  5. package/build/components/grpc.js +664 -0
  6. package/build/components/mixed.d.ts +11 -0
  7. package/build/components/mixed.js +66 -0
  8. package/build/components/rest.d.ts +7 -0
  9. package/build/components/rest.js +291 -0
  10. package/build/constants.d.ts +46 -0
  11. package/build/constants.js +101 -0
  12. package/build/index.d.ts +11 -0
  13. package/build/index.js +285 -0
  14. package/build/models/common.d.ts +241 -0
  15. package/build/models/common.js +8 -0
  16. package/build/models/context.d.ts +22 -0
  17. package/build/models/context.js +2 -0
  18. package/build/models/error.d.ts +12 -0
  19. package/build/models/error.js +2 -0
  20. package/build/utils/axios.d.ts +2 -0
  21. package/build/utils/axios.js +24 -0
  22. package/build/utils/common.d.ts +15 -0
  23. package/build/utils/common.js +50 -0
  24. package/build/utils/create-context-api.d.ts +4 -0
  25. package/build/utils/create-context-api.js +45 -0
  26. package/build/utils/grpc-reflection.d.ts +22 -0
  27. package/build/utils/grpc-reflection.js +56 -0
  28. package/build/utils/grpc.d.ts +15 -0
  29. package/build/utils/grpc.js +55 -0
  30. package/build/utils/overrideEndpoints/index.d.ts +2 -0
  31. package/build/utils/overrideEndpoints/index.js +4 -0
  32. package/build/utils/overrideEndpoints/overrideEndpoints.d.ts +17 -0
  33. package/build/utils/overrideEndpoints/overrideEndpoints.js +103 -0
  34. package/build/utils/parse-error.d.ts +32 -0
  35. package/build/utils/parse-error.js +224 -0
  36. package/build/utils/redact-sensitive-headers.d.ts +4 -0
  37. package/build/utils/redact-sensitive-headers.js +16 -0
  38. package/build/utils/typed-api.d.ts +2 -0
  39. package/build/utils/typed-api.js +7 -0
  40. package/build/utils/validate.d.ts +4 -0
  41. package/build/utils/validate.js +56 -0
  42. package/package.json +91 -0
  43. package/patches/grpc-reflection-js+0.1.2.patch +87 -0
  44. package/patches/protobufjs+6.11.4.patch +121 -0
  45. package/proto/google/api/annotations.proto +31 -0
  46. package/proto/google/api/http.proto +291 -0
  47. package/proto/google/protobuf/any.proto +158 -0
  48. package/proto/google/protobuf/api.proto +208 -0
  49. package/proto/google/protobuf/compiler/plugin.proto +183 -0
  50. package/proto/google/protobuf/descriptor.proto +909 -0
  51. package/proto/google/protobuf/duration.proto +116 -0
  52. package/proto/google/protobuf/empty.proto +52 -0
  53. package/proto/google/protobuf/field_mask.proto +245 -0
  54. package/proto/google/protobuf/source_context.proto +48 -0
  55. package/proto/google/protobuf/struct.proto +95 -0
  56. package/proto/google/protobuf/timestamp.proto +147 -0
  57. package/proto/google/protobuf/type.proto +187 -0
  58. package/proto/google/protobuf/wrappers.proto +123 -0
  59. package/proto/google/rpc/README.md +5 -0
  60. package/proto/google/rpc/code.proto +186 -0
  61. package/proto/google/rpc/error_details.proto +200 -0
  62. package/proto/google/rpc/status.proto +92 -0
  63. package/proto/google/type/dayofweek.proto +51 -0
  64. package/proto/google/type/timeofday.proto +45 -0
@@ -0,0 +1,147 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2008 Google Inc. All rights reserved.
3
+ // https://developers.google.com/protocol-buffers/
4
+ //
5
+ // Redistribution and use in source and binary forms, with or without
6
+ // modification, are permitted provided that the following conditions are
7
+ // met:
8
+ //
9
+ // * Redistributions of source code must retain the above copyright
10
+ // notice, this list of conditions and the following disclaimer.
11
+ // * Redistributions in binary form must reproduce the above
12
+ // copyright notice, this list of conditions and the following disclaimer
13
+ // in the documentation and/or other materials provided with the
14
+ // distribution.
15
+ // * Neither the name of Google Inc. nor the names of its
16
+ // contributors may be used to endorse or promote products derived from
17
+ // this software without specific prior written permission.
18
+ //
19
+ // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
+ // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
+ // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
+ // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
+ // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
+ // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
+ // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
+ // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
+ // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
+ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+
31
+ syntax = "proto3";
32
+
33
+ package google.protobuf;
34
+
35
+ option csharp_namespace = "Google.Protobuf.WellKnownTypes";
36
+ option cc_enable_arenas = true;
37
+ option go_package = "google.golang.org/protobuf/types/known/timestamppb";
38
+ option java_package = "com.google.protobuf";
39
+ option java_outer_classname = "TimestampProto";
40
+ option java_multiple_files = true;
41
+ option objc_class_prefix = "GPB";
42
+
43
+ // A Timestamp represents a point in time independent of any time zone or local
44
+ // calendar, encoded as a count of seconds and fractions of seconds at
45
+ // nanosecond resolution. The count is relative to an epoch at UTC midnight on
46
+ // January 1, 1970, in the proleptic Gregorian calendar which extends the
47
+ // Gregorian calendar backwards to year one.
48
+ //
49
+ // All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
50
+ // second table is needed for interpretation, using a [24-hour linear
51
+ // smear](https://developers.google.com/time/smear).
52
+ //
53
+ // The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
54
+ // restricting to that range, we ensure that we can convert to and from [RFC
55
+ // 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
56
+ //
57
+ // # Examples
58
+ //
59
+ // Example 1: Compute Timestamp from POSIX `time()`.
60
+ //
61
+ // Timestamp timestamp;
62
+ // timestamp.set_seconds(time(NULL));
63
+ // timestamp.set_nanos(0);
64
+ //
65
+ // Example 2: Compute Timestamp from POSIX `gettimeofday()`.
66
+ //
67
+ // struct timeval tv;
68
+ // gettimeofday(&tv, NULL);
69
+ //
70
+ // Timestamp timestamp;
71
+ // timestamp.set_seconds(tv.tv_sec);
72
+ // timestamp.set_nanos(tv.tv_usec * 1000);
73
+ //
74
+ // Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
75
+ //
76
+ // FILETIME ft;
77
+ // GetSystemTimeAsFileTime(&ft);
78
+ // UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
79
+ //
80
+ // // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
81
+ // // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
82
+ // Timestamp timestamp;
83
+ // timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
84
+ // timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
85
+ //
86
+ // Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
87
+ //
88
+ // long millis = System.currentTimeMillis();
89
+ //
90
+ // Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
91
+ // .setNanos((int) ((millis % 1000) * 1000000)).build();
92
+ //
93
+ //
94
+ // Example 5: Compute Timestamp from Java `Instant.now()`.
95
+ //
96
+ // Instant now = Instant.now();
97
+ //
98
+ // Timestamp timestamp =
99
+ // Timestamp.newBuilder().setSeconds(now.getEpochSecond())
100
+ // .setNanos(now.getNano()).build();
101
+ //
102
+ //
103
+ // Example 6: Compute Timestamp from current time in Python.
104
+ //
105
+ // timestamp = Timestamp()
106
+ // timestamp.GetCurrentTime()
107
+ //
108
+ // # JSON Mapping
109
+ //
110
+ // In JSON format, the Timestamp type is encoded as a string in the
111
+ // [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
112
+ // format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
113
+ // where {year} is always expressed using four digits while {month}, {day},
114
+ // {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
115
+ // seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
116
+ // are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
117
+ // is required. A proto3 JSON serializer should always use UTC (as indicated by
118
+ // "Z") when printing the Timestamp type and a proto3 JSON parser should be
119
+ // able to accept both UTC and other timezones (as indicated by an offset).
120
+ //
121
+ // For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
122
+ // 01:30 UTC on January 15, 2017.
123
+ //
124
+ // In JavaScript, one can convert a Date object to this format using the
125
+ // standard
126
+ // [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
127
+ // method. In Python, a standard `datetime.datetime` object can be converted
128
+ // to this format using
129
+ // [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
130
+ // the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
131
+ // the Joda Time's [`ISODateTimeFormat.dateTime()`](
132
+ // http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
133
+ // ) to obtain a formatter capable of generating timestamps in this format.
134
+ //
135
+ //
136
+ message Timestamp {
137
+ // Represents seconds of UTC time since Unix epoch
138
+ // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
139
+ // 9999-12-31T23:59:59Z inclusive.
140
+ int64 seconds = 1;
141
+
142
+ // Non-negative fractions of a second at nanosecond resolution. Negative
143
+ // second values with fractions must still have non-negative nanos values
144
+ // that count forward in time. Must be from 0 to 999,999,999
145
+ // inclusive.
146
+ int32 nanos = 2;
147
+ }
@@ -0,0 +1,187 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2008 Google Inc. All rights reserved.
3
+ // https://developers.google.com/protocol-buffers/
4
+ //
5
+ // Redistribution and use in source and binary forms, with or without
6
+ // modification, are permitted provided that the following conditions are
7
+ // met:
8
+ //
9
+ // * Redistributions of source code must retain the above copyright
10
+ // notice, this list of conditions and the following disclaimer.
11
+ // * Redistributions in binary form must reproduce the above
12
+ // copyright notice, this list of conditions and the following disclaimer
13
+ // in the documentation and/or other materials provided with the
14
+ // distribution.
15
+ // * Neither the name of Google Inc. nor the names of its
16
+ // contributors may be used to endorse or promote products derived from
17
+ // this software without specific prior written permission.
18
+ //
19
+ // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
+ // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
+ // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
+ // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
+ // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
+ // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
+ // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
+ // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
+ // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
+ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+
31
+ syntax = "proto3";
32
+
33
+ package google.protobuf;
34
+
35
+ import "google/protobuf/any.proto";
36
+ import "google/protobuf/source_context.proto";
37
+
38
+ option csharp_namespace = "Google.Protobuf.WellKnownTypes";
39
+ option cc_enable_arenas = true;
40
+ option java_package = "com.google.protobuf";
41
+ option java_outer_classname = "TypeProto";
42
+ option java_multiple_files = true;
43
+ option objc_class_prefix = "GPB";
44
+ option go_package = "google.golang.org/protobuf/types/known/typepb";
45
+
46
+ // A protocol buffer message type.
47
+ message Type {
48
+ // The fully qualified message name.
49
+ string name = 1;
50
+ // The list of fields.
51
+ repeated Field fields = 2;
52
+ // The list of types appearing in `oneof` definitions in this type.
53
+ repeated string oneofs = 3;
54
+ // The protocol buffer options.
55
+ repeated Option options = 4;
56
+ // The source context.
57
+ SourceContext source_context = 5;
58
+ // The source syntax.
59
+ Syntax syntax = 6;
60
+ }
61
+
62
+ // A single field of a message type.
63
+ message Field {
64
+ // Basic field types.
65
+ enum Kind {
66
+ // Field type unknown.
67
+ TYPE_UNKNOWN = 0;
68
+ // Field type double.
69
+ TYPE_DOUBLE = 1;
70
+ // Field type float.
71
+ TYPE_FLOAT = 2;
72
+ // Field type int64.
73
+ TYPE_INT64 = 3;
74
+ // Field type uint64.
75
+ TYPE_UINT64 = 4;
76
+ // Field type int32.
77
+ TYPE_INT32 = 5;
78
+ // Field type fixed64.
79
+ TYPE_FIXED64 = 6;
80
+ // Field type fixed32.
81
+ TYPE_FIXED32 = 7;
82
+ // Field type bool.
83
+ TYPE_BOOL = 8;
84
+ // Field type string.
85
+ TYPE_STRING = 9;
86
+ // Field type group. Proto2 syntax only, and deprecated.
87
+ TYPE_GROUP = 10;
88
+ // Field type message.
89
+ TYPE_MESSAGE = 11;
90
+ // Field type bytes.
91
+ TYPE_BYTES = 12;
92
+ // Field type uint32.
93
+ TYPE_UINT32 = 13;
94
+ // Field type enum.
95
+ TYPE_ENUM = 14;
96
+ // Field type sfixed32.
97
+ TYPE_SFIXED32 = 15;
98
+ // Field type sfixed64.
99
+ TYPE_SFIXED64 = 16;
100
+ // Field type sint32.
101
+ TYPE_SINT32 = 17;
102
+ // Field type sint64.
103
+ TYPE_SINT64 = 18;
104
+ }
105
+
106
+ // Whether a field is optional, required, or repeated.
107
+ enum Cardinality {
108
+ // For fields with unknown cardinality.
109
+ CARDINALITY_UNKNOWN = 0;
110
+ // For optional fields.
111
+ CARDINALITY_OPTIONAL = 1;
112
+ // For required fields. Proto2 syntax only.
113
+ CARDINALITY_REQUIRED = 2;
114
+ // For repeated fields.
115
+ CARDINALITY_REPEATED = 3;
116
+ }
117
+
118
+ // The field type.
119
+ Kind kind = 1;
120
+ // The field cardinality.
121
+ Cardinality cardinality = 2;
122
+ // The field number.
123
+ int32 number = 3;
124
+ // The field name.
125
+ string name = 4;
126
+ // The field type URL, without the scheme, for message or enumeration
127
+ // types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
128
+ string type_url = 6;
129
+ // The index of the field type in `Type.oneofs`, for message or enumeration
130
+ // types. The first type has index 1; zero means the type is not in the list.
131
+ int32 oneof_index = 7;
132
+ // Whether to use alternative packed wire representation.
133
+ bool packed = 8;
134
+ // The protocol buffer options.
135
+ repeated Option options = 9;
136
+ // The field JSON name.
137
+ string json_name = 10;
138
+ // The string value of the default value of this field. Proto2 syntax only.
139
+ string default_value = 11;
140
+ }
141
+
142
+ // Enum type definition.
143
+ message Enum {
144
+ // Enum type name.
145
+ string name = 1;
146
+ // Enum value definitions.
147
+ repeated EnumValue enumvalue = 2;
148
+ // Protocol buffer options.
149
+ repeated Option options = 3;
150
+ // The source context.
151
+ SourceContext source_context = 4;
152
+ // The source syntax.
153
+ Syntax syntax = 5;
154
+ }
155
+
156
+ // Enum value definition.
157
+ message EnumValue {
158
+ // Enum value name.
159
+ string name = 1;
160
+ // Enum value number.
161
+ int32 number = 2;
162
+ // Protocol buffer options.
163
+ repeated Option options = 3;
164
+ }
165
+
166
+ // A protocol buffer option, which can be attached to a message, field,
167
+ // enumeration, etc.
168
+ message Option {
169
+ // The option's name. For protobuf built-in options (options defined in
170
+ // descriptor.proto), this is the short name. For example, `"map_entry"`.
171
+ // For custom options, it should be the fully-qualified name. For example,
172
+ // `"google.api.http"`.
173
+ string name = 1;
174
+ // The option's value packed in an Any message. If the value is a primitive,
175
+ // the corresponding wrapper type defined in google/protobuf/wrappers.proto
176
+ // should be used. If the value is an enum, it should be stored as an int32
177
+ // value using the google.protobuf.Int32Value type.
178
+ Any value = 2;
179
+ }
180
+
181
+ // The syntax in which a protocol buffer element is defined.
182
+ enum Syntax {
183
+ // Syntax `proto2`.
184
+ SYNTAX_PROTO2 = 0;
185
+ // Syntax `proto3`.
186
+ SYNTAX_PROTO3 = 1;
187
+ }
@@ -0,0 +1,123 @@
1
+ // Protocol Buffers - Google's data interchange format
2
+ // Copyright 2008 Google Inc. All rights reserved.
3
+ // https://developers.google.com/protocol-buffers/
4
+ //
5
+ // Redistribution and use in source and binary forms, with or without
6
+ // modification, are permitted provided that the following conditions are
7
+ // met:
8
+ //
9
+ // * Redistributions of source code must retain the above copyright
10
+ // notice, this list of conditions and the following disclaimer.
11
+ // * Redistributions in binary form must reproduce the above
12
+ // copyright notice, this list of conditions and the following disclaimer
13
+ // in the documentation and/or other materials provided with the
14
+ // distribution.
15
+ // * Neither the name of Google Inc. nor the names of its
16
+ // contributors may be used to endorse or promote products derived from
17
+ // this software without specific prior written permission.
18
+ //
19
+ // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
+ // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
+ // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
+ // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
+ // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
+ // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
+ // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
+ // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
+ // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
+ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
+
31
+ // Wrappers for primitive (non-message) types. These types are useful
32
+ // for embedding primitives in the `google.protobuf.Any` type and for places
33
+ // where we need to distinguish between the absence of a primitive
34
+ // typed field and its default value.
35
+ //
36
+ // These wrappers have no meaningful use within repeated fields as they lack
37
+ // the ability to detect presence on individual elements.
38
+ // These wrappers have no meaningful use within a map or a oneof since
39
+ // individual entries of a map or fields of a oneof can already detect presence.
40
+
41
+ syntax = "proto3";
42
+
43
+ package google.protobuf;
44
+
45
+ option csharp_namespace = "Google.Protobuf.WellKnownTypes";
46
+ option cc_enable_arenas = true;
47
+ option go_package = "google.golang.org/protobuf/types/known/wrapperspb";
48
+ option java_package = "com.google.protobuf";
49
+ option java_outer_classname = "WrappersProto";
50
+ option java_multiple_files = true;
51
+ option objc_class_prefix = "GPB";
52
+
53
+ // Wrapper message for `double`.
54
+ //
55
+ // The JSON representation for `DoubleValue` is JSON number.
56
+ message DoubleValue {
57
+ // The double value.
58
+ double value = 1;
59
+ }
60
+
61
+ // Wrapper message for `float`.
62
+ //
63
+ // The JSON representation for `FloatValue` is JSON number.
64
+ message FloatValue {
65
+ // The float value.
66
+ float value = 1;
67
+ }
68
+
69
+ // Wrapper message for `int64`.
70
+ //
71
+ // The JSON representation for `Int64Value` is JSON string.
72
+ message Int64Value {
73
+ // The int64 value.
74
+ int64 value = 1;
75
+ }
76
+
77
+ // Wrapper message for `uint64`.
78
+ //
79
+ // The JSON representation for `UInt64Value` is JSON string.
80
+ message UInt64Value {
81
+ // The uint64 value.
82
+ uint64 value = 1;
83
+ }
84
+
85
+ // Wrapper message for `int32`.
86
+ //
87
+ // The JSON representation for `Int32Value` is JSON number.
88
+ message Int32Value {
89
+ // The int32 value.
90
+ int32 value = 1;
91
+ }
92
+
93
+ // Wrapper message for `uint32`.
94
+ //
95
+ // The JSON representation for `UInt32Value` is JSON number.
96
+ message UInt32Value {
97
+ // The uint32 value.
98
+ uint32 value = 1;
99
+ }
100
+
101
+ // Wrapper message for `bool`.
102
+ //
103
+ // The JSON representation for `BoolValue` is JSON `true` and `false`.
104
+ message BoolValue {
105
+ // The bool value.
106
+ bool value = 1;
107
+ }
108
+
109
+ // Wrapper message for `string`.
110
+ //
111
+ // The JSON representation for `StringValue` is JSON string.
112
+ message StringValue {
113
+ // The string value.
114
+ string value = 1;
115
+ }
116
+
117
+ // Wrapper message for `bytes`.
118
+ //
119
+ // The JSON representation for `BytesValue` is JSON string.
120
+ message BytesValue {
121
+ // The bytes value.
122
+ bytes value = 1;
123
+ }
@@ -0,0 +1,5 @@
1
+ # Google RPC
2
+
3
+ This package contains type definitions for general RPC systems. While
4
+ [gRPC](https://github.com/grpc) is using these defintions, they
5
+ are not designed specifically to support gRPC.
@@ -0,0 +1,186 @@
1
+ // Copyright 2017 Google Inc.
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.rpc;
18
+
19
+ option go_package = "google.golang.org/genproto/googleapis/rpc/code;code";
20
+ option java_multiple_files = true;
21
+ option java_outer_classname = "CodeProto";
22
+ option java_package = "com.google.rpc";
23
+ option objc_class_prefix = "RPC";
24
+
25
+
26
+ // The canonical error codes for Google APIs.
27
+ //
28
+ //
29
+ // Sometimes multiple error codes may apply. Services should return
30
+ // the most specific error code that applies. For example, prefer
31
+ // `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
32
+ // Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
33
+ enum Code {
34
+ // Not an error; returned on success
35
+ //
36
+ // HTTP Mapping: 200 OK
37
+ OK = 0;
38
+
39
+ // The operation was cancelled, typically by the caller.
40
+ //
41
+ // HTTP Mapping: 499 Client Closed Request
42
+ CANCELLED = 1;
43
+
44
+ // Unknown error. For example, this error may be returned when
45
+ // a `Status` value received from another address space belongs to
46
+ // an error space that is not known in this address space. Also
47
+ // errors raised by APIs that do not return enough error information
48
+ // may be converted to this error.
49
+ //
50
+ // HTTP Mapping: 500 Internal Server Error
51
+ UNKNOWN = 2;
52
+
53
+ // The client specified an invalid argument. Note that this differs
54
+ // from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
55
+ // that are problematic regardless of the state of the system
56
+ // (e.g., a malformed file name).
57
+ //
58
+ // HTTP Mapping: 400 Bad Request
59
+ INVALID_ARGUMENT = 3;
60
+
61
+ // The deadline expired before the operation could complete. For operations
62
+ // that change the state of the system, this error may be returned
63
+ // even if the operation has completed successfully. For example, a
64
+ // successful response from a server could have been delayed long
65
+ // enough for the deadline to expire.
66
+ //
67
+ // HTTP Mapping: 504 Gateway Timeout
68
+ DEADLINE_EXCEEDED = 4;
69
+
70
+ // Some requested entity (e.g., file or directory) was not found.
71
+ //
72
+ // Note to server developers: if a request is denied for an entire class
73
+ // of users, such as gradual feature rollout or undocumented whitelist,
74
+ // `NOT_FOUND` may be used. If a request is denied for some users within
75
+ // a class of users, such as user-based access control, `PERMISSION_DENIED`
76
+ // must be used.
77
+ //
78
+ // HTTP Mapping: 404 Not Found
79
+ NOT_FOUND = 5;
80
+
81
+ // The entity that a client attempted to create (e.g., file or directory)
82
+ // already exists.
83
+ //
84
+ // HTTP Mapping: 409 Conflict
85
+ ALREADY_EXISTS = 6;
86
+
87
+ // The caller does not have permission to execute the specified
88
+ // operation. `PERMISSION_DENIED` must not be used for rejections
89
+ // caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
90
+ // instead for those errors). `PERMISSION_DENIED` must not be
91
+ // used if the caller can not be identified (use `UNAUTHENTICATED`
92
+ // instead for those errors). This error code does not imply the
93
+ // request is valid or the requested entity exists or satisfies
94
+ // other pre-conditions.
95
+ //
96
+ // HTTP Mapping: 403 Forbidden
97
+ PERMISSION_DENIED = 7;
98
+
99
+ // The request does not have valid authentication credentials for the
100
+ // operation.
101
+ //
102
+ // HTTP Mapping: 401 Unauthorized
103
+ UNAUTHENTICATED = 16;
104
+
105
+ // Some resource has been exhausted, perhaps a per-user quota, or
106
+ // perhaps the entire file system is out of space.
107
+ //
108
+ // HTTP Mapping: 429 Too Many Requests
109
+ RESOURCE_EXHAUSTED = 8;
110
+
111
+ // The operation was rejected because the system is not in a state
112
+ // required for the operation's execution. For example, the directory
113
+ // to be deleted is non-empty, an rmdir operation is applied to
114
+ // a non-directory, etc.
115
+ //
116
+ // Service implementors can use the following guidelines to decide
117
+ // between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
118
+ // (a) Use `UNAVAILABLE` if the client can retry just the failing call.
119
+ // (b) Use `ABORTED` if the client should retry at a higher level
120
+ // (e.g., when a client-specified test-and-set fails, indicating the
121
+ // client should restart a read-modify-write sequence).
122
+ // (c) Use `FAILED_PRECONDITION` if the client should not retry until
123
+ // the system state has been explicitly fixed. E.g., if an "rmdir"
124
+ // fails because the directory is non-empty, `FAILED_PRECONDITION`
125
+ // should be returned since the client should not retry unless
126
+ // the files are deleted from the directory.
127
+ //
128
+ // HTTP Mapping: 400 Bad Request
129
+ FAILED_PRECONDITION = 9;
130
+
131
+ // The operation was aborted, typically due to a concurrency issue such as
132
+ // a sequencer check failure or transaction abort.
133
+ //
134
+ // See the guidelines above for deciding between `FAILED_PRECONDITION`,
135
+ // `ABORTED`, and `UNAVAILABLE`.
136
+ //
137
+ // HTTP Mapping: 409 Conflict
138
+ ABORTED = 10;
139
+
140
+ // The operation was attempted past the valid range. E.g., seeking or
141
+ // reading past end-of-file.
142
+ //
143
+ // Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
144
+ // be fixed if the system state changes. For example, a 32-bit file
145
+ // system will generate `INVALID_ARGUMENT` if asked to read at an
146
+ // offset that is not in the range [0,2^32-1], but it will generate
147
+ // `OUT_OF_RANGE` if asked to read from an offset past the current
148
+ // file size.
149
+ //
150
+ // There is a fair bit of overlap between `FAILED_PRECONDITION` and
151
+ // `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
152
+ // error) when it applies so that callers who are iterating through
153
+ // a space can easily look for an `OUT_OF_RANGE` error to detect when
154
+ // they are done.
155
+ //
156
+ // HTTP Mapping: 400 Bad Request
157
+ OUT_OF_RANGE = 11;
158
+
159
+ // The operation is not implemented or is not supported/enabled in this
160
+ // service.
161
+ //
162
+ // HTTP Mapping: 501 Not Implemented
163
+ UNIMPLEMENTED = 12;
164
+
165
+ // Internal errors. This means that some invariants expected by the
166
+ // underlying system have been broken. This error code is reserved
167
+ // for serious errors.
168
+ //
169
+ // HTTP Mapping: 500 Internal Server Error
170
+ INTERNAL = 13;
171
+
172
+ // The service is currently unavailable. This is most likely a
173
+ // transient condition, which can be corrected by retrying with
174
+ // a backoff.
175
+ //
176
+ // See the guidelines above for deciding between `FAILED_PRECONDITION`,
177
+ // `ABORTED`, and `UNAVAILABLE`.
178
+ //
179
+ // HTTP Mapping: 503 Service Unavailable
180
+ UNAVAILABLE = 14;
181
+
182
+ // Unrecoverable data loss or corruption.
183
+ //
184
+ // HTTP Mapping: 500 Internal Server Error
185
+ DATA_LOSS = 15;
186
+ }