Documentation
¶
Index ¶
- Variables
- func RegisterShikamaruServiceServer(s grpc.ServiceRegistrar, srv ShikamaruServiceServer)
- type CreateEntityRequest
- func (*CreateEntityRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateEntityRequest) GetEntity() *Entity
- func (*CreateEntityRequest) ProtoMessage()
- func (x *CreateEntityRequest) ProtoReflect() protoreflect.Message
- func (x *CreateEntityRequest) Reset()
- func (x *CreateEntityRequest) String() string
- type CreateEntityResponse
- func (*CreateEntityResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateEntityResponse) GetEntity() *Entity
- func (*CreateEntityResponse) ProtoMessage()
- func (x *CreateEntityResponse) ProtoReflect() protoreflect.Message
- func (x *CreateEntityResponse) Reset()
- func (x *CreateEntityResponse) String() string
- type CreateRecordRequest
- func (*CreateRecordRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRecordRequest) GetEntityName() string
- func (x *CreateRecordRequest) GetRecord() *Record
- func (*CreateRecordRequest) ProtoMessage()
- func (x *CreateRecordRequest) ProtoReflect() protoreflect.Message
- func (x *CreateRecordRequest) Reset()
- func (x *CreateRecordRequest) String() string
- type CreateRecordResponse
- func (*CreateRecordResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRecordResponse) GetErrors() []*RecordValidationError
- func (x *CreateRecordResponse) GetRecord() *Record
- func (*CreateRecordResponse) ProtoMessage()
- func (x *CreateRecordResponse) ProtoReflect() protoreflect.Message
- func (x *CreateRecordResponse) Reset()
- func (x *CreateRecordResponse) String() string
- type Entity
- func (*Entity) Descriptor() ([]byte, []int)deprecated
- func (x *Entity) GetCollection() string
- func (x *Entity) GetFields() []*Field
- func (x *Entity) GetId() string
- func (x *Entity) GetName() string
- func (x *Entity) GetPluralName() string
- func (x *Entity) GetSingularName() string
- func (*Entity) ProtoMessage()
- func (x *Entity) ProtoReflect() protoreflect.Message
- func (x *Entity) Reset()
- func (x *Entity) String() string
- type Field
- func (*Field) Descriptor() ([]byte, []int)deprecated
- func (x *Field) GetFieldType() FieldType
- func (x *Field) GetHelp() string
- func (x *Field) GetLabel() string
- func (x *Field) GetName() string
- func (x *Field) GetPlaceholder() string
- func (x *Field) GetRules() []*Rule
- func (*Field) ProtoMessage()
- func (x *Field) ProtoReflect() protoreflect.Message
- func (x *Field) Reset()
- func (x *Field) String() string
- type FieldType
- type Record
- type RecordValidationError
- func (*RecordValidationError) Descriptor() ([]byte, []int)deprecated
- func (x *RecordValidationError) GetField() string
- func (x *RecordValidationError) GetMessage() string
- func (*RecordValidationError) ProtoMessage()
- func (x *RecordValidationError) ProtoReflect() protoreflect.Message
- func (x *RecordValidationError) Reset()
- func (x *RecordValidationError) String() string
- type Rule
- type RuleType
- type ShikamaruServiceClient
- type ShikamaruServiceServer
- type UnimplementedShikamaruServiceServer
- type UnsafeShikamaruServiceServer
Constants ¶
This section is empty.
Variables ¶
var ( FieldType_name = map[int32]string{ 0: "NONE_FIELD", 1: "TEXT", 2: "EMAIL", } FieldType_value = map[string]int32{ "NONE_FIELD": 0, "TEXT": 1, "EMAIL": 2, } )
Enum value maps for FieldType.
var ( RuleType_name = map[int32]string{ 0: "NONE_RULE", 1: "REQUIRED", 2: "IS_EMAIL", } RuleType_value = map[string]int32{ "NONE_RULE": 0, "REQUIRED": 1, "IS_EMAIL": 2, } )
Enum value maps for RuleType.
var File_entity_proto protoreflect.FileDescriptor
var File_field_proto protoreflect.FileDescriptor
var File_record_proto protoreflect.FileDescriptor
var File_rule_proto protoreflect.FileDescriptor
var File_shikamaru_proto protoreflect.FileDescriptor
var ShikamaruService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "shikamaru.ShikamaruService", HandlerType: (*ShikamaruServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateEntity", Handler: _ShikamaruService_CreateEntity_Handler, }, { MethodName: "CreateRecord", Handler: _ShikamaruService_CreateRecord_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "shikamaru.proto", }
ShikamaruService_ServiceDesc is the grpc.ServiceDesc for ShikamaruService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterShikamaruServiceServer ¶
func RegisterShikamaruServiceServer(s grpc.ServiceRegistrar, srv ShikamaruServiceServer)
Types ¶
type CreateEntityRequest ¶
type CreateEntityRequest struct { Entity *Entity `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"` // contains filtered or unexported fields }
func (*CreateEntityRequest) Descriptor
deprecated
func (*CreateEntityRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateEntityRequest.ProtoReflect.Descriptor instead.
func (*CreateEntityRequest) GetEntity ¶
func (x *CreateEntityRequest) GetEntity() *Entity
func (*CreateEntityRequest) ProtoMessage ¶
func (*CreateEntityRequest) ProtoMessage()
func (*CreateEntityRequest) ProtoReflect ¶
func (x *CreateEntityRequest) ProtoReflect() protoreflect.Message
func (*CreateEntityRequest) Reset ¶
func (x *CreateEntityRequest) Reset()
func (*CreateEntityRequest) String ¶
func (x *CreateEntityRequest) String() string
type CreateEntityResponse ¶
type CreateEntityResponse struct { Entity *Entity `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"` // contains filtered or unexported fields }
func (*CreateEntityResponse) Descriptor
deprecated
func (*CreateEntityResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateEntityResponse.ProtoReflect.Descriptor instead.
func (*CreateEntityResponse) GetEntity ¶
func (x *CreateEntityResponse) GetEntity() *Entity
func (*CreateEntityResponse) ProtoMessage ¶
func (*CreateEntityResponse) ProtoMessage()
func (*CreateEntityResponse) ProtoReflect ¶
func (x *CreateEntityResponse) ProtoReflect() protoreflect.Message
func (*CreateEntityResponse) Reset ¶
func (x *CreateEntityResponse) Reset()
func (*CreateEntityResponse) String ¶
func (x *CreateEntityResponse) String() string
type CreateRecordRequest ¶ added in v1.3.0
type CreateRecordRequest struct { EntityName string `protobuf:"bytes,1,opt,name=entity_name,json=entityName,proto3" json:"entity_name,omitempty"` Record *Record `protobuf:"bytes,2,opt,name=record,proto3" json:"record,omitempty"` // contains filtered or unexported fields }
func (*CreateRecordRequest) Descriptor
deprecated
added in
v1.3.0
func (*CreateRecordRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRecordRequest.ProtoReflect.Descriptor instead.
func (*CreateRecordRequest) GetEntityName ¶ added in v1.3.0
func (x *CreateRecordRequest) GetEntityName() string
func (*CreateRecordRequest) GetRecord ¶ added in v1.3.0
func (x *CreateRecordRequest) GetRecord() *Record
func (*CreateRecordRequest) ProtoMessage ¶ added in v1.3.0
func (*CreateRecordRequest) ProtoMessage()
func (*CreateRecordRequest) ProtoReflect ¶ added in v1.3.0
func (x *CreateRecordRequest) ProtoReflect() protoreflect.Message
func (*CreateRecordRequest) Reset ¶ added in v1.3.0
func (x *CreateRecordRequest) Reset()
func (*CreateRecordRequest) String ¶ added in v1.3.0
func (x *CreateRecordRequest) String() string
type CreateRecordResponse ¶ added in v1.3.0
type CreateRecordResponse struct { Record *Record `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"` Errors []*RecordValidationError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"` // contains filtered or unexported fields }
func (*CreateRecordResponse) Descriptor
deprecated
added in
v1.3.0
func (*CreateRecordResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateRecordResponse.ProtoReflect.Descriptor instead.
func (*CreateRecordResponse) GetErrors ¶ added in v1.3.0
func (x *CreateRecordResponse) GetErrors() []*RecordValidationError
func (*CreateRecordResponse) GetRecord ¶ added in v1.3.0
func (x *CreateRecordResponse) GetRecord() *Record
func (*CreateRecordResponse) ProtoMessage ¶ added in v1.3.0
func (*CreateRecordResponse) ProtoMessage()
func (*CreateRecordResponse) ProtoReflect ¶ added in v1.3.0
func (x *CreateRecordResponse) ProtoReflect() protoreflect.Message
func (*CreateRecordResponse) Reset ¶ added in v1.3.0
func (x *CreateRecordResponse) Reset()
func (*CreateRecordResponse) String ¶ added in v1.3.0
func (x *CreateRecordResponse) String() string
type Entity ¶
type Entity struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` SingularName string `protobuf:"bytes,3,opt,name=singular_name,json=singularName,proto3" json:"singular_name,omitempty"` PluralName string `protobuf:"bytes,4,opt,name=plural_name,json=pluralName,proto3" json:"plural_name,omitempty"` Fields []*Field `protobuf:"bytes,5,rep,name=fields,proto3" json:"fields,omitempty"` // collection is the name of the collection where records // should be stored. // NOTE: it could be the table name as well, // depending of the type of the data store. Collection string `protobuf:"bytes,6,opt,name=collection,proto3" json:"collection,omitempty"` // contains filtered or unexported fields }
func (*Entity) Descriptor
deprecated
func (*Entity) GetCollection ¶ added in v1.1.0
func (*Entity) GetPluralName ¶
func (*Entity) GetSingularName ¶
func (*Entity) ProtoMessage ¶
func (*Entity) ProtoMessage()
func (*Entity) ProtoReflect ¶
func (x *Entity) ProtoReflect() protoreflect.Message
type Field ¶
type Field struct { FieldType FieldType `protobuf:"varint,1,opt,name=field_type,json=fieldType,proto3,enum=shikamaru.FieldType" json:"field_type,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"` Help string `protobuf:"bytes,4,opt,name=help,proto3" json:"help,omitempty"` Placeholder string `protobuf:"bytes,5,opt,name=placeholder,proto3" json:"placeholder,omitempty"` Rules []*Rule `protobuf:"bytes,6,rep,name=rules,proto3" json:"rules,omitempty"` // contains filtered or unexported fields }
func (*Field) Descriptor
deprecated
func (*Field) GetFieldType ¶
func (*Field) GetPlaceholder ¶
func (*Field) ProtoMessage ¶
func (*Field) ProtoMessage()
func (*Field) ProtoReflect ¶
func (x *Field) ProtoReflect() protoreflect.Message
type FieldType ¶
type FieldType int32
func (FieldType) Descriptor ¶
func (FieldType) Descriptor() protoreflect.EnumDescriptor
func (FieldType) EnumDescriptor
deprecated
func (FieldType) Number ¶
func (x FieldType) Number() protoreflect.EnumNumber
func (FieldType) Type ¶
func (FieldType) Type() protoreflect.EnumType
type Record ¶
type Record struct { Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
func (*Record) Descriptor
deprecated
func (*Record) ProtoMessage ¶
func (*Record) ProtoMessage()
func (*Record) ProtoReflect ¶
func (x *Record) ProtoReflect() protoreflect.Message
type RecordValidationError ¶
type RecordValidationError struct { Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"` Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
func (*RecordValidationError) Descriptor
deprecated
func (*RecordValidationError) Descriptor() ([]byte, []int)
Deprecated: Use RecordValidationError.ProtoReflect.Descriptor instead.
func (*RecordValidationError) GetField ¶
func (x *RecordValidationError) GetField() string
func (*RecordValidationError) GetMessage ¶
func (x *RecordValidationError) GetMessage() string
func (*RecordValidationError) ProtoMessage ¶
func (*RecordValidationError) ProtoMessage()
func (*RecordValidationError) ProtoReflect ¶
func (x *RecordValidationError) ProtoReflect() protoreflect.Message
func (*RecordValidationError) Reset ¶
func (x *RecordValidationError) Reset()
func (*RecordValidationError) String ¶
func (x *RecordValidationError) String() string
type Rule ¶
type Rule struct { RuleType RuleType `protobuf:"varint,1,opt,name=rule_type,json=ruleType,proto3,enum=shikamaru.RuleType" json:"rule_type,omitempty"` // contains filtered or unexported fields }
func (*Rule) Descriptor
deprecated
func (*Rule) GetRuleType ¶
func (*Rule) ProtoMessage ¶
func (*Rule) ProtoMessage()
func (*Rule) ProtoReflect ¶
func (x *Rule) ProtoReflect() protoreflect.Message
type RuleType ¶
type RuleType int32
func (RuleType) Descriptor ¶
func (RuleType) Descriptor() protoreflect.EnumDescriptor
func (RuleType) EnumDescriptor
deprecated
func (RuleType) Number ¶
func (x RuleType) Number() protoreflect.EnumNumber
func (RuleType) Type ¶
func (RuleType) Type() protoreflect.EnumType
type ShikamaruServiceClient ¶
type ShikamaruServiceClient interface { CreateEntity(ctx context.Context, in *CreateEntityRequest, opts ...grpc.CallOption) (*CreateEntityResponse, error) CreateRecord(ctx context.Context, in *CreateRecordRequest, opts ...grpc.CallOption) (*CreateRecordResponse, error) }
ShikamaruServiceClient is the client API for ShikamaruService 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.
func NewShikamaruServiceClient ¶
func NewShikamaruServiceClient(cc grpc.ClientConnInterface) ShikamaruServiceClient
type ShikamaruServiceServer ¶
type ShikamaruServiceServer interface { CreateEntity(context.Context, *CreateEntityRequest) (*CreateEntityResponse, error) CreateRecord(context.Context, *CreateRecordRequest) (*CreateRecordResponse, error) }
ShikamaruServiceServer is the server API for ShikamaruService service. All implementations should embed UnimplementedShikamaruServiceServer for forward compatibility
type UnimplementedShikamaruServiceServer ¶
type UnimplementedShikamaruServiceServer struct { }
UnimplementedShikamaruServiceServer should be embedded to have forward compatible implementations.
func (UnimplementedShikamaruServiceServer) CreateEntity ¶
func (UnimplementedShikamaruServiceServer) CreateEntity(context.Context, *CreateEntityRequest) (*CreateEntityResponse, error)
func (UnimplementedShikamaruServiceServer) CreateRecord ¶ added in v1.3.0
func (UnimplementedShikamaruServiceServer) CreateRecord(context.Context, *CreateRecordRequest) (*CreateRecordResponse, error)
type UnsafeShikamaruServiceServer ¶
type UnsafeShikamaruServiceServer interface {
// contains filtered or unexported methods
}
UnsafeShikamaruServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ShikamaruServiceServer will result in compilation errors.