Documentation ¶
Overview ¶
Package riak is a generated protocol buffer package.
It is generated from these files:
riak.proto
It has these top-level messages:
RpbErrorResp RpbGetServerInfoResp RpbPair RpbGetBucketReq RpbGetBucketResp RpbSetBucketReq RpbResetBucketReq RpbGetBucketTypeReq RpbSetBucketTypeReq RpbModFun RpbCommitHook RpbBucketProps RpbAuthReq
Index ¶
- Constants
- Variables
- type RpbAuthReq
- type RpbBucketProps
- func (m *RpbBucketProps) GetAllowMult() bool
- func (m *RpbBucketProps) GetBackend() []byte
- func (m *RpbBucketProps) GetBasicQuorum() bool
- func (m *RpbBucketProps) GetBigVclock() uint32
- func (m *RpbBucketProps) GetChashKeyfun() *RpbModFun
- func (m *RpbBucketProps) GetConsistent() bool
- func (m *RpbBucketProps) GetDatatype() []byte
- func (m *RpbBucketProps) GetDw() uint32
- func (m *RpbBucketProps) GetHasPostcommit() bool
- func (m *RpbBucketProps) GetHasPrecommit() bool
- func (m *RpbBucketProps) GetLastWriteWins() bool
- func (m *RpbBucketProps) GetLinkfun() *RpbModFun
- func (m *RpbBucketProps) GetNVal() uint32
- func (m *RpbBucketProps) GetNotfoundOk() bool
- func (m *RpbBucketProps) GetOldVclock() uint32
- func (m *RpbBucketProps) GetPostcommit() []*RpbCommitHook
- func (m *RpbBucketProps) GetPr() uint32
- func (m *RpbBucketProps) GetPrecommit() []*RpbCommitHook
- func (m *RpbBucketProps) GetPw() uint32
- func (m *RpbBucketProps) GetR() uint32
- func (m *RpbBucketProps) GetRepl() RpbBucketProps_RpbReplMode
- func (m *RpbBucketProps) GetRw() uint32
- func (m *RpbBucketProps) GetSearch() bool
- func (m *RpbBucketProps) GetSearchIndex() []byte
- func (m *RpbBucketProps) GetSmallVclock() uint32
- func (m *RpbBucketProps) GetW() uint32
- func (m *RpbBucketProps) GetWriteOnce() bool
- func (m *RpbBucketProps) GetYoungVclock() uint32
- func (*RpbBucketProps) ProtoMessage()
- func (m *RpbBucketProps) Reset()
- func (m *RpbBucketProps) String() string
- type RpbBucketProps_RpbReplMode
- type RpbCommitHook
- type RpbErrorResp
- type RpbGetBucketReq
- func (m *RpbGetBucketReq) BucketIsRequired() bool
- func (m *RpbGetBucketReq) GetBucket() []byte
- func (m *RpbGetBucketReq) GetKey() []byte
- func (m *RpbGetBucketReq) GetType() []byte
- func (m *RpbGetBucketReq) KeyIsRequired() bool
- func (*RpbGetBucketReq) ProtoMessage()
- func (m *RpbGetBucketReq) Reset()
- func (m *RpbGetBucketReq) SetType(bt []byte)
- func (m *RpbGetBucketReq) String() string
- type RpbGetBucketResp
- type RpbGetBucketTypeReq
- type RpbGetServerInfoResp
- type RpbModFun
- type RpbPair
- type RpbResetBucketReq
- type RpbSetBucketReq
- func (m *RpbSetBucketReq) BucketIsRequired() bool
- func (m *RpbSetBucketReq) GetBucket() []byte
- func (m *RpbSetBucketReq) GetKey() []byte
- func (m *RpbSetBucketReq) GetProps() *RpbBucketProps
- func (m *RpbSetBucketReq) GetType() []byte
- func (m *RpbSetBucketReq) KeyIsRequired() bool
- func (*RpbSetBucketReq) ProtoMessage()
- func (m *RpbSetBucketReq) Reset()
- func (m *RpbSetBucketReq) SetType(bt []byte)
- func (m *RpbSetBucketReq) String() string
- type RpbSetBucketTypeReq
Constants ¶
const Default_RpbBucketProps_HasPostcommit bool = false
const Default_RpbBucketProps_HasPrecommit bool = false
Variables ¶
var RpbBucketProps_RpbReplMode_name = map[int32]string{
0: "FALSE",
1: "REALTIME",
2: "FULLSYNC",
3: "TRUE",
}
var RpbBucketProps_RpbReplMode_value = map[string]int32{
"FALSE": 0,
"REALTIME": 1,
"FULLSYNC": 2,
"TRUE": 3,
}
Functions ¶
This section is empty.
Types ¶
type RpbAuthReq ¶
type RpbAuthReq struct { User []byte `protobuf:"bytes,1,req,name=user" json:"user,omitempty"` Password []byte `protobuf:"bytes,2,req,name=password" json:"password,omitempty"` XXX_unrecognized []byte `json:"-"` }
Authentication request
func (*RpbAuthReq) GetPassword ¶
func (m *RpbAuthReq) GetPassword() []byte
func (*RpbAuthReq) GetUser ¶
func (m *RpbAuthReq) GetUser() []byte
func (*RpbAuthReq) ProtoMessage ¶
func (*RpbAuthReq) ProtoMessage()
func (*RpbAuthReq) Reset ¶
func (m *RpbAuthReq) Reset()
func (*RpbAuthReq) String ¶
func (m *RpbAuthReq) String() string
type RpbBucketProps ¶
type RpbBucketProps struct { // Declared in riak_core_app NVal *uint32 `protobuf:"varint,1,opt,name=n_val" json:"n_val,omitempty"` AllowMult *bool `protobuf:"varint,2,opt,name=allow_mult" json:"allow_mult,omitempty"` LastWriteWins *bool `protobuf:"varint,3,opt,name=last_write_wins" json:"last_write_wins,omitempty"` Precommit []*RpbCommitHook `protobuf:"bytes,4,rep,name=precommit" json:"precommit,omitempty"` HasPrecommit *bool `protobuf:"varint,5,opt,name=has_precommit,def=0" json:"has_precommit,omitempty"` Postcommit []*RpbCommitHook `protobuf:"bytes,6,rep,name=postcommit" json:"postcommit,omitempty"` HasPostcommit *bool `protobuf:"varint,7,opt,name=has_postcommit,def=0" json:"has_postcommit,omitempty"` ChashKeyfun *RpbModFun `protobuf:"bytes,8,opt,name=chash_keyfun" json:"chash_keyfun,omitempty"` // Declared in riak_kv_app Linkfun *RpbModFun `protobuf:"bytes,9,opt,name=linkfun" json:"linkfun,omitempty"` OldVclock *uint32 `protobuf:"varint,10,opt,name=old_vclock" json:"old_vclock,omitempty"` YoungVclock *uint32 `protobuf:"varint,11,opt,name=young_vclock" json:"young_vclock,omitempty"` BigVclock *uint32 `protobuf:"varint,12,opt,name=big_vclock" json:"big_vclock,omitempty"` SmallVclock *uint32 `protobuf:"varint,13,opt,name=small_vclock" json:"small_vclock,omitempty"` Pr *uint32 `protobuf:"varint,14,opt,name=pr" json:"pr,omitempty"` R *uint32 `protobuf:"varint,15,opt,name=r" json:"r,omitempty"` W *uint32 `protobuf:"varint,16,opt,name=w" json:"w,omitempty"` Pw *uint32 `protobuf:"varint,17,opt,name=pw" json:"pw,omitempty"` Dw *uint32 `protobuf:"varint,18,opt,name=dw" json:"dw,omitempty"` Rw *uint32 `protobuf:"varint,19,opt,name=rw" json:"rw,omitempty"` BasicQuorum *bool `protobuf:"varint,20,opt,name=basic_quorum" json:"basic_quorum,omitempty"` NotfoundOk *bool `protobuf:"varint,21,opt,name=notfound_ok" json:"notfound_ok,omitempty"` // Used by riak_kv_multi_backend Backend []byte `protobuf:"bytes,22,opt,name=backend" json:"backend,omitempty"` // Used by riak_search bucket fixup Search *bool `protobuf:"varint,23,opt,name=search" json:"search,omitempty"` Repl *RpbBucketProps_RpbReplMode `protobuf:"varint,24,opt,name=repl,enum=RpbBucketProps_RpbReplMode" json:"repl,omitempty"` // Search index SearchIndex []byte `protobuf:"bytes,25,opt,name=search_index" json:"search_index,omitempty"` // KV Datatypes Datatype []byte `protobuf:"bytes,26,opt,name=datatype" json:"datatype,omitempty"` // KV strong consistency Consistent *bool `protobuf:"varint,27,opt,name=consistent" json:"consistent,omitempty"` // KV fast path WriteOnce *bool `protobuf:"varint,28,opt,name=write_once" json:"write_once,omitempty"` XXX_unrecognized []byte `json:"-"` }
Bucket properties
func (*RpbBucketProps) GetAllowMult ¶
func (m *RpbBucketProps) GetAllowMult() bool
func (*RpbBucketProps) GetBackend ¶
func (m *RpbBucketProps) GetBackend() []byte
func (*RpbBucketProps) GetBasicQuorum ¶
func (m *RpbBucketProps) GetBasicQuorum() bool
func (*RpbBucketProps) GetBigVclock ¶
func (m *RpbBucketProps) GetBigVclock() uint32
func (*RpbBucketProps) GetChashKeyfun ¶
func (m *RpbBucketProps) GetChashKeyfun() *RpbModFun
func (*RpbBucketProps) GetConsistent ¶
func (m *RpbBucketProps) GetConsistent() bool
func (*RpbBucketProps) GetDatatype ¶
func (m *RpbBucketProps) GetDatatype() []byte
func (*RpbBucketProps) GetDw ¶
func (m *RpbBucketProps) GetDw() uint32
func (*RpbBucketProps) GetHasPostcommit ¶
func (m *RpbBucketProps) GetHasPostcommit() bool
func (*RpbBucketProps) GetHasPrecommit ¶
func (m *RpbBucketProps) GetHasPrecommit() bool
func (*RpbBucketProps) GetLastWriteWins ¶
func (m *RpbBucketProps) GetLastWriteWins() bool
func (*RpbBucketProps) GetLinkfun ¶
func (m *RpbBucketProps) GetLinkfun() *RpbModFun
func (*RpbBucketProps) GetNVal ¶
func (m *RpbBucketProps) GetNVal() uint32
func (*RpbBucketProps) GetNotfoundOk ¶
func (m *RpbBucketProps) GetNotfoundOk() bool
func (*RpbBucketProps) GetOldVclock ¶
func (m *RpbBucketProps) GetOldVclock() uint32
func (*RpbBucketProps) GetPostcommit ¶
func (m *RpbBucketProps) GetPostcommit() []*RpbCommitHook
func (*RpbBucketProps) GetPr ¶
func (m *RpbBucketProps) GetPr() uint32
func (*RpbBucketProps) GetPrecommit ¶
func (m *RpbBucketProps) GetPrecommit() []*RpbCommitHook
func (*RpbBucketProps) GetPw ¶
func (m *RpbBucketProps) GetPw() uint32
func (*RpbBucketProps) GetR ¶
func (m *RpbBucketProps) GetR() uint32
func (*RpbBucketProps) GetRepl ¶
func (m *RpbBucketProps) GetRepl() RpbBucketProps_RpbReplMode
func (*RpbBucketProps) GetRw ¶
func (m *RpbBucketProps) GetRw() uint32
func (*RpbBucketProps) GetSearch ¶
func (m *RpbBucketProps) GetSearch() bool
func (*RpbBucketProps) GetSearchIndex ¶
func (m *RpbBucketProps) GetSearchIndex() []byte
func (*RpbBucketProps) GetSmallVclock ¶
func (m *RpbBucketProps) GetSmallVclock() uint32
func (*RpbBucketProps) GetW ¶
func (m *RpbBucketProps) GetW() uint32
func (*RpbBucketProps) GetWriteOnce ¶
func (m *RpbBucketProps) GetWriteOnce() bool
func (*RpbBucketProps) GetYoungVclock ¶
func (m *RpbBucketProps) GetYoungVclock() uint32
func (*RpbBucketProps) ProtoMessage ¶
func (*RpbBucketProps) ProtoMessage()
func (*RpbBucketProps) Reset ¶
func (m *RpbBucketProps) Reset()
func (*RpbBucketProps) String ¶
func (m *RpbBucketProps) String() string
type RpbBucketProps_RpbReplMode ¶
type RpbBucketProps_RpbReplMode int32
Used by riak_repl bucket fixup
const ( RpbBucketProps_FALSE RpbBucketProps_RpbReplMode = 0 RpbBucketProps_REALTIME RpbBucketProps_RpbReplMode = 1 RpbBucketProps_FULLSYNC RpbBucketProps_RpbReplMode = 2 RpbBucketProps_TRUE RpbBucketProps_RpbReplMode = 3 )
func (RpbBucketProps_RpbReplMode) Enum ¶
func (x RpbBucketProps_RpbReplMode) Enum() *RpbBucketProps_RpbReplMode
func (RpbBucketProps_RpbReplMode) String ¶
func (x RpbBucketProps_RpbReplMode) String() string
func (*RpbBucketProps_RpbReplMode) UnmarshalJSON ¶
func (x *RpbBucketProps_RpbReplMode) UnmarshalJSON(data []byte) error
type RpbCommitHook ¶
type RpbCommitHook struct { Modfun *RpbModFun `protobuf:"bytes,1,opt,name=modfun" json:"modfun,omitempty"` Name []byte `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"` XXX_unrecognized []byte `json:"-"` }
A commit hook, which may either be a modfun or a JavaScript named function
func (*RpbCommitHook) GetModfun ¶
func (m *RpbCommitHook) GetModfun() *RpbModFun
func (*RpbCommitHook) GetName ¶
func (m *RpbCommitHook) GetName() []byte
func (*RpbCommitHook) ProtoMessage ¶
func (*RpbCommitHook) ProtoMessage()
func (*RpbCommitHook) Reset ¶
func (m *RpbCommitHook) Reset()
func (*RpbCommitHook) String ¶
func (m *RpbCommitHook) String() string
type RpbErrorResp ¶
type RpbErrorResp struct { Errmsg []byte `protobuf:"bytes,1,req,name=errmsg" json:"errmsg,omitempty"` Errcode *uint32 `protobuf:"varint,2,req,name=errcode" json:"errcode,omitempty"` XXX_unrecognized []byte `json:"-"` }
Error response - may be generated for any Req
func (*RpbErrorResp) GetErrcode ¶
func (m *RpbErrorResp) GetErrcode() uint32
func (*RpbErrorResp) GetErrmsg ¶
func (m *RpbErrorResp) GetErrmsg() []byte
func (*RpbErrorResp) ProtoMessage ¶
func (*RpbErrorResp) ProtoMessage()
func (*RpbErrorResp) Reset ¶
func (m *RpbErrorResp) Reset()
func (*RpbErrorResp) String ¶
func (m *RpbErrorResp) String() string
type RpbGetBucketReq ¶
type RpbGetBucketReq struct { Bucket []byte `protobuf:"bytes,1,req,name=bucket" json:"bucket,omitempty"` Type []byte `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"` XXX_unrecognized []byte `json:"-"` }
Get bucket properties request
func (*RpbGetBucketReq) BucketIsRequired ¶
func (m *RpbGetBucketReq) BucketIsRequired() bool
func (*RpbGetBucketReq) GetBucket ¶
func (m *RpbGetBucketReq) GetBucket() []byte
func (*RpbGetBucketReq) GetKey ¶
func (m *RpbGetBucketReq) GetKey() []byte
func (*RpbGetBucketReq) GetType ¶
func (m *RpbGetBucketReq) GetType() []byte
func (*RpbGetBucketReq) KeyIsRequired ¶
func (m *RpbGetBucketReq) KeyIsRequired() bool
func (*RpbGetBucketReq) ProtoMessage ¶
func (*RpbGetBucketReq) ProtoMessage()
func (*RpbGetBucketReq) Reset ¶
func (m *RpbGetBucketReq) Reset()
func (*RpbGetBucketReq) SetType ¶
func (m *RpbGetBucketReq) SetType(bt []byte)
func (*RpbGetBucketReq) String ¶
func (m *RpbGetBucketReq) String() string
type RpbGetBucketResp ¶
type RpbGetBucketResp struct { Props *RpbBucketProps `protobuf:"bytes,1,req,name=props" json:"props,omitempty"` XXX_unrecognized []byte `json:"-"` }
Get bucket properties response
func (*RpbGetBucketResp) GetProps ¶
func (m *RpbGetBucketResp) GetProps() *RpbBucketProps
func (*RpbGetBucketResp) ProtoMessage ¶
func (*RpbGetBucketResp) ProtoMessage()
func (*RpbGetBucketResp) Reset ¶
func (m *RpbGetBucketResp) Reset()
func (*RpbGetBucketResp) String ¶
func (m *RpbGetBucketResp) String() string
type RpbGetBucketTypeReq ¶
type RpbGetBucketTypeReq struct { Type []byte `protobuf:"bytes,1,req,name=type" json:"type,omitempty"` XXX_unrecognized []byte `json:"-"` }
Get bucket properties request
func (*RpbGetBucketTypeReq) GetType ¶
func (m *RpbGetBucketTypeReq) GetType() []byte
func (*RpbGetBucketTypeReq) ProtoMessage ¶
func (*RpbGetBucketTypeReq) ProtoMessage()
func (*RpbGetBucketTypeReq) Reset ¶
func (m *RpbGetBucketTypeReq) Reset()
func (*RpbGetBucketTypeReq) String ¶
func (m *RpbGetBucketTypeReq) String() string
type RpbGetServerInfoResp ¶
type RpbGetServerInfoResp struct { Node []byte `protobuf:"bytes,1,opt,name=node" json:"node,omitempty"` ServerVersion []byte `protobuf:"bytes,2,opt,name=server_version" json:"server_version,omitempty"` XXX_unrecognized []byte `json:"-"` }
Get server info request - no message defined, just send RpbGetServerInfoReq message code
func (*RpbGetServerInfoResp) GetNode ¶
func (m *RpbGetServerInfoResp) GetNode() []byte
func (*RpbGetServerInfoResp) GetServerVersion ¶
func (m *RpbGetServerInfoResp) GetServerVersion() []byte
func (*RpbGetServerInfoResp) ProtoMessage ¶
func (*RpbGetServerInfoResp) ProtoMessage()
func (*RpbGetServerInfoResp) Reset ¶
func (m *RpbGetServerInfoResp) Reset()
func (*RpbGetServerInfoResp) String ¶
func (m *RpbGetServerInfoResp) String() string
type RpbModFun ¶
type RpbModFun struct { Module []byte `protobuf:"bytes,1,req,name=module" json:"module,omitempty"` Function []byte `protobuf:"bytes,2,req,name=function" json:"function,omitempty"` XXX_unrecognized []byte `json:"-"` }
Module-Function pairs for commit hooks and other bucket properties that take functions
func (*RpbModFun) GetFunction ¶
func (*RpbModFun) ProtoMessage ¶
func (*RpbModFun) ProtoMessage()
type RpbPair ¶
type RpbPair struct { Key []byte `protobuf:"bytes,1,req,name=key" json:"key,omitempty"` Value []byte `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` XXX_unrecognized []byte `json:"-"` }
Key/value pair - used for user metadata, indexes, search doc fields
func (*RpbPair) ProtoMessage ¶
func (*RpbPair) ProtoMessage()
type RpbResetBucketReq ¶
type RpbResetBucketReq struct { Bucket []byte `protobuf:"bytes,1,req,name=bucket" json:"bucket,omitempty"` Type []byte `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"` XXX_unrecognized []byte `json:"-"` }
Reset bucket properties request
func (*RpbResetBucketReq) GetBucket ¶
func (m *RpbResetBucketReq) GetBucket() []byte
func (*RpbResetBucketReq) GetType ¶
func (m *RpbResetBucketReq) GetType() []byte
func (*RpbResetBucketReq) ProtoMessage ¶
func (*RpbResetBucketReq) ProtoMessage()
func (*RpbResetBucketReq) Reset ¶
func (m *RpbResetBucketReq) Reset()
func (*RpbResetBucketReq) String ¶
func (m *RpbResetBucketReq) String() string
type RpbSetBucketReq ¶
type RpbSetBucketReq struct { Bucket []byte `protobuf:"bytes,1,req,name=bucket" json:"bucket,omitempty"` Props *RpbBucketProps `protobuf:"bytes,2,req,name=props" json:"props,omitempty"` Type []byte `protobuf:"bytes,3,opt,name=type" json:"type,omitempty"` XXX_unrecognized []byte `json:"-"` }
Set bucket properties request
func (*RpbSetBucketReq) BucketIsRequired ¶
func (m *RpbSetBucketReq) BucketIsRequired() bool
func (*RpbSetBucketReq) GetBucket ¶
func (m *RpbSetBucketReq) GetBucket() []byte
func (*RpbSetBucketReq) GetKey ¶
func (m *RpbSetBucketReq) GetKey() []byte
func (*RpbSetBucketReq) GetProps ¶
func (m *RpbSetBucketReq) GetProps() *RpbBucketProps
func (*RpbSetBucketReq) GetType ¶
func (m *RpbSetBucketReq) GetType() []byte
func (*RpbSetBucketReq) KeyIsRequired ¶
func (m *RpbSetBucketReq) KeyIsRequired() bool
func (*RpbSetBucketReq) ProtoMessage ¶
func (*RpbSetBucketReq) ProtoMessage()
func (*RpbSetBucketReq) Reset ¶
func (m *RpbSetBucketReq) Reset()
func (*RpbSetBucketReq) SetType ¶
func (m *RpbSetBucketReq) SetType(bt []byte)
func (*RpbSetBucketReq) String ¶
func (m *RpbSetBucketReq) String() string
type RpbSetBucketTypeReq ¶
type RpbSetBucketTypeReq struct { Type []byte `protobuf:"bytes,1,req,name=type" json:"type,omitempty"` Props *RpbBucketProps `protobuf:"bytes,2,req,name=props" json:"props,omitempty"` XXX_unrecognized []byte `json:"-"` }
Set bucket properties request
func (*RpbSetBucketTypeReq) GetProps ¶
func (m *RpbSetBucketTypeReq) GetProps() *RpbBucketProps
func (*RpbSetBucketTypeReq) GetType ¶
func (m *RpbSetBucketTypeReq) GetType() []byte
func (*RpbSetBucketTypeReq) ProtoMessage ¶
func (*RpbSetBucketTypeReq) ProtoMessage()
func (*RpbSetBucketTypeReq) Reset ¶
func (m *RpbSetBucketTypeReq) Reset()
func (*RpbSetBucketTypeReq) String ¶
func (m *RpbSetBucketTypeReq) String() string