queue

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2025 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_proto_queue_queue_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Close

type Close struct {
	// contains filtered or unexported fields
}

Close is a queue event which instructs that the queue executor should close.

func (*Close) Descriptor deprecated

func (*Close) Descriptor() ([]byte, []int)

Deprecated: Use Close.ProtoReflect.Descriptor instead.

func (*Close) ProtoMessage

func (*Close) ProtoMessage()

func (*Close) ProtoReflect

func (x *Close) ProtoReflect() protoreflect.Message

func (*Close) Reset

func (x *Close) Reset()

func (*Close) String

func (x *Close) String() string

type CloseJob

type CloseJob struct {

	// job_name is the job whose resources should be closed.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// contains filtered or unexported fields
}

CloseJob is a queue event which instructs the given job name has been closed and the associated resources should be released.

func (*CloseJob) Descriptor deprecated

func (*CloseJob) Descriptor() ([]byte, []int)

Deprecated: Use CloseJob.ProtoReflect.Descriptor instead.

func (*CloseJob) GetJobName

func (x *CloseJob) GetJobName() string

func (*CloseJob) ProtoMessage

func (*CloseJob) ProtoMessage()

func (*CloseJob) ProtoReflect

func (x *CloseJob) ProtoReflect() protoreflect.Message

func (*CloseJob) Reset

func (x *CloseJob) Reset()

func (*CloseJob) String

func (x *CloseJob) String() string

type ControlEvent

type ControlEvent struct {

	// action is the typed action which should be executed by the queue control
	// loop.
	//
	// Types that are assignable to Action:
	//
	//	*ControlEvent_Informed
	//	*ControlEvent_ExecuteRequest
	//	*ControlEvent_ExecuteResponse
	//	*ControlEvent_DeliverablePrefixes
	//	*ControlEvent_UndeliverablePrefixes
	//	*ControlEvent_CloseJob
	//	*ControlEvent_Close
	Action isControlEvent_Action `protobuf_oneof:"action"`
	// contains filtered or unexported fields
}

ControlEvent is a queue event which should be executed in turn of the queue control loop. Used for all job events.

func (*ControlEvent) Descriptor deprecated

func (*ControlEvent) Descriptor() ([]byte, []int)

Deprecated: Use ControlEvent.ProtoReflect.Descriptor instead.

func (*ControlEvent) GetAction

func (m *ControlEvent) GetAction() isControlEvent_Action

func (*ControlEvent) GetClose

func (x *ControlEvent) GetClose() *Close

func (*ControlEvent) GetCloseJob

func (x *ControlEvent) GetCloseJob() *CloseJob

func (*ControlEvent) GetDeliverablePrefixes

func (x *ControlEvent) GetDeliverablePrefixes() *DeliverablePrefixes

func (*ControlEvent) GetExecuteRequest

func (x *ControlEvent) GetExecuteRequest() *ExecuteRequest

func (*ControlEvent) GetExecuteResponse

func (x *ControlEvent) GetExecuteResponse() *ExecuteResponse

func (*ControlEvent) GetInformed

func (x *ControlEvent) GetInformed() *Informed

func (*ControlEvent) GetUndeliverablePrefixes

func (x *ControlEvent) GetUndeliverablePrefixes() *UndeliverablePrefixes

func (*ControlEvent) ProtoMessage

func (*ControlEvent) ProtoMessage()

func (*ControlEvent) ProtoReflect

func (x *ControlEvent) ProtoReflect() protoreflect.Message

func (*ControlEvent) Reset

func (x *ControlEvent) Reset()

func (*ControlEvent) String

func (x *ControlEvent) String() string

type ControlEvent_Close

type ControlEvent_Close struct {
	Close *Close `protobuf:"bytes,7,opt,name=close,proto3,oneof"`
}

type ControlEvent_CloseJob

type ControlEvent_CloseJob struct {
	CloseJob *CloseJob `protobuf:"bytes,6,opt,name=close_job,json=closeJob,proto3,oneof"`
}

type ControlEvent_DeliverablePrefixes

type ControlEvent_DeliverablePrefixes struct {
	DeliverablePrefixes *DeliverablePrefixes `protobuf:"bytes,4,opt,name=deliverable_prefixes,json=deliverablePrefixes,proto3,oneof"`
}

type ControlEvent_ExecuteRequest

type ControlEvent_ExecuteRequest struct {
	ExecuteRequest *ExecuteRequest `protobuf:"bytes,2,opt,name=execute_request,json=executeRequest,proto3,oneof"`
}

type ControlEvent_ExecuteResponse

type ControlEvent_ExecuteResponse struct {
	ExecuteResponse *ExecuteResponse `protobuf:"bytes,3,opt,name=execute_response,json=executeResponse,proto3,oneof"`
}

type ControlEvent_Informed

type ControlEvent_Informed struct {
	Informed *Informed `protobuf:"bytes,1,opt,name=informed,proto3,oneof"`
}

type ControlEvent_UndeliverablePrefixes

type ControlEvent_UndeliverablePrefixes struct {
	UndeliverablePrefixes *UndeliverablePrefixes `protobuf:"bytes,5,opt,name=undeliverable_prefixes,json=undeliverablePrefixes,proto3,oneof"`
}

type DeliverableJob

type DeliverableJob struct {
	// contains filtered or unexported fields
}

DeliverableJob is a job event which instructs that the given job can now be executed by the queue executor.

func (*DeliverableJob) Descriptor deprecated

func (*DeliverableJob) Descriptor() ([]byte, []int)

Deprecated: Use DeliverableJob.ProtoReflect.Descriptor instead.

func (*DeliverableJob) ProtoMessage

func (*DeliverableJob) ProtoMessage()

func (*DeliverableJob) ProtoReflect

func (x *DeliverableJob) ProtoReflect() protoreflect.Message

func (*DeliverableJob) Reset

func (x *DeliverableJob) Reset()

func (*DeliverableJob) String

func (x *DeliverableJob) String() string

type DeliverablePrefixes

type DeliverablePrefixes struct {

	// prefixes is the set of prefixes that can now be executed.
	Prefixes []string `protobuf:"bytes,1,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
	// contains filtered or unexported fields
}

DeliverablePrefixes is a queue event which instructs that the given prefixes can now be executed by the queue executor.

func (*DeliverablePrefixes) Descriptor deprecated

func (*DeliverablePrefixes) Descriptor() ([]byte, []int)

Deprecated: Use DeliverablePrefixes.ProtoReflect.Descriptor instead.

func (*DeliverablePrefixes) GetPrefixes

func (x *DeliverablePrefixes) GetPrefixes() []string

func (*DeliverablePrefixes) ProtoMessage

func (*DeliverablePrefixes) ProtoMessage()

func (*DeliverablePrefixes) ProtoReflect

func (x *DeliverablePrefixes) ProtoReflect() protoreflect.Message

func (*DeliverablePrefixes) Reset

func (x *DeliverablePrefixes) Reset()

func (*DeliverablePrefixes) String

func (x *DeliverablePrefixes) String() string

type ExecuteRequest

type ExecuteRequest struct {

	// job_name is the name of the job to execute.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// counter_key is the storage key of the job counter to execute.
	CounterKey string `protobuf:"bytes,2,opt,name=counter_key,json=counterKey,proto3" json:"counter_key,omitempty"`
	// contains filtered or unexported fields
}

ExecuteRequest is the queue event to execute a job.

func (*ExecuteRequest) Descriptor deprecated

func (*ExecuteRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExecuteRequest.ProtoReflect.Descriptor instead.

func (*ExecuteRequest) GetCounterKey

func (x *ExecuteRequest) GetCounterKey() string

func (*ExecuteRequest) GetJobName

func (x *ExecuteRequest) GetJobName() string

func (*ExecuteRequest) ProtoMessage

func (*ExecuteRequest) ProtoMessage()

func (*ExecuteRequest) ProtoReflect

func (x *ExecuteRequest) ProtoReflect() protoreflect.Message

func (*ExecuteRequest) Reset

func (x *ExecuteRequest) Reset()

func (*ExecuteRequest) String

func (x *ExecuteRequest) String() string

type ExecuteResponse

type ExecuteResponse struct {

	// job_name is the name of the job to execute.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// counter_key is the storage key of the job counter to execute.
	CounterKey string `protobuf:"bytes,2,opt,name=counter_key,json=counterKey,proto3" json:"counter_key,omitempty"`
	// uid tracks the id of this execution to account for mid-execution
	// cancellations.
	Uid int64 `protobuf:"varint,3,opt,name=uid,proto3" json:"uid,omitempty"`
	// result is the trigger result of executing this job counter.
	Result *api.TriggerResponse `protobuf:"bytes,4,opt,name=result,proto3" json:"result,omitempty"`
	// contains filtered or unexported fields
}

ExecuteResponse is to report the result of a job execution.

func (*ExecuteResponse) Descriptor deprecated

func (*ExecuteResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExecuteResponse.ProtoReflect.Descriptor instead.

func (*ExecuteResponse) GetCounterKey

func (x *ExecuteResponse) GetCounterKey() string

func (*ExecuteResponse) GetJobName

func (x *ExecuteResponse) GetJobName() string

func (*ExecuteResponse) GetResult

func (x *ExecuteResponse) GetResult() *api.TriggerResponse

func (*ExecuteResponse) GetUid

func (x *ExecuteResponse) GetUid() int64

func (*ExecuteResponse) ProtoMessage

func (*ExecuteResponse) ProtoMessage()

func (*ExecuteResponse) ProtoReflect

func (x *ExecuteResponse) ProtoReflect() protoreflect.Message

func (*ExecuteResponse) Reset

func (x *ExecuteResponse) Reset()

func (*ExecuteResponse) String

func (x *ExecuteResponse) String() string

type Informed

type Informed struct {

	// job is the stored job object.
	Job *stored.Job `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"`
	// name is the name of the job object.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// is_put is true if the event is a put event, false if it is a delete event.
	IsPut bool `protobuf:"varint,3,opt,name=is_put,json=isPut,proto3" json:"is_put,omitempty"`
	// job_mod_revision is the key revision of the job object in the storage.
	JobModRevision int64 `protobuf:"varint,4,opt,name=job_mod_revision,json=jobModRevision,proto3" json:"job_mod_revision,omitempty"`
	// contains filtered or unexported fields
}

Informed is the event that is sent to the queue when a job is added or deleted from the storage informer.

func (*Informed) Descriptor deprecated

func (*Informed) Descriptor() ([]byte, []int)

Deprecated: Use Informed.ProtoReflect.Descriptor instead.

func (*Informed) GetIsPut

func (x *Informed) GetIsPut() bool

func (*Informed) GetJob

func (x *Informed) GetJob() *stored.Job

func (*Informed) GetJobModRevision

func (x *Informed) GetJobModRevision() int64

func (*Informed) GetName

func (x *Informed) GetName() string

func (*Informed) ProtoMessage

func (*Informed) ProtoMessage()

func (*Informed) ProtoReflect

func (x *Informed) ProtoReflect() protoreflect.Message

func (*Informed) Reset

func (x *Informed) Reset()

func (*Informed) String

func (x *Informed) String() string

type JobAction

type JobAction struct {

	// action is the typed action which should be executed by the queue control
	// loop.
	//
	// Types that are assignable to Action:
	//
	//	*JobAction_Informed
	//	*JobAction_ExecuteRequest
	//	*JobAction_ExecuteResponse
	//	*JobAction_Deliverable
	//	*JobAction_CloseJob
	//	*JobAction_Close
	Action isJobAction_Action `protobuf_oneof:"action"`
	// contains filtered or unexported fields
}

func (*JobAction) Descriptor deprecated

func (*JobAction) Descriptor() ([]byte, []int)

Deprecated: Use JobAction.ProtoReflect.Descriptor instead.

func (*JobAction) GetAction

func (m *JobAction) GetAction() isJobAction_Action

func (*JobAction) GetClose

func (x *JobAction) GetClose() *Close

func (*JobAction) GetCloseJob

func (x *JobAction) GetCloseJob() *CloseJob

func (*JobAction) GetDeliverable

func (x *JobAction) GetDeliverable() *DeliverableJob

func (*JobAction) GetExecuteRequest

func (x *JobAction) GetExecuteRequest() *ExecuteRequest

func (*JobAction) GetExecuteResponse

func (x *JobAction) GetExecuteResponse() *ExecuteResponse

func (*JobAction) GetInformed

func (x *JobAction) GetInformed() *Informed

func (*JobAction) ProtoMessage

func (*JobAction) ProtoMessage()

func (*JobAction) ProtoReflect

func (x *JobAction) ProtoReflect() protoreflect.Message

func (*JobAction) Reset

func (x *JobAction) Reset()

func (*JobAction) String

func (x *JobAction) String() string

type JobAction_Close

type JobAction_Close struct {
	Close *Close `protobuf:"bytes,6,opt,name=close,proto3,oneof"`
}

type JobAction_CloseJob

type JobAction_CloseJob struct {
	CloseJob *CloseJob `protobuf:"bytes,5,opt,name=close_job,json=closeJob,proto3,oneof"`
}

type JobAction_Deliverable

type JobAction_Deliverable struct {
	Deliverable *DeliverableJob `protobuf:"bytes,4,opt,name=deliverable,proto3,oneof"`
}

type JobAction_ExecuteRequest

type JobAction_ExecuteRequest struct {
	ExecuteRequest *ExecuteRequest `protobuf:"bytes,2,opt,name=execute_request,json=executeRequest,proto3,oneof"`
}

type JobAction_ExecuteResponse

type JobAction_ExecuteResponse struct {
	ExecuteResponse *ExecuteResponse `protobuf:"bytes,3,opt,name=execute_response,json=executeResponse,proto3,oneof"`
}

type JobAction_Informed

type JobAction_Informed struct {
	Informed *Informed `protobuf:"bytes,1,opt,name=informed,proto3,oneof"`
}

type JobEvent

type JobEvent struct {

	// job_name is the name of the job associated with this event.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// action is the typed action which should be executed by the job event.
	Action *JobAction `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

JobEvent is queue events that should be processed by the inner Job event loop. These events are performed on a per-job handler.

func (*JobEvent) Descriptor deprecated

func (*JobEvent) Descriptor() ([]byte, []int)

Deprecated: Use JobEvent.ProtoReflect.Descriptor instead.

func (*JobEvent) GetAction

func (x *JobEvent) GetAction() *JobAction

func (*JobEvent) GetJobName

func (x *JobEvent) GetJobName() string

func (*JobEvent) ProtoMessage

func (*JobEvent) ProtoMessage()

func (*JobEvent) ProtoReflect

func (x *JobEvent) ProtoReflect() protoreflect.Message

func (*JobEvent) Reset

func (x *JobEvent) Reset()

func (*JobEvent) String

func (x *JobEvent) String() string

type UndeliverablePrefixes

type UndeliverablePrefixes struct {

	// prefixes is the set of prefixes that can no longer be executed.
	Prefixes []string `protobuf:"bytes,1,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
	// contains filtered or unexported fields
}

UndeliverablePrefixes is a queue event which instructs that the previously given prefixes can no longer be executed by the queue executor.

func (*UndeliverablePrefixes) Descriptor deprecated

func (*UndeliverablePrefixes) Descriptor() ([]byte, []int)

Deprecated: Use UndeliverablePrefixes.ProtoReflect.Descriptor instead.

func (*UndeliverablePrefixes) GetPrefixes

func (x *UndeliverablePrefixes) GetPrefixes() []string

func (*UndeliverablePrefixes) ProtoMessage

func (*UndeliverablePrefixes) ProtoMessage()

func (*UndeliverablePrefixes) ProtoReflect

func (x *UndeliverablePrefixes) ProtoReflect() protoreflect.Message

func (*UndeliverablePrefixes) Reset

func (x *UndeliverablePrefixes) Reset()

func (*UndeliverablePrefixes) String

func (x *UndeliverablePrefixes) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL