Documentation ¶
Index ¶
- Variables
- type DeclareRequest
- type Empty
- type HeaderValue
- type Job
- func (*Job) Descriptor() ([]byte, []int)deprecated
- func (x *Job) GetHeaders() map[string]*HeaderValue
- func (x *Job) GetId() string
- func (x *Job) GetJob() string
- func (x *Job) GetOptions() *Options
- func (x *Job) GetPayload() string
- func (*Job) ProtoMessage()
- func (x *Job) ProtoReflect() protoreflect.Message
- func (x *Job) Reset()
- func (x *Job) String() string
- type Options
- func (*Options) Descriptor() ([]byte, []int)deprecated
- func (x *Options) GetAutoAck() bool
- func (x *Options) GetDelay() int64
- func (x *Options) GetMetadata() string
- func (x *Options) GetOffset() int64
- func (x *Options) GetPartition() int32
- func (x *Options) GetPipeline() string
- func (x *Options) GetPriority() int64
- func (x *Options) GetTopic() string
- func (*Options) ProtoMessage()
- func (x *Options) ProtoReflect() protoreflect.Message
- func (x *Options) Reset()
- func (x *Options) String() string
- type Pipelines
- type PushBatchRequest
- type PushRequest
- type Stat
- func (*Stat) Descriptor() ([]byte, []int)deprecated
- func (x *Stat) GetActive() int64
- func (x *Stat) GetDelayed() int64
- func (x *Stat) GetDriver() string
- func (x *Stat) GetPipeline() string
- func (x *Stat) GetPriority() uint64
- func (x *Stat) GetQueue() string
- func (x *Stat) GetReady() bool
- func (x *Stat) GetReserved() int64
- func (*Stat) ProtoMessage()
- func (x *Stat) ProtoReflect() protoreflect.Message
- func (x *Stat) Reset()
- func (x *Stat) String() string
- type Stats
Constants ¶
This section is empty.
Variables ¶
var File_proto_jobs_v1_jobs_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type DeclareRequest ¶
type DeclareRequest struct { Pipeline map[string]string `` /* 157-byte string literal not displayed */ // contains filtered or unexported fields }
--------------------------------------------- DeclareRequest used to dynamically declare pipeline -> Declare(req *jobsProto.DeclareRequest, _ *jobsProto.Empty) response `message Empty`
func (*DeclareRequest) Descriptor
deprecated
func (*DeclareRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeclareRequest.ProtoReflect.Descriptor instead.
func (*DeclareRequest) GetPipeline ¶
func (x *DeclareRequest) GetPipeline() map[string]string
func (*DeclareRequest) ProtoMessage ¶
func (*DeclareRequest) ProtoMessage()
func (*DeclareRequest) ProtoReflect ¶
func (x *DeclareRequest) ProtoReflect() protoreflect.Message
func (*DeclareRequest) Reset ¶
func (x *DeclareRequest) Reset()
func (*DeclareRequest) String ¶
func (x *DeclareRequest) String() string
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
some endpoints receives nothing all endpoints returns nothing, except error
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
type HeaderValue ¶
type HeaderValue struct { Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
HeaderValue represents []string value for the header (map[string][]string)
func (*HeaderValue) Descriptor
deprecated
func (*HeaderValue) Descriptor() ([]byte, []int)
Deprecated: Use HeaderValue.ProtoReflect.Descriptor instead.
func (*HeaderValue) GetValue ¶
func (x *HeaderValue) GetValue() []string
func (*HeaderValue) ProtoMessage ¶
func (*HeaderValue) ProtoMessage()
func (*HeaderValue) ProtoReflect ¶
func (x *HeaderValue) ProtoReflect() protoreflect.Message
func (*HeaderValue) Reset ¶
func (x *HeaderValue) Reset()
func (*HeaderValue) String ¶
func (x *HeaderValue) String() string
type Job ¶
type Job struct { // job name, usually PHP class Job string `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"` // unique job id Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"` // payload, might be embedded json or just byte-string Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"` // headers map[string][]string Headers map[string]*HeaderValue `` /* 155-byte string literal not displayed */ // job options, contains common and driver specific fields Options *Options `protobuf:"bytes,5,opt,name=options,proto3" json:"options,omitempty"` // contains filtered or unexported fields }
Job is a main message which user might send to the RR jobs plugin
func (*Job) GetHeaders ¶
func (x *Job) GetHeaders() map[string]*HeaderValue
func (*Job) ProtoReflect ¶
func (x *Job) ProtoReflect() protoreflect.Message
type Options ¶
type Options struct { Priority int64 `protobuf:"varint,1,opt,name=priority,proto3" json:"priority,omitempty"` Pipeline string `protobuf:"bytes,2,opt,name=pipeline,proto3" json:"pipeline,omitempty"` Delay int64 `protobuf:"varint,3,opt,name=delay,proto3" json:"delay,omitempty"` // new in 2.10 AutoAck bool `protobuf:"varint,6,opt,name=auto_ack,json=autoAck,proto3" json:"auto_ack,omitempty"` // -------------- // new in 2.11 (kafka related) Topic string `protobuf:"bytes,7,opt,name=topic,proto3" json:"topic,omitempty"` Metadata string `protobuf:"bytes,8,opt,name=metadata,proto3" json:"metadata,omitempty"` Offset int64 `protobuf:"varint,9,opt,name=offset,proto3" json:"offset,omitempty"` Partition int32 `protobuf:"varint,10,opt,name=partition,proto3" json:"partition,omitempty"` // ------------- // contains filtered or unexported fields }
Options message represents all Jobs' options
func (*Options) ProtoReflect ¶
func (x *Options) ProtoReflect() protoreflect.Message
type Pipelines ¶
type Pipelines struct { Pipelines []string `protobuf:"bytes,1,rep,name=pipelines,proto3" json:"pipelines,omitempty"` // contains filtered or unexported fields }
--------------------------------------------- request to pause/resume/list/destroy/declare
func (*Pipelines) ProtoReflect ¶
func (x *Pipelines) ProtoReflect() protoreflect.Message
type PushBatchRequest ¶
type PushBatchRequest struct { Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"` // contains filtered or unexported fields }
batch jobs request (jobs.PushBatch RPC endpoint) -> PushBatch(j *jobsProto.PushBatchRequest, _ *jobsProto.Empty) response `message Empty`
func (*PushBatchRequest) Descriptor
deprecated
func (*PushBatchRequest) Descriptor() ([]byte, []int)
Deprecated: Use PushBatchRequest.ProtoReflect.Descriptor instead.
func (*PushBatchRequest) GetJobs ¶
func (x *PushBatchRequest) GetJobs() []*Job
func (*PushBatchRequest) ProtoMessage ¶
func (*PushBatchRequest) ProtoMessage()
func (*PushBatchRequest) ProtoReflect ¶
func (x *PushBatchRequest) ProtoReflect() protoreflect.Message
func (*PushBatchRequest) Reset ¶
func (x *PushBatchRequest) Reset()
func (*PushBatchRequest) String ¶
func (x *PushBatchRequest) String() string
type PushRequest ¶
type PushRequest struct { Job *Job `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"` // contains filtered or unexported fields }
single job request (jobs.Push RPC endpoint) -> Push(j *jobsProto.PushRequest, _ *jobsProto.Empty) response `message Empty`
func (*PushRequest) Descriptor
deprecated
func (*PushRequest) Descriptor() ([]byte, []int)
Deprecated: Use PushRequest.ProtoReflect.Descriptor instead.
func (*PushRequest) GetJob ¶
func (x *PushRequest) GetJob() *Job
func (*PushRequest) ProtoMessage ¶
func (*PushRequest) ProtoMessage()
func (*PushRequest) ProtoReflect ¶
func (x *PushRequest) ProtoReflect() protoreflect.Message
func (*PushRequest) Reset ¶
func (x *PushRequest) Reset()
func (*PushRequest) String ¶
func (x *PushRequest) String() string
type Stat ¶
type Stat struct { Pipeline string `protobuf:"bytes,1,opt,name=pipeline,proto3" json:"pipeline,omitempty"` Driver string `protobuf:"bytes,2,opt,name=driver,proto3" json:"driver,omitempty"` Queue string `protobuf:"bytes,3,opt,name=queue,proto3" json:"queue,omitempty"` Active int64 `protobuf:"varint,4,opt,name=active,proto3" json:"active,omitempty"` Delayed int64 `protobuf:"varint,5,opt,name=delayed,proto3" json:"delayed,omitempty"` Reserved int64 `protobuf:"varint,6,opt,name=reserved,proto3" json:"reserved,omitempty"` Ready bool `protobuf:"varint,7,opt,name=ready,proto3" json:"ready,omitempty"` // new in 2.10.5 Priority uint64 `protobuf:"varint,8,opt,name=priority,proto3" json:"priority,omitempty"` // contains filtered or unexported fields }
Stat used as a response for the Stats RPC call
func (*Stat) ProtoReflect ¶
func (x *Stat) ProtoReflect() protoreflect.Message