Skip to content

Commit 684dba7

Browse files
blakeli0blakeli0
committed
Add .proto files for well-known types.
1 parent 7f60784 commit 684dba7

File tree

10 files changed

+1383
-0
lines changed

10 files changed

+1383
-0
lines changed

‎protobuf-sdk/src/main/resources/any.proto

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
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 go_package = "google.golang.org/protobuf/types/known/anypb";
36+
option java_package = "com.google.protobuf";
37+
option java_outer_classname = "AnyProto";
38+
option java_multiple_files = true;
39+
option objc_class_prefix = "GPB";
40+
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
41+
42+
// `Any` contains an arbitrary serialized protocol buffer message along with a
43+
// URL that describes the type of the serialized message.
44+
//
45+
// Protobuf library provides support to pack/unpack Any values in the form
46+
// of utility functions or additional generated methods of the Any type.
47+
//
48+
// Example 1: Pack and unpack a message in C++.
49+
//
50+
// Foo foo = ...;
51+
// Any any;
52+
// any.PackFrom(foo);
53+
// ...
54+
// if (any.UnpackTo(&foo)) {
55+
// ...
56+
// }
57+
//
58+
// Example 2: Pack and unpack a message in Java.
59+
//
60+
// Foo foo = ...;
61+
// Any any = Any.pack(foo);
62+
// ...
63+
// if (any.is(Foo.class)) {
64+
// foo = any.unpack(Foo.class);
65+
// }
66+
// // or ...
67+
// if (any.isSameTypeAs(Foo.getDefaultInstance())) {
68+
// foo = any.unpack(Foo.getDefaultInstance());
69+
// }
70+
//
71+
// Example 3: Pack and unpack a message in Python.
72+
//
73+
// foo = Foo(...)
74+
// any = Any()
75+
// any.Pack(foo)
76+
// ...
77+
// if any.Is(Foo.DESCRIPTOR):
78+
// any.Unpack(foo)
79+
// ...
80+
//
81+
// Example 4: Pack and unpack a message in Go
82+
//
83+
// foo := &pb.Foo{...}
84+
// any, err := anypb.New(foo)
85+
// if err != nil {
86+
// ...
87+
// }
88+
// ...
89+
// foo := &pb.Foo{}
90+
// if err := any.UnmarshalTo(foo); err != nil {
91+
// ...
92+
// }
93+
//
94+
// The pack methods provided by protobuf library will by default use
95+
// 'type.googleapis.com/full.type.name' as the type URL and the unpack
96+
// methods only use the fully qualified type name after the last '/'
97+
// in the type URL, for example "foo.bar.com/x/y.z" will yield type
98+
// name "y.z".
99+
//
100+
// JSON
101+
// ====
102+
// The JSON representation of an `Any` value uses the regular
103+
// representation of the deserialized, embedded message, with an
104+
// additional field `@type` which contains the type URL. Example:
105+
//
106+
// package google.profile;
107+
// message Person {
108+
// string first_name = 1;
109+
// string last_name = 2;
110+
// }
111+
//
112+
// {
113+
// "@type": "type.googleapis.com/google.profile.Person",
114+
// "firstName": <string>,
115+
// "lastName": <string>
116+
// }
117+
//
118+
// If the embedded message type is well-known and has a custom JSON
119+
// representation, that representation will be embedded adding a field
120+
// `value` which holds the custom JSON in addition to the `@type`
121+
// field. Example (for message [google.protobuf.Duration][]):
122+
//
123+
// {
124+
// "@type": "type.googleapis.com/google.protobuf.Duration",
125+
// "value": "1.212s"
126+
// }
127+
//
128+
message Any {
129+
// A URL/resource name that uniquely identifies the type of the serialized
130+
// protocol buffer message. This string must contain at least
131+
// one "/" character. The last segment of the URL's path must represent
132+
// the fully qualified name of the type (as in
133+
// `path/google.protobuf.Duration`). The name should be in a canonical form
134+
// (e.g., leading "." is not accepted).
135+
//
136+
// In practice, teams usually precompile into the binary all types that they
137+
// expect it to use in the context of Any. However, for URLs which use the
138+
// scheme `http`, `https`, or no scheme, one can optionally set up a type
139+
// server that maps type URLs to message definitions as follows:
140+
//
141+
// * If no scheme is provided, `https` is assumed.
142+
// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
143+
// value in binary format, or produce an error.
144+
// * Applications are allowed to cache lookup results based on the
145+
// URL, or have them precompiled into a binary to avoid any
146+
// lookup. Therefore, binary compatibility needs to be preserved
147+
// on changes to types. (Use versioned type names to manage
148+
// breaking changes.)
149+
//
150+
// Note: this functionality is not currently available in the official
151+
// protobuf release, and it is not used for type URLs beginning with
152+
// type.googleapis.com. As of May 2023, there are no widely used type server
153+
// implementations and no plans to implement one.
154+
//
155+
// Schemes other than `http`, `https` (or the empty scheme) might be
156+
// used with implementation specific semantics.
157+
//
158+
string type_url = 1;
159+
160+
// Must be a valid serialized protocol buffer of the above specified type.
161+
bytes value = 2;
162+
}

‎protobuf-sdk/src/main/resources/api.proto

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
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/source_context.proto";
36+
import "google/protobuf/type.proto";
37+
38+
option java_package = "com.google.protobuf";
39+
option java_outer_classname = "ApiProto";
40+
option java_multiple_files = true;
41+
option objc_class_prefix = "GPB";
42+
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
43+
option go_package = "google.golang.org/protobuf/types/known/apipb";
44+
45+
// Api is a light-weight descriptor for an API Interface.
46+
//
47+
// Interfaces are also described as "protocol buffer services" in some contexts,
48+
// such as by the "service" keyword in a .proto file, but they are different
49+
// from API Services, which represent a concrete implementation of an interface
50+
// as opposed to simply a description of methods and bindings. They are also
51+
// sometimes simply referred to as "APIs" in other contexts, such as the name of
52+
// this message itself. See https://cloud.google.com/apis/design/glossary for
53+
// detailed terminology.
54+
message Api {
55+
// The fully qualified name of this interface, including package name
56+
// followed by the interface's simple name.
57+
string name = 1;
58+
59+
// The methods of this interface, in unspecified order.
60+
repeated Method methods = 2;
61+
62+
// Any metadata attached to the interface.
63+
repeated Option options = 3;
64+
65+
// A version string for this interface. If specified, must have the form
66+
// `major-version.minor-version`, as in `1.10`. If the minor version is
67+
// omitted, it defaults to zero. If the entire version field is empty, the
68+
// major version is derived from the package name, as outlined below. If the
69+
// field is not empty, the version in the package name will be verified to be
70+
// consistent with what is provided here.
71+
//
72+
// The versioning schema uses [semantic
73+
// versioning](http://semver.org) where the major version number
74+
// indicates a breaking change and the minor version an additive,
75+
// non-breaking change. Both version numbers are signals to users
76+
// what to expect from different versions, and should be carefully
77+
// chosen based on the product plan.
78+
//
79+
// The major version is also reflected in the package name of the
80+
// interface, which must end in `v<major-version>`, as in
81+
// `google.feature.v1`. For major versions 0 and 1, the suffix can
82+
// be omitted. Zero major versions must only be used for
83+
// experimental, non-GA interfaces.
84+
//
85+
string version = 4;
86+
87+
// Source context for the protocol buffer service represented by this
88+
// message.
89+
SourceContext source_context = 5;
90+
91+
// Included interfaces. See [Mixin][].
92+
repeated Mixin mixins = 6;
93+
94+
// The source syntax of the service.
95+
Syntax syntax = 7;
96+
}
97+
98+
// Method represents a method of an API interface.
99+
message Method {
100+
// The simple name of this method.
101+
string name = 1;
102+
103+
// A URL of the input message type.
104+
string request_type_url = 2;
105+
106+
// If true, the request is streamed.
107+
bool request_streaming = 3;
108+
109+
// The URL of the output message type.
110+
string response_type_url = 4;
111+
112+
// If true, the response is streamed.
113+
bool response_streaming = 5;
114+
115+
// Any metadata attached to the method.
116+
repeated Option options = 6;
117+
118+
// The source syntax of this method.
119+
Syntax syntax = 7;
120+
}
121+
122+
// Declares an API Interface to be included in this interface. The including
123+
// interface must redeclare all the methods from the included interface, but
124+
// documentation and options are inherited as follows:
125+
//
126+
// - If after comment and whitespace stripping, the documentation
127+
// string of the redeclared method is empty, it will be inherited
128+
// from the original method.
129+
//
130+
// - Each annotation belonging to the service config (http,
131+
// visibility) which is not set in the redeclared method will be
132+
// inherited.
133+
//
134+
// - If an http annotation is inherited, the path pattern will be
135+
// modified as follows. Any version prefix will be replaced by the
136+
// version of the including interface plus the [root][] path if
137+
// specified.
138+
//
139+
// Example of a simple mixin:
140+
//
141+
// package google.acl.v1;
142+
// service AccessControl {
143+
// // Get the underlying ACL object.
144+
// rpc GetAcl(GetAclRequest) returns (Acl) {
145+
// option (google.api.http).get = "/v1/{resource=**}:getAcl";
146+
// }
147+
// }
148+
//
149+
// package google.storage.v2;
150+
// service Storage {
151+
// rpc GetAcl(GetAclRequest) returns (Acl);
152+
//
153+
// // Get a data record.
154+
// rpc GetData(GetDataRequest) returns (Data) {
155+
// option (google.api.http).get = "/v2/{resource=**}";
156+
// }
157+
// }
158+
//
159+
// Example of a mixin configuration:
160+
//
161+
// apis:
162+
// - name: google.storage.v2.Storage
163+
// mixins:
164+
// - name: google.acl.v1.AccessControl
165+
//
166+
// The mixin construct implies that all methods in `AccessControl` are
167+
// also declared with same name and request/response types in
168+
// `Storage`. A documentation generator or annotation processor will
169+
// see the effective `Storage.GetAcl` method after inheriting
170+
// documentation and annotations as follows:
171+
//
172+
// service Storage {
173+
// // Get the underlying ACL object.
174+
// rpc GetAcl(GetAclRequest) returns (Acl) {
175+
// option (google.api.http).get = "/v2/{resource=**}:getAcl";
176+
// }
177+
// ...
178+
// }
179+
//
180+
// Note how the version in the path pattern changed from `v1` to `v2`.
181+
//
182+
// If the `root` field in the mixin is specified, it should be a
183+
// relative path under which inherited HTTP paths are placed. Example:
184+
//
185+
// apis:
186+
// - name: google.storage.v2.Storage
187+
// mixins:
188+
// - name: google.acl.v1.AccessControl
189+
// root: acls
190+
//
191+
// This implies the following inherited HTTP annotation:
192+
//
193+
// service Storage {
194+
// // Get the underlying ACL object.
195+
// rpc GetAcl(GetAclRequest) returns (Acl) {
196+
// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
197+
// }
198+
// ...
199+
// }
200+
message Mixin {
201+
// The fully qualified name of the interface which is included.
202+
string name = 1;
203+
204+
// If non-empty specifies a path under which inherited HTTP paths
205+
// are rooted.
206+
string root = 2;
207+
}

0 commit comments

Comments
 (0)