Documentation ¶
Index ¶
- Variables
- type Filter
- type MethodMap
- func (*MethodMap) Descriptor() ([]byte, []int)deprecated
- func (x *MethodMap) GetBody() string
- func (x *MethodMap) GetMethod() string
- func (x *MethodMap) GetPath() string
- func (x *MethodMap) GetQueryString() string
- func (*MethodMap) ProtoMessage()
- func (x *MethodMap) ProtoReflect() protoreflect.Message
- func (x *MethodMap) Reset()
- func (x *MethodMap) String() string
- type Page
- type QueryMap
- type ServiceMap
- func (*ServiceMap) Descriptor() ([]byte, []int)deprecated
- func (x *ServiceMap) GetBaseUri() string
- func (x *ServiceMap) GetTargetPackage() string
- func (x *ServiceMap) GetVersion() string
- func (*ServiceMap) ProtoMessage()
- func (x *ServiceMap) ProtoReflect() protoreflect.Message
- func (x *ServiceMap) Reset()
- func (x *ServiceMap) String() string
- type Sort
Constants ¶
This section is empty.
Variables ¶
var (
// optional string dart_package = 97454431;
E_DartPackage = &file_pbmap_proto_extTypes[3]
)
Extension fields to descriptorpb.FileOptions.
var (
// optional pbmap.MethodMap method_map = 87654321;
E_MethodMap = &file_pbmap_proto_extTypes[0]
)
Extension fields to descriptorpb.MethodOptions.
var (
// optional pbmap.QueryMap query_map = 9813242;
E_QueryMap = &file_pbmap_proto_extTypes[1]
)
Extension fields to descriptorpb.MessageOptions.
var (
// optional pbmap.ServiceMap service_map = 87654323;
E_ServiceMap = &file_pbmap_proto_extTypes[2]
)
Extension fields to descriptorpb.ServiceOptions.
var File_pbmap_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Filter ¶
type Filter struct { Query string `protobuf:"bytes,1,opt,name=Query,proto3" json:"Query,omitempty"` // contains filtered or unexported fields }
func (*Filter) Descriptor
deprecated
func (*Filter) ProtoMessage ¶
func (*Filter) ProtoMessage()
func (*Filter) ProtoReflect ¶ added in v1.0.3
func (x *Filter) ProtoReflect() protoreflect.Message
type MethodMap ¶
type MethodMap struct { // "GET", "PUT", "POST", "DELETE" Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"` // Format "a/b/c/:d/:e" - a/b/c are fixed in the path, :d and :e are paramaters mapped to fields D, E in the underlying GRPC Request // Has to be compatible with Julian Schmidt's HTTP Router Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // Format "key1=:var1&key=:var2" They keys will be mapped to the variables var1, var2 of the unterlying GRPC Request QueryString string `protobuf:"bytes,3,opt,name=query_string,json=queryString,proto3" json:"query_string,omitempty"` Body string `protobuf:"bytes,4,opt,name=body,proto3" json:"body,omitempty"` // contains filtered or unexported fields }
MethodMap gives the parameters how to Map a GRPC Service Method to an REST Endpoint
func (*MethodMap) Descriptor
deprecated
func (*MethodMap) GetQueryString ¶
func (*MethodMap) ProtoMessage ¶
func (*MethodMap) ProtoMessage()
func (*MethodMap) ProtoReflect ¶ added in v1.0.3
func (x *MethodMap) ProtoReflect() protoreflect.Message
type Page ¶
type Page struct { Limit uint64 `protobuf:"varint,1,opt,name=Limit,proto3" json:"Limit,omitempty"` Offset uint64 `protobuf:"varint,2,opt,name=Offset,proto3" json:"Offset,omitempty"` // contains filtered or unexported fields }
Page provides information from the query string which you can use to get a larger collection of objects pagewise
func (*Page) Descriptor
deprecated
func (*Page) ProtoMessage ¶
func (*Page) ProtoMessage()
func (*Page) ProtoReflect ¶ added in v1.0.3
func (x *Page) ProtoReflect() protoreflect.Message
type QueryMap ¶
type QueryMap struct { Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` // contains filtered or unexported fields }
If an Submessage of an Request-Message in Protobuf has a field (directly at the moment, deeper nesting is not supported at the moment), then additional parameters defined in query (similar to the querystring syntax of your rest-framework) will be added to the queryString documentation and mapped automatically to the objects
func (*QueryMap) Descriptor
deprecated
func (*QueryMap) ProtoMessage ¶
func (*QueryMap) ProtoMessage()
func (*QueryMap) ProtoReflect ¶ added in v1.0.3
func (x *QueryMap) ProtoReflect() protoreflect.Message
type ServiceMap ¶
type ServiceMap struct { Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` BaseUri string `protobuf:"bytes,2,opt,name=base_uri,json=baseUri,proto3" json:"base_uri,omitempty"` TargetPackage string `protobuf:"bytes,3,opt,name=target_package,json=targetPackage,proto3" json:"target_package,omitempty"` // contains filtered or unexported fields }
ServiceMap provides information for how to map an GRPC Service to an REST Service
func (*ServiceMap) Descriptor
deprecated
func (*ServiceMap) Descriptor() ([]byte, []int)
Deprecated: Use ServiceMap.ProtoReflect.Descriptor instead.
func (*ServiceMap) GetBaseUri ¶
func (x *ServiceMap) GetBaseUri() string
func (*ServiceMap) GetTargetPackage ¶
func (x *ServiceMap) GetTargetPackage() string
func (*ServiceMap) GetVersion ¶
func (x *ServiceMap) GetVersion() string
func (*ServiceMap) ProtoMessage ¶
func (*ServiceMap) ProtoMessage()
func (*ServiceMap) ProtoReflect ¶ added in v1.0.3
func (x *ServiceMap) ProtoReflect() protoreflect.Message
func (*ServiceMap) Reset ¶
func (x *ServiceMap) Reset()
func (*ServiceMap) String ¶
func (x *ServiceMap) String() string
type Sort ¶
type Sort struct { Field string `protobuf:"bytes,1,opt,name=Field,proto3" json:"Field,omitempty"` Desc bool `protobuf:"varint,2,opt,name=Desc,proto3" json:"Desc,omitempty"` // contains filtered or unexported fields }
Sort provides information from the query string on how to sort a given collection of objects
func (*Sort) Descriptor
deprecated
func (*Sort) ProtoMessage ¶
func (*Sort) ProtoMessage()
func (*Sort) ProtoReflect ¶ added in v1.0.3
func (x *Sort) ProtoReflect() protoreflect.Message