init
This commit is contained in:
commit
04f41a7fe6
|
@ -0,0 +1,8 @@
|
||||||
|
# Default ignored files
|
||||||
|
/shelf/
|
||||||
|
/workspace.xml
|
||||||
|
# Editor-based HTTP Client requests
|
||||||
|
/httpRequests/
|
||||||
|
# Datasource local storage ignored files
|
||||||
|
/dataSources/
|
||||||
|
/dataSources.local.xml
|
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectModuleManager">
|
||||||
|
<modules>
|
||||||
|
<module fileurl="file://$PROJECT_DIR$/.idea/plugins.iml" filepath="$PROJECT_DIR$/.idea/plugins.iml" />
|
||||||
|
</modules>
|
||||||
|
</component>
|
||||||
|
</project>
|
|
@ -0,0 +1,9 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="WEB_MODULE" version="4">
|
||||||
|
<component name="Go" enabled="true" />
|
||||||
|
<component name="NewModuleRootManager">
|
||||||
|
<content url="file://$MODULE_DIR$" />
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="VcsDirectoryMappings">
|
||||||
|
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||||
|
</component>
|
||||||
|
</project>
|
|
@ -0,0 +1,48 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"plugins/sdk/instance"
|
||||||
|
"plugins/sdk/proto"
|
||||||
|
)
|
||||||
|
|
||||||
|
var appKey = "8db16e8cc8363ed4eb4c14f9520bcc32"
|
||||||
|
var appId = "23329"
|
||||||
|
var baseUri = "http://test.openapi.1688sup.cn"
|
||||||
|
var notifyUrl = "http://test.openapi.1688sup.cn"
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
load := []*instance.PkgConf{
|
||||||
|
{
|
||||||
|
Cmd: "pkg/zltx",
|
||||||
|
Tag: "zltx",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
err := instance.Load(load)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
request := &proto.OrderRequest{
|
||||||
|
Config: &proto.Config{
|
||||||
|
AppId: appId,
|
||||||
|
AppKey: appKey,
|
||||||
|
BaseUri: baseUri,
|
||||||
|
NotifyUrl: notifyUrl,
|
||||||
|
},
|
||||||
|
Order: &proto.OrderRequest_Order{
|
||||||
|
OrderNo: "test_main_zltx_5",
|
||||||
|
Account: "18666666666",
|
||||||
|
Extra: nil,
|
||||||
|
},
|
||||||
|
Product: &proto.OrderRequest_Product{
|
||||||
|
ProductNo: "106",
|
||||||
|
Extra: []byte(`{}`),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
res, err := instance.Get("zltx").Order(context.Background(), request)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalln(err)
|
||||||
|
}
|
||||||
|
log.Printf("Order res:%+v", res)
|
||||||
|
}
|
|
@ -0,0 +1,26 @@
|
||||||
|
module plugins
|
||||||
|
|
||||||
|
go 1.21
|
||||||
|
|
||||||
|
replace plugins/sdk => ./sdk
|
||||||
|
|
||||||
|
require plugins/sdk v0.0.0-00010101000000-000000000000
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4 // indirect
|
||||||
|
github.com/fatih/color v1.7.0 // indirect
|
||||||
|
github.com/golang/protobuf v1.5.4 // indirect
|
||||||
|
github.com/hashicorp/go-hclog v1.0.0 // indirect
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1 // indirect
|
||||||
|
github.com/hashicorp/yamux v0.1.1 // indirect
|
||||||
|
github.com/mattn/go-colorable v0.1.4 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.10 // indirect
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77 // indirect
|
||||||
|
github.com/oklog/run v1.0.0 // indirect
|
||||||
|
golang.org/x/net v0.22.0 // indirect
|
||||||
|
golang.org/x/sys v0.18.0 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect
|
||||||
|
google.golang.org/grpc v1.64.0 // indirect
|
||||||
|
google.golang.org/protobuf v1.34.2 // indirect
|
||||||
|
)
|
|
@ -0,0 +1,47 @@
|
||||||
|
github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA=
|
||||||
|
github.com/bufbuild/protocompile v0.4.0/go.mod h1:3v93+mbWn/v3xzN+31nwkJfrEpAUwp+BagBSZWx+TP8=
|
||||||
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4 h1:gVPz/FMfvh57HdSJQyvBtF00j8JU4zdyUgIUNhlgg0A=
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4/go.mod h1:qys6tmnRsYrQqIhm2bvKZH4Blx/1gTIZ2UKVY1M+Yew=
|
||||||
|
github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
|
||||||
|
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
|
||||||
|
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
|
||||||
|
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
|
||||||
|
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||||
|
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
|
github.com/hashicorp/go-hclog v1.0.0 h1:bkKf0BeBXcSYa7f5Fyi9gMuQ8gNsxeiNpZjR6VxNZeo=
|
||||||
|
github.com/hashicorp/go-hclog v1.0.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ=
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1 h1:P7MR2UP6gNKGPp+y7EZw2kOiq4IR9WiqLvp0XOsVdwI=
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1/go.mod h1:XPHFku2tFo3o3QKFgSYo+cghcUhw1NA1hZyMK0PWAw0=
|
||||||
|
github.com/hashicorp/yamux v0.1.1 h1:yrQxtgseBDrq9Y652vSRDvsKCJKOUD+GzTS4Y0Y8pvE=
|
||||||
|
github.com/hashicorp/yamux v0.1.1/go.mod h1:CtWFDAQgb7dxtzFs4tWbplKIe2jSi3+5vKbgIO0SLnQ=
|
||||||
|
github.com/jhump/protoreflect v1.15.1 h1:HUMERORf3I3ZdX05WaQ6MIpd/NJ434hTp5YiKgfCL6c=
|
||||||
|
github.com/jhump/protoreflect v1.15.1/go.mod h1:jD/2GMKKE6OqX8qTjhADU1e6DShO+gavG9e0Q693nKo=
|
||||||
|
github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
|
||||||
|
github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
|
||||||
|
github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
|
||||||
|
github.com/mattn/go-isatty v0.0.10 h1:qxFzApOv4WsAL965uUPIsXzAKCZxN2p9UqdhFS4ZW10=
|
||||||
|
github.com/mattn/go-isatty v0.0.10/go.mod h1:qgIWMr58cqv1PHHyhnkY9lrL7etaEgOFcMEpPG5Rm84=
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77 h1:7GoSOOW2jpsfkntVKaS2rAr1TJqfcxotyaUcuxoZSzg=
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI=
|
||||||
|
github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw=
|
||||||
|
github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
|
||||||
|
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||||
|
golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
|
||||||
|
golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
|
||||||
|
golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
|
golang.org/x/sys v0.0.0-20191008105621-543471e840be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
|
||||||
|
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 h1:NnYq6UN9ReLM9/Y01KWNOWyI5xQ9kbIms5GGJVwS/Yc=
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY=
|
||||||
|
google.golang.org/grpc v1.64.0 h1:KH3VH9y/MgNQg1dE7b3XfVK0GsPSIzJwdF617gUSbvY=
|
||||||
|
google.golang.org/grpc v1.64.0/go.mod h1:oxjF8E3FBnjp+/gVFYdWacaLDx9na1aqy9oovLpxQYg=
|
||||||
|
google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
|
||||||
|
google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
|
|
@ -0,0 +1,7 @@
|
||||||
|
.PHONY: build
|
||||||
|
build:
|
||||||
|
cd ${name} && go build -o ../../pkg/${name} .
|
||||||
|
|
||||||
|
.PHONY: zltx
|
||||||
|
zltx:
|
||||||
|
make build name=zltx
|
|
@ -0,0 +1,40 @@
|
||||||
|
module plugins/zltx
|
||||||
|
|
||||||
|
go 1.21
|
||||||
|
|
||||||
|
replace plugins/sdk => ../../sdk
|
||||||
|
|
||||||
|
require (
|
||||||
|
codeup.aliyun.com/6552e56cc3b2728a4557fc18/plugin v0.0.0-20240701062026-8d942924410e
|
||||||
|
github.com/carlmjohnson/requests v0.23.5
|
||||||
|
github.com/go-playground/validator/v10 v10.22.0
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1
|
||||||
|
github.com/stretchr/testify v1.9.0
|
||||||
|
plugins/sdk v0.0.0-00010101000000-000000000000
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4 // indirect
|
||||||
|
github.com/fatih/color v1.7.0 // indirect
|
||||||
|
github.com/gabriel-vasile/mimetype v1.4.3 // indirect
|
||||||
|
github.com/go-playground/locales v0.14.1 // indirect
|
||||||
|
github.com/go-playground/universal-translator v0.18.1 // indirect
|
||||||
|
github.com/golang/protobuf v1.5.4 // indirect
|
||||||
|
github.com/hashicorp/go-hclog v0.14.1 // indirect
|
||||||
|
github.com/hashicorp/yamux v0.1.1 // indirect
|
||||||
|
github.com/leodido/go-urn v1.4.0 // indirect
|
||||||
|
github.com/mattn/go-colorable v0.1.4 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.10 // indirect
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77 // indirect
|
||||||
|
github.com/oklog/run v1.0.0 // indirect
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||||
|
golang.org/x/crypto v0.21.0 // indirect
|
||||||
|
golang.org/x/net v0.22.0 // indirect
|
||||||
|
golang.org/x/sys v0.18.0 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect
|
||||||
|
google.golang.org/grpc v1.64.0 // indirect
|
||||||
|
google.golang.org/protobuf v1.34.2 // indirect
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||||
|
)
|
|
@ -0,0 +1,70 @@
|
||||||
|
codeup.aliyun.com/6552e56cc3b2728a4557fc18/plugin v0.0.0-20240701062026-8d942924410e h1:1X0dk1OR8Zhf9gjZHRKpY7d/iYqX7UqMPqy8q+GxmXM=
|
||||||
|
codeup.aliyun.com/6552e56cc3b2728a4557fc18/plugin v0.0.0-20240701062026-8d942924410e/go.mod h1:QdW8HjHYQN8LCkFAB9e4oh7HziePCYnDXnUaKtmb8iQ=
|
||||||
|
github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA=
|
||||||
|
github.com/bufbuild/protocompile v0.4.0/go.mod h1:3v93+mbWn/v3xzN+31nwkJfrEpAUwp+BagBSZWx+TP8=
|
||||||
|
github.com/carlmjohnson/requests v0.23.5 h1:NPANcAofwwSuC6SIMwlgmHry2V3pLrSqRiSBKYbNHHA=
|
||||||
|
github.com/carlmjohnson/requests v0.23.5/go.mod h1:zG9P28thdRnN61aD7iECFhH5iGGKX2jIjKQD9kqYH+o=
|
||||||
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4 h1:gVPz/FMfvh57HdSJQyvBtF00j8JU4zdyUgIUNhlgg0A=
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4/go.mod h1:qys6tmnRsYrQqIhm2bvKZH4Blx/1gTIZ2UKVY1M+Yew=
|
||||||
|
github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
|
||||||
|
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
|
||||||
|
github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0=
|
||||||
|
github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk=
|
||||||
|
github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
|
||||||
|
github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
|
||||||
|
github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
|
||||||
|
github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
|
||||||
|
github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY=
|
||||||
|
github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
|
||||||
|
github.com/go-playground/validator/v10 v10.22.0 h1:k6HsTZ0sTnROkhS//R0O+55JgM8C4Bx7ia+JlgcnOao=
|
||||||
|
github.com/go-playground/validator/v10 v10.22.0/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM=
|
||||||
|
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
|
||||||
|
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
|
||||||
|
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||||
|
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
|
github.com/hashicorp/go-hclog v0.14.1 h1:nQcJDQwIAGnmoUWp8ubocEX40cCml/17YkF6csQLReU=
|
||||||
|
github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ=
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1 h1:P7MR2UP6gNKGPp+y7EZw2kOiq4IR9WiqLvp0XOsVdwI=
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1/go.mod h1:XPHFku2tFo3o3QKFgSYo+cghcUhw1NA1hZyMK0PWAw0=
|
||||||
|
github.com/hashicorp/yamux v0.1.1 h1:yrQxtgseBDrq9Y652vSRDvsKCJKOUD+GzTS4Y0Y8pvE=
|
||||||
|
github.com/hashicorp/yamux v0.1.1/go.mod h1:CtWFDAQgb7dxtzFs4tWbplKIe2jSi3+5vKbgIO0SLnQ=
|
||||||
|
github.com/jhump/protoreflect v1.15.1 h1:HUMERORf3I3ZdX05WaQ6MIpd/NJ434hTp5YiKgfCL6c=
|
||||||
|
github.com/jhump/protoreflect v1.15.1/go.mod h1:jD/2GMKKE6OqX8qTjhADU1e6DShO+gavG9e0Q693nKo=
|
||||||
|
github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ=
|
||||||
|
github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI=
|
||||||
|
github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
|
||||||
|
github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
|
||||||
|
github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
|
||||||
|
github.com/mattn/go-isatty v0.0.10 h1:qxFzApOv4WsAL965uUPIsXzAKCZxN2p9UqdhFS4ZW10=
|
||||||
|
github.com/mattn/go-isatty v0.0.10/go.mod h1:qgIWMr58cqv1PHHyhnkY9lrL7etaEgOFcMEpPG5Rm84=
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77 h1:7GoSOOW2jpsfkntVKaS2rAr1TJqfcxotyaUcuxoZSzg=
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI=
|
||||||
|
github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw=
|
||||||
|
github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||||
|
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
|
||||||
|
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||||
|
golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
|
||||||
|
golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
|
||||||
|
golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
|
||||||
|
golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
|
||||||
|
golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
|
golang.org/x/sys v0.0.0-20191008105621-543471e840be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
|
||||||
|
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 h1:NnYq6UN9ReLM9/Y01KWNOWyI5xQ9kbIms5GGJVwS/Yc=
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY=
|
||||||
|
google.golang.org/grpc v1.64.0 h1:KH3VH9y/MgNQg1dE7b3XfVK0GsPSIzJwdF617gUSbvY=
|
||||||
|
google.golang.org/grpc v1.64.0/go.mod h1:oxjF8E3FBnjp+/gVFYdWacaLDx9na1aqy9oovLpxQYg=
|
||||||
|
google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
|
||||||
|
google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
|
@ -0,0 +1,22 @@
|
||||||
|
package po
|
||||||
|
|
||||||
|
import "plugins/zltx/internal/vo"
|
||||||
|
|
||||||
|
type OrderReq struct {
|
||||||
|
Number uint32 `validate:"required"`
|
||||||
|
AccountType int `validate:"required"`
|
||||||
|
MerchantId string `validate:"required"`
|
||||||
|
OutTradeNo string `validate:"required"`
|
||||||
|
ProductId string `validate:"required"`
|
||||||
|
TimeStamp int64 `validate:"required"`
|
||||||
|
RechargeAccount string `validate:"required"`
|
||||||
|
NotifyUrl string `validate:"required"`
|
||||||
|
Version string `validate:"required"`
|
||||||
|
Sign string
|
||||||
|
}
|
||||||
|
|
||||||
|
type OrderResp struct {
|
||||||
|
Code any `json:"code"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
CodeStr vo.Code // 充值接口返回的请求码,可能是整数类型、浮点数类型、字符串,统一处理成字符串
|
||||||
|
}
|
|
@ -0,0 +1,33 @@
|
||||||
|
package po
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/go-playground/validator/v10"
|
||||||
|
"plugins/zltx/internal/vo"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Req interface {
|
||||||
|
Validate() error
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ Req = (*OrderReq)(nil)
|
||||||
|
|
||||||
|
func (req *OrderReq) Validate() error {
|
||||||
|
err := validator.New().Struct(req)
|
||||||
|
if err != nil {
|
||||||
|
for _, err = range err.(validator.ValidationErrors) {
|
||||||
|
return fmt.Errorf("参数有误:" + err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type Resp interface {
|
||||||
|
SetCodeStr()
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ Resp = (*OrderResp)(nil)
|
||||||
|
|
||||||
|
func (r *OrderResp) SetCodeStr() {
|
||||||
|
r.CodeStr = vo.Code(fmt.Sprintf("%v", r.Code))
|
||||||
|
}
|
|
@ -0,0 +1,35 @@
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
sdkproto "codeup.aliyun.com/6552e56cc3b2728a4557fc18/plugin/proto"
|
||||||
|
"encoding/json"
|
||||||
|
"plugins/zltx/internal/po"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func rechargeReq(c *sdkproto.OrderRequest) *po.OrderReq {
|
||||||
|
return &po.OrderReq{
|
||||||
|
MerchantId: c.Config.AppId,
|
||||||
|
OutTradeNo: c.Order.OrderNo,
|
||||||
|
ProductId: c.Product.ProductNo,
|
||||||
|
RechargeAccount: c.Order.Account,
|
||||||
|
AccountType: 1,
|
||||||
|
Number: 1,
|
||||||
|
Version: "1.0",
|
||||||
|
TimeStamp: time.Now().Unix(),
|
||||||
|
NotifyUrl: c.Config.NotifyUrl,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func rechargeResp(resp po.OrderResp) *sdkproto.OrderResponse {
|
||||||
|
data, _ := json.Marshal(resp)
|
||||||
|
return &sdkproto.OrderResponse{
|
||||||
|
Result: &sdkproto.Result{
|
||||||
|
Status: sdkproto.Status_ING,
|
||||||
|
OrderNo: "",
|
||||||
|
TradeNo: "",
|
||||||
|
Message: resp.Message,
|
||||||
|
Data: data,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,42 @@
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/md5"
|
||||||
|
"encoding/hex"
|
||||||
|
"net/url"
|
||||||
|
"plugins/sdk/utils"
|
||||||
|
"plugins/zltx/internal/po"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
func sign(values []byte) string {
|
||||||
|
hash := md5.Sum(values)
|
||||||
|
return strings.ToUpper(hex.EncodeToString(hash[:]))
|
||||||
|
}
|
||||||
|
|
||||||
|
func urlValues(req po.Req, appKey string) url.Values {
|
||||||
|
uv := url.Values{}
|
||||||
|
var kvStr []string
|
||||||
|
kvRows := utils.SortStruct(req)
|
||||||
|
for _, kv := range kvRows {
|
||||||
|
if kv.Key == "sign" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
uv.Set(kv.Key, kv.Value)
|
||||||
|
if kv.Key != "version" {
|
||||||
|
kvStr = append(kvStr, kv.Key+"="+kv.Value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
kvStr = append(kvStr, "key="+appKey)
|
||||||
|
signStr := strings.Join(kvStr, "&")
|
||||||
|
uv.Set("sign", sign([]byte(signStr)))
|
||||||
|
|
||||||
|
return uv
|
||||||
|
}
|
||||||
|
|
||||||
|
func req(req po.Req, appKey string) (url.Values, error) {
|
||||||
|
if err := req.Validate(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return urlValues(req, appKey), nil
|
||||||
|
}
|
|
@ -0,0 +1,38 @@
|
||||||
|
package vo
|
||||||
|
|
||||||
|
type Code string
|
||||||
|
|
||||||
|
const CodeSuccess Code = "0000"
|
||||||
|
const RechargeCodeSuccess Code = "2000"
|
||||||
|
|
||||||
|
var ResMessageMap = map[Code]string{
|
||||||
|
"1000": "Ip limit(ip未绑定或绑定失败)",
|
||||||
|
"1001": "Missing parameters(参数异常)",
|
||||||
|
"1002": "Invalid merchant(无效商户信息)",
|
||||||
|
"1003": "Invalid signature(签名校验失败)",
|
||||||
|
"1004": "Request expiration(请求时间过期)",
|
||||||
|
"1005": "Order repeat(订单重复)",
|
||||||
|
"1006": "Invalid item(商品未开通)",
|
||||||
|
"1007": "Item price invalid(商品价格无效)",
|
||||||
|
"1008": "Insufficient Balance(余额不足)",
|
||||||
|
"1009": "Interface adjustment(商品映射无效)",
|
||||||
|
"1010": "Interface price adjustment(映射价格无效)",
|
||||||
|
"1011": "Account format matching(充值账号格式不匹配)",
|
||||||
|
"1012": "no order(无订单信息)",
|
||||||
|
"1999": "unknown error(异常错误,建议人工处理或查询订单状态)",
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Code) IsRechargeSuccess() bool {
|
||||||
|
return c == RechargeCodeSuccess
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Code) GetMessage() string {
|
||||||
|
if message, ok := ResMessageMap[c]; ok {
|
||||||
|
return message
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Code) IsSuccess() bool {
|
||||||
|
return c == CodeSuccess
|
||||||
|
}
|
|
@ -0,0 +1,43 @@
|
||||||
|
package vo
|
||||||
|
|
||||||
|
import (
|
||||||
|
proto2 "plugins/sdk/proto"
|
||||||
|
)
|
||||||
|
|
||||||
|
type OrderStatus string
|
||||||
|
|
||||||
|
const (
|
||||||
|
OrderSuccess OrderStatus = "01" // 充值成功
|
||||||
|
OrderPending OrderStatus = "02" // 充值处理中
|
||||||
|
OrderFail OrderStatus = "03" // 充值失败
|
||||||
|
OrderAbnormal OrderStatus = "04" // 充值异常,处理中
|
||||||
|
)
|
||||||
|
|
||||||
|
var orderStatusMap = map[OrderStatus]proto2.Status{
|
||||||
|
OrderSuccess: proto2.Status_SUCCESS,
|
||||||
|
OrderPending: proto2.Status_ING,
|
||||||
|
OrderFail: proto2.Status_FAIL,
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o OrderStatus) IsSuccess() bool {
|
||||||
|
return o == OrderSuccess
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o OrderStatus) IsPending() bool {
|
||||||
|
return o == OrderPending
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o OrderStatus) IsFail() bool {
|
||||||
|
return o == OrderFail
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o OrderStatus) IsAbnormal() bool {
|
||||||
|
return o == OrderAbnormal
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o OrderStatus) GetOrderStatus() proto2.Status {
|
||||||
|
if resultStatus, ok := orderStatusMap[o]; ok {
|
||||||
|
return resultStatus
|
||||||
|
}
|
||||||
|
return proto2.Status_ING
|
||||||
|
}
|
|
@ -0,0 +1,59 @@
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
sdkproto "codeup.aliyun.com/6552e56cc3b2728a4557fc18/plugin/proto"
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"github.com/carlmjohnson/requests"
|
||||||
|
"plugins/zltx/internal/po"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
Tag = "zltx"
|
||||||
|
orderMethod = "/recharge/order"
|
||||||
|
queryMethod = "/recharge/query"
|
||||||
|
balanceMethod = "/recharge/info"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ZltxService struct {
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *ZltxService) Order(ctx context.Context, request *sdkproto.OrderRequest) (*sdkproto.OrderResponse, error) {
|
||||||
|
uv, err := req(rechargeReq(request), request.Config.AppKey)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var response po.OrderResp
|
||||||
|
err = requests.URL(request.Config.BaseUri + orderMethod).BodyForm(uv).ToJSON(&response).Fetch(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("请求异常,msg:" + err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
response.SetCodeStr()
|
||||||
|
if !response.CodeStr.IsRechargeSuccess() {
|
||||||
|
return nil, fmt.Errorf("请求错误,msg:" + response.Message)
|
||||||
|
}
|
||||||
|
|
||||||
|
return rechargeResp(response), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *ZltxService) Query(ctx context.Context, request *sdkproto.QueryRequest) (*sdkproto.QueryResponse, error) {
|
||||||
|
return &sdkproto.QueryResponse{Result: &sdkproto.Result{
|
||||||
|
Status: 0,
|
||||||
|
OrderNo: "111",
|
||||||
|
TradeNo: "111",
|
||||||
|
Message: "11111",
|
||||||
|
Data: nil,
|
||||||
|
}}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *ZltxService) Notify(ctx context.Context, request *sdkproto.NotifyRequest) (*sdkproto.NotifyResponse, error) {
|
||||||
|
return &sdkproto.NotifyResponse{Result: &sdkproto.Result{
|
||||||
|
Status: 0,
|
||||||
|
OrderNo: "11",
|
||||||
|
TradeNo: "112",
|
||||||
|
Message: "111",
|
||||||
|
Data: nil,
|
||||||
|
}}, nil
|
||||||
|
}
|
|
@ -0,0 +1,46 @@
|
||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"plugins/sdk/proto"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
var appKey = "8db16e8cc8363ed4eb4c14f9520bcc32"
|
||||||
|
var appId = "23329"
|
||||||
|
var baseUri = "http://test.openapi.1688sup.cn"
|
||||||
|
var notifyUrl = "http://test.openapi.1688sup.cn"
|
||||||
|
|
||||||
|
var lsxd = &ZltxService{}
|
||||||
|
|
||||||
|
func TestOrder(t *testing.T) {
|
||||||
|
request := &proto.OrderRequest{
|
||||||
|
Config: &proto.Config{
|
||||||
|
Name: "xxx",
|
||||||
|
AppId: appId,
|
||||||
|
AppKey: appKey,
|
||||||
|
BaseUri: baseUri,
|
||||||
|
NotifyUrl: notifyUrl,
|
||||||
|
},
|
||||||
|
Order: &proto.OrderRequest_Order{
|
||||||
|
OrderNo: "test_zltx_4",
|
||||||
|
Account: "18666666666",
|
||||||
|
Extra: nil,
|
||||||
|
},
|
||||||
|
Product: &proto.OrderRequest_Product{
|
||||||
|
ProductNo: "106",
|
||||||
|
Extra: []byte(`{}`),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
t.Run("TestOrder", func(t *testing.T) {
|
||||||
|
got, err := lsxd.Order(context.Background(), request)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Order() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Printf("%+v", got)
|
||||||
|
assert.Equal(t, int(proto.Status_ING), int(got.Result.Status))
|
||||||
|
})
|
||||||
|
}
|
|
@ -0,0 +1,16 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
sdkshared "codeup.aliyun.com/6552e56cc3b2728a4557fc18/plugin/shared"
|
||||||
|
"github.com/hashicorp/go-plugin"
|
||||||
|
"plugins/sdk/shared"
|
||||||
|
"plugins/zltx/internal"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
plugin.Serve(&plugin.ServeConfig{
|
||||||
|
HandshakeConfig: shared.Handshake,
|
||||||
|
Plugins: sdkshared.PluginSet(sdkshared.NewPlugin(&internal.ZltxService{}, internal.Tag)),
|
||||||
|
GRPCServer: plugin.DefaultGRPCServer,
|
||||||
|
})
|
||||||
|
}
|
|
@ -0,0 +1,39 @@
|
||||||
|
GOHOSTOS:=$(shell go env GOHOSTOS)
|
||||||
|
GOPATH:=$(shell go env GOPATH)
|
||||||
|
|
||||||
|
ifeq ($(GOHOSTOS), windows)
|
||||||
|
Git_Bash=$(subst \,/,$(subst cmd\,bin\bash.exe,$(dir $(shell where git | grep cmd))))
|
||||||
|
PROTO_FILES=$(shell $(Git_Bash) -c "find proto -name *.proto")
|
||||||
|
else
|
||||||
|
PROTO_FILES=$(shell find proto -name *.proto)
|
||||||
|
endif
|
||||||
|
|
||||||
|
.PHONY: proto
|
||||||
|
# generate proto
|
||||||
|
proto:
|
||||||
|
protoc --proto_path=./ \
|
||||||
|
--proto_path=./proto \
|
||||||
|
--proto_path=./third_party \
|
||||||
|
--go_out=paths=source_relative:./ \
|
||||||
|
--go-http_out=paths=source_relative:./ \
|
||||||
|
--go-grpc_out=paths=source_relative:./ \
|
||||||
|
--validate_out=paths=source_relative,lang=go:./ \
|
||||||
|
--go-errors_out=paths=source_relative:./ \
|
||||||
|
$(PROTO_FILES)
|
||||||
|
|
||||||
|
# show help
|
||||||
|
help:
|
||||||
|
@echo ''
|
||||||
|
@echo 'Usage:'
|
||||||
|
@echo ' make [target]'
|
||||||
|
@echo ''
|
||||||
|
@echo 'Targets:'
|
||||||
|
@awk '/^[a-zA-Z\-\_0-9]+:/ { \
|
||||||
|
helpMessage = match(lastLine, /^# (.*)/); \
|
||||||
|
if (helpMessage) { \
|
||||||
|
helpCommand = substr($$1, 0, index($$1, ":")-1); \
|
||||||
|
helpMessage = substr(lastLine, RSTART + 2, RLENGTH); \
|
||||||
|
printf "\033[36m%-22s\033[0m %s\n", helpCommand,helpMessage; \
|
||||||
|
} \
|
||||||
|
} \
|
||||||
|
{ lastLine = $$0 }' $(MAKEFILE_LIST)
|
|
@ -0,0 +1,25 @@
|
||||||
|
module plugins/sdk
|
||||||
|
|
||||||
|
go 1.21
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1
|
||||||
|
google.golang.org/grpc v1.64.0
|
||||||
|
google.golang.org/protobuf v1.34.2
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/fatih/color v1.7.0 // indirect
|
||||||
|
github.com/golang/protobuf v1.5.4 // indirect
|
||||||
|
github.com/hashicorp/go-hclog v0.14.1 // indirect
|
||||||
|
github.com/hashicorp/yamux v0.1.1 // indirect
|
||||||
|
github.com/mattn/go-colorable v0.1.4 // indirect
|
||||||
|
github.com/mattn/go-isatty v0.0.10 // indirect
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77 // indirect
|
||||||
|
github.com/oklog/run v1.0.0 // indirect
|
||||||
|
golang.org/x/net v0.22.0 // indirect
|
||||||
|
golang.org/x/sys v0.18.0 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect
|
||||||
|
)
|
|
@ -0,0 +1,47 @@
|
||||||
|
github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA=
|
||||||
|
github.com/bufbuild/protocompile v0.4.0/go.mod h1:3v93+mbWn/v3xzN+31nwkJfrEpAUwp+BagBSZWx+TP8=
|
||||||
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4 h1:gVPz/FMfvh57HdSJQyvBtF00j8JU4zdyUgIUNhlgg0A=
|
||||||
|
github.com/envoyproxy/protoc-gen-validate v1.0.4/go.mod h1:qys6tmnRsYrQqIhm2bvKZH4Blx/1gTIZ2UKVY1M+Yew=
|
||||||
|
github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
|
||||||
|
github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
|
||||||
|
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
|
||||||
|
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
|
||||||
|
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||||
|
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||||
|
github.com/hashicorp/go-hclog v0.14.1 h1:nQcJDQwIAGnmoUWp8ubocEX40cCml/17YkF6csQLReU=
|
||||||
|
github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ=
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1 h1:P7MR2UP6gNKGPp+y7EZw2kOiq4IR9WiqLvp0XOsVdwI=
|
||||||
|
github.com/hashicorp/go-plugin v1.6.1/go.mod h1:XPHFku2tFo3o3QKFgSYo+cghcUhw1NA1hZyMK0PWAw0=
|
||||||
|
github.com/hashicorp/yamux v0.1.1 h1:yrQxtgseBDrq9Y652vSRDvsKCJKOUD+GzTS4Y0Y8pvE=
|
||||||
|
github.com/hashicorp/yamux v0.1.1/go.mod h1:CtWFDAQgb7dxtzFs4tWbplKIe2jSi3+5vKbgIO0SLnQ=
|
||||||
|
github.com/jhump/protoreflect v1.15.1 h1:HUMERORf3I3ZdX05WaQ6MIpd/NJ434hTp5YiKgfCL6c=
|
||||||
|
github.com/jhump/protoreflect v1.15.1/go.mod h1:jD/2GMKKE6OqX8qTjhADU1e6DShO+gavG9e0Q693nKo=
|
||||||
|
github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
|
||||||
|
github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
|
||||||
|
github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
|
||||||
|
github.com/mattn/go-isatty v0.0.10 h1:qxFzApOv4WsAL965uUPIsXzAKCZxN2p9UqdhFS4ZW10=
|
||||||
|
github.com/mattn/go-isatty v0.0.10/go.mod h1:qgIWMr58cqv1PHHyhnkY9lrL7etaEgOFcMEpPG5Rm84=
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77 h1:7GoSOOW2jpsfkntVKaS2rAr1TJqfcxotyaUcuxoZSzg=
|
||||||
|
github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI=
|
||||||
|
github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw=
|
||||||
|
github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
|
||||||
|
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||||
|
golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
|
||||||
|
golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
|
||||||
|
golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
|
golang.org/x/sys v0.0.0-20191008105621-543471e840be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
|
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
|
||||||
|
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 h1:NnYq6UN9ReLM9/Y01KWNOWyI5xQ9kbIms5GGJVwS/Yc=
|
||||||
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY=
|
||||||
|
google.golang.org/grpc v1.64.0 h1:KH3VH9y/MgNQg1dE7b3XfVK0GsPSIzJwdF617gUSbvY=
|
||||||
|
google.golang.org/grpc v1.64.0/go.mod h1:oxjF8E3FBnjp+/gVFYdWacaLDx9na1aqy9oovLpxQYg=
|
||||||
|
google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
|
||||||
|
google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
|
|
@ -0,0 +1,65 @@
|
||||||
|
package instance
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/hashicorp/go-plugin"
|
||||||
|
"os/exec"
|
||||||
|
"plugins/sdk/shared"
|
||||||
|
)
|
||||||
|
|
||||||
|
type PkgConf struct {
|
||||||
|
Cmd string // 插件的执行路径
|
||||||
|
Tag string // 插件的tag,对应插件
|
||||||
|
}
|
||||||
|
|
||||||
|
var ManageMap manage
|
||||||
|
|
||||||
|
// Get 获取服务
|
||||||
|
func Get(tag string) shared.PluginService {
|
||||||
|
if _, ok := ManageMap[tag]; ok {
|
||||||
|
return ManageMap[tag].service
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func Load(load []*PkgConf) error {
|
||||||
|
ManageMap = make(manage)
|
||||||
|
for _, v := range load {
|
||||||
|
srv, err := service(v.Cmd, v.Tag)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
err = ManageMap.add(server{
|
||||||
|
tag: v.Tag,
|
||||||
|
service: srv,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func service(cmd, tag string) (shared.PluginService, error) {
|
||||||
|
pluginClientConfig := &plugin.ClientConfig{
|
||||||
|
HandshakeConfig: shared.Handshake,
|
||||||
|
Cmd: exec.Command(cmd),
|
||||||
|
Plugins: map[string]plugin.Plugin{tag: &shared.GRPCPlugin{}},
|
||||||
|
AllowedProtocols: []plugin.Protocol{plugin.ProtocolGRPC},
|
||||||
|
}
|
||||||
|
|
||||||
|
client := plugin.NewClient(pluginClientConfig)
|
||||||
|
pluginClientConfig.Reattach = client.ReattachConfig()
|
||||||
|
protocol, err := client.Client()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("plugin.NewClient err:%v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
raw, err := protocol.Dispense(tag)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("protocol.Dispense err:%v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 类型断言为PluginService接口
|
||||||
|
return raw.(shared.PluginService), nil
|
||||||
|
}
|
|
@ -0,0 +1,49 @@
|
||||||
|
package instance
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"plugins/sdk/proto"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestLoad(t *testing.T) {
|
||||||
|
load := []*PkgConf{
|
||||||
|
{
|
||||||
|
Cmd: "pkg/zltx",
|
||||||
|
Tag: "zltx",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
if err := Load(load); err != nil {
|
||||||
|
t.Errorf("Load() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
srv := Get("zltx")
|
||||||
|
if srv == nil {
|
||||||
|
t.Errorf("Get() is nill")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
request := &proto.OrderRequest{
|
||||||
|
Config: &proto.Config{
|
||||||
|
AppId: "",
|
||||||
|
AppKey: "",
|
||||||
|
BaseUri: "",
|
||||||
|
NotifyUrl: "",
|
||||||
|
},
|
||||||
|
Order: &proto.OrderRequest_Order{
|
||||||
|
OrderNo: "zltx_" + time.Now().Format("20060102150405"),
|
||||||
|
Account: "18666666666",
|
||||||
|
Extra: nil,
|
||||||
|
},
|
||||||
|
Product: &proto.OrderRequest_Product{
|
||||||
|
ProductNo: "106",
|
||||||
|
Extra: []byte(`{}`),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
result, err := srv.Order(context.Background(), request)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Order() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
t.Logf("Order() result = %v", result)
|
||||||
|
}
|
|
@ -0,0 +1,21 @@
|
||||||
|
package instance
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"plugins/sdk/shared"
|
||||||
|
)
|
||||||
|
|
||||||
|
type server struct {
|
||||||
|
tag string
|
||||||
|
service shared.PluginService
|
||||||
|
}
|
||||||
|
|
||||||
|
type manage map[string]server
|
||||||
|
|
||||||
|
func (m manage) add(p server) error {
|
||||||
|
if _, ok := m[p.tag]; ok {
|
||||||
|
return fmt.Errorf("%s %s", p.tag, "插件已存在")
|
||||||
|
}
|
||||||
|
m[p.tag] = p
|
||||||
|
return nil
|
||||||
|
}
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,949 @@
|
||||||
|
// Code generated by protoc-gen-validate. DO NOT EDIT.
|
||||||
|
// source: proto/plugin.proto
|
||||||
|
|
||||||
|
package proto
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"net/mail"
|
||||||
|
"net/url"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
"unicode/utf8"
|
||||||
|
|
||||||
|
"google.golang.org/protobuf/types/known/anypb"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ensure the imports are used
|
||||||
|
var (
|
||||||
|
_ = bytes.MinRead
|
||||||
|
_ = errors.New("")
|
||||||
|
_ = fmt.Print
|
||||||
|
_ = utf8.UTFMax
|
||||||
|
_ = (*regexp.Regexp)(nil)
|
||||||
|
_ = (*strings.Reader)(nil)
|
||||||
|
_ = net.IPv4len
|
||||||
|
_ = time.Duration(0)
|
||||||
|
_ = (*url.URL)(nil)
|
||||||
|
_ = (*mail.Address)(nil)
|
||||||
|
_ = anypb.Any{}
|
||||||
|
)
|
||||||
|
|
||||||
|
// Validate checks the field values on Empty with the rules defined in the
|
||||||
|
// proto definition for this message. If any rules are violated, an error is returned.
|
||||||
|
func (m *Empty) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EmptyValidationError is the validation error returned by Empty.Validate if
|
||||||
|
// the designated constraints aren't met.
|
||||||
|
type EmptyValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e EmptyValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e EmptyValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e EmptyValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e EmptyValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e EmptyValidationError) ErrorName() string { return "EmptyValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e EmptyValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sEmpty.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = EmptyValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = EmptyValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on Config with the rules defined in the
|
||||||
|
// proto definition for this message. If any rules are violated, an error is returned.
|
||||||
|
func (m *Config) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if utf8.RuneCountInString(m.GetAppId()) < 1 {
|
||||||
|
return ConfigValidationError{
|
||||||
|
field: "AppId",
|
||||||
|
reason: "value length must be at least 1 runes",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if utf8.RuneCountInString(m.GetAppKey()) < 1 {
|
||||||
|
return ConfigValidationError{
|
||||||
|
field: "AppKey",
|
||||||
|
reason: "value length must be at least 1 runes",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no validation rules for BaseUri
|
||||||
|
|
||||||
|
// no validation rules for NotifyUrl
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConfigValidationError is the validation error returned by Config.Validate if
|
||||||
|
// the designated constraints aren't met.
|
||||||
|
type ConfigValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e ConfigValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e ConfigValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e ConfigValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e ConfigValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e ConfigValidationError) ErrorName() string { return "ConfigValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e ConfigValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sConfig.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = ConfigValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = ConfigValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on Result with the rules defined in the
|
||||||
|
// proto definition for this message. If any rules are violated, an error is returned.
|
||||||
|
func (m *Result) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// no validation rules for Status
|
||||||
|
|
||||||
|
// no validation rules for OrderNo
|
||||||
|
|
||||||
|
// no validation rules for TradeNo
|
||||||
|
|
||||||
|
// no validation rules for Message
|
||||||
|
|
||||||
|
// no validation rules for Data
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ResultValidationError is the validation error returned by Result.Validate if
|
||||||
|
// the designated constraints aren't met.
|
||||||
|
type ResultValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e ResultValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e ResultValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e ResultValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e ResultValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e ResultValidationError) ErrorName() string { return "ResultValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e ResultValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sResult.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = ResultValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = ResultValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on OrderRequest with the rules defined in
|
||||||
|
// the proto definition for this message. If any rules are violated, an error
|
||||||
|
// is returned.
|
||||||
|
func (m *OrderRequest) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetConfig()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return OrderRequestValidationError{
|
||||||
|
field: "Config",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetOrder()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return OrderRequestValidationError{
|
||||||
|
field: "Order",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetProduct()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return OrderRequestValidationError{
|
||||||
|
field: "Product",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OrderRequestValidationError is the validation error returned by
|
||||||
|
// OrderRequest.Validate if the designated constraints aren't met.
|
||||||
|
type OrderRequestValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e OrderRequestValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e OrderRequestValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e OrderRequestValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e OrderRequestValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e OrderRequestValidationError) ErrorName() string { return "OrderRequestValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e OrderRequestValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sOrderRequest.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = OrderRequestValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = OrderRequestValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on OrderResponse with the rules defined in
|
||||||
|
// the proto definition for this message. If any rules are violated, an error
|
||||||
|
// is returned.
|
||||||
|
func (m *OrderResponse) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetResult()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return OrderResponseValidationError{
|
||||||
|
field: "Result",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OrderResponseValidationError is the validation error returned by
|
||||||
|
// OrderResponse.Validate if the designated constraints aren't met.
|
||||||
|
type OrderResponseValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e OrderResponseValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e OrderResponseValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e OrderResponseValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e OrderResponseValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e OrderResponseValidationError) ErrorName() string { return "OrderResponseValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e OrderResponseValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sOrderResponse.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = OrderResponseValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = OrderResponseValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on QueryRequest with the rules defined in
|
||||||
|
// the proto definition for this message. If any rules are violated, an error
|
||||||
|
// is returned.
|
||||||
|
func (m *QueryRequest) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetConfig()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return QueryRequestValidationError{
|
||||||
|
field: "Config",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryRequestValidationError is the validation error returned by
|
||||||
|
// QueryRequest.Validate if the designated constraints aren't met.
|
||||||
|
type QueryRequestValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e QueryRequestValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e QueryRequestValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e QueryRequestValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e QueryRequestValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e QueryRequestValidationError) ErrorName() string { return "QueryRequestValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e QueryRequestValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sQueryRequest.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = QueryRequestValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = QueryRequestValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on QueryResponse with the rules defined in
|
||||||
|
// the proto definition for this message. If any rules are violated, an error
|
||||||
|
// is returned.
|
||||||
|
func (m *QueryResponse) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetResult()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return QueryResponseValidationError{
|
||||||
|
field: "Result",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryResponseValidationError is the validation error returned by
|
||||||
|
// QueryResponse.Validate if the designated constraints aren't met.
|
||||||
|
type QueryResponseValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e QueryResponseValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e QueryResponseValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e QueryResponseValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e QueryResponseValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e QueryResponseValidationError) ErrorName() string { return "QueryResponseValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e QueryResponseValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sQueryResponse.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = QueryResponseValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = QueryResponseValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on NotifyRequest with the rules defined in
|
||||||
|
// the proto definition for this message. If any rules are violated, an error
|
||||||
|
// is returned.
|
||||||
|
func (m *NotifyRequest) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetConfig()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return NotifyRequestValidationError{
|
||||||
|
field: "Config",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no validation rules for Queries
|
||||||
|
|
||||||
|
// no validation rules for Headers
|
||||||
|
|
||||||
|
// no validation rules for Body
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotifyRequestValidationError is the validation error returned by
|
||||||
|
// NotifyRequest.Validate if the designated constraints aren't met.
|
||||||
|
type NotifyRequestValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e NotifyRequestValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e NotifyRequestValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e NotifyRequestValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e NotifyRequestValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e NotifyRequestValidationError) ErrorName() string { return "NotifyRequestValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e NotifyRequestValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sNotifyRequest.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = NotifyRequestValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = NotifyRequestValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on NotifyResponse with the rules defined in
|
||||||
|
// the proto definition for this message. If any rules are violated, an error
|
||||||
|
// is returned.
|
||||||
|
func (m *NotifyResponse) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := interface{}(m.GetResult()).(interface{ Validate() error }); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return NotifyResponseValidationError{
|
||||||
|
field: "Result",
|
||||||
|
reason: "embedded message failed validation",
|
||||||
|
cause: err,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotifyResponseValidationError is the validation error returned by
|
||||||
|
// NotifyResponse.Validate if the designated constraints aren't met.
|
||||||
|
type NotifyResponseValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e NotifyResponseValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e NotifyResponseValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e NotifyResponseValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e NotifyResponseValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e NotifyResponseValidationError) ErrorName() string { return "NotifyResponseValidationError" }
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e NotifyResponseValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sNotifyResponse.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = NotifyResponseValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = NotifyResponseValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on OrderRequest_Order with the rules
|
||||||
|
// defined in the proto definition for this message. If any rules are
|
||||||
|
// violated, an error is returned.
|
||||||
|
func (m *OrderRequest_Order) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// no validation rules for OrderNo
|
||||||
|
|
||||||
|
// no validation rules for Account
|
||||||
|
|
||||||
|
// no validation rules for Extra
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OrderRequest_OrderValidationError is the validation error returned by
|
||||||
|
// OrderRequest_Order.Validate if the designated constraints aren't met.
|
||||||
|
type OrderRequest_OrderValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e OrderRequest_OrderValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e OrderRequest_OrderValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e OrderRequest_OrderValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e OrderRequest_OrderValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e OrderRequest_OrderValidationError) ErrorName() string {
|
||||||
|
return "OrderRequest_OrderValidationError"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e OrderRequest_OrderValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sOrderRequest_Order.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = OrderRequest_OrderValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = OrderRequest_OrderValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on OrderRequest_Product with the rules
|
||||||
|
// defined in the proto definition for this message. If any rules are
|
||||||
|
// violated, an error is returned.
|
||||||
|
func (m *OrderRequest_Product) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// no validation rules for ProductNo
|
||||||
|
|
||||||
|
// no validation rules for Price
|
||||||
|
|
||||||
|
// no validation rules for Extra
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OrderRequest_ProductValidationError is the validation error returned by
|
||||||
|
// OrderRequest_Product.Validate if the designated constraints aren't met.
|
||||||
|
type OrderRequest_ProductValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e OrderRequest_ProductValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e OrderRequest_ProductValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e OrderRequest_ProductValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e OrderRequest_ProductValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e OrderRequest_ProductValidationError) ErrorName() string {
|
||||||
|
return "OrderRequest_ProductValidationError"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e OrderRequest_ProductValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sOrderRequest_Product.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = OrderRequest_ProductValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = OrderRequest_ProductValidationError{}
|
||||||
|
|
||||||
|
// Validate checks the field values on QueryRequest_Request with the rules
|
||||||
|
// defined in the proto definition for this message. If any rules are
|
||||||
|
// violated, an error is returned.
|
||||||
|
func (m *QueryRequest_Request) Validate() error {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// no validation rules for OrderNo
|
||||||
|
|
||||||
|
// no validation rules for TradeNo
|
||||||
|
|
||||||
|
// no validation rules for Extra
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryRequest_RequestValidationError is the validation error returned by
|
||||||
|
// QueryRequest_Request.Validate if the designated constraints aren't met.
|
||||||
|
type QueryRequest_RequestValidationError struct {
|
||||||
|
field string
|
||||||
|
reason string
|
||||||
|
cause error
|
||||||
|
key bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field function returns field value.
|
||||||
|
func (e QueryRequest_RequestValidationError) Field() string { return e.field }
|
||||||
|
|
||||||
|
// Reason function returns reason value.
|
||||||
|
func (e QueryRequest_RequestValidationError) Reason() string { return e.reason }
|
||||||
|
|
||||||
|
// Cause function returns cause value.
|
||||||
|
func (e QueryRequest_RequestValidationError) Cause() error { return e.cause }
|
||||||
|
|
||||||
|
// Key function returns key value.
|
||||||
|
func (e QueryRequest_RequestValidationError) Key() bool { return e.key }
|
||||||
|
|
||||||
|
// ErrorName returns error name.
|
||||||
|
func (e QueryRequest_RequestValidationError) ErrorName() string {
|
||||||
|
return "QueryRequest_RequestValidationError"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error satisfies the builtin error interface
|
||||||
|
func (e QueryRequest_RequestValidationError) Error() string {
|
||||||
|
cause := ""
|
||||||
|
if e.cause != nil {
|
||||||
|
cause = fmt.Sprintf(" | caused by: %v", e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
key := ""
|
||||||
|
if e.key {
|
||||||
|
key = "key for "
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"invalid %sQueryRequest_Request.%s: %s%s",
|
||||||
|
key,
|
||||||
|
e.field,
|
||||||
|
e.reason,
|
||||||
|
cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = QueryRequest_RequestValidationError{}
|
||||||
|
|
||||||
|
var _ interface {
|
||||||
|
Field() string
|
||||||
|
Reason() string
|
||||||
|
Key() bool
|
||||||
|
Cause() error
|
||||||
|
ErrorName() string
|
||||||
|
} = QueryRequest_RequestValidationError{}
|
|
@ -0,0 +1,77 @@
|
||||||
|
syntax = "proto3";
|
||||||
|
option go_package = "plugins/proto";
|
||||||
|
|
||||||
|
import "validate/validate.proto";
|
||||||
|
|
||||||
|
package proto;
|
||||||
|
|
||||||
|
message Empty {}
|
||||||
|
|
||||||
|
service Plugin {
|
||||||
|
rpc Order (OrderRequest) returns (OrderResponse) {}
|
||||||
|
rpc Query (QueryRequest) returns (QueryResponse) {}
|
||||||
|
rpc Notify (NotifyRequest) returns (NotifyResponse) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
message Config{
|
||||||
|
string appId = 2 [(validate.rules).string = {min_len: 1}];
|
||||||
|
string appKey = 3 [(validate.rules).string = {min_len: 1}];
|
||||||
|
string baseUri = 4;
|
||||||
|
string notifyUrl = 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
enum Status{
|
||||||
|
INVALID = 0; // 无效的状态
|
||||||
|
SUCCESS = 1; // 成功
|
||||||
|
ING = 2; // 处理中
|
||||||
|
FAIL = 3; // 失败
|
||||||
|
}
|
||||||
|
|
||||||
|
message Result {
|
||||||
|
Status status = 1;
|
||||||
|
string order_no = 2;
|
||||||
|
string trade_no = 3;
|
||||||
|
string message = 4;
|
||||||
|
bytes data = 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
message OrderRequest{
|
||||||
|
Config config = 1;
|
||||||
|
message Order {
|
||||||
|
string order_no = 1;
|
||||||
|
string account = 2;
|
||||||
|
bytes extra = 3; // extra 其他的拓展参数 json 格式
|
||||||
|
};
|
||||||
|
message Product {
|
||||||
|
string product_no = 1;
|
||||||
|
float price = 2;
|
||||||
|
bytes extra = 3; // extra 其他的拓展参数 json 格式
|
||||||
|
}
|
||||||
|
Order order = 2;
|
||||||
|
Product product = 3;
|
||||||
|
}
|
||||||
|
message OrderResponse{
|
||||||
|
Result result = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message QueryRequest{
|
||||||
|
Config config = 1;
|
||||||
|
message Request {
|
||||||
|
string order_no = 1;
|
||||||
|
string trade_no = 2;
|
||||||
|
bytes extra = 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
message QueryResponse{
|
||||||
|
Result result = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message NotifyRequest{
|
||||||
|
Config config = 1;
|
||||||
|
bytes queries = 2; // url 地址中的参数 json
|
||||||
|
bytes headers = 3; // header 头里面的参数 json
|
||||||
|
bytes body = 4; // 通过 form 表单或者 body 提交的数据 json
|
||||||
|
}
|
||||||
|
message NotifyResponse{
|
||||||
|
Result result = 1;
|
||||||
|
}
|
|
@ -0,0 +1,183 @@
|
||||||
|
// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
|
||||||
|
// versions:
|
||||||
|
// - protoc-gen-go-grpc v1.3.0
|
||||||
|
// - protoc v4.24.3
|
||||||
|
// source: proto/plugin.proto
|
||||||
|
|
||||||
|
package proto
|
||||||
|
|
||||||
|
import (
|
||||||
|
context "context"
|
||||||
|
grpc "google.golang.org/grpc"
|
||||||
|
codes "google.golang.org/grpc/codes"
|
||||||
|
status "google.golang.org/grpc/status"
|
||||||
|
)
|
||||||
|
|
||||||
|
// This is a compile-time assertion to ensure that this generated file
|
||||||
|
// is compatible with the grpc package it is being compiled against.
|
||||||
|
// Requires gRPC-Go v1.32.0 or later.
|
||||||
|
const _ = grpc.SupportPackageIsVersion7
|
||||||
|
|
||||||
|
const (
|
||||||
|
Plugin_Order_FullMethodName = "/proto.Plugin/Order"
|
||||||
|
Plugin_Query_FullMethodName = "/proto.Plugin/Query"
|
||||||
|
Plugin_Notify_FullMethodName = "/proto.Plugin/Notify"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PluginClient is the client API for Plugin service.
|
||||||
|
//
|
||||||
|
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
|
||||||
|
type PluginClient interface {
|
||||||
|
Order(ctx context.Context, in *OrderRequest, opts ...grpc.CallOption) (*OrderResponse, error)
|
||||||
|
Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
|
||||||
|
Notify(ctx context.Context, in *NotifyRequest, opts ...grpc.CallOption) (*NotifyResponse, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type pluginClient struct {
|
||||||
|
cc grpc.ClientConnInterface
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewPluginClient(cc grpc.ClientConnInterface) PluginClient {
|
||||||
|
return &pluginClient{cc}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *pluginClient) Order(ctx context.Context, in *OrderRequest, opts ...grpc.CallOption) (*OrderResponse, error) {
|
||||||
|
out := new(OrderResponse)
|
||||||
|
err := c.cc.Invoke(ctx, Plugin_Order_FullMethodName, in, out, opts...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *pluginClient) Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error) {
|
||||||
|
out := new(QueryResponse)
|
||||||
|
err := c.cc.Invoke(ctx, Plugin_Query_FullMethodName, in, out, opts...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *pluginClient) Notify(ctx context.Context, in *NotifyRequest, opts ...grpc.CallOption) (*NotifyResponse, error) {
|
||||||
|
out := new(NotifyResponse)
|
||||||
|
err := c.cc.Invoke(ctx, Plugin_Notify_FullMethodName, in, out, opts...)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// PluginServer is the server API for Plugin service.
|
||||||
|
// All implementations must embed UnimplementedPluginServer
|
||||||
|
// for forward compatibility
|
||||||
|
type PluginServer interface {
|
||||||
|
Order(context.Context, *OrderRequest) (*OrderResponse, error)
|
||||||
|
Query(context.Context, *QueryRequest) (*QueryResponse, error)
|
||||||
|
Notify(context.Context, *NotifyRequest) (*NotifyResponse, error)
|
||||||
|
mustEmbedUnimplementedPluginServer()
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnimplementedPluginServer must be embedded to have forward compatible implementations.
|
||||||
|
type UnimplementedPluginServer struct {
|
||||||
|
}
|
||||||
|
|
||||||
|
func (UnimplementedPluginServer) Order(context.Context, *OrderRequest) (*OrderResponse, error) {
|
||||||
|
return nil, status.Errorf(codes.Unimplemented, "method Order not implemented")
|
||||||
|
}
|
||||||
|
func (UnimplementedPluginServer) Query(context.Context, *QueryRequest) (*QueryResponse, error) {
|
||||||
|
return nil, status.Errorf(codes.Unimplemented, "method Query not implemented")
|
||||||
|
}
|
||||||
|
func (UnimplementedPluginServer) Notify(context.Context, *NotifyRequest) (*NotifyResponse, error) {
|
||||||
|
return nil, status.Errorf(codes.Unimplemented, "method Notify not implemented")
|
||||||
|
}
|
||||||
|
func (UnimplementedPluginServer) mustEmbedUnimplementedPluginServer() {}
|
||||||
|
|
||||||
|
// UnsafePluginServer may be embedded to opt out of forward compatibility for this service.
|
||||||
|
// Use of this interface is not recommended, as added methods to PluginServer will
|
||||||
|
// result in compilation errors.
|
||||||
|
type UnsafePluginServer interface {
|
||||||
|
mustEmbedUnimplementedPluginServer()
|
||||||
|
}
|
||||||
|
|
||||||
|
func RegisterPluginServer(s grpc.ServiceRegistrar, srv PluginServer) {
|
||||||
|
s.RegisterService(&Plugin_ServiceDesc, srv)
|
||||||
|
}
|
||||||
|
|
||||||
|
func _Plugin_Order_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
|
||||||
|
in := new(OrderRequest)
|
||||||
|
if err := dec(in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if interceptor == nil {
|
||||||
|
return srv.(PluginServer).Order(ctx, in)
|
||||||
|
}
|
||||||
|
info := &grpc.UnaryServerInfo{
|
||||||
|
Server: srv,
|
||||||
|
FullMethod: Plugin_Order_FullMethodName,
|
||||||
|
}
|
||||||
|
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
|
||||||
|
return srv.(PluginServer).Order(ctx, req.(*OrderRequest))
|
||||||
|
}
|
||||||
|
return interceptor(ctx, in, info, handler)
|
||||||
|
}
|
||||||
|
|
||||||
|
func _Plugin_Query_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
|
||||||
|
in := new(QueryRequest)
|
||||||
|
if err := dec(in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if interceptor == nil {
|
||||||
|
return srv.(PluginServer).Query(ctx, in)
|
||||||
|
}
|
||||||
|
info := &grpc.UnaryServerInfo{
|
||||||
|
Server: srv,
|
||||||
|
FullMethod: Plugin_Query_FullMethodName,
|
||||||
|
}
|
||||||
|
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
|
||||||
|
return srv.(PluginServer).Query(ctx, req.(*QueryRequest))
|
||||||
|
}
|
||||||
|
return interceptor(ctx, in, info, handler)
|
||||||
|
}
|
||||||
|
|
||||||
|
func _Plugin_Notify_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
|
||||||
|
in := new(NotifyRequest)
|
||||||
|
if err := dec(in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if interceptor == nil {
|
||||||
|
return srv.(PluginServer).Notify(ctx, in)
|
||||||
|
}
|
||||||
|
info := &grpc.UnaryServerInfo{
|
||||||
|
Server: srv,
|
||||||
|
FullMethod: Plugin_Notify_FullMethodName,
|
||||||
|
}
|
||||||
|
handler := func(ctx context.Context, req interface{}) (interface{}, error) {
|
||||||
|
return srv.(PluginServer).Notify(ctx, req.(*NotifyRequest))
|
||||||
|
}
|
||||||
|
return interceptor(ctx, in, info, handler)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Plugin_ServiceDesc is the grpc.ServiceDesc for Plugin service.
|
||||||
|
// It's only intended for direct use with grpc.RegisterService,
|
||||||
|
// and not to be introspected or modified (even as a copy)
|
||||||
|
var Plugin_ServiceDesc = grpc.ServiceDesc{
|
||||||
|
ServiceName: "proto.Plugin",
|
||||||
|
HandlerType: (*PluginServer)(nil),
|
||||||
|
Methods: []grpc.MethodDesc{
|
||||||
|
{
|
||||||
|
MethodName: "Order",
|
||||||
|
Handler: _Plugin_Order_Handler,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
MethodName: "Query",
|
||||||
|
Handler: _Plugin_Query_Handler,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
MethodName: "Notify",
|
||||||
|
Handler: _Plugin_Notify_Handler,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
Streams: []grpc.StreamDesc{},
|
||||||
|
Metadata: "proto/plugin.proto",
|
||||||
|
}
|
|
@ -0,0 +1,84 @@
|
||||||
|
package shared
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"github.com/hashicorp/go-plugin"
|
||||||
|
"google.golang.org/grpc"
|
||||||
|
"plugins/sdk/proto"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Handshake is a common handshake that is shared by pkg and host.
|
||||||
|
var Handshake = plugin.HandshakeConfig{
|
||||||
|
// This isn't required when using VersionedPlugins
|
||||||
|
ProtocolVersion: 1,
|
||||||
|
MagicCookieKey: "BASIC_PLUGIN",
|
||||||
|
MagicCookieValue: "p",
|
||||||
|
}
|
||||||
|
|
||||||
|
// PluginService .
|
||||||
|
type PluginService interface {
|
||||||
|
Order(ctx context.Context, request *proto.OrderRequest) (*proto.OrderResponse, error)
|
||||||
|
Query(ctx context.Context, request *proto.QueryRequest) (*proto.QueryResponse, error)
|
||||||
|
Notify(ctx context.Context, request *proto.NotifyRequest) (*proto.NotifyResponse, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GRPCPlugin implement plugin.GRPCPlugin
|
||||||
|
type GRPCPlugin struct {
|
||||||
|
plugin.Plugin
|
||||||
|
Impl PluginService
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p GRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, server *grpc.Server) error {
|
||||||
|
proto.RegisterPluginServer(server, GPRCPluginServerWrapper{impl: p.Impl})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p GRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, conn *grpc.ClientConn) (interface{}, error) {
|
||||||
|
return GRPCPluginClientWrapper{client: proto.NewPluginClient(conn)}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type GPRCPluginServerWrapper struct {
|
||||||
|
impl PluginService
|
||||||
|
proto.UnimplementedPluginServer
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_this GPRCPluginServerWrapper) Order(ctx context.Context, request *proto.OrderRequest) (*proto.OrderResponse, error) {
|
||||||
|
return _this.impl.Order(ctx, request)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_this GPRCPluginServerWrapper) Query(ctx context.Context, request *proto.QueryRequest) (*proto.QueryResponse, error) {
|
||||||
|
return _this.impl.Query(ctx, request)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_this GPRCPluginServerWrapper) Notify(ctx context.Context, request *proto.NotifyRequest) (*proto.NotifyResponse, error) {
|
||||||
|
return _this.impl.Notify(ctx, request)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GRPCPluginClientWrapper 作为 server 调用插件接口的包装器,
|
||||||
|
type GRPCPluginClientWrapper struct {
|
||||||
|
client proto.PluginClient
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_this GRPCPluginClientWrapper) Order(ctx context.Context, request *proto.OrderRequest) (*proto.OrderResponse, error) {
|
||||||
|
resp, err := _this.client.Order(context.Background(), request)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return resp, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_this GRPCPluginClientWrapper) Query(ctx context.Context, request *proto.QueryRequest) (*proto.QueryResponse, error) {
|
||||||
|
resp, err := _this.client.Query(context.Background(), request)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return resp, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_this GRPCPluginClientWrapper) Notify(ctx context.Context, request *proto.NotifyRequest) (*proto.NotifyResponse, error) {
|
||||||
|
resp, err := _this.client.Notify(context.Background(), request)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return resp, nil
|
||||||
|
}
|
|
@ -0,0 +1,22 @@
|
||||||
|
package shared
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/hashicorp/go-plugin"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Plugin struct {
|
||||||
|
Tag string
|
||||||
|
P PluginService
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewPlugin(p PluginService, tag string) *Plugin {
|
||||||
|
return &Plugin{P: p, Tag: tag}
|
||||||
|
}
|
||||||
|
|
||||||
|
func PluginSet(opts ...*Plugin) plugin.PluginSet {
|
||||||
|
plugins := make(map[string]plugin.Plugin, len(opts))
|
||||||
|
for _, opt := range opts {
|
||||||
|
plugins[opt.Tag] = &GRPCPlugin{Impl: opt.P}
|
||||||
|
}
|
||||||
|
return plugins
|
||||||
|
}
|
|
@ -0,0 +1,18 @@
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package errors;
|
||||||
|
|
||||||
|
option go_package = "github.com/go-kratos/kratos/v2/errors;errors";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option java_package = "com.github.kratos.errors";
|
||||||
|
option objc_class_prefix = "KratosErrors";
|
||||||
|
|
||||||
|
import "google/protobuf/descriptor.proto";
|
||||||
|
|
||||||
|
extend google.protobuf.EnumOptions {
|
||||||
|
int32 default_code = 1108;
|
||||||
|
}
|
||||||
|
|
||||||
|
extend google.protobuf.EnumValueOptions {
|
||||||
|
int32 code = 1109;
|
||||||
|
}
|
|
@ -0,0 +1,31 @@
|
||||||
|
// Copyright (c) 2015, Google Inc.
|
||||||
|
//
|
||||||
|
// 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.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.api;
|
||||||
|
|
||||||
|
import "google/api/http.proto";
|
||||||
|
import "google/protobuf/descriptor.proto";
|
||||||
|
|
||||||
|
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option java_outer_classname = "AnnotationsProto";
|
||||||
|
option java_package = "com.google.api";
|
||||||
|
option objc_class_prefix = "GAPI";
|
||||||
|
|
||||||
|
extend google.protobuf.MethodOptions {
|
||||||
|
// See `HttpRule`.
|
||||||
|
HttpRule http = 72295728;
|
||||||
|
}
|
|
@ -0,0 +1,101 @@
|
||||||
|
// Copyright 2019 Google LLC.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.api;
|
||||||
|
|
||||||
|
import "google/protobuf/descriptor.proto";
|
||||||
|
|
||||||
|
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option java_outer_classname = "ClientProto";
|
||||||
|
option java_package = "com.google.api";
|
||||||
|
option objc_class_prefix = "GAPI";
|
||||||
|
|
||||||
|
|
||||||
|
extend google.protobuf.ServiceOptions {
|
||||||
|
// The hostname for this service.
|
||||||
|
// This should be specified with no prefix or protocol.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// service Foo {
|
||||||
|
// option (google.api.default_host) = "foo.googleapi.com";
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
string default_host = 1049;
|
||||||
|
|
||||||
|
// OAuth scopes needed for the client.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// service Foo {
|
||||||
|
// option (google.api.oauth_scopes) = \
|
||||||
|
// "https://www.googleapis.com/auth/cloud-platform";
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// If there is more than one scope, use a comma-separated string:
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// service Foo {
|
||||||
|
// option (google.api.oauth_scopes) = \
|
||||||
|
// "https://www.googleapis.com/auth/cloud-platform,"
|
||||||
|
// "https://www.googleapis.com/auth/monitoring";
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
string oauth_scopes = 1050;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
extend google.protobuf.MethodOptions {
|
||||||
|
// A definition of a client library method signature.
|
||||||
|
//
|
||||||
|
// In client libraries, each proto RPC corresponds to one or more methods
|
||||||
|
// which the end user is able to call, and calls the underlying RPC.
|
||||||
|
// Normally, this method receives a single argument (a struct or instance
|
||||||
|
// corresponding to the RPC request object). Defining this field will
|
||||||
|
// add one or more overloads providing flattened or simpler method signatures
|
||||||
|
// in some languages.
|
||||||
|
//
|
||||||
|
// The fields on the method signature are provided as a comma-separated
|
||||||
|
// string.
|
||||||
|
//
|
||||||
|
// For example, the proto RPC and annotation:
|
||||||
|
//
|
||||||
|
// rpc CreateSubscription(CreateSubscriptionRequest)
|
||||||
|
// returns (Subscription) {
|
||||||
|
// option (google.api.method_signature) = "name,topic";
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Would add the following Java overload (in addition to the method accepting
|
||||||
|
// the request object):
|
||||||
|
//
|
||||||
|
// public final Subscription createSubscription(String name, String topic)
|
||||||
|
//
|
||||||
|
// The following backwards-compatibility guidelines apply:
|
||||||
|
//
|
||||||
|
// * Adding this annotation to an unannotated method is backwards
|
||||||
|
// compatible.
|
||||||
|
// * Adding this annotation to a method which already has existing
|
||||||
|
// method signature annotations is backwards compatible if and only if
|
||||||
|
// the new method signature annotation is last in the sequence.
|
||||||
|
// * Modifying or removing an existing method signature annotation is
|
||||||
|
// a breaking change.
|
||||||
|
// * Re-ordering existing method signature annotations is a breaking
|
||||||
|
// change.
|
||||||
|
repeated string method_signature = 1051;
|
||||||
|
}
|
|
@ -0,0 +1,80 @@
|
||||||
|
// Copyright 2019 Google LLC.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.api;
|
||||||
|
|
||||||
|
import "google/protobuf/descriptor.proto";
|
||||||
|
|
||||||
|
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option java_outer_classname = "FieldBehaviorProto";
|
||||||
|
option java_package = "com.google.api";
|
||||||
|
option objc_class_prefix = "GAPI";
|
||||||
|
|
||||||
|
|
||||||
|
// An indicator of the behavior of a given field (for example, that a field
|
||||||
|
// is required in requests, or given as output but ignored as input).
|
||||||
|
// This **does not** change the behavior in protocol buffers itself; it only
|
||||||
|
// denotes the behavior and may affect how API tooling handles the field.
|
||||||
|
//
|
||||||
|
// Note: This enum **may** receive new values in the future.
|
||||||
|
enum FieldBehavior {
|
||||||
|
// Conventional default for enums. Do not use this.
|
||||||
|
FIELD_BEHAVIOR_UNSPECIFIED = 0;
|
||||||
|
|
||||||
|
// Specifically denotes a field as optional.
|
||||||
|
// While all fields in protocol buffers are optional, this may be specified
|
||||||
|
// for emphasis if appropriate.
|
||||||
|
OPTIONAL = 1;
|
||||||
|
|
||||||
|
// Denotes a field as required.
|
||||||
|
// This indicates that the field **must** be provided as part of the request,
|
||||||
|
// and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
||||||
|
REQUIRED = 2;
|
||||||
|
|
||||||
|
// Denotes a field as output only.
|
||||||
|
// This indicates that the field is provided in responses, but including the
|
||||||
|
// field in a request does nothing (the server *must* ignore it and
|
||||||
|
// *must not* throw an error as a result of the field's presence).
|
||||||
|
OUTPUT_ONLY = 3;
|
||||||
|
|
||||||
|
// Denotes a field as input only.
|
||||||
|
// This indicates that the field is provided in requests, and the
|
||||||
|
// corresponding field is not included in output.
|
||||||
|
INPUT_ONLY = 4;
|
||||||
|
|
||||||
|
// Denotes a field as immutable.
|
||||||
|
// This indicates that the field may be set once in a request to create a
|
||||||
|
// resource, but may not be changed thereafter.
|
||||||
|
IMMUTABLE = 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
extend google.protobuf.FieldOptions {
|
||||||
|
// A designation of a specific field behavior (required, output only, etc.)
|
||||||
|
// in protobuf messages.
|
||||||
|
//
|
||||||
|
// Examples:
|
||||||
|
//
|
||||||
|
// string name = 1 [(google.api.field_behavior) = REQUIRED];
|
||||||
|
// State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
||||||
|
// google.protobuf.Duration ttl = 1
|
||||||
|
// [(google.api.field_behavior) = INPUT_ONLY];
|
||||||
|
// google.protobuf.Timestamp expire_time = 1
|
||||||
|
// [(google.api.field_behavior) = OUTPUT_ONLY,
|
||||||
|
// (google.api.field_behavior) = IMMUTABLE];
|
||||||
|
repeated FieldBehavior field_behavior = 1052;
|
||||||
|
}
|
|
@ -0,0 +1,375 @@
|
||||||
|
// Copyright 2020 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.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.api;
|
||||||
|
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option java_outer_classname = "HttpProto";
|
||||||
|
option java_package = "com.google.api";
|
||||||
|
option objc_class_prefix = "GAPI";
|
||||||
|
|
||||||
|
// Defines the HTTP configuration for an API service. It contains a list of
|
||||||
|
// [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
|
||||||
|
// to one or more HTTP REST API methods.
|
||||||
|
message Http {
|
||||||
|
// A list of HTTP configuration rules that apply to individual API methods.
|
||||||
|
//
|
||||||
|
// **NOTE:** All service configuration rules follow "last one wins" order.
|
||||||
|
repeated HttpRule rules = 1;
|
||||||
|
|
||||||
|
// When set to true, URL path parameters will be fully URI-decoded except in
|
||||||
|
// cases of single segment matches in reserved expansion, where "%2F" will be
|
||||||
|
// left encoded.
|
||||||
|
//
|
||||||
|
// The default behavior is to not decode RFC 6570 reserved characters in multi
|
||||||
|
// segment matches.
|
||||||
|
bool fully_decode_reserved_expansion = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// # gRPC Transcoding
|
||||||
|
//
|
||||||
|
// gRPC Transcoding is a feature for mapping between a gRPC method and one or
|
||||||
|
// more HTTP REST endpoints. It allows developers to build a single API service
|
||||||
|
// that supports both gRPC APIs and REST APIs. Many systems, including [Google
|
||||||
|
// APIs](https://github.com/googleapis/googleapis),
|
||||||
|
// [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
|
||||||
|
// Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
|
||||||
|
// and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
|
||||||
|
// and use it for large scale production services.
|
||||||
|
//
|
||||||
|
// `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
|
||||||
|
// how different portions of the gRPC request message are mapped to the URL
|
||||||
|
// path, URL query parameters, and HTTP request body. It also controls how the
|
||||||
|
// gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
||||||
|
// typically specified as an `google.api.http` annotation on the gRPC method.
|
||||||
|
//
|
||||||
|
// Each mapping specifies a URL path template and an HTTP method. The path
|
||||||
|
// template may refer to one or more fields in the gRPC request message, as long
|
||||||
|
// as each field is a non-repeated field with a primitive (non-message) type.
|
||||||
|
// The path template controls how fields of the request message are mapped to
|
||||||
|
// the URL path.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// service Messaging {
|
||||||
|
// rpc GetMessage(GetMessageRequest) returns (Message) {
|
||||||
|
// option (google.api.http) = {
|
||||||
|
// get: "/v1/{name=messages/*}"
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// message GetMessageRequest {
|
||||||
|
// string name = 1; // Mapped to URL path.
|
||||||
|
// }
|
||||||
|
// message Message {
|
||||||
|
// string text = 1; // The resource content.
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// This enables an HTTP REST to gRPC mapping as below:
|
||||||
|
//
|
||||||
|
// HTTP | gRPC
|
||||||
|
// -----|-----
|
||||||
|
// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
|
||||||
|
//
|
||||||
|
// Any fields in the request message which are not bound by the path template
|
||||||
|
// automatically become HTTP query parameters if there is no HTTP request body.
|
||||||
|
// For example:
|
||||||
|
//
|
||||||
|
// service Messaging {
|
||||||
|
// rpc GetMessage(GetMessageRequest) returns (Message) {
|
||||||
|
// option (google.api.http) = {
|
||||||
|
// get:"/v1/messages/{message_id}"
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// message GetMessageRequest {
|
||||||
|
// message SubMessage {
|
||||||
|
// string subfield = 1;
|
||||||
|
// }
|
||||||
|
// string message_id = 1; // Mapped to URL path.
|
||||||
|
// int64 revision = 2; // Mapped to URL query parameter `revision`.
|
||||||
|
// SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// This enables a HTTP JSON to RPC mapping as below:
|
||||||
|
//
|
||||||
|
// HTTP | gRPC
|
||||||
|
// -----|-----
|
||||||
|
// `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
||||||
|
// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
|
||||||
|
// "foo"))`
|
||||||
|
//
|
||||||
|
// Note that fields which are mapped to URL query parameters must have a
|
||||||
|
// primitive type or a repeated primitive type or a non-repeated message type.
|
||||||
|
// In the case of a repeated type, the parameter can be repeated in the URL
|
||||||
|
// as `...?param=A¶m=B`. In the case of a message type, each field of the
|
||||||
|
// message is mapped to a separate parameter, such as
|
||||||
|
// `...?foo.a=A&foo.b=B&foo.c=C`.
|
||||||
|
//
|
||||||
|
// For HTTP methods that allow a request body, the `body` field
|
||||||
|
// specifies the mapping. Consider a REST update method on the
|
||||||
|
// message resource collection:
|
||||||
|
//
|
||||||
|
// service Messaging {
|
||||||
|
// rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
|
||||||
|
// option (google.api.http) = {
|
||||||
|
// patch: "/v1/messages/{message_id}"
|
||||||
|
// body: "message"
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// message UpdateMessageRequest {
|
||||||
|
// string message_id = 1; // mapped to the URL
|
||||||
|
// Message message = 2; // mapped to the body
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// The following HTTP JSON to RPC mapping is enabled, where the
|
||||||
|
// representation of the JSON in the request body is determined by
|
||||||
|
// protos JSON encoding:
|
||||||
|
//
|
||||||
|
// HTTP | gRPC
|
||||||
|
// -----|-----
|
||||||
|
// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
|
||||||
|
// "123456" message { text: "Hi!" })`
|
||||||
|
//
|
||||||
|
// The special name `*` can be used in the body mapping to define that
|
||||||
|
// every field not bound by the path template should be mapped to the
|
||||||
|
// request body. This enables the following alternative definition of
|
||||||
|
// the update method:
|
||||||
|
//
|
||||||
|
// service Messaging {
|
||||||
|
// rpc UpdateMessage(Message) returns (Message) {
|
||||||
|
// option (google.api.http) = {
|
||||||
|
// patch: "/v1/messages/{message_id}"
|
||||||
|
// body: "*"
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// message Message {
|
||||||
|
// string message_id = 1;
|
||||||
|
// string text = 2;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// The following HTTP JSON to RPC mapping is enabled:
|
||||||
|
//
|
||||||
|
// HTTP | gRPC
|
||||||
|
// -----|-----
|
||||||
|
// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
|
||||||
|
// "123456" text: "Hi!")`
|
||||||
|
//
|
||||||
|
// Note that when using `*` in the body mapping, it is not possible to
|
||||||
|
// have HTTP parameters, as all fields not bound by the path end in
|
||||||
|
// the body. This makes this option more rarely used in practice when
|
||||||
|
// defining REST APIs. The common usage of `*` is in custom methods
|
||||||
|
// which don't use the URL at all for transferring data.
|
||||||
|
//
|
||||||
|
// It is possible to define multiple HTTP methods for one RPC by using
|
||||||
|
// the `additional_bindings` option. Example:
|
||||||
|
//
|
||||||
|
// service Messaging {
|
||||||
|
// rpc GetMessage(GetMessageRequest) returns (Message) {
|
||||||
|
// option (google.api.http) = {
|
||||||
|
// get: "/v1/messages/{message_id}"
|
||||||
|
// additional_bindings {
|
||||||
|
// get: "/v1/users/{user_id}/messages/{message_id}"
|
||||||
|
// }
|
||||||
|
// };
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
// message GetMessageRequest {
|
||||||
|
// string message_id = 1;
|
||||||
|
// string user_id = 2;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// This enables the following two alternative HTTP JSON to RPC mappings:
|
||||||
|
//
|
||||||
|
// HTTP | gRPC
|
||||||
|
// -----|-----
|
||||||
|
// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
||||||
|
// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
||||||
|
// "123456")`
|
||||||
|
//
|
||||||
|
// ## Rules for HTTP mapping
|
||||||
|
//
|
||||||
|
// 1. Leaf request fields (recursive expansion nested messages in the request
|
||||||
|
// message) are classified into three categories:
|
||||||
|
// - Fields referred by the path template. They are passed via the URL path.
|
||||||
|
// - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
|
||||||
|
// request body.
|
||||||
|
// - All other fields are passed via the URL query parameters, and the
|
||||||
|
// parameter name is the field path in the request message. A repeated
|
||||||
|
// field can be represented as multiple query parameters under the same
|
||||||
|
// name.
|
||||||
|
// 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
|
||||||
|
// are passed via URL path and HTTP request body.
|
||||||
|
// 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
|
||||||
|
// fields are passed via URL path and URL query parameters.
|
||||||
|
//
|
||||||
|
// ### Path template syntax
|
||||||
|
//
|
||||||
|
// Template = "/" Segments [ Verb ] ;
|
||||||
|
// Segments = Segment { "/" Segment } ;
|
||||||
|
// Segment = "*" | "**" | LITERAL | Variable ;
|
||||||
|
// Variable = "{" FieldPath [ "=" Segments ] "}" ;
|
||||||
|
// FieldPath = IDENT { "." IDENT } ;
|
||||||
|
// Verb = ":" LITERAL ;
|
||||||
|
//
|
||||||
|
// The syntax `*` matches a single URL path segment. The syntax `**` matches
|
||||||
|
// zero or more URL path segments, which must be the last part of the URL path
|
||||||
|
// except the `Verb`.
|
||||||
|
//
|
||||||
|
// The syntax `Variable` matches part of the URL path as specified by its
|
||||||
|
// template. A variable template must not contain other variables. If a variable
|
||||||
|
// matches a single path segment, its template may be omitted, e.g. `{var}`
|
||||||
|
// is equivalent to `{var=*}`.
|
||||||
|
//
|
||||||
|
// The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
||||||
|
// contains any reserved character, such characters should be percent-encoded
|
||||||
|
// before the matching.
|
||||||
|
//
|
||||||
|
// If a variable contains exactly one path segment, such as `"{var}"` or
|
||||||
|
// `"{var=*}"`, when such a variable is expanded into a URL path on the client
|
||||||
|
// side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
||||||
|
// server side does the reverse decoding. Such variables show up in the
|
||||||
|
// [Discovery
|
||||||
|
// Document](https://developers.google.com/discovery/v1/reference/apis) as
|
||||||
|
// `{var}`.
|
||||||
|
//
|
||||||
|
// If a variable contains multiple path segments, such as `"{var=foo/*}"`
|
||||||
|
// or `"{var=**}"`, when such a variable is expanded into a URL path on the
|
||||||
|
// client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
||||||
|
// The server side does the reverse decoding, except "%2F" and "%2f" are left
|
||||||
|
// unchanged. Such variables show up in the
|
||||||
|
// [Discovery
|
||||||
|
// Document](https://developers.google.com/discovery/v1/reference/apis) as
|
||||||
|
// `{+var}`.
|
||||||
|
//
|
||||||
|
// ## Using gRPC API Service Configuration
|
||||||
|
//
|
||||||
|
// gRPC API Service Configuration (service config) is a configuration language
|
||||||
|
// for configuring a gRPC service to become a user-facing product. The
|
||||||
|
// service config is simply the YAML representation of the `google.api.Service`
|
||||||
|
// proto message.
|
||||||
|
//
|
||||||
|
// As an alternative to annotating your proto file, you can configure gRPC
|
||||||
|
// transcoding in your service config YAML files. You do this by specifying a
|
||||||
|
// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
||||||
|
// effect as the proto annotation. This can be particularly useful if you
|
||||||
|
// have a proto that is reused in multiple services. Note that any transcoding
|
||||||
|
// specified in the service config will override any matching transcoding
|
||||||
|
// configuration in the proto.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// http:
|
||||||
|
// rules:
|
||||||
|
// # Selects a gRPC method and applies HttpRule to it.
|
||||||
|
// - selector: example.v1.Messaging.GetMessage
|
||||||
|
// get: /v1/messages/{message_id}/{sub.subfield}
|
||||||
|
//
|
||||||
|
// ## Special notes
|
||||||
|
//
|
||||||
|
// When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
|
||||||
|
// proto to JSON conversion must follow the [proto3
|
||||||
|
// specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
|
||||||
|
//
|
||||||
|
// While the single segment variable follows the semantics of
|
||||||
|
// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
||||||
|
// Expansion, the multi segment variable **does not** follow RFC 6570 Section
|
||||||
|
// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
|
||||||
|
// does not expand special characters like `?` and `#`, which would lead
|
||||||
|
// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
|
||||||
|
// for multi segment variables.
|
||||||
|
//
|
||||||
|
// The path variables **must not** refer to any repeated or mapped field,
|
||||||
|
// because client libraries are not capable of handling such variable expansion.
|
||||||
|
//
|
||||||
|
// The path variables **must not** capture the leading "/" character. The reason
|
||||||
|
// is that the most common use case "{var}" does not capture the leading "/"
|
||||||
|
// character. For consistency, all path variables must share the same behavior.
|
||||||
|
//
|
||||||
|
// Repeated message fields must not be mapped to URL query parameters, because
|
||||||
|
// no client library can support such complicated mapping.
|
||||||
|
//
|
||||||
|
// If an API needs to use a JSON array for request or response body, it can map
|
||||||
|
// the request or response body to a repeated field. However, some gRPC
|
||||||
|
// Transcoding implementations may not support this feature.
|
||||||
|
message HttpRule {
|
||||||
|
// Selects a method to which this rule applies.
|
||||||
|
//
|
||||||
|
// Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
|
||||||
|
string selector = 1;
|
||||||
|
|
||||||
|
// Determines the URL pattern is matched by this rules. This pattern can be
|
||||||
|
// used with any of the {get|put|post|delete|patch} methods. A custom method
|
||||||
|
// can be defined using the 'custom' field.
|
||||||
|
oneof pattern {
|
||||||
|
// Maps to HTTP GET. Used for listing and getting information about
|
||||||
|
// resources.
|
||||||
|
string get = 2;
|
||||||
|
|
||||||
|
// Maps to HTTP PUT. Used for replacing a resource.
|
||||||
|
string put = 3;
|
||||||
|
|
||||||
|
// Maps to HTTP POST. Used for creating a resource or performing an action.
|
||||||
|
string post = 4;
|
||||||
|
|
||||||
|
// Maps to HTTP DELETE. Used for deleting a resource.
|
||||||
|
string delete = 5;
|
||||||
|
|
||||||
|
// Maps to HTTP PATCH. Used for updating a resource.
|
||||||
|
string patch = 6;
|
||||||
|
|
||||||
|
// The custom pattern is used for specifying an HTTP method that is not
|
||||||
|
// included in the `pattern` field, such as HEAD, or "*" to leave the
|
||||||
|
// HTTP method unspecified for this rule. The wild-card rule is useful
|
||||||
|
// for services that provide content to Web (HTML) clients.
|
||||||
|
CustomHttpPattern custom = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The name of the request field whose value is mapped to the HTTP request
|
||||||
|
// body, or `*` for mapping all request fields not captured by the path
|
||||||
|
// pattern to the HTTP body, or omitted for not having any HTTP request body.
|
||||||
|
//
|
||||||
|
// NOTE: the referred field must be present at the top-level of the request
|
||||||
|
// message type.
|
||||||
|
string body = 7;
|
||||||
|
|
||||||
|
// Optional. The name of the response field whose value is mapped to the HTTP
|
||||||
|
// response body. When omitted, the entire response message will be used
|
||||||
|
// as the HTTP response body.
|
||||||
|
//
|
||||||
|
// NOTE: The referred field must be present at the top-level of the response
|
||||||
|
// message type.
|
||||||
|
string response_body = 12;
|
||||||
|
|
||||||
|
// Additional HTTP bindings for the selector. Nested bindings must
|
||||||
|
// not contain an `additional_bindings` field themselves (that is,
|
||||||
|
// the nesting may only be one level deep).
|
||||||
|
repeated HttpRule additional_bindings = 11;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A custom pattern is used for defining custom HTTP verb.
|
||||||
|
message CustomHttpPattern {
|
||||||
|
// The name of this custom HTTP verb.
|
||||||
|
string kind = 1;
|
||||||
|
|
||||||
|
// The path matched by this custom verb.
|
||||||
|
string path = 2;
|
||||||
|
}
|
|
@ -0,0 +1,77 @@
|
||||||
|
// Copyright 2020 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.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.api;
|
||||||
|
|
||||||
|
import "google/protobuf/any.proto";
|
||||||
|
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option go_package = "google.golang.org/genproto/googleapis/api/httpbody;httpbody";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option java_outer_classname = "HttpBodyProto";
|
||||||
|
option java_package = "com.google.api";
|
||||||
|
option objc_class_prefix = "GAPI";
|
||||||
|
|
||||||
|
// Message that represents an arbitrary HTTP body. It should only be used for
|
||||||
|
// payload formats that can't be represented as JSON, such as raw binary or
|
||||||
|
// an HTML page.
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// This message can be used both in streaming and non-streaming API methods in
|
||||||
|
// the request as well as the response.
|
||||||
|
//
|
||||||
|
// It can be used as a top-level request field, which is convenient if one
|
||||||
|
// wants to extract parameters from either the URL or HTTP template into the
|
||||||
|
// request fields and also want access to the raw HTTP body.
|
||||||
|
//
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// message GetResourceRequest {
|
||||||
|
// // A unique request id.
|
||||||
|
// string request_id = 1;
|
||||||
|
//
|
||||||
|
// // The raw HTTP body is bound to this field.
|
||||||
|
// google.api.HttpBody http_body = 2;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// service ResourceService {
|
||||||
|
// rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
|
||||||
|
// rpc UpdateResource(google.api.HttpBody) returns
|
||||||
|
// (google.protobuf.Empty);
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Example with streaming methods:
|
||||||
|
//
|
||||||
|
// service CaldavService {
|
||||||
|
// rpc GetCalendar(stream google.api.HttpBody)
|
||||||
|
// returns (stream google.api.HttpBody);
|
||||||
|
// rpc UpdateCalendar(stream google.api.HttpBody)
|
||||||
|
// returns (stream google.api.HttpBody);
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Use of this type only changes how the request and response bodies are
|
||||||
|
// handled, all other features will continue to work unchanged.
|
||||||
|
message HttpBody {
|
||||||
|
// The HTTP Content-Type header value specifying the content type of the body.
|
||||||
|
string content_type = 1;
|
||||||
|
|
||||||
|
// The HTTP request/response body as raw binary.
|
||||||
|
bytes data = 2;
|
||||||
|
|
||||||
|
// Application specific response metadata. Must be set in the first response
|
||||||
|
// for streaming APIs.
|
||||||
|
repeated google.protobuf.Any extensions = 3;
|
||||||
|
}
|
|
@ -0,0 +1,158 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/anypb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "AnyProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
|
||||||
|
// `Any` contains an arbitrary serialized protocol buffer message along with a
|
||||||
|
// URL that describes the type of the serialized message.
|
||||||
|
//
|
||||||
|
// Protobuf library provides support to pack/unpack Any values in the form
|
||||||
|
// of utility functions or additional generated methods of the Any type.
|
||||||
|
//
|
||||||
|
// Example 1: Pack and unpack a message in C++.
|
||||||
|
//
|
||||||
|
// Foo foo = ...;
|
||||||
|
// Any any;
|
||||||
|
// any.PackFrom(foo);
|
||||||
|
// ...
|
||||||
|
// if (any.UnpackTo(&foo)) {
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Example 2: Pack and unpack a message in Java.
|
||||||
|
//
|
||||||
|
// Foo foo = ...;
|
||||||
|
// Any any = Any.pack(foo);
|
||||||
|
// ...
|
||||||
|
// if (any.is(Foo.class)) {
|
||||||
|
// foo = any.unpack(Foo.class);
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Example 3: Pack and unpack a message in Python.
|
||||||
|
//
|
||||||
|
// foo = Foo(...)
|
||||||
|
// any = Any()
|
||||||
|
// any.Pack(foo)
|
||||||
|
// ...
|
||||||
|
// if any.Is(Foo.DESCRIPTOR):
|
||||||
|
// any.Unpack(foo)
|
||||||
|
// ...
|
||||||
|
//
|
||||||
|
// Example 4: Pack and unpack a message in Go
|
||||||
|
//
|
||||||
|
// foo := &pb.Foo{...}
|
||||||
|
// any, err := anypb.New(foo)
|
||||||
|
// if err != nil {
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
// ...
|
||||||
|
// foo := &pb.Foo{}
|
||||||
|
// if err := any.UnmarshalTo(foo); err != nil {
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// The pack methods provided by protobuf library will by default use
|
||||||
|
// 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
||||||
|
// methods only use the fully qualified type name after the last '/'
|
||||||
|
// in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
||||||
|
// name "y.z".
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// JSON
|
||||||
|
//
|
||||||
|
// The JSON representation of an `Any` value uses the regular
|
||||||
|
// representation of the deserialized, embedded message, with an
|
||||||
|
// additional field `@type` which contains the type URL. Example:
|
||||||
|
//
|
||||||
|
// package google.profile;
|
||||||
|
// message Person {
|
||||||
|
// string first_name = 1;
|
||||||
|
// string last_name = 2;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// {
|
||||||
|
// "@type": "type.googleapis.com/google.profile.Person",
|
||||||
|
// "firstName": <string>,
|
||||||
|
// "lastName": <string>
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// If the embedded message type is well-known and has a custom JSON
|
||||||
|
// representation, that representation will be embedded adding a field
|
||||||
|
// `value` which holds the custom JSON in addition to the `@type`
|
||||||
|
// field. Example (for message [google.protobuf.Duration][]):
|
||||||
|
//
|
||||||
|
// {
|
||||||
|
// "@type": "type.googleapis.com/google.protobuf.Duration",
|
||||||
|
// "value": "1.212s"
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
message Any {
|
||||||
|
// A URL/resource name that uniquely identifies the type of the serialized
|
||||||
|
// protocol buffer message. This string must contain at least
|
||||||
|
// one "/" character. The last segment of the URL's path must represent
|
||||||
|
// the fully qualified name of the type (as in
|
||||||
|
// `path/google.protobuf.Duration`). The name should be in a canonical form
|
||||||
|
// (e.g., leading "." is not accepted).
|
||||||
|
//
|
||||||
|
// In practice, teams usually precompile into the binary all types that they
|
||||||
|
// expect it to use in the context of Any. However, for URLs which use the
|
||||||
|
// scheme `http`, `https`, or no scheme, one can optionally set up a type
|
||||||
|
// server that maps type URLs to message definitions as follows:
|
||||||
|
//
|
||||||
|
// * If no scheme is provided, `https` is assumed.
|
||||||
|
// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
||||||
|
// value in binary format, or produce an error.
|
||||||
|
// * Applications are allowed to cache lookup results based on the
|
||||||
|
// URL, or have them precompiled into a binary to avoid any
|
||||||
|
// lookup. Therefore, binary compatibility needs to be preserved
|
||||||
|
// on changes to types. (Use versioned type names to manage
|
||||||
|
// breaking changes.)
|
||||||
|
//
|
||||||
|
// Note: this functionality is not currently available in the official
|
||||||
|
// protobuf release, and it is not used for type URLs beginning with
|
||||||
|
// type.googleapis.com.
|
||||||
|
//
|
||||||
|
// Schemes other than `http`, `https` (or the empty scheme) might be
|
||||||
|
// used with implementation specific semantics.
|
||||||
|
//
|
||||||
|
string type_url = 1;
|
||||||
|
|
||||||
|
// Must be a valid serialized protocol buffer of the above specified type.
|
||||||
|
bytes value = 2;
|
||||||
|
}
|
|
@ -0,0 +1,208 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
import "google/protobuf/source_context.proto";
|
||||||
|
import "google/protobuf/type.proto";
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "ApiProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/apipb";
|
||||||
|
|
||||||
|
// Api is a light-weight descriptor for an API Interface.
|
||||||
|
//
|
||||||
|
// Interfaces are also described as "protocol buffer services" in some contexts,
|
||||||
|
// such as by the "service" keyword in a .proto file, but they are different
|
||||||
|
// from API Services, which represent a concrete implementation of an interface
|
||||||
|
// as opposed to simply a description of methods and bindings. They are also
|
||||||
|
// sometimes simply referred to as "APIs" in other contexts, such as the name of
|
||||||
|
// this message itself. See https://cloud.google.com/apis/design/glossary for
|
||||||
|
// detailed terminology.
|
||||||
|
message Api {
|
||||||
|
// The fully qualified name of this interface, including package name
|
||||||
|
// followed by the interface's simple name.
|
||||||
|
string name = 1;
|
||||||
|
|
||||||
|
// The methods of this interface, in unspecified order.
|
||||||
|
repeated Method methods = 2;
|
||||||
|
|
||||||
|
// Any metadata attached to the interface.
|
||||||
|
repeated Option options = 3;
|
||||||
|
|
||||||
|
// A version string for this interface. If specified, must have the form
|
||||||
|
// `major-version.minor-version`, as in `1.10`. If the minor version is
|
||||||
|
// omitted, it defaults to zero. If the entire version field is empty, the
|
||||||
|
// major version is derived from the package name, as outlined below. If the
|
||||||
|
// field is not empty, the version in the package name will be verified to be
|
||||||
|
// consistent with what is provided here.
|
||||||
|
//
|
||||||
|
// The versioning schema uses [semantic
|
||||||
|
// versioning](http://semver.org) where the major version number
|
||||||
|
// indicates a breaking change and the minor version an additive,
|
||||||
|
// non-breaking change. Both version numbers are signals to users
|
||||||
|
// what to expect from different versions, and should be carefully
|
||||||
|
// chosen based on the product plan.
|
||||||
|
//
|
||||||
|
// The major version is also reflected in the package name of the
|
||||||
|
// interface, which must end in `v<major-version>`, as in
|
||||||
|
// `google.feature.v1`. For major versions 0 and 1, the suffix can
|
||||||
|
// be omitted. Zero major versions must only be used for
|
||||||
|
// experimental, non-GA interfaces.
|
||||||
|
//
|
||||||
|
//
|
||||||
|
string version = 4;
|
||||||
|
|
||||||
|
// Source context for the protocol buffer service represented by this
|
||||||
|
// message.
|
||||||
|
SourceContext source_context = 5;
|
||||||
|
|
||||||
|
// Included interfaces. See [Mixin][].
|
||||||
|
repeated Mixin mixins = 6;
|
||||||
|
|
||||||
|
// The source syntax of the service.
|
||||||
|
Syntax syntax = 7;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Method represents a method of an API interface.
|
||||||
|
message Method {
|
||||||
|
// The simple name of this method.
|
||||||
|
string name = 1;
|
||||||
|
|
||||||
|
// A URL of the input message type.
|
||||||
|
string request_type_url = 2;
|
||||||
|
|
||||||
|
// If true, the request is streamed.
|
||||||
|
bool request_streaming = 3;
|
||||||
|
|
||||||
|
// The URL of the output message type.
|
||||||
|
string response_type_url = 4;
|
||||||
|
|
||||||
|
// If true, the response is streamed.
|
||||||
|
bool response_streaming = 5;
|
||||||
|
|
||||||
|
// Any metadata attached to the method.
|
||||||
|
repeated Option options = 6;
|
||||||
|
|
||||||
|
// The source syntax of this method.
|
||||||
|
Syntax syntax = 7;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Declares an API Interface to be included in this interface. The including
|
||||||
|
// interface must redeclare all the methods from the included interface, but
|
||||||
|
// documentation and options are inherited as follows:
|
||||||
|
//
|
||||||
|
// - If after comment and whitespace stripping, the documentation
|
||||||
|
// string of the redeclared method is empty, it will be inherited
|
||||||
|
// from the original method.
|
||||||
|
//
|
||||||
|
// - Each annotation belonging to the service config (http,
|
||||||
|
// visibility) which is not set in the redeclared method will be
|
||||||
|
// inherited.
|
||||||
|
//
|
||||||
|
// - If an http annotation is inherited, the path pattern will be
|
||||||
|
// modified as follows. Any version prefix will be replaced by the
|
||||||
|
// version of the including interface plus the [root][] path if
|
||||||
|
// specified.
|
||||||
|
//
|
||||||
|
// Example of a simple mixin:
|
||||||
|
//
|
||||||
|
// package google.acl.v1;
|
||||||
|
// service AccessControl {
|
||||||
|
// // Get the underlying ACL object.
|
||||||
|
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
||||||
|
// option (google.api.http).get = "/v1/{resource=**}:getAcl";
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// package google.storage.v2;
|
||||||
|
// service Storage {
|
||||||
|
// rpc GetAcl(GetAclRequest) returns (Acl);
|
||||||
|
//
|
||||||
|
// // Get a data record.
|
||||||
|
// rpc GetData(GetDataRequest) returns (Data) {
|
||||||
|
// option (google.api.http).get = "/v2/{resource=**}";
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Example of a mixin configuration:
|
||||||
|
//
|
||||||
|
// apis:
|
||||||
|
// - name: google.storage.v2.Storage
|
||||||
|
// mixins:
|
||||||
|
// - name: google.acl.v1.AccessControl
|
||||||
|
//
|
||||||
|
// The mixin construct implies that all methods in `AccessControl` are
|
||||||
|
// also declared with same name and request/response types in
|
||||||
|
// `Storage`. A documentation generator or annotation processor will
|
||||||
|
// see the effective `Storage.GetAcl` method after inheriting
|
||||||
|
// documentation and annotations as follows:
|
||||||
|
//
|
||||||
|
// service Storage {
|
||||||
|
// // Get the underlying ACL object.
|
||||||
|
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
||||||
|
// option (google.api.http).get = "/v2/{resource=**}:getAcl";
|
||||||
|
// }
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Note how the version in the path pattern changed from `v1` to `v2`.
|
||||||
|
//
|
||||||
|
// If the `root` field in the mixin is specified, it should be a
|
||||||
|
// relative path under which inherited HTTP paths are placed. Example:
|
||||||
|
//
|
||||||
|
// apis:
|
||||||
|
// - name: google.storage.v2.Storage
|
||||||
|
// mixins:
|
||||||
|
// - name: google.acl.v1.AccessControl
|
||||||
|
// root: acls
|
||||||
|
//
|
||||||
|
// This implies the following inherited HTTP annotation:
|
||||||
|
//
|
||||||
|
// service Storage {
|
||||||
|
// // Get the underlying ACL object.
|
||||||
|
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
||||||
|
// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
|
||||||
|
// }
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
message Mixin {
|
||||||
|
// The fully qualified name of the interface which is included.
|
||||||
|
string name = 1;
|
||||||
|
|
||||||
|
// If non-empty specifies a path under which inherited HTTP paths
|
||||||
|
// are rooted.
|
||||||
|
string root = 2;
|
||||||
|
}
|
|
@ -0,0 +1,183 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// Author: kenton@google.com (Kenton Varda)
|
||||||
|
//
|
||||||
|
// WARNING: The plugin interface is currently EXPERIMENTAL and is subject to
|
||||||
|
// change.
|
||||||
|
//
|
||||||
|
// protoc (aka the Protocol Compiler) can be extended via plugins. A plugin is
|
||||||
|
// just a program that reads a CodeGeneratorRequest from stdin and writes a
|
||||||
|
// CodeGeneratorResponse to stdout.
|
||||||
|
//
|
||||||
|
// Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
|
||||||
|
// of dealing with the raw protocol defined here.
|
||||||
|
//
|
||||||
|
// A plugin executable needs only to be placed somewhere in the path. The
|
||||||
|
// plugin should be named "protoc-gen-$NAME", and will then be used when the
|
||||||
|
// flag "--${NAME}_out" is passed to protoc.
|
||||||
|
|
||||||
|
syntax = "proto2";
|
||||||
|
|
||||||
|
package google.protobuf.compiler;
|
||||||
|
option java_package = "com.google.protobuf.compiler";
|
||||||
|
option java_outer_classname = "PluginProtos";
|
||||||
|
|
||||||
|
option go_package = "google.golang.org/protobuf/types/pluginpb";
|
||||||
|
|
||||||
|
import "google/protobuf/descriptor.proto";
|
||||||
|
|
||||||
|
// The version number of protocol compiler.
|
||||||
|
message Version {
|
||||||
|
optional int32 major = 1;
|
||||||
|
optional int32 minor = 2;
|
||||||
|
optional int32 patch = 3;
|
||||||
|
// A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
|
||||||
|
// be empty for mainline stable releases.
|
||||||
|
optional string suffix = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
// An encoded CodeGeneratorRequest is written to the plugin's stdin.
|
||||||
|
message CodeGeneratorRequest {
|
||||||
|
// The .proto files that were explicitly listed on the command-line. The
|
||||||
|
// code generator should generate code only for these files. Each file's
|
||||||
|
// descriptor will be included in proto_file, below.
|
||||||
|
repeated string file_to_generate = 1;
|
||||||
|
|
||||||
|
// The generator parameter passed on the command-line.
|
||||||
|
optional string parameter = 2;
|
||||||
|
|
||||||
|
// FileDescriptorProtos for all files in files_to_generate and everything
|
||||||
|
// they import. The files will appear in topological order, so each file
|
||||||
|
// appears before any file that imports it.
|
||||||
|
//
|
||||||
|
// protoc guarantees that all proto_files will be written after
|
||||||
|
// the fields above, even though this is not technically guaranteed by the
|
||||||
|
// protobuf wire format. This theoretically could allow a plugin to stream
|
||||||
|
// in the FileDescriptorProtos and handle them one by one rather than read
|
||||||
|
// the entire set into memory at once. However, as of this writing, this
|
||||||
|
// is not similarly optimized on protoc's end -- it will store all fields in
|
||||||
|
// memory at once before sending them to the plugin.
|
||||||
|
//
|
||||||
|
// Type names of fields and extensions in the FileDescriptorProto are always
|
||||||
|
// fully qualified.
|
||||||
|
repeated FileDescriptorProto proto_file = 15;
|
||||||
|
|
||||||
|
// The version number of protocol compiler.
|
||||||
|
optional Version compiler_version = 3;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// The plugin writes an encoded CodeGeneratorResponse to stdout.
|
||||||
|
message CodeGeneratorResponse {
|
||||||
|
// Error message. If non-empty, code generation failed. The plugin process
|
||||||
|
// should exit with status code zero even if it reports an error in this way.
|
||||||
|
//
|
||||||
|
// This should be used to indicate errors in .proto files which prevent the
|
||||||
|
// code generator from generating correct code. Errors which indicate a
|
||||||
|
// problem in protoc itself -- such as the input CodeGeneratorRequest being
|
||||||
|
// unparseable -- should be reported by writing a message to stderr and
|
||||||
|
// exiting with a non-zero status code.
|
||||||
|
optional string error = 1;
|
||||||
|
|
||||||
|
// A bitmask of supported features that the code generator supports.
|
||||||
|
// This is a bitwise "or" of values from the Feature enum.
|
||||||
|
optional uint64 supported_features = 2;
|
||||||
|
|
||||||
|
// Sync with code_generator.h.
|
||||||
|
enum Feature {
|
||||||
|
FEATURE_NONE = 0;
|
||||||
|
FEATURE_PROTO3_OPTIONAL = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Represents a single generated file.
|
||||||
|
message File {
|
||||||
|
// The file name, relative to the output directory. The name must not
|
||||||
|
// contain "." or ".." components and must be relative, not be absolute (so,
|
||||||
|
// the file cannot lie outside the output directory). "/" must be used as
|
||||||
|
// the path separator, not "\".
|
||||||
|
//
|
||||||
|
// If the name is omitted, the content will be appended to the previous
|
||||||
|
// file. This allows the generator to break large files into small chunks,
|
||||||
|
// and allows the generated text to be streamed back to protoc so that large
|
||||||
|
// files need not reside completely in memory at one time. Note that as of
|
||||||
|
// this writing protoc does not optimize for this -- it will read the entire
|
||||||
|
// CodeGeneratorResponse before writing files to disk.
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
// If non-empty, indicates that the named file should already exist, and the
|
||||||
|
// content here is to be inserted into that file at a defined insertion
|
||||||
|
// point. This feature allows a code generator to extend the output
|
||||||
|
// produced by another code generator. The original generator may provide
|
||||||
|
// insertion points by placing special annotations in the file that look
|
||||||
|
// like:
|
||||||
|
// @@protoc_insertion_point(NAME)
|
||||||
|
// The annotation can have arbitrary text before and after it on the line,
|
||||||
|
// which allows it to be placed in a comment. NAME should be replaced with
|
||||||
|
// an identifier naming the point -- this is what other generators will use
|
||||||
|
// as the insertion_point. Code inserted at this point will be placed
|
||||||
|
// immediately above the line containing the insertion point (thus multiple
|
||||||
|
// insertions to the same point will come out in the order they were added).
|
||||||
|
// The double-@ is intended to make it unlikely that the generated code
|
||||||
|
// could contain things that look like insertion points by accident.
|
||||||
|
//
|
||||||
|
// For example, the C++ code generator places the following line in the
|
||||||
|
// .pb.h files that it generates:
|
||||||
|
// // @@protoc_insertion_point(namespace_scope)
|
||||||
|
// This line appears within the scope of the file's package namespace, but
|
||||||
|
// outside of any particular class. Another plugin can then specify the
|
||||||
|
// insertion_point "namespace_scope" to generate additional classes or
|
||||||
|
// other declarations that should be placed in this scope.
|
||||||
|
//
|
||||||
|
// Note that if the line containing the insertion point begins with
|
||||||
|
// whitespace, the same whitespace will be added to every line of the
|
||||||
|
// inserted text. This is useful for languages like Python, where
|
||||||
|
// indentation matters. In these languages, the insertion point comment
|
||||||
|
// should be indented the same amount as any inserted code will need to be
|
||||||
|
// in order to work correctly in that context.
|
||||||
|
//
|
||||||
|
// The code generator that generates the initial file and the one which
|
||||||
|
// inserts into it must both run as part of a single invocation of protoc.
|
||||||
|
// Code generators are executed in the order in which they appear on the
|
||||||
|
// command line.
|
||||||
|
//
|
||||||
|
// If |insertion_point| is present, |name| must also be present.
|
||||||
|
optional string insertion_point = 2;
|
||||||
|
|
||||||
|
// The file contents.
|
||||||
|
optional string content = 15;
|
||||||
|
|
||||||
|
// Information describing the file content being inserted. If an insertion
|
||||||
|
// point is used, this information will be appropriately offset and inserted
|
||||||
|
// into the code generation metadata for the generated files.
|
||||||
|
optional GeneratedCodeInfo generated_code_info = 16;
|
||||||
|
}
|
||||||
|
repeated File file = 15;
|
||||||
|
}
|
|
@ -0,0 +1,921 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// Author: kenton@google.com (Kenton Varda)
|
||||||
|
// Based on original Protocol Buffers design by
|
||||||
|
// Sanjay Ghemawat, Jeff Dean, and others.
|
||||||
|
//
|
||||||
|
// The messages in this file describe the definitions found in .proto files.
|
||||||
|
// A valid .proto file can be translated directly to a FileDescriptorProto
|
||||||
|
// without any other information (e.g. without reading its imports).
|
||||||
|
|
||||||
|
|
||||||
|
syntax = "proto2";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option go_package = "google.golang.org/protobuf/types/descriptorpb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "DescriptorProtos";
|
||||||
|
option csharp_namespace = "Google.Protobuf.Reflection";
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
|
||||||
|
// descriptor.proto must be optimized for speed because reflection-based
|
||||||
|
// algorithms don't work during bootstrapping.
|
||||||
|
option optimize_for = SPEED;
|
||||||
|
|
||||||
|
// The protocol compiler can output a FileDescriptorSet containing the .proto
|
||||||
|
// files it parses.
|
||||||
|
message FileDescriptorSet {
|
||||||
|
repeated FileDescriptorProto file = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a complete .proto file.
|
||||||
|
message FileDescriptorProto {
|
||||||
|
optional string name = 1; // file name, relative to root of source tree
|
||||||
|
optional string package = 2; // e.g. "foo", "foo.bar", etc.
|
||||||
|
|
||||||
|
// Names of files imported by this file.
|
||||||
|
repeated string dependency = 3;
|
||||||
|
// Indexes of the public imported files in the dependency list above.
|
||||||
|
repeated int32 public_dependency = 10;
|
||||||
|
// Indexes of the weak imported files in the dependency list.
|
||||||
|
// For Google-internal migration only. Do not use.
|
||||||
|
repeated int32 weak_dependency = 11;
|
||||||
|
|
||||||
|
// All top-level definitions in this file.
|
||||||
|
repeated DescriptorProto message_type = 4;
|
||||||
|
repeated EnumDescriptorProto enum_type = 5;
|
||||||
|
repeated ServiceDescriptorProto service = 6;
|
||||||
|
repeated FieldDescriptorProto extension = 7;
|
||||||
|
|
||||||
|
optional FileOptions options = 8;
|
||||||
|
|
||||||
|
// This field contains optional information about the original source code.
|
||||||
|
// You may safely remove this entire field without harming runtime
|
||||||
|
// functionality of the descriptors -- the information is needed only by
|
||||||
|
// development tools.
|
||||||
|
optional SourceCodeInfo source_code_info = 9;
|
||||||
|
|
||||||
|
// The syntax of the proto file.
|
||||||
|
// The supported values are "proto2" and "proto3".
|
||||||
|
optional string syntax = 12;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a message type.
|
||||||
|
message DescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
repeated FieldDescriptorProto field = 2;
|
||||||
|
repeated FieldDescriptorProto extension = 6;
|
||||||
|
|
||||||
|
repeated DescriptorProto nested_type = 3;
|
||||||
|
repeated EnumDescriptorProto enum_type = 4;
|
||||||
|
|
||||||
|
message ExtensionRange {
|
||||||
|
optional int32 start = 1; // Inclusive.
|
||||||
|
optional int32 end = 2; // Exclusive.
|
||||||
|
|
||||||
|
optional ExtensionRangeOptions options = 3;
|
||||||
|
}
|
||||||
|
repeated ExtensionRange extension_range = 5;
|
||||||
|
|
||||||
|
repeated OneofDescriptorProto oneof_decl = 8;
|
||||||
|
|
||||||
|
optional MessageOptions options = 7;
|
||||||
|
|
||||||
|
// Range of reserved tag numbers. Reserved tag numbers may not be used by
|
||||||
|
// fields or extension ranges in the same message. Reserved ranges may
|
||||||
|
// not overlap.
|
||||||
|
message ReservedRange {
|
||||||
|
optional int32 start = 1; // Inclusive.
|
||||||
|
optional int32 end = 2; // Exclusive.
|
||||||
|
}
|
||||||
|
repeated ReservedRange reserved_range = 9;
|
||||||
|
// Reserved field names, which may not be used by fields in the same message.
|
||||||
|
// A given name may only be reserved once.
|
||||||
|
repeated string reserved_name = 10;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ExtensionRangeOptions {
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a field within a message.
|
||||||
|
message FieldDescriptorProto {
|
||||||
|
enum Type {
|
||||||
|
// 0 is reserved for errors.
|
||||||
|
// Order is weird for historical reasons.
|
||||||
|
TYPE_DOUBLE = 1;
|
||||||
|
TYPE_FLOAT = 2;
|
||||||
|
// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
|
||||||
|
// negative values are likely.
|
||||||
|
TYPE_INT64 = 3;
|
||||||
|
TYPE_UINT64 = 4;
|
||||||
|
// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
|
||||||
|
// negative values are likely.
|
||||||
|
TYPE_INT32 = 5;
|
||||||
|
TYPE_FIXED64 = 6;
|
||||||
|
TYPE_FIXED32 = 7;
|
||||||
|
TYPE_BOOL = 8;
|
||||||
|
TYPE_STRING = 9;
|
||||||
|
// Tag-delimited aggregate.
|
||||||
|
// Group type is deprecated and not supported in proto3. However, Proto3
|
||||||
|
// implementations should still be able to parse the group wire format and
|
||||||
|
// treat group fields as unknown fields.
|
||||||
|
TYPE_GROUP = 10;
|
||||||
|
TYPE_MESSAGE = 11; // Length-delimited aggregate.
|
||||||
|
|
||||||
|
// New in version 2.
|
||||||
|
TYPE_BYTES = 12;
|
||||||
|
TYPE_UINT32 = 13;
|
||||||
|
TYPE_ENUM = 14;
|
||||||
|
TYPE_SFIXED32 = 15;
|
||||||
|
TYPE_SFIXED64 = 16;
|
||||||
|
TYPE_SINT32 = 17; // Uses ZigZag encoding.
|
||||||
|
TYPE_SINT64 = 18; // Uses ZigZag encoding.
|
||||||
|
}
|
||||||
|
|
||||||
|
enum Label {
|
||||||
|
// 0 is reserved for errors
|
||||||
|
LABEL_OPTIONAL = 1;
|
||||||
|
LABEL_REQUIRED = 2;
|
||||||
|
LABEL_REPEATED = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
optional string name = 1;
|
||||||
|
optional int32 number = 3;
|
||||||
|
optional Label label = 4;
|
||||||
|
|
||||||
|
// If type_name is set, this need not be set. If both this and type_name
|
||||||
|
// are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
|
||||||
|
optional Type type = 5;
|
||||||
|
|
||||||
|
// For message and enum types, this is the name of the type. If the name
|
||||||
|
// starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
|
||||||
|
// rules are used to find the type (i.e. first the nested types within this
|
||||||
|
// message are searched, then within the parent, on up to the root
|
||||||
|
// namespace).
|
||||||
|
optional string type_name = 6;
|
||||||
|
|
||||||
|
// For extensions, this is the name of the type being extended. It is
|
||||||
|
// resolved in the same manner as type_name.
|
||||||
|
optional string extendee = 2;
|
||||||
|
|
||||||
|
// For numeric types, contains the original text representation of the value.
|
||||||
|
// For booleans, "true" or "false".
|
||||||
|
// For strings, contains the default text contents (not escaped in any way).
|
||||||
|
// For bytes, contains the C escaped value. All bytes >= 128 are escaped.
|
||||||
|
optional string default_value = 7;
|
||||||
|
|
||||||
|
// If set, gives the index of a oneof in the containing type's oneof_decl
|
||||||
|
// list. This field is a member of that oneof.
|
||||||
|
optional int32 oneof_index = 9;
|
||||||
|
|
||||||
|
// JSON name of this field. The value is set by protocol compiler. If the
|
||||||
|
// user has set a "json_name" option on this field, that option's value
|
||||||
|
// will be used. Otherwise, it's deduced from the field's name by converting
|
||||||
|
// it to camelCase.
|
||||||
|
optional string json_name = 10;
|
||||||
|
|
||||||
|
optional FieldOptions options = 8;
|
||||||
|
|
||||||
|
// If true, this is a proto3 "optional". When a proto3 field is optional, it
|
||||||
|
// tracks presence regardless of field type.
|
||||||
|
//
|
||||||
|
// When proto3_optional is true, this field must be belong to a oneof to
|
||||||
|
// signal to old proto3 clients that presence is tracked for this field. This
|
||||||
|
// oneof is known as a "synthetic" oneof, and this field must be its sole
|
||||||
|
// member (each proto3 optional field gets its own synthetic oneof). Synthetic
|
||||||
|
// oneofs exist in the descriptor only, and do not generate any API. Synthetic
|
||||||
|
// oneofs must be ordered after all "real" oneofs.
|
||||||
|
//
|
||||||
|
// For message fields, proto3_optional doesn't create any semantic change,
|
||||||
|
// since non-repeated message fields always track presence. However it still
|
||||||
|
// indicates the semantic detail of whether the user wrote "optional" or not.
|
||||||
|
// This can be useful for round-tripping the .proto file. For consistency we
|
||||||
|
// give message fields a synthetic oneof also, even though it is not required
|
||||||
|
// to track presence. This is especially important because the parser can't
|
||||||
|
// tell if a field is a message or an enum, so it must always create a
|
||||||
|
// synthetic oneof.
|
||||||
|
//
|
||||||
|
// Proto2 optional fields do not set this flag, because they already indicate
|
||||||
|
// optional with `LABEL_OPTIONAL`.
|
||||||
|
optional bool proto3_optional = 17;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a oneof.
|
||||||
|
message OneofDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
optional OneofOptions options = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes an enum type.
|
||||||
|
message EnumDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
repeated EnumValueDescriptorProto value = 2;
|
||||||
|
|
||||||
|
optional EnumOptions options = 3;
|
||||||
|
|
||||||
|
// Range of reserved numeric values. Reserved values may not be used by
|
||||||
|
// entries in the same enum. Reserved ranges may not overlap.
|
||||||
|
//
|
||||||
|
// Note that this is distinct from DescriptorProto.ReservedRange in that it
|
||||||
|
// is inclusive such that it can appropriately represent the entire int32
|
||||||
|
// domain.
|
||||||
|
message EnumReservedRange {
|
||||||
|
optional int32 start = 1; // Inclusive.
|
||||||
|
optional int32 end = 2; // Inclusive.
|
||||||
|
}
|
||||||
|
|
||||||
|
// Range of reserved numeric values. Reserved numeric values may not be used
|
||||||
|
// by enum values in the same enum declaration. Reserved ranges may not
|
||||||
|
// overlap.
|
||||||
|
repeated EnumReservedRange reserved_range = 4;
|
||||||
|
|
||||||
|
// Reserved enum value names, which may not be reused. A given name may only
|
||||||
|
// be reserved once.
|
||||||
|
repeated string reserved_name = 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a value within an enum.
|
||||||
|
message EnumValueDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
optional int32 number = 2;
|
||||||
|
|
||||||
|
optional EnumValueOptions options = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a service.
|
||||||
|
message ServiceDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
repeated MethodDescriptorProto method = 2;
|
||||||
|
|
||||||
|
optional ServiceOptions options = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes a method of a service.
|
||||||
|
message MethodDescriptorProto {
|
||||||
|
optional string name = 1;
|
||||||
|
|
||||||
|
// Input and output type names. These are resolved in the same way as
|
||||||
|
// FieldDescriptorProto.type_name, but must refer to a message type.
|
||||||
|
optional string input_type = 2;
|
||||||
|
optional string output_type = 3;
|
||||||
|
|
||||||
|
optional MethodOptions options = 4;
|
||||||
|
|
||||||
|
// Identifies if client streams multiple client messages
|
||||||
|
optional bool client_streaming = 5 [default = false];
|
||||||
|
// Identifies if server streams multiple server messages
|
||||||
|
optional bool server_streaming = 6 [default = false];
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// ===================================================================
|
||||||
|
// Options
|
||||||
|
|
||||||
|
// Each of the definitions above may have "options" attached. These are
|
||||||
|
// just annotations which may cause code to be generated slightly differently
|
||||||
|
// or may contain hints for code that manipulates protocol messages.
|
||||||
|
//
|
||||||
|
// Clients may define custom options as extensions of the *Options messages.
|
||||||
|
// These extensions may not yet be known at parsing time, so the parser cannot
|
||||||
|
// store the values in them. Instead it stores them in a field in the *Options
|
||||||
|
// message called uninterpreted_option. This field must have the same name
|
||||||
|
// across all *Options messages. We then use this field to populate the
|
||||||
|
// extensions when we build a descriptor, at which point all protos have been
|
||||||
|
// parsed and so all extensions are known.
|
||||||
|
//
|
||||||
|
// Extension numbers for custom options may be chosen as follows:
|
||||||
|
// * For options which will only be used within a single application or
|
||||||
|
// organization, or for experimental options, use field numbers 50000
|
||||||
|
// through 99999. It is up to you to ensure that you do not use the
|
||||||
|
// same number for multiple options.
|
||||||
|
// * For options which will be published and used publicly by multiple
|
||||||
|
// independent entities, e-mail protobuf-global-extension-registry@google.com
|
||||||
|
// to reserve extension numbers. Simply provide your project name (e.g.
|
||||||
|
// Objective-C plugin) and your project website (if available) -- there's no
|
||||||
|
// need to explain how you intend to use them. Usually you only need one
|
||||||
|
// extension number. You can declare multiple options with only one extension
|
||||||
|
// number by putting them in a sub-message. See the Custom Options section of
|
||||||
|
// the docs for examples:
|
||||||
|
// https://developers.google.com/protocol-buffers/docs/proto#options
|
||||||
|
// If this turns out to be popular, a web service will be set up
|
||||||
|
// to automatically assign option numbers.
|
||||||
|
|
||||||
|
message FileOptions {
|
||||||
|
|
||||||
|
// Sets the Java package where classes generated from this .proto will be
|
||||||
|
// placed. By default, the proto package is used, but this is often
|
||||||
|
// inappropriate because proto packages do not normally start with backwards
|
||||||
|
// domain names.
|
||||||
|
optional string java_package = 1;
|
||||||
|
|
||||||
|
|
||||||
|
// Controls the name of the wrapper Java class generated for the .proto file.
|
||||||
|
// That class will always contain the .proto file's getDescriptor() method as
|
||||||
|
// well as any top-level extensions defined in the .proto file.
|
||||||
|
// If java_multiple_files is disabled, then all the other classes from the
|
||||||
|
// .proto file will be nested inside the single wrapper outer class.
|
||||||
|
optional string java_outer_classname = 8;
|
||||||
|
|
||||||
|
// If enabled, then the Java code generator will generate a separate .java
|
||||||
|
// file for each top-level message, enum, and service defined in the .proto
|
||||||
|
// file. Thus, these types will *not* be nested inside the wrapper class
|
||||||
|
// named by java_outer_classname. However, the wrapper class will still be
|
||||||
|
// generated to contain the file's getDescriptor() method as well as any
|
||||||
|
// top-level extensions defined in the file.
|
||||||
|
optional bool java_multiple_files = 10 [default = false];
|
||||||
|
|
||||||
|
// This option does nothing.
|
||||||
|
optional bool java_generate_equals_and_hash = 20 [deprecated=true];
|
||||||
|
|
||||||
|
// If set true, then the Java2 code generator will generate code that
|
||||||
|
// throws an exception whenever an attempt is made to assign a non-UTF-8
|
||||||
|
// byte sequence to a string field.
|
||||||
|
// Message reflection will do the same.
|
||||||
|
// However, an extension field still accepts non-UTF-8 byte sequences.
|
||||||
|
// This option has no effect on when used with the lite runtime.
|
||||||
|
optional bool java_string_check_utf8 = 27 [default = false];
|
||||||
|
|
||||||
|
|
||||||
|
// Generated classes can be optimized for speed or code size.
|
||||||
|
enum OptimizeMode {
|
||||||
|
SPEED = 1; // Generate complete code for parsing, serialization,
|
||||||
|
// etc.
|
||||||
|
CODE_SIZE = 2; // Use ReflectionOps to implement these methods.
|
||||||
|
LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime.
|
||||||
|
}
|
||||||
|
optional OptimizeMode optimize_for = 9 [default = SPEED];
|
||||||
|
|
||||||
|
// Sets the Go package where structs generated from this .proto will be
|
||||||
|
// placed. If omitted, the Go package will be derived from the following:
|
||||||
|
// - The basename of the package import path, if provided.
|
||||||
|
// - Otherwise, the package statement in the .proto file, if present.
|
||||||
|
// - Otherwise, the basename of the .proto file, without extension.
|
||||||
|
optional string go_package = 11;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Should generic services be generated in each language? "Generic" services
|
||||||
|
// are not specific to any particular RPC system. They are generated by the
|
||||||
|
// main code generators in each language (without additional plugins).
|
||||||
|
// Generic services were the only kind of service generation supported by
|
||||||
|
// early versions of google.protobuf.
|
||||||
|
//
|
||||||
|
// Generic services are now considered deprecated in favor of using plugins
|
||||||
|
// that generate code specific to your particular RPC system. Therefore,
|
||||||
|
// these default to false. Old code which depends on generic services should
|
||||||
|
// explicitly set them to true.
|
||||||
|
optional bool cc_generic_services = 16 [default = false];
|
||||||
|
optional bool java_generic_services = 17 [default = false];
|
||||||
|
optional bool py_generic_services = 18 [default = false];
|
||||||
|
optional bool php_generic_services = 42 [default = false];
|
||||||
|
|
||||||
|
// Is this file deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for everything in the file, or it will be completely ignored; in the very
|
||||||
|
// least, this is a formalization for deprecating files.
|
||||||
|
optional bool deprecated = 23 [default = false];
|
||||||
|
|
||||||
|
// Enables the use of arenas for the proto messages in this file. This applies
|
||||||
|
// only to generated classes for C++.
|
||||||
|
optional bool cc_enable_arenas = 31 [default = true];
|
||||||
|
|
||||||
|
|
||||||
|
// Sets the objective c class prefix which is prepended to all objective c
|
||||||
|
// generated classes from this .proto. There is no default.
|
||||||
|
optional string objc_class_prefix = 36;
|
||||||
|
|
||||||
|
// Namespace for generated classes; defaults to the package.
|
||||||
|
optional string csharp_namespace = 37;
|
||||||
|
|
||||||
|
// By default Swift generators will take the proto package and CamelCase it
|
||||||
|
// replacing '.' with underscore and use that to prefix the types/symbols
|
||||||
|
// defined. When this options is provided, they will use this value instead
|
||||||
|
// to prefix the types/symbols defined.
|
||||||
|
optional string swift_prefix = 39;
|
||||||
|
|
||||||
|
// Sets the php class prefix which is prepended to all php generated classes
|
||||||
|
// from this .proto. Default is empty.
|
||||||
|
optional string php_class_prefix = 40;
|
||||||
|
|
||||||
|
// Use this option to change the namespace of php generated classes. Default
|
||||||
|
// is empty. When this option is empty, the package name will be used for
|
||||||
|
// determining the namespace.
|
||||||
|
optional string php_namespace = 41;
|
||||||
|
|
||||||
|
// Use this option to change the namespace of php generated metadata classes.
|
||||||
|
// Default is empty. When this option is empty, the proto file name will be
|
||||||
|
// used for determining the namespace.
|
||||||
|
optional string php_metadata_namespace = 44;
|
||||||
|
|
||||||
|
// Use this option to change the package of ruby generated classes. Default
|
||||||
|
// is empty. When this option is not set, the package name will be used for
|
||||||
|
// determining the ruby package.
|
||||||
|
optional string ruby_package = 45;
|
||||||
|
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here.
|
||||||
|
// See the documentation for the "Options" section above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message.
|
||||||
|
// See the documentation for the "Options" section above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
|
||||||
|
reserved 38;
|
||||||
|
}
|
||||||
|
|
||||||
|
message MessageOptions {
|
||||||
|
// Set true to use the old proto1 MessageSet wire format for extensions.
|
||||||
|
// This is provided for backwards-compatibility with the MessageSet wire
|
||||||
|
// format. You should not use this for any other reason: It's less
|
||||||
|
// efficient, has fewer features, and is more complicated.
|
||||||
|
//
|
||||||
|
// The message must be defined exactly as follows:
|
||||||
|
// message Foo {
|
||||||
|
// option message_set_wire_format = true;
|
||||||
|
// extensions 4 to max;
|
||||||
|
// }
|
||||||
|
// Note that the message cannot have any defined fields; MessageSets only
|
||||||
|
// have extensions.
|
||||||
|
//
|
||||||
|
// All extensions of your type must be singular messages; e.g. they cannot
|
||||||
|
// be int32s, enums, or repeated messages.
|
||||||
|
//
|
||||||
|
// Because this is an option, the above two restrictions are not enforced by
|
||||||
|
// the protocol compiler.
|
||||||
|
optional bool message_set_wire_format = 1 [default = false];
|
||||||
|
|
||||||
|
// Disables the generation of the standard "descriptor()" accessor, which can
|
||||||
|
// conflict with a field of the same name. This is meant to make migration
|
||||||
|
// from proto1 easier; new code should avoid fields named "descriptor".
|
||||||
|
optional bool no_standard_descriptor_accessor = 2 [default = false];
|
||||||
|
|
||||||
|
// Is this message deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for the message, or it will be completely ignored; in the very least,
|
||||||
|
// this is a formalization for deprecating messages.
|
||||||
|
optional bool deprecated = 3 [default = false];
|
||||||
|
|
||||||
|
reserved 4, 5, 6;
|
||||||
|
|
||||||
|
// Whether the message is an automatically generated map entry type for the
|
||||||
|
// maps field.
|
||||||
|
//
|
||||||
|
// For maps fields:
|
||||||
|
// map<KeyType, ValueType> map_field = 1;
|
||||||
|
// The parsed descriptor looks like:
|
||||||
|
// message MapFieldEntry {
|
||||||
|
// option map_entry = true;
|
||||||
|
// optional KeyType key = 1;
|
||||||
|
// optional ValueType value = 2;
|
||||||
|
// }
|
||||||
|
// repeated MapFieldEntry map_field = 1;
|
||||||
|
//
|
||||||
|
// Implementations may choose not to generate the map_entry=true message, but
|
||||||
|
// use a native map in the target language to hold the keys and values.
|
||||||
|
// The reflection APIs in such implementations still need to work as
|
||||||
|
// if the field is a repeated message field.
|
||||||
|
//
|
||||||
|
// NOTE: Do not set the option in .proto files. Always use the maps syntax
|
||||||
|
// instead. The option should only be implicitly set by the proto compiler
|
||||||
|
// parser.
|
||||||
|
optional bool map_entry = 7;
|
||||||
|
|
||||||
|
reserved 8; // javalite_serializable
|
||||||
|
reserved 9; // javanano_as_lite
|
||||||
|
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message FieldOptions {
|
||||||
|
// The ctype option instructs the C++ code generator to use a different
|
||||||
|
// representation of the field than it normally would. See the specific
|
||||||
|
// options below. This option is not yet implemented in the open source
|
||||||
|
// release -- sorry, we'll try to include it in a future version!
|
||||||
|
optional CType ctype = 1 [default = STRING];
|
||||||
|
enum CType {
|
||||||
|
// Default mode.
|
||||||
|
STRING = 0;
|
||||||
|
|
||||||
|
CORD = 1;
|
||||||
|
|
||||||
|
STRING_PIECE = 2;
|
||||||
|
}
|
||||||
|
// The packed option can be enabled for repeated primitive fields to enable
|
||||||
|
// a more efficient representation on the wire. Rather than repeatedly
|
||||||
|
// writing the tag and type for each element, the entire array is encoded as
|
||||||
|
// a single length-delimited blob. In proto3, only explicit setting it to
|
||||||
|
// false will avoid using packed encoding.
|
||||||
|
optional bool packed = 2;
|
||||||
|
|
||||||
|
// The jstype option determines the JavaScript type used for values of the
|
||||||
|
// field. The option is permitted only for 64 bit integral and fixed types
|
||||||
|
// (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
|
||||||
|
// is represented as JavaScript string, which avoids loss of precision that
|
||||||
|
// can happen when a large value is converted to a floating point JavaScript.
|
||||||
|
// Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
|
||||||
|
// use the JavaScript "number" type. The behavior of the default option
|
||||||
|
// JS_NORMAL is implementation dependent.
|
||||||
|
//
|
||||||
|
// This option is an enum to permit additional types to be added, e.g.
|
||||||
|
// goog.math.Integer.
|
||||||
|
optional JSType jstype = 6 [default = JS_NORMAL];
|
||||||
|
enum JSType {
|
||||||
|
// Use the default type.
|
||||||
|
JS_NORMAL = 0;
|
||||||
|
|
||||||
|
// Use JavaScript strings.
|
||||||
|
JS_STRING = 1;
|
||||||
|
|
||||||
|
// Use JavaScript numbers.
|
||||||
|
JS_NUMBER = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Should this field be parsed lazily? Lazy applies only to message-type
|
||||||
|
// fields. It means that when the outer message is initially parsed, the
|
||||||
|
// inner message's contents will not be parsed but instead stored in encoded
|
||||||
|
// form. The inner message will actually be parsed when it is first accessed.
|
||||||
|
//
|
||||||
|
// This is only a hint. Implementations are free to choose whether to use
|
||||||
|
// eager or lazy parsing regardless of the value of this option. However,
|
||||||
|
// setting this option true suggests that the protocol author believes that
|
||||||
|
// using lazy parsing on this field is worth the additional bookkeeping
|
||||||
|
// overhead typically needed to implement it.
|
||||||
|
//
|
||||||
|
// This option does not affect the public interface of any generated code;
|
||||||
|
// all method signatures remain the same. Furthermore, thread-safety of the
|
||||||
|
// interface is not affected by this option; const methods remain safe to
|
||||||
|
// call from multiple threads concurrently, while non-const methods continue
|
||||||
|
// to require exclusive access.
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// Note that implementations may choose not to check required fields within
|
||||||
|
// a lazy sub-message. That is, calling IsInitialized() on the outer message
|
||||||
|
// may return true even if the inner message has missing required fields.
|
||||||
|
// This is necessary because otherwise the inner message would have to be
|
||||||
|
// parsed in order to perform the check, defeating the purpose of lazy
|
||||||
|
// parsing. An implementation which chooses not to check required fields
|
||||||
|
// must be consistent about it. That is, for any particular sub-message, the
|
||||||
|
// implementation must either *always* check its required fields, or *never*
|
||||||
|
// check its required fields, regardless of whether or not the message has
|
||||||
|
// been parsed.
|
||||||
|
//
|
||||||
|
// As of 2021, lazy does no correctness checks on the byte stream during
|
||||||
|
// parsing. This may lead to crashes if and when an invalid byte stream is
|
||||||
|
// finally parsed upon access.
|
||||||
|
//
|
||||||
|
// TODO(b/211906113): Enable validation on lazy fields.
|
||||||
|
optional bool lazy = 5 [default = false];
|
||||||
|
|
||||||
|
// unverified_lazy does no correctness checks on the byte stream. This should
|
||||||
|
// only be used where lazy with verification is prohibitive for performance
|
||||||
|
// reasons.
|
||||||
|
optional bool unverified_lazy = 15 [default = false];
|
||||||
|
|
||||||
|
// Is this field deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for accessors, or it will be completely ignored; in the very least, this
|
||||||
|
// is a formalization for deprecating fields.
|
||||||
|
optional bool deprecated = 3 [default = false];
|
||||||
|
|
||||||
|
// For Google-internal migration only. Do not use.
|
||||||
|
optional bool weak = 10 [default = false];
|
||||||
|
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
|
||||||
|
reserved 4; // removed jtype
|
||||||
|
}
|
||||||
|
|
||||||
|
message OneofOptions {
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message EnumOptions {
|
||||||
|
|
||||||
|
// Set this option to true to allow mapping different tag names to the same
|
||||||
|
// value.
|
||||||
|
optional bool allow_alias = 2;
|
||||||
|
|
||||||
|
// Is this enum deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for the enum, or it will be completely ignored; in the very least, this
|
||||||
|
// is a formalization for deprecating enums.
|
||||||
|
optional bool deprecated = 3 [default = false];
|
||||||
|
|
||||||
|
reserved 5; // javanano_as_lite
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message EnumValueOptions {
|
||||||
|
// Is this enum value deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for the enum value, or it will be completely ignored; in the very least,
|
||||||
|
// this is a formalization for deprecating enum values.
|
||||||
|
optional bool deprecated = 1 [default = false];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ServiceOptions {
|
||||||
|
|
||||||
|
// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
|
||||||
|
// framework. We apologize for hoarding these numbers to ourselves, but
|
||||||
|
// we were already using them long before we decided to release Protocol
|
||||||
|
// Buffers.
|
||||||
|
|
||||||
|
// Is this service deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for the service, or it will be completely ignored; in the very least,
|
||||||
|
// this is a formalization for deprecating services.
|
||||||
|
optional bool deprecated = 33 [default = false];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
message MethodOptions {
|
||||||
|
|
||||||
|
// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
|
||||||
|
// framework. We apologize for hoarding these numbers to ourselves, but
|
||||||
|
// we were already using them long before we decided to release Protocol
|
||||||
|
// Buffers.
|
||||||
|
|
||||||
|
// Is this method deprecated?
|
||||||
|
// Depending on the target platform, this can emit Deprecated annotations
|
||||||
|
// for the method, or it will be completely ignored; in the very least,
|
||||||
|
// this is a formalization for deprecating methods.
|
||||||
|
optional bool deprecated = 33 [default = false];
|
||||||
|
|
||||||
|
// Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
|
||||||
|
// or neither? HTTP based RPC implementation may choose GET verb for safe
|
||||||
|
// methods, and PUT verb for idempotent methods instead of the default POST.
|
||||||
|
enum IdempotencyLevel {
|
||||||
|
IDEMPOTENCY_UNKNOWN = 0;
|
||||||
|
NO_SIDE_EFFECTS = 1; // implies idempotent
|
||||||
|
IDEMPOTENT = 2; // idempotent, but may have side effects
|
||||||
|
}
|
||||||
|
optional IdempotencyLevel idempotency_level = 34
|
||||||
|
[default = IDEMPOTENCY_UNKNOWN];
|
||||||
|
|
||||||
|
// The parser stores options it doesn't recognize here. See above.
|
||||||
|
repeated UninterpretedOption uninterpreted_option = 999;
|
||||||
|
|
||||||
|
// Clients can define custom options in extensions of this message. See above.
|
||||||
|
extensions 1000 to max;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// A message representing a option the parser does not recognize. This only
|
||||||
|
// appears in options protos created by the compiler::Parser class.
|
||||||
|
// DescriptorPool resolves these when building Descriptor objects. Therefore,
|
||||||
|
// options protos in descriptor objects (e.g. returned by Descriptor::options(),
|
||||||
|
// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
|
||||||
|
// in them.
|
||||||
|
message UninterpretedOption {
|
||||||
|
// The name of the uninterpreted option. Each string represents a segment in
|
||||||
|
// a dot-separated name. is_extension is true iff a segment represents an
|
||||||
|
// extension (denoted with parentheses in options specs in .proto files).
|
||||||
|
// E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
|
||||||
|
// "foo.(bar.baz).qux".
|
||||||
|
message NamePart {
|
||||||
|
required string name_part = 1;
|
||||||
|
required bool is_extension = 2;
|
||||||
|
}
|
||||||
|
repeated NamePart name = 2;
|
||||||
|
|
||||||
|
// The value of the uninterpreted option, in whatever type the tokenizer
|
||||||
|
// identified it as during parsing. Exactly one of these should be set.
|
||||||
|
optional string identifier_value = 3;
|
||||||
|
optional uint64 positive_int_value = 4;
|
||||||
|
optional int64 negative_int_value = 5;
|
||||||
|
optional double double_value = 6;
|
||||||
|
optional bytes string_value = 7;
|
||||||
|
optional string aggregate_value = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ===================================================================
|
||||||
|
// Optional source code info
|
||||||
|
|
||||||
|
// Encapsulates information about the original source file from which a
|
||||||
|
// FileDescriptorProto was generated.
|
||||||
|
message SourceCodeInfo {
|
||||||
|
// A Location identifies a piece of source code in a .proto file which
|
||||||
|
// corresponds to a particular definition. This information is intended
|
||||||
|
// to be useful to IDEs, code indexers, documentation generators, and similar
|
||||||
|
// tools.
|
||||||
|
//
|
||||||
|
// For example, say we have a file like:
|
||||||
|
// message Foo {
|
||||||
|
// optional string foo = 1;
|
||||||
|
// }
|
||||||
|
// Let's look at just the field definition:
|
||||||
|
// optional string foo = 1;
|
||||||
|
// ^ ^^ ^^ ^ ^^^
|
||||||
|
// a bc de f ghi
|
||||||
|
// We have the following locations:
|
||||||
|
// span path represents
|
||||||
|
// [a,i) [ 4, 0, 2, 0 ] The whole field definition.
|
||||||
|
// [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
|
||||||
|
// [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
|
||||||
|
// [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
|
||||||
|
// [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
|
||||||
|
//
|
||||||
|
// Notes:
|
||||||
|
// - A location may refer to a repeated field itself (i.e. not to any
|
||||||
|
// particular index within it). This is used whenever a set of elements are
|
||||||
|
// logically enclosed in a single code segment. For example, an entire
|
||||||
|
// extend block (possibly containing multiple extension definitions) will
|
||||||
|
// have an outer location whose path refers to the "extensions" repeated
|
||||||
|
// field without an index.
|
||||||
|
// - Multiple locations may have the same path. This happens when a single
|
||||||
|
// logical declaration is spread out across multiple places. The most
|
||||||
|
// obvious example is the "extend" block again -- there may be multiple
|
||||||
|
// extend blocks in the same scope, each of which will have the same path.
|
||||||
|
// - A location's span is not always a subset of its parent's span. For
|
||||||
|
// example, the "extendee" of an extension declaration appears at the
|
||||||
|
// beginning of the "extend" block and is shared by all extensions within
|
||||||
|
// the block.
|
||||||
|
// - Just because a location's span is a subset of some other location's span
|
||||||
|
// does not mean that it is a descendant. For example, a "group" defines
|
||||||
|
// both a type and a field in a single declaration. Thus, the locations
|
||||||
|
// corresponding to the type and field and their components will overlap.
|
||||||
|
// - Code which tries to interpret locations should probably be designed to
|
||||||
|
// ignore those that it doesn't understand, as more types of locations could
|
||||||
|
// be recorded in the future.
|
||||||
|
repeated Location location = 1;
|
||||||
|
message Location {
|
||||||
|
// Identifies which part of the FileDescriptorProto was defined at this
|
||||||
|
// location.
|
||||||
|
//
|
||||||
|
// Each element is a field number or an index. They form a path from
|
||||||
|
// the root FileDescriptorProto to the place where the definition occurs.
|
||||||
|
// For example, this path:
|
||||||
|
// [ 4, 3, 2, 7, 1 ]
|
||||||
|
// refers to:
|
||||||
|
// file.message_type(3) // 4, 3
|
||||||
|
// .field(7) // 2, 7
|
||||||
|
// .name() // 1
|
||||||
|
// This is because FileDescriptorProto.message_type has field number 4:
|
||||||
|
// repeated DescriptorProto message_type = 4;
|
||||||
|
// and DescriptorProto.field has field number 2:
|
||||||
|
// repeated FieldDescriptorProto field = 2;
|
||||||
|
// and FieldDescriptorProto.name has field number 1:
|
||||||
|
// optional string name = 1;
|
||||||
|
//
|
||||||
|
// Thus, the above path gives the location of a field name. If we removed
|
||||||
|
// the last element:
|
||||||
|
// [ 4, 3, 2, 7 ]
|
||||||
|
// this path refers to the whole field declaration (from the beginning
|
||||||
|
// of the label to the terminating semicolon).
|
||||||
|
repeated int32 path = 1 [packed = true];
|
||||||
|
|
||||||
|
// Always has exactly three or four elements: start line, start column,
|
||||||
|
// end line (optional, otherwise assumed same as start line), end column.
|
||||||
|
// These are packed into a single field for efficiency. Note that line
|
||||||
|
// and column numbers are zero-based -- typically you will want to add
|
||||||
|
// 1 to each before displaying to a user.
|
||||||
|
repeated int32 span = 2 [packed = true];
|
||||||
|
|
||||||
|
// If this SourceCodeInfo represents a complete declaration, these are any
|
||||||
|
// comments appearing before and after the declaration which appear to be
|
||||||
|
// attached to the declaration.
|
||||||
|
//
|
||||||
|
// A series of line comments appearing on consecutive lines, with no other
|
||||||
|
// tokens appearing on those lines, will be treated as a single comment.
|
||||||
|
//
|
||||||
|
// leading_detached_comments will keep paragraphs of comments that appear
|
||||||
|
// before (but not connected to) the current element. Each paragraph,
|
||||||
|
// separated by empty lines, will be one comment element in the repeated
|
||||||
|
// field.
|
||||||
|
//
|
||||||
|
// Only the comment content is provided; comment markers (e.g. //) are
|
||||||
|
// stripped out. For block comments, leading whitespace and an asterisk
|
||||||
|
// will be stripped from the beginning of each line other than the first.
|
||||||
|
// Newlines are included in the output.
|
||||||
|
//
|
||||||
|
// Examples:
|
||||||
|
//
|
||||||
|
// optional int32 foo = 1; // Comment attached to foo.
|
||||||
|
// // Comment attached to bar.
|
||||||
|
// optional int32 bar = 2;
|
||||||
|
//
|
||||||
|
// optional string baz = 3;
|
||||||
|
// // Comment attached to baz.
|
||||||
|
// // Another line attached to baz.
|
||||||
|
//
|
||||||
|
// // Comment attached to qux.
|
||||||
|
// //
|
||||||
|
// // Another line attached to qux.
|
||||||
|
// optional double qux = 4;
|
||||||
|
//
|
||||||
|
// // Detached comment for corge. This is not leading or trailing comments
|
||||||
|
// // to qux or corge because there are blank lines separating it from
|
||||||
|
// // both.
|
||||||
|
//
|
||||||
|
// // Detached comment for corge paragraph 2.
|
||||||
|
//
|
||||||
|
// optional string corge = 5;
|
||||||
|
// /* Block comment attached
|
||||||
|
// * to corge. Leading asterisks
|
||||||
|
// * will be removed. */
|
||||||
|
// /* Block comment attached to
|
||||||
|
// * grault. */
|
||||||
|
// optional int32 grault = 6;
|
||||||
|
//
|
||||||
|
// // ignored detached comments.
|
||||||
|
optional string leading_comments = 3;
|
||||||
|
optional string trailing_comments = 4;
|
||||||
|
repeated string leading_detached_comments = 6;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Describes the relationship between generated code and its original source
|
||||||
|
// file. A GeneratedCodeInfo message is associated with only one generated
|
||||||
|
// source file, but may contain references to different source .proto files.
|
||||||
|
message GeneratedCodeInfo {
|
||||||
|
// An Annotation connects some span of text in generated code to an element
|
||||||
|
// of its generating .proto file.
|
||||||
|
repeated Annotation annotation = 1;
|
||||||
|
message Annotation {
|
||||||
|
// Identifies the element in the original source .proto file. This field
|
||||||
|
// is formatted the same as SourceCodeInfo.Location.path.
|
||||||
|
repeated int32 path = 1 [packed = true];
|
||||||
|
|
||||||
|
// Identifies the filesystem path to the original source .proto.
|
||||||
|
optional string source_file = 2;
|
||||||
|
|
||||||
|
// Identifies the starting offset in bytes in the generated code
|
||||||
|
// that relates to the identified object.
|
||||||
|
optional int32 begin = 3;
|
||||||
|
|
||||||
|
// Identifies the ending offset in bytes in the generated code that
|
||||||
|
// relates to the identified offset. The end offset should be one past
|
||||||
|
// the last relevant byte (so the length of the text = end - begin).
|
||||||
|
optional int32 end = 4;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,116 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/durationpb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "DurationProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
|
||||||
|
// A Duration represents a signed, fixed-length span of time represented
|
||||||
|
// as a count of seconds and fractions of seconds at nanosecond
|
||||||
|
// resolution. It is independent of any calendar and concepts like "day"
|
||||||
|
// or "month". It is related to Timestamp in that the difference between
|
||||||
|
// two Timestamp values is a Duration and it can be added or subtracted
|
||||||
|
// from a Timestamp. Range is approximately +-10,000 years.
|
||||||
|
//
|
||||||
|
// # Examples
|
||||||
|
//
|
||||||
|
// Example 1: Compute Duration from two Timestamps in pseudo code.
|
||||||
|
//
|
||||||
|
// Timestamp start = ...;
|
||||||
|
// Timestamp end = ...;
|
||||||
|
// Duration duration = ...;
|
||||||
|
//
|
||||||
|
// duration.seconds = end.seconds - start.seconds;
|
||||||
|
// duration.nanos = end.nanos - start.nanos;
|
||||||
|
//
|
||||||
|
// if (duration.seconds < 0 && duration.nanos > 0) {
|
||||||
|
// duration.seconds += 1;
|
||||||
|
// duration.nanos -= 1000000000;
|
||||||
|
// } else if (duration.seconds > 0 && duration.nanos < 0) {
|
||||||
|
// duration.seconds -= 1;
|
||||||
|
// duration.nanos += 1000000000;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
||||||
|
//
|
||||||
|
// Timestamp start = ...;
|
||||||
|
// Duration duration = ...;
|
||||||
|
// Timestamp end = ...;
|
||||||
|
//
|
||||||
|
// end.seconds = start.seconds + duration.seconds;
|
||||||
|
// end.nanos = start.nanos + duration.nanos;
|
||||||
|
//
|
||||||
|
// if (end.nanos < 0) {
|
||||||
|
// end.seconds -= 1;
|
||||||
|
// end.nanos += 1000000000;
|
||||||
|
// } else if (end.nanos >= 1000000000) {
|
||||||
|
// end.seconds += 1;
|
||||||
|
// end.nanos -= 1000000000;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Example 3: Compute Duration from datetime.timedelta in Python.
|
||||||
|
//
|
||||||
|
// td = datetime.timedelta(days=3, minutes=10)
|
||||||
|
// duration = Duration()
|
||||||
|
// duration.FromTimedelta(td)
|
||||||
|
//
|
||||||
|
// # JSON Mapping
|
||||||
|
//
|
||||||
|
// In JSON format, the Duration type is encoded as a string rather than an
|
||||||
|
// object, where the string ends in the suffix "s" (indicating seconds) and
|
||||||
|
// is preceded by the number of seconds, with nanoseconds expressed as
|
||||||
|
// fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
||||||
|
// encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
||||||
|
// be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
||||||
|
// microsecond should be expressed in JSON format as "3.000001s".
|
||||||
|
//
|
||||||
|
//
|
||||||
|
message Duration {
|
||||||
|
// Signed seconds of the span of time. Must be from -315,576,000,000
|
||||||
|
// to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
||||||
|
// 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
||||||
|
int64 seconds = 1;
|
||||||
|
|
||||||
|
// Signed fractions of a second at nanosecond resolution of the span
|
||||||
|
// of time. Durations less than one second are represented with a 0
|
||||||
|
// `seconds` field and a positive or negative `nanos` field. For durations
|
||||||
|
// of one second or more, a non-zero value for the `nanos` field must be
|
||||||
|
// of the same sign as the `seconds` field. Must be from -999,999,999
|
||||||
|
// to +999,999,999 inclusive.
|
||||||
|
int32 nanos = 2;
|
||||||
|
}
|
|
@ -0,0 +1,52 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/emptypb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "EmptyProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
|
||||||
|
// A generic empty message that you can re-use to avoid defining duplicated
|
||||||
|
// empty messages in your APIs. A typical example is to use it as the request
|
||||||
|
// or the response type of an API method. For instance:
|
||||||
|
//
|
||||||
|
// service Foo {
|
||||||
|
// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// The JSON representation for `Empty` is empty JSON object `{}`.
|
||||||
|
message Empty {}
|
|
@ -0,0 +1,245 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "FieldMaskProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/fieldmaskpb";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
|
||||||
|
// `FieldMask` represents a set of symbolic field paths, for example:
|
||||||
|
//
|
||||||
|
// paths: "f.a"
|
||||||
|
// paths: "f.b.d"
|
||||||
|
//
|
||||||
|
// Here `f` represents a field in some root message, `a` and `b`
|
||||||
|
// fields in the message found in `f`, and `d` a field found in the
|
||||||
|
// message in `f.b`.
|
||||||
|
//
|
||||||
|
// Field masks are used to specify a subset of fields that should be
|
||||||
|
// returned by a get operation or modified by an update operation.
|
||||||
|
// Field masks also have a custom JSON encoding (see below).
|
||||||
|
//
|
||||||
|
// # Field Masks in Projections
|
||||||
|
//
|
||||||
|
// When used in the context of a projection, a response message or
|
||||||
|
// sub-message is filtered by the API to only contain those fields as
|
||||||
|
// specified in the mask. For example, if the mask in the previous
|
||||||
|
// example is applied to a response message as follows:
|
||||||
|
//
|
||||||
|
// f {
|
||||||
|
// a : 22
|
||||||
|
// b {
|
||||||
|
// d : 1
|
||||||
|
// x : 2
|
||||||
|
// }
|
||||||
|
// y : 13
|
||||||
|
// }
|
||||||
|
// z: 8
|
||||||
|
//
|
||||||
|
// The result will not contain specific values for fields x,y and z
|
||||||
|
// (their value will be set to the default, and omitted in proto text
|
||||||
|
// output):
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// f {
|
||||||
|
// a : 22
|
||||||
|
// b {
|
||||||
|
// d : 1
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// A repeated field is not allowed except at the last position of a
|
||||||
|
// paths string.
|
||||||
|
//
|
||||||
|
// If a FieldMask object is not present in a get operation, the
|
||||||
|
// operation applies to all fields (as if a FieldMask of all fields
|
||||||
|
// had been specified).
|
||||||
|
//
|
||||||
|
// Note that a field mask does not necessarily apply to the
|
||||||
|
// top-level response message. In case of a REST get operation, the
|
||||||
|
// field mask applies directly to the response, but in case of a REST
|
||||||
|
// list operation, the mask instead applies to each individual message
|
||||||
|
// in the returned resource list. In case of a REST custom method,
|
||||||
|
// other definitions may be used. Where the mask applies will be
|
||||||
|
// clearly documented together with its declaration in the API. In
|
||||||
|
// any case, the effect on the returned resource/resources is required
|
||||||
|
// behavior for APIs.
|
||||||
|
//
|
||||||
|
// # Field Masks in Update Operations
|
||||||
|
//
|
||||||
|
// A field mask in update operations specifies which fields of the
|
||||||
|
// targeted resource are going to be updated. The API is required
|
||||||
|
// to only change the values of the fields as specified in the mask
|
||||||
|
// and leave the others untouched. If a resource is passed in to
|
||||||
|
// describe the updated values, the API ignores the values of all
|
||||||
|
// fields not covered by the mask.
|
||||||
|
//
|
||||||
|
// If a repeated field is specified for an update operation, new values will
|
||||||
|
// be appended to the existing repeated field in the target resource. Note that
|
||||||
|
// a repeated field is only allowed in the last position of a `paths` string.
|
||||||
|
//
|
||||||
|
// If a sub-message is specified in the last position of the field mask for an
|
||||||
|
// update operation, then new value will be merged into the existing sub-message
|
||||||
|
// in the target resource.
|
||||||
|
//
|
||||||
|
// For example, given the target message:
|
||||||
|
//
|
||||||
|
// f {
|
||||||
|
// b {
|
||||||
|
// d: 1
|
||||||
|
// x: 2
|
||||||
|
// }
|
||||||
|
// c: [1]
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// And an update message:
|
||||||
|
//
|
||||||
|
// f {
|
||||||
|
// b {
|
||||||
|
// d: 10
|
||||||
|
// }
|
||||||
|
// c: [2]
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// then if the field mask is:
|
||||||
|
//
|
||||||
|
// paths: ["f.b", "f.c"]
|
||||||
|
//
|
||||||
|
// then the result will be:
|
||||||
|
//
|
||||||
|
// f {
|
||||||
|
// b {
|
||||||
|
// d: 10
|
||||||
|
// x: 2
|
||||||
|
// }
|
||||||
|
// c: [1, 2]
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// An implementation may provide options to override this default behavior for
|
||||||
|
// repeated and message fields.
|
||||||
|
//
|
||||||
|
// In order to reset a field's value to the default, the field must
|
||||||
|
// be in the mask and set to the default value in the provided resource.
|
||||||
|
// Hence, in order to reset all fields of a resource, provide a default
|
||||||
|
// instance of the resource and set all fields in the mask, or do
|
||||||
|
// not provide a mask as described below.
|
||||||
|
//
|
||||||
|
// If a field mask is not present on update, the operation applies to
|
||||||
|
// all fields (as if a field mask of all fields has been specified).
|
||||||
|
// Note that in the presence of schema evolution, this may mean that
|
||||||
|
// fields the client does not know and has therefore not filled into
|
||||||
|
// the request will be reset to their default. If this is unwanted
|
||||||
|
// behavior, a specific service may require a client to always specify
|
||||||
|
// a field mask, producing an error if not.
|
||||||
|
//
|
||||||
|
// As with get operations, the location of the resource which
|
||||||
|
// describes the updated values in the request message depends on the
|
||||||
|
// operation kind. In any case, the effect of the field mask is
|
||||||
|
// required to be honored by the API.
|
||||||
|
//
|
||||||
|
// ## Considerations for HTTP REST
|
||||||
|
//
|
||||||
|
// The HTTP kind of an update operation which uses a field mask must
|
||||||
|
// be set to PATCH instead of PUT in order to satisfy HTTP semantics
|
||||||
|
// (PUT must only be used for full updates).
|
||||||
|
//
|
||||||
|
// # JSON Encoding of Field Masks
|
||||||
|
//
|
||||||
|
// In JSON, a field mask is encoded as a single string where paths are
|
||||||
|
// separated by a comma. Fields name in each path are converted
|
||||||
|
// to/from lower-camel naming conventions.
|
||||||
|
//
|
||||||
|
// As an example, consider the following message declarations:
|
||||||
|
//
|
||||||
|
// message Profile {
|
||||||
|
// User user = 1;
|
||||||
|
// Photo photo = 2;
|
||||||
|
// }
|
||||||
|
// message User {
|
||||||
|
// string display_name = 1;
|
||||||
|
// string address = 2;
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// In proto a field mask for `Profile` may look as such:
|
||||||
|
//
|
||||||
|
// mask {
|
||||||
|
// paths: "user.display_name"
|
||||||
|
// paths: "photo"
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// In JSON, the same mask is represented as below:
|
||||||
|
//
|
||||||
|
// {
|
||||||
|
// mask: "user.displayName,photo"
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// # Field Masks and Oneof Fields
|
||||||
|
//
|
||||||
|
// Field masks treat fields in oneofs just as regular fields. Consider the
|
||||||
|
// following message:
|
||||||
|
//
|
||||||
|
// message SampleMessage {
|
||||||
|
// oneof test_oneof {
|
||||||
|
// string name = 4;
|
||||||
|
// SubMessage sub_message = 9;
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// The field mask can be:
|
||||||
|
//
|
||||||
|
// mask {
|
||||||
|
// paths: "name"
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Or:
|
||||||
|
//
|
||||||
|
// mask {
|
||||||
|
// paths: "sub_message"
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// Note that oneof type names ("test_oneof" in this case) cannot be used in
|
||||||
|
// paths.
|
||||||
|
//
|
||||||
|
// ## Field Mask Verification
|
||||||
|
//
|
||||||
|
// The implementation of any API method which has a FieldMask type field in the
|
||||||
|
// request should verify the included field paths, and return an
|
||||||
|
// `INVALID_ARGUMENT` error if any path is unmappable.
|
||||||
|
message FieldMask {
|
||||||
|
// The set of field mask paths.
|
||||||
|
repeated string paths = 1;
|
||||||
|
}
|
|
@ -0,0 +1,48 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "SourceContextProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/sourcecontextpb";
|
||||||
|
|
||||||
|
// `SourceContext` represents information about the source of a
|
||||||
|
// protobuf element, like the file in which it is defined.
|
||||||
|
message SourceContext {
|
||||||
|
// The path-qualified name of the .proto file that contained the associated
|
||||||
|
// protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
||||||
|
string file_name = 1;
|
||||||
|
}
|
|
@ -0,0 +1,95 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/structpb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "StructProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
|
||||||
|
// `Struct` represents a structured data value, consisting of fields
|
||||||
|
// which map to dynamically typed values. In some languages, `Struct`
|
||||||
|
// might be supported by a native representation. For example, in
|
||||||
|
// scripting languages like JS a struct is represented as an
|
||||||
|
// object. The details of that representation are described together
|
||||||
|
// with the proto support for the language.
|
||||||
|
//
|
||||||
|
// The JSON representation for `Struct` is JSON object.
|
||||||
|
message Struct {
|
||||||
|
// Unordered map of dynamically typed values.
|
||||||
|
map<string, Value> fields = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// `Value` represents a dynamically typed value which can be either
|
||||||
|
// null, a number, a string, a boolean, a recursive struct value, or a
|
||||||
|
// list of values. A producer of value is expected to set one of these
|
||||||
|
// variants. Absence of any variant indicates an error.
|
||||||
|
//
|
||||||
|
// The JSON representation for `Value` is JSON value.
|
||||||
|
message Value {
|
||||||
|
// The kind of value.
|
||||||
|
oneof kind {
|
||||||
|
// Represents a null value.
|
||||||
|
NullValue null_value = 1;
|
||||||
|
// Represents a double value.
|
||||||
|
double number_value = 2;
|
||||||
|
// Represents a string value.
|
||||||
|
string string_value = 3;
|
||||||
|
// Represents a boolean value.
|
||||||
|
bool bool_value = 4;
|
||||||
|
// Represents a structured value.
|
||||||
|
Struct struct_value = 5;
|
||||||
|
// Represents a repeated `Value`.
|
||||||
|
ListValue list_value = 6;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// `NullValue` is a singleton enumeration to represent the null value for the
|
||||||
|
// `Value` type union.
|
||||||
|
//
|
||||||
|
// The JSON representation for `NullValue` is JSON `null`.
|
||||||
|
enum NullValue {
|
||||||
|
// Null value.
|
||||||
|
NULL_VALUE = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// `ListValue` is a wrapper around a repeated field of values.
|
||||||
|
//
|
||||||
|
// The JSON representation for `ListValue` is JSON array.
|
||||||
|
message ListValue {
|
||||||
|
// Repeated field of dynamically typed values.
|
||||||
|
repeated Value values = 1;
|
||||||
|
}
|
|
@ -0,0 +1,147 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/timestamppb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "TimestampProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
|
||||||
|
// A Timestamp represents a point in time independent of any time zone or local
|
||||||
|
// calendar, encoded as a count of seconds and fractions of seconds at
|
||||||
|
// nanosecond resolution. The count is relative to an epoch at UTC midnight on
|
||||||
|
// January 1, 1970, in the proleptic Gregorian calendar which extends the
|
||||||
|
// Gregorian calendar backwards to year one.
|
||||||
|
//
|
||||||
|
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
|
||||||
|
// second table is needed for interpretation, using a [24-hour linear
|
||||||
|
// smear](https://developers.google.com/time/smear).
|
||||||
|
//
|
||||||
|
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
|
||||||
|
// restricting to that range, we ensure that we can convert to and from [RFC
|
||||||
|
// 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
|
||||||
|
//
|
||||||
|
// # Examples
|
||||||
|
//
|
||||||
|
// Example 1: Compute Timestamp from POSIX `time()`.
|
||||||
|
//
|
||||||
|
// Timestamp timestamp;
|
||||||
|
// timestamp.set_seconds(time(NULL));
|
||||||
|
// timestamp.set_nanos(0);
|
||||||
|
//
|
||||||
|
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
||||||
|
//
|
||||||
|
// struct timeval tv;
|
||||||
|
// gettimeofday(&tv, NULL);
|
||||||
|
//
|
||||||
|
// Timestamp timestamp;
|
||||||
|
// timestamp.set_seconds(tv.tv_sec);
|
||||||
|
// timestamp.set_nanos(tv.tv_usec * 1000);
|
||||||
|
//
|
||||||
|
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
||||||
|
//
|
||||||
|
// FILETIME ft;
|
||||||
|
// GetSystemTimeAsFileTime(&ft);
|
||||||
|
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
|
||||||
|
//
|
||||||
|
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
|
||||||
|
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
|
||||||
|
// Timestamp timestamp;
|
||||||
|
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
||||||
|
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
||||||
|
//
|
||||||
|
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
||||||
|
//
|
||||||
|
// long millis = System.currentTimeMillis();
|
||||||
|
//
|
||||||
|
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
|
||||||
|
// .setNanos((int) ((millis % 1000) * 1000000)).build();
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// Example 5: Compute Timestamp from Java `Instant.now()`.
|
||||||
|
//
|
||||||
|
// Instant now = Instant.now();
|
||||||
|
//
|
||||||
|
// Timestamp timestamp =
|
||||||
|
// Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
||||||
|
// .setNanos(now.getNano()).build();
|
||||||
|
//
|
||||||
|
//
|
||||||
|
// Example 6: Compute Timestamp from current time in Python.
|
||||||
|
//
|
||||||
|
// timestamp = Timestamp()
|
||||||
|
// timestamp.GetCurrentTime()
|
||||||
|
//
|
||||||
|
// # JSON Mapping
|
||||||
|
//
|
||||||
|
// In JSON format, the Timestamp type is encoded as a string in the
|
||||||
|
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
|
||||||
|
// format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
|
||||||
|
// where {year} is always expressed using four digits while {month}, {day},
|
||||||
|
// {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
|
||||||
|
// seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
|
||||||
|
// are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
|
||||||
|
// is required. A proto3 JSON serializer should always use UTC (as indicated by
|
||||||
|
// "Z") when printing the Timestamp type and a proto3 JSON parser should be
|
||||||
|
// able to accept both UTC and other timezones (as indicated by an offset).
|
||||||
|
//
|
||||||
|
// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
|
||||||
|
// 01:30 UTC on January 15, 2017.
|
||||||
|
//
|
||||||
|
// In JavaScript, one can convert a Date object to this format using the
|
||||||
|
// standard
|
||||||
|
// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
|
||||||
|
// method. In Python, a standard `datetime.datetime` object can be converted
|
||||||
|
// to this format using
|
||||||
|
// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
||||||
|
// the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
||||||
|
// the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
||||||
|
// http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
|
||||||
|
// ) to obtain a formatter capable of generating timestamps in this format.
|
||||||
|
//
|
||||||
|
//
|
||||||
|
message Timestamp {
|
||||||
|
// Represents seconds of UTC time since Unix epoch
|
||||||
|
// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
|
||||||
|
// 9999-12-31T23:59:59Z inclusive.
|
||||||
|
int64 seconds = 1;
|
||||||
|
|
||||||
|
// Non-negative fractions of a second at nanosecond resolution. Negative
|
||||||
|
// second values with fractions must still have non-negative nanos values
|
||||||
|
// that count forward in time. Must be from 0 to 999,999,999
|
||||||
|
// inclusive.
|
||||||
|
int32 nanos = 2;
|
||||||
|
}
|
|
@ -0,0 +1,187 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
import "google/protobuf/any.proto";
|
||||||
|
import "google/protobuf/source_context.proto";
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "TypeProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/typepb";
|
||||||
|
|
||||||
|
// A protocol buffer message type.
|
||||||
|
message Type {
|
||||||
|
// The fully qualified message name.
|
||||||
|
string name = 1;
|
||||||
|
// The list of fields.
|
||||||
|
repeated Field fields = 2;
|
||||||
|
// The list of types appearing in `oneof` definitions in this type.
|
||||||
|
repeated string oneofs = 3;
|
||||||
|
// The protocol buffer options.
|
||||||
|
repeated Option options = 4;
|
||||||
|
// The source context.
|
||||||
|
SourceContext source_context = 5;
|
||||||
|
// The source syntax.
|
||||||
|
Syntax syntax = 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A single field of a message type.
|
||||||
|
message Field {
|
||||||
|
// Basic field types.
|
||||||
|
enum Kind {
|
||||||
|
// Field type unknown.
|
||||||
|
TYPE_UNKNOWN = 0;
|
||||||
|
// Field type double.
|
||||||
|
TYPE_DOUBLE = 1;
|
||||||
|
// Field type float.
|
||||||
|
TYPE_FLOAT = 2;
|
||||||
|
// Field type int64.
|
||||||
|
TYPE_INT64 = 3;
|
||||||
|
// Field type uint64.
|
||||||
|
TYPE_UINT64 = 4;
|
||||||
|
// Field type int32.
|
||||||
|
TYPE_INT32 = 5;
|
||||||
|
// Field type fixed64.
|
||||||
|
TYPE_FIXED64 = 6;
|
||||||
|
// Field type fixed32.
|
||||||
|
TYPE_FIXED32 = 7;
|
||||||
|
// Field type bool.
|
||||||
|
TYPE_BOOL = 8;
|
||||||
|
// Field type string.
|
||||||
|
TYPE_STRING = 9;
|
||||||
|
// Field type group. Proto2 syntax only, and deprecated.
|
||||||
|
TYPE_GROUP = 10;
|
||||||
|
// Field type message.
|
||||||
|
TYPE_MESSAGE = 11;
|
||||||
|
// Field type bytes.
|
||||||
|
TYPE_BYTES = 12;
|
||||||
|
// Field type uint32.
|
||||||
|
TYPE_UINT32 = 13;
|
||||||
|
// Field type enum.
|
||||||
|
TYPE_ENUM = 14;
|
||||||
|
// Field type sfixed32.
|
||||||
|
TYPE_SFIXED32 = 15;
|
||||||
|
// Field type sfixed64.
|
||||||
|
TYPE_SFIXED64 = 16;
|
||||||
|
// Field type sint32.
|
||||||
|
TYPE_SINT32 = 17;
|
||||||
|
// Field type sint64.
|
||||||
|
TYPE_SINT64 = 18;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Whether a field is optional, required, or repeated.
|
||||||
|
enum Cardinality {
|
||||||
|
// For fields with unknown cardinality.
|
||||||
|
CARDINALITY_UNKNOWN = 0;
|
||||||
|
// For optional fields.
|
||||||
|
CARDINALITY_OPTIONAL = 1;
|
||||||
|
// For required fields. Proto2 syntax only.
|
||||||
|
CARDINALITY_REQUIRED = 2;
|
||||||
|
// For repeated fields.
|
||||||
|
CARDINALITY_REPEATED = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The field type.
|
||||||
|
Kind kind = 1;
|
||||||
|
// The field cardinality.
|
||||||
|
Cardinality cardinality = 2;
|
||||||
|
// The field number.
|
||||||
|
int32 number = 3;
|
||||||
|
// The field name.
|
||||||
|
string name = 4;
|
||||||
|
// The field type URL, without the scheme, for message or enumeration
|
||||||
|
// types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
||||||
|
string type_url = 6;
|
||||||
|
// The index of the field type in `Type.oneofs`, for message or enumeration
|
||||||
|
// types. The first type has index 1; zero means the type is not in the list.
|
||||||
|
int32 oneof_index = 7;
|
||||||
|
// Whether to use alternative packed wire representation.
|
||||||
|
bool packed = 8;
|
||||||
|
// The protocol buffer options.
|
||||||
|
repeated Option options = 9;
|
||||||
|
// The field JSON name.
|
||||||
|
string json_name = 10;
|
||||||
|
// The string value of the default value of this field. Proto2 syntax only.
|
||||||
|
string default_value = 11;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enum type definition.
|
||||||
|
message Enum {
|
||||||
|
// Enum type name.
|
||||||
|
string name = 1;
|
||||||
|
// Enum value definitions.
|
||||||
|
repeated EnumValue enumvalue = 2;
|
||||||
|
// Protocol buffer options.
|
||||||
|
repeated Option options = 3;
|
||||||
|
// The source context.
|
||||||
|
SourceContext source_context = 4;
|
||||||
|
// The source syntax.
|
||||||
|
Syntax syntax = 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enum value definition.
|
||||||
|
message EnumValue {
|
||||||
|
// Enum value name.
|
||||||
|
string name = 1;
|
||||||
|
// Enum value number.
|
||||||
|
int32 number = 2;
|
||||||
|
// Protocol buffer options.
|
||||||
|
repeated Option options = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A protocol buffer option, which can be attached to a message, field,
|
||||||
|
// enumeration, etc.
|
||||||
|
message Option {
|
||||||
|
// The option's name. For protobuf built-in options (options defined in
|
||||||
|
// descriptor.proto), this is the short name. For example, `"map_entry"`.
|
||||||
|
// For custom options, it should be the fully-qualified name. For example,
|
||||||
|
// `"google.api.http"`.
|
||||||
|
string name = 1;
|
||||||
|
// The option's value packed in an Any message. If the value is a primitive,
|
||||||
|
// the corresponding wrapper type defined in google/protobuf/wrappers.proto
|
||||||
|
// should be used. If the value is an enum, it should be stored as an int32
|
||||||
|
// value using the google.protobuf.Int32Value type.
|
||||||
|
Any value = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The syntax in which a protocol buffer element is defined.
|
||||||
|
enum Syntax {
|
||||||
|
// Syntax `proto2`.
|
||||||
|
SYNTAX_PROTO2 = 0;
|
||||||
|
// Syntax `proto3`.
|
||||||
|
SYNTAX_PROTO3 = 1;
|
||||||
|
}
|
|
@ -0,0 +1,123 @@
|
||||||
|
// Protocol Buffers - Google's data interchange format
|
||||||
|
// Copyright 2008 Google Inc. All rights reserved.
|
||||||
|
// https://developers.google.com/protocol-buffers/
|
||||||
|
//
|
||||||
|
// Redistribution and use in source and binary forms, with or without
|
||||||
|
// modification, are permitted provided that the following conditions are
|
||||||
|
// met:
|
||||||
|
//
|
||||||
|
// * Redistributions of source code must retain the above copyright
|
||||||
|
// notice, this list of conditions and the following disclaimer.
|
||||||
|
// * Redistributions in binary form must reproduce the above
|
||||||
|
// copyright notice, this list of conditions and the following disclaimer
|
||||||
|
// in the documentation and/or other materials provided with the
|
||||||
|
// distribution.
|
||||||
|
// * Neither the name of Google Inc. nor the names of its
|
||||||
|
// contributors may be used to endorse or promote products derived from
|
||||||
|
// this software without specific prior written permission.
|
||||||
|
//
|
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
// Wrappers for primitive (non-message) types. These types are useful
|
||||||
|
// for embedding primitives in the `google.protobuf.Any` type and for places
|
||||||
|
// where we need to distinguish between the absence of a primitive
|
||||||
|
// typed field and its default value.
|
||||||
|
//
|
||||||
|
// These wrappers have no meaningful use within repeated fields as they lack
|
||||||
|
// the ability to detect presence on individual elements.
|
||||||
|
// These wrappers have no meaningful use within a map or a oneof since
|
||||||
|
// individual entries of a map or fields of a oneof can already detect presence.
|
||||||
|
|
||||||
|
syntax = "proto3";
|
||||||
|
|
||||||
|
package google.protobuf;
|
||||||
|
|
||||||
|
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||||
|
option cc_enable_arenas = true;
|
||||||
|
option go_package = "google.golang.org/protobuf/types/known/wrapperspb";
|
||||||
|
option java_package = "com.google.protobuf";
|
||||||
|
option java_outer_classname = "WrappersProto";
|
||||||
|
option java_multiple_files = true;
|
||||||
|
option objc_class_prefix = "GPB";
|
||||||
|
|
||||||
|
// Wrapper message for `double`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `DoubleValue` is JSON number.
|
||||||
|
message DoubleValue {
|
||||||
|
// The double value.
|
||||||
|
double value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `float`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `FloatValue` is JSON number.
|
||||||
|
message FloatValue {
|
||||||
|
// The float value.
|
||||||
|
float value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `int64`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `Int64Value` is JSON string.
|
||||||
|
message Int64Value {
|
||||||
|
// The int64 value.
|
||||||
|
int64 value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `uint64`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `UInt64Value` is JSON string.
|
||||||
|
message UInt64Value {
|
||||||
|
// The uint64 value.
|
||||||
|
uint64 value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `int32`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `Int32Value` is JSON number.
|
||||||
|
message Int32Value {
|
||||||
|
// The int32 value.
|
||||||
|
int32 value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `uint32`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `UInt32Value` is JSON number.
|
||||||
|
message UInt32Value {
|
||||||
|
// The uint32 value.
|
||||||
|
uint32 value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `bool`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `BoolValue` is JSON `true` and `false`.
|
||||||
|
message BoolValue {
|
||||||
|
// The bool value.
|
||||||
|
bool value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `string`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `StringValue` is JSON string.
|
||||||
|
message StringValue {
|
||||||
|
// The string value.
|
||||||
|
string value = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrapper message for `bytes`.
|
||||||
|
//
|
||||||
|
// The JSON representation for `BytesValue` is JSON string.
|
||||||
|
message BytesValue {
|
||||||
|
// The bytes value.
|
||||||
|
bytes value = 1;
|
||||||
|
}
|
|
@ -0,0 +1,3 @@
|
||||||
|
# protoc-gen-validate (PGV)
|
||||||
|
|
||||||
|
* https://github.com/envoyproxy/protoc-gen-validate
|
|
@ -0,0 +1,862 @@
|
||||||
|
syntax = "proto2";
|
||||||
|
package validate;
|
||||||
|
|
||||||
|
option go_package = "github.com/envoyproxy/protoc-gen-validate/validate";
|
||||||
|
option java_package = "io.envoyproxy.pgv.validate";
|
||||||
|
|
||||||
|
import "google/protobuf/descriptor.proto";
|
||||||
|
import "google/protobuf/duration.proto";
|
||||||
|
import "google/protobuf/timestamp.proto";
|
||||||
|
|
||||||
|
// Validation rules applied at the message level
|
||||||
|
extend google.protobuf.MessageOptions {
|
||||||
|
// Disabled nullifies any validation rules for this message, including any
|
||||||
|
// message fields associated with it that do support validation.
|
||||||
|
optional bool disabled = 1071;
|
||||||
|
// Ignore skips generation of validation methods for this message.
|
||||||
|
optional bool ignored = 1072;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validation rules applied at the oneof level
|
||||||
|
extend google.protobuf.OneofOptions {
|
||||||
|
// Required ensures that exactly one the field options in a oneof is set;
|
||||||
|
// validation fails if no fields in the oneof are set.
|
||||||
|
optional bool required = 1071;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validation rules applied at the field level
|
||||||
|
extend google.protobuf.FieldOptions {
|
||||||
|
// Rules specify the validations to be performed on this field. By default,
|
||||||
|
// no validation is performed against a field.
|
||||||
|
optional FieldRules rules = 1071;
|
||||||
|
}
|
||||||
|
|
||||||
|
// FieldRules encapsulates the rules for each type of field. Depending on the
|
||||||
|
// field, the correct set should be used to ensure proper validations.
|
||||||
|
message FieldRules {
|
||||||
|
optional MessageRules message = 17;
|
||||||
|
oneof type {
|
||||||
|
// Scalar Field Types
|
||||||
|
FloatRules float = 1;
|
||||||
|
DoubleRules double = 2;
|
||||||
|
Int32Rules int32 = 3;
|
||||||
|
Int64Rules int64 = 4;
|
||||||
|
UInt32Rules uint32 = 5;
|
||||||
|
UInt64Rules uint64 = 6;
|
||||||
|
SInt32Rules sint32 = 7;
|
||||||
|
SInt64Rules sint64 = 8;
|
||||||
|
Fixed32Rules fixed32 = 9;
|
||||||
|
Fixed64Rules fixed64 = 10;
|
||||||
|
SFixed32Rules sfixed32 = 11;
|
||||||
|
SFixed64Rules sfixed64 = 12;
|
||||||
|
BoolRules bool = 13;
|
||||||
|
StringRules string = 14;
|
||||||
|
BytesRules bytes = 15;
|
||||||
|
|
||||||
|
// Complex Field Types
|
||||||
|
EnumRules enum = 16;
|
||||||
|
RepeatedRules repeated = 18;
|
||||||
|
MapRules map = 19;
|
||||||
|
|
||||||
|
// Well-Known Field Types
|
||||||
|
AnyRules any = 20;
|
||||||
|
DurationRules duration = 21;
|
||||||
|
TimestampRules timestamp = 22;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// FloatRules describes the constraints applied to `float` values
|
||||||
|
message FloatRules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional float const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional float lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional float lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional float gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional float gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated float in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated float not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// DoubleRules describes the constraints applied to `double` values
|
||||||
|
message DoubleRules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional double const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional double lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional double lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional double gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional double gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated double in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated double not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32Rules describes the constraints applied to `int32` values
|
||||||
|
message Int32Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional int32 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional int32 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional int32 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional int32 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional int32 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated int32 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated int32 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64Rules describes the constraints applied to `int64` values
|
||||||
|
message Int64Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional int64 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional int64 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional int64 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional int64 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional int64 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated int64 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated int64 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// UInt32Rules describes the constraints applied to `uint32` values
|
||||||
|
message UInt32Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional uint32 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional uint32 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional uint32 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional uint32 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional uint32 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated uint32 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated uint32 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// UInt64Rules describes the constraints applied to `uint64` values
|
||||||
|
message UInt64Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional uint64 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional uint64 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional uint64 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional uint64 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional uint64 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated uint64 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated uint64 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// SInt32Rules describes the constraints applied to `sint32` values
|
||||||
|
message SInt32Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional sint32 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional sint32 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional sint32 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional sint32 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional sint32 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sint32 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sint32 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// SInt64Rules describes the constraints applied to `sint64` values
|
||||||
|
message SInt64Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional sint64 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional sint64 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional sint64 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional sint64 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional sint64 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sint64 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sint64 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fixed32Rules describes the constraints applied to `fixed32` values
|
||||||
|
message Fixed32Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional fixed32 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional fixed32 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional fixed32 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional fixed32 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional fixed32 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated fixed32 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated fixed32 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fixed64Rules describes the constraints applied to `fixed64` values
|
||||||
|
message Fixed64Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional fixed64 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional fixed64 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional fixed64 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional fixed64 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional fixed64 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated fixed64 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated fixed64 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// SFixed32Rules describes the constraints applied to `sfixed32` values
|
||||||
|
message SFixed32Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional sfixed32 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional sfixed32 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional sfixed32 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional sfixed32 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional sfixed32 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sfixed32 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sfixed32 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// SFixed64Rules describes the constraints applied to `sfixed64` values
|
||||||
|
message SFixed64Rules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional sfixed64 const = 1;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional sfixed64 lt = 2;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than or equal to the
|
||||||
|
// specified value, inclusive
|
||||||
|
optional sfixed64 lte = 3;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive. If the value of Gt is larger than a specified Lt or Lte, the
|
||||||
|
// range is reversed.
|
||||||
|
optional sfixed64 gt = 4;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than or equal to the
|
||||||
|
// specified value, inclusive. If the value of Gte is larger than a
|
||||||
|
// specified Lt or Lte, the range is reversed.
|
||||||
|
optional sfixed64 gte = 5;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sfixed64 in = 6;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated sfixed64 not_in = 7;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolRules describes the constraints applied to `bool` values
|
||||||
|
message BoolRules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional bool const = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// StringRules describe the constraints applied to `string` values
|
||||||
|
message StringRules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional string const = 1;
|
||||||
|
|
||||||
|
// Len specifies that this field must be the specified number of
|
||||||
|
// characters (Unicode code points). Note that the number of
|
||||||
|
// characters may differ from the number of bytes in the string.
|
||||||
|
optional uint64 len = 19;
|
||||||
|
|
||||||
|
// MinLen specifies that this field must be the specified number of
|
||||||
|
// characters (Unicode code points) at a minimum. Note that the number of
|
||||||
|
// characters may differ from the number of bytes in the string.
|
||||||
|
optional uint64 min_len = 2;
|
||||||
|
|
||||||
|
// MaxLen specifies that this field must be the specified number of
|
||||||
|
// characters (Unicode code points) at a maximum. Note that the number of
|
||||||
|
// characters may differ from the number of bytes in the string.
|
||||||
|
optional uint64 max_len = 3;
|
||||||
|
|
||||||
|
// LenBytes specifies that this field must be the specified number of bytes
|
||||||
|
optional uint64 len_bytes = 20;
|
||||||
|
|
||||||
|
// MinBytes specifies that this field must be the specified number of bytes
|
||||||
|
// at a minimum
|
||||||
|
optional uint64 min_bytes = 4;
|
||||||
|
|
||||||
|
// MaxBytes specifies that this field must be the specified number of bytes
|
||||||
|
// at a maximum
|
||||||
|
optional uint64 max_bytes = 5;
|
||||||
|
|
||||||
|
// Pattern specifes that this field must match against the specified
|
||||||
|
// regular expression (RE2 syntax). The included expression should elide
|
||||||
|
// any delimiters.
|
||||||
|
optional string pattern = 6;
|
||||||
|
|
||||||
|
// Prefix specifies that this field must have the specified substring at
|
||||||
|
// the beginning of the string.
|
||||||
|
optional string prefix = 7;
|
||||||
|
|
||||||
|
// Suffix specifies that this field must have the specified substring at
|
||||||
|
// the end of the string.
|
||||||
|
optional string suffix = 8;
|
||||||
|
|
||||||
|
// Contains specifies that this field must have the specified substring
|
||||||
|
// anywhere in the string.
|
||||||
|
optional string contains = 9;
|
||||||
|
|
||||||
|
// NotContains specifies that this field cannot have the specified substring
|
||||||
|
// anywhere in the string.
|
||||||
|
optional string not_contains = 23;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated string in = 10;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated string not_in = 11;
|
||||||
|
|
||||||
|
// WellKnown rules provide advanced constraints against common string
|
||||||
|
// patterns
|
||||||
|
oneof well_known {
|
||||||
|
// Email specifies that the field must be a valid email address as
|
||||||
|
// defined by RFC 5322
|
||||||
|
bool email = 12;
|
||||||
|
|
||||||
|
// Hostname specifies that the field must be a valid hostname as
|
||||||
|
// defined by RFC 1034. This constraint does not support
|
||||||
|
// internationalized domain names (IDNs).
|
||||||
|
bool hostname = 13;
|
||||||
|
|
||||||
|
// Ip specifies that the field must be a valid IP (v4 or v6) address.
|
||||||
|
// Valid IPv6 addresses should not include surrounding square brackets.
|
||||||
|
bool ip = 14;
|
||||||
|
|
||||||
|
// Ipv4 specifies that the field must be a valid IPv4 address.
|
||||||
|
bool ipv4 = 15;
|
||||||
|
|
||||||
|
// Ipv6 specifies that the field must be a valid IPv6 address. Valid
|
||||||
|
// IPv6 addresses should not include surrounding square brackets.
|
||||||
|
bool ipv6 = 16;
|
||||||
|
|
||||||
|
// Uri specifies that the field must be a valid, absolute URI as defined
|
||||||
|
// by RFC 3986
|
||||||
|
bool uri = 17;
|
||||||
|
|
||||||
|
// UriRef specifies that the field must be a valid URI as defined by RFC
|
||||||
|
// 3986 and may be relative or absolute.
|
||||||
|
bool uri_ref = 18;
|
||||||
|
|
||||||
|
// Address specifies that the field must be either a valid hostname as
|
||||||
|
// defined by RFC 1034 (which does not support internationalized domain
|
||||||
|
// names or IDNs), or it can be a valid IP (v4 or v6).
|
||||||
|
bool address = 21;
|
||||||
|
|
||||||
|
// Uuid specifies that the field must be a valid UUID as defined by
|
||||||
|
// RFC 4122
|
||||||
|
bool uuid = 22;
|
||||||
|
|
||||||
|
// WellKnownRegex specifies a common well known pattern defined as a regex.
|
||||||
|
KnownRegex well_known_regex = 24;
|
||||||
|
}
|
||||||
|
|
||||||
|
// This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable
|
||||||
|
// strict header validation.
|
||||||
|
// By default, this is true, and HTTP header validations are RFC-compliant.
|
||||||
|
// Setting to false will enable a looser validations that only disallows
|
||||||
|
// \r\n\0 characters, which can be used to bypass header matching rules.
|
||||||
|
optional bool strict = 25 [default = true];
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 26;
|
||||||
|
}
|
||||||
|
|
||||||
|
// WellKnownRegex contain some well-known patterns.
|
||||||
|
enum KnownRegex {
|
||||||
|
UNKNOWN = 0;
|
||||||
|
|
||||||
|
// HTTP header name as defined by RFC 7230.
|
||||||
|
HTTP_HEADER_NAME = 1;
|
||||||
|
|
||||||
|
// HTTP header value as defined by RFC 7230.
|
||||||
|
HTTP_HEADER_VALUE = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesRules describe the constraints applied to `bytes` values
|
||||||
|
message BytesRules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional bytes const = 1;
|
||||||
|
|
||||||
|
// Len specifies that this field must be the specified number of bytes
|
||||||
|
optional uint64 len = 13;
|
||||||
|
|
||||||
|
// MinLen specifies that this field must be the specified number of bytes
|
||||||
|
// at a minimum
|
||||||
|
optional uint64 min_len = 2;
|
||||||
|
|
||||||
|
// MaxLen specifies that this field must be the specified number of bytes
|
||||||
|
// at a maximum
|
||||||
|
optional uint64 max_len = 3;
|
||||||
|
|
||||||
|
// Pattern specifes that this field must match against the specified
|
||||||
|
// regular expression (RE2 syntax). The included expression should elide
|
||||||
|
// any delimiters.
|
||||||
|
optional string pattern = 4;
|
||||||
|
|
||||||
|
// Prefix specifies that this field must have the specified bytes at the
|
||||||
|
// beginning of the string.
|
||||||
|
optional bytes prefix = 5;
|
||||||
|
|
||||||
|
// Suffix specifies that this field must have the specified bytes at the
|
||||||
|
// end of the string.
|
||||||
|
optional bytes suffix = 6;
|
||||||
|
|
||||||
|
// Contains specifies that this field must have the specified bytes
|
||||||
|
// anywhere in the string.
|
||||||
|
optional bytes contains = 7;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated bytes in = 8;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated bytes not_in = 9;
|
||||||
|
|
||||||
|
// WellKnown rules provide advanced constraints against common byte
|
||||||
|
// patterns
|
||||||
|
oneof well_known {
|
||||||
|
// Ip specifies that the field must be a valid IP (v4 or v6) address in
|
||||||
|
// byte format
|
||||||
|
bool ip = 10;
|
||||||
|
|
||||||
|
// Ipv4 specifies that the field must be a valid IPv4 address in byte
|
||||||
|
// format
|
||||||
|
bool ipv4 = 11;
|
||||||
|
|
||||||
|
// Ipv6 specifies that the field must be a valid IPv6 address in byte
|
||||||
|
// format
|
||||||
|
bool ipv6 = 12;
|
||||||
|
}
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 14;
|
||||||
|
}
|
||||||
|
|
||||||
|
// EnumRules describe the constraints applied to enum values
|
||||||
|
message EnumRules {
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional int32 const = 1;
|
||||||
|
|
||||||
|
// DefinedOnly specifies that this field must be only one of the defined
|
||||||
|
// values for this enum, failing on any undefined value.
|
||||||
|
optional bool defined_only = 2;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated int32 in = 3;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated int32 not_in = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
// MessageRules describe the constraints applied to embedded message values.
|
||||||
|
// For message-type fields, validation is performed recursively.
|
||||||
|
message MessageRules {
|
||||||
|
// Skip specifies that the validation rules of this field should not be
|
||||||
|
// evaluated
|
||||||
|
optional bool skip = 1;
|
||||||
|
|
||||||
|
// Required specifies that this field must be set
|
||||||
|
optional bool required = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// RepeatedRules describe the constraints applied to `repeated` values
|
||||||
|
message RepeatedRules {
|
||||||
|
// MinItems specifies that this field must have the specified number of
|
||||||
|
// items at a minimum
|
||||||
|
optional uint64 min_items = 1;
|
||||||
|
|
||||||
|
// MaxItems specifies that this field must have the specified number of
|
||||||
|
// items at a maximum
|
||||||
|
optional uint64 max_items = 2;
|
||||||
|
|
||||||
|
// Unique specifies that all elements in this field must be unique. This
|
||||||
|
// contraint is only applicable to scalar and enum types (messages are not
|
||||||
|
// supported).
|
||||||
|
optional bool unique = 3;
|
||||||
|
|
||||||
|
// Items specifies the contraints to be applied to each item in the field.
|
||||||
|
// Repeated message fields will still execute validation against each item
|
||||||
|
// unless skip is specified here.
|
||||||
|
optional FieldRules items = 4;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 5;
|
||||||
|
}
|
||||||
|
|
||||||
|
// MapRules describe the constraints applied to `map` values
|
||||||
|
message MapRules {
|
||||||
|
// MinPairs specifies that this field must have the specified number of
|
||||||
|
// KVs at a minimum
|
||||||
|
optional uint64 min_pairs = 1;
|
||||||
|
|
||||||
|
// MaxPairs specifies that this field must have the specified number of
|
||||||
|
// KVs at a maximum
|
||||||
|
optional uint64 max_pairs = 2;
|
||||||
|
|
||||||
|
// NoSparse specifies values in this field cannot be unset. This only
|
||||||
|
// applies to map's with message value types.
|
||||||
|
optional bool no_sparse = 3;
|
||||||
|
|
||||||
|
// Keys specifies the constraints to be applied to each key in the field.
|
||||||
|
optional FieldRules keys = 4;
|
||||||
|
|
||||||
|
// Values specifies the constraints to be applied to the value of each key
|
||||||
|
// in the field. Message values will still have their validations evaluated
|
||||||
|
// unless skip is specified here.
|
||||||
|
optional FieldRules values = 5;
|
||||||
|
|
||||||
|
// IgnoreEmpty specifies that the validation rules of this field should be
|
||||||
|
// evaluated only if the field is not empty
|
||||||
|
optional bool ignore_empty = 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnyRules describe constraints applied exclusively to the
|
||||||
|
// `google.protobuf.Any` well-known type
|
||||||
|
message AnyRules {
|
||||||
|
// Required specifies that this field must be set
|
||||||
|
optional bool required = 1;
|
||||||
|
|
||||||
|
// In specifies that this field's `type_url` must be equal to one of the
|
||||||
|
// specified values.
|
||||||
|
repeated string in = 2;
|
||||||
|
|
||||||
|
// NotIn specifies that this field's `type_url` must not be equal to any of
|
||||||
|
// the specified values.
|
||||||
|
repeated string not_in = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationRules describe the constraints applied exclusively to the
|
||||||
|
// `google.protobuf.Duration` well-known type
|
||||||
|
message DurationRules {
|
||||||
|
// Required specifies that this field must be set
|
||||||
|
optional bool required = 1;
|
||||||
|
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional google.protobuf.Duration const = 2;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional google.protobuf.Duration lt = 3;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// inclusive
|
||||||
|
optional google.protobuf.Duration lte = 4;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional google.protobuf.Duration gt = 5;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than the specified value,
|
||||||
|
// inclusive
|
||||||
|
optional google.protobuf.Duration gte = 6;
|
||||||
|
|
||||||
|
// In specifies that this field must be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated google.protobuf.Duration in = 7;
|
||||||
|
|
||||||
|
// NotIn specifies that this field cannot be equal to one of the specified
|
||||||
|
// values
|
||||||
|
repeated google.protobuf.Duration not_in = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// TimestampRules describe the constraints applied exclusively to the
|
||||||
|
// `google.protobuf.Timestamp` well-known type
|
||||||
|
message TimestampRules {
|
||||||
|
// Required specifies that this field must be set
|
||||||
|
optional bool required = 1;
|
||||||
|
|
||||||
|
// Const specifies that this field must be exactly the specified value
|
||||||
|
optional google.protobuf.Timestamp const = 2;
|
||||||
|
|
||||||
|
// Lt specifies that this field must be less than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional google.protobuf.Timestamp lt = 3;
|
||||||
|
|
||||||
|
// Lte specifies that this field must be less than the specified value,
|
||||||
|
// inclusive
|
||||||
|
optional google.protobuf.Timestamp lte = 4;
|
||||||
|
|
||||||
|
// Gt specifies that this field must be greater than the specified value,
|
||||||
|
// exclusive
|
||||||
|
optional google.protobuf.Timestamp gt = 5;
|
||||||
|
|
||||||
|
// Gte specifies that this field must be greater than the specified value,
|
||||||
|
// inclusive
|
||||||
|
optional google.protobuf.Timestamp gte = 6;
|
||||||
|
|
||||||
|
// LtNow specifies that this must be less than the current time. LtNow
|
||||||
|
// can only be used with the Within rule.
|
||||||
|
optional bool lt_now = 7;
|
||||||
|
|
||||||
|
// GtNow specifies that this must be greater than the current time. GtNow
|
||||||
|
// can only be used with the Within rule.
|
||||||
|
optional bool gt_now = 8;
|
||||||
|
|
||||||
|
// Within specifies that this field must be within this duration of the
|
||||||
|
// current time. This constraint can be used alone or with the LtNow and
|
||||||
|
// GtNow rules.
|
||||||
|
optional google.protobuf.Duration within = 9;
|
||||||
|
}
|
|
@ -0,0 +1,62 @@
|
||||||
|
package utils
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
type KeyValue struct {
|
||||||
|
Key string
|
||||||
|
Value string
|
||||||
|
}
|
||||||
|
|
||||||
|
func LowercaseFirstLetter(s string) string {
|
||||||
|
if len(s) == 0 {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
firstLetter := strings.ToLower(s[:1])
|
||||||
|
return firstLetter + s[1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
func SortStruct(data any) []KeyValue {
|
||||||
|
v := reflect.ValueOf(data).Elem()
|
||||||
|
t := v.Type()
|
||||||
|
var kv []KeyValue
|
||||||
|
for i := 0; i < v.NumField(); i++ {
|
||||||
|
field := v.Field(i)
|
||||||
|
key := LowercaseFirstLetter(t.Field(i).Name)
|
||||||
|
value := fmt.Sprintf("%v", field.Interface())
|
||||||
|
kv = append(kv, KeyValue{Key: key, Value: value})
|
||||||
|
}
|
||||||
|
sort.SliceStable(kv, func(i, j int) bool {
|
||||||
|
return kv[i].Key < kv[j].Key
|
||||||
|
})
|
||||||
|
return kv
|
||||||
|
}
|
||||||
|
|
||||||
|
func SortStructJsonTag(data any) []KeyValue {
|
||||||
|
// 获取 data 结构体的类型和值
|
||||||
|
dataType := reflect.TypeOf(data).Elem()
|
||||||
|
dataValue := reflect.ValueOf(data).Elem()
|
||||||
|
|
||||||
|
var kv []KeyValue
|
||||||
|
for i := 0; i < dataType.NumField(); i++ {
|
||||||
|
field := dataType.Field(i)
|
||||||
|
// 获取字段的值
|
||||||
|
fieldValue := dataValue.FieldByName(field.Name).Interface()
|
||||||
|
// 获取 JSON 字段名
|
||||||
|
jsonTagName := field.Tag.Get("json")
|
||||||
|
if jsonTagName != "" {
|
||||||
|
kv = append(kv, KeyValue{Key: jsonTagName, Value: fmt.Sprintf("%v", fieldValue)})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 排序
|
||||||
|
sort.SliceStable(kv, func(i, j int) bool {
|
||||||
|
return kv[i].Key < kv[j].Key
|
||||||
|
})
|
||||||
|
|
||||||
|
return kv
|
||||||
|
}
|
|
@ -0,0 +1,26 @@
|
||||||
|
package utils
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Load 获取插件目录中的文件信息
|
||||||
|
func Load(dir string) ([]string, error) {
|
||||||
|
entries, err := os.ReadDir(dir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("读取目录错误:%w", err)
|
||||||
|
}
|
||||||
|
files := make([]string, 0, len(entries))
|
||||||
|
for _, entry := range entries {
|
||||||
|
info, err := entry.Info()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("获取文件信息错误:%w", err)
|
||||||
|
}
|
||||||
|
if !info.IsDir() {
|
||||||
|
files = append(files, fmt.Sprintf("%s/%s", dir, info.Name()))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return files, nil
|
||||||
|
}
|
|
@ -0,0 +1,16 @@
|
||||||
|
package utils
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func Test_load(t *testing.T) {
|
||||||
|
got, err := Load("../../pkg")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("load() error = %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Printf("%v \n", got)
|
||||||
|
fmt.Printf("%v \n", got[0])
|
||||||
|
}
|
Loading…
Reference in New Issue