Documentation ¶
Index ¶
- type CommonBody
- type CommonMetadata
- type CommonVersion
- type RecurringNewTask
- type RecurringTask
- type RecurringTaskDefinition
- type RecurringTaskUpdate
- type TaskArgs
- type TaskClaim
- type TaskContext
- type TaskFailure
- type TaskJSONObj
- type TaskLastClaimed
- type TaskNewReport
- type TaskNewTask
- type TaskReport
- type TaskReportedData
- type TaskResult
- type TaskSuccess
- type TaskTask
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CommonBody ¶
type CommonBody struct { // The error message // Required: true Message *string `json:"message"` }
CommonBody common body swagger:model common.Body
func (*CommonBody) MarshalBinary ¶
func (m *CommonBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommonBody) UnmarshalBinary ¶
func (m *CommonBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CommonMetadata ¶
type CommonMetadata struct { // When the data was created // Format: date-time CreatedAt strfmt.DateTime `json:"created_at,omitempty"` // When the data was last modified // Format: date-time ModifiedAt strfmt.DateTime `json:"modified_at,omitempty"` // Data versioning information Version *CommonVersion `json:"version,omitempty"` }
CommonMetadata common metadata swagger:model common.Metadata
func (*CommonMetadata) MarshalBinary ¶
func (m *CommonMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommonMetadata) UnmarshalBinary ¶
func (m *CommonMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CommonVersion ¶
type CommonVersion struct { // primary term PrimaryTerm int64 `json:"primary_term,omitempty"` // seq num SeqNum int64 `json:"seq_num,omitempty"` }
CommonVersion common version swagger:model common.Version
func (*CommonVersion) MarshalBinary ¶
func (m *CommonVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommonVersion) UnmarshalBinary ¶
func (m *CommonVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RecurringNewTask ¶
type RecurringNewTask struct { // User-definable Id for the recurring Task. Must not collide with other existing ones. // Required: true ID *string `json:"id"` // A schedule expression; can be any valid cron expression, with some support for simple macros // Required: true ScheduleExpression *string `json:"schedule_expression"` // The Task to insert at intervals defined by ScheduleExpression // Required: true TaskDefinition *RecurringTaskDefinition `json:"task_definition"` }
RecurringNewTask recurring new task swagger:model recurring.NewTask
func (*RecurringNewTask) MarshalBinary ¶
func (m *RecurringNewTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RecurringNewTask) UnmarshalBinary ¶
func (m *RecurringNewTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RecurringTask ¶
type RecurringTask struct { // User-defined Id for the recurring Task. Must not collide with other existing ones. // Required: true ID *string `json:"id"` // When this recurring Task was last acknoledged and _loaded_ by a Tasques server for later // automatic enqueueing LoadedAt string `json:"loaded_at,omitempty"` // Metadata (data about data) // Required: true Metadata *CommonMetadata `json:"metadata"` // A schedule expression; can be any valid cron expression, with some support for simple macros // Required: true ScheduleExpression *string `json:"schedule_expression"` // The Task to insert at intervals defined by ScheduleExpression // Required: true TaskDefinition *RecurringTaskDefinition `json:"task_definition"` }
RecurringTask recurring task swagger:model recurring.Task
func (*RecurringTask) MarshalBinary ¶
func (m *RecurringTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RecurringTask) UnmarshalBinary ¶
func (m *RecurringTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RecurringTaskDefinition ¶
type RecurringTaskDefinition struct { // Arguments for this Task Args interface{} `json:"args,omitempty"` // Context for this Task Context interface{} `json:"context,omitempty"` // The kind of Task; corresponds roughly with a function name // Required: true Kind *string `json:"kind"` // The priority of this Task (higher means higher priority) // If not passed, defaults to zero (neutral) Priority int64 `json:"priority,omitempty"` // How long a Worker has upon claiming this Task to finish or report back before it gets timed out by the Tasques server // If not passed, falls back to a server-side configured default ProcessingTimeout string `json:"processing_timeout,omitempty"` // The queue that a Task will be inserted into // Required: true Queue *string `json:"queue"` // The number of times that a Task will be retried if it fails // If not passed, falls back to a server-side configured default RetryTimes int64 `json:"retry_times,omitempty"` }
RecurringTaskDefinition recurring task definition swagger:model recurring.TaskDefinition
func (*RecurringTaskDefinition) MarshalBinary ¶
func (m *RecurringTaskDefinition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RecurringTaskDefinition) UnmarshalBinary ¶
func (m *RecurringTaskDefinition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RecurringTaskUpdate ¶
type RecurringTaskUpdate struct { // A schedule expression; can be any valid cron expression, with some support for simple macros // If not defined, reuses the existing one on the recurring Task ScheduleExpression string `json:"schedule_expression,omitempty"` // The Task to insert at intervals defined by ScheduleExpression // If not defined, reuses the existing one on the recurring Task TaskDefinition *RecurringTaskDefinition `json:"task_definition,omitempty"` }
RecurringTaskUpdate recurring task update swagger:model recurring.TaskUpdate
func (*RecurringTaskUpdate) MarshalBinary ¶
func (m *RecurringTaskUpdate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RecurringTaskUpdate) UnmarshalBinary ¶
func (m *RecurringTaskUpdate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskArgs ¶
type TaskArgs = TaskJSONObj
type TaskClaim ¶
type TaskClaim struct { // How many Tasks to try to claim Amount int64 `json:"amount,omitempty"` // How long to block for before retrying, if the specified amount cannot be claimed. // If not passed, falls back to a server-side configured default BlockFor string `json:"block_for,omitempty"` // The Task queues to claim from // Required: true Queues []string `json:"queues"` }
TaskClaim task claim swagger:model task.Claim
func (*TaskClaim) MarshalBinary ¶
MarshalBinary interface implementation
func (*TaskClaim) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskContext ¶
type TaskContext = TaskJSONObj
type TaskFailure ¶
type TaskFailure struct {
// data
Data interface{} `json:"data,omitempty"`
}
TaskFailure task failure swagger:model task.Failure
func (*TaskFailure) MarshalBinary ¶
func (m *TaskFailure) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskFailure) UnmarshalBinary ¶
func (m *TaskFailure) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskJSONObj ¶
type TaskJSONObj interface{}
TaskJSONObj task Json obj swagger:model task.JsonObj
type TaskLastClaimed ¶
type TaskLastClaimed struct { // When the claim was made // Required: true // Format: date-time ClaimedAt *strfmt.DateTime `json:"claimed_at"` // The LastReport filed by a worker holding a claim on the Task LastReport *TaskReport `json:"last_report,omitempty"` // The processing Result Result *TaskResult `json:"result,omitempty"` // When the Task will be timed out if the worker doesn't finish or report back // Required: true // Format: date-time TimesOutAt *strfmt.DateTime `json:"times_out_at"` // Id belonging to a worker that claimed the Task // Required: true WorkerID *string `json:"worker_id"` }
TaskLastClaimed task last claimed swagger:model task.LastClaimed
func (*TaskLastClaimed) MarshalBinary ¶
func (m *TaskLastClaimed) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskLastClaimed) UnmarshalBinary ¶
func (m *TaskLastClaimed) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskNewReport ¶
type TaskNewReport struct { // Optional data for the report Data TaskReportedData `json:"data,omitempty"` }
TaskNewReport task new report swagger:model task.NewReport
func (*TaskNewReport) MarshalBinary ¶
func (m *TaskNewReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskNewReport) UnmarshalBinary ¶
func (m *TaskNewReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskNewTask ¶
type TaskNewTask struct { // Arguments for this Task Args interface{} `json:"args,omitempty"` // Context for this Task Context interface{} `json:"context,omitempty"` // The kind of Task; corresponds roughly with a function name // Required: true Kind *string `json:"kind"` // The priority of this Task (higher means higher priority) // If not passed, defaults to zero (neutral) Priority int64 `json:"priority,omitempty"` // How long a Worker has upon claiming this Task to finish or report back before it gets timed out by the Tasques server // If not passed, falls back to a server-side configured default ProcessingTimeout string `json:"processing_timeout,omitempty"` // The queue that a Task will be inserted into // Required: true Queue *string `json:"queue"` // The number of times that a Task will be retried if it fails // If not passed, falls back to a server-side configured default RetryTimes int64 `json:"retry_times,omitempty"` // If defined, when this Task should run // If not passed, falls back to now. // Format: date-time RunAt strfmt.DateTime `json:"run_at,omitempty"` }
TaskNewTask task new task swagger:model task.NewTask
func (*TaskNewTask) MarshalBinary ¶
func (m *TaskNewTask) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskNewTask) UnmarshalBinary ¶
func (m *TaskNewTask) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskReport ¶
type TaskReport struct { // When the report was filed // Required: true // Format: date-time At *strfmt.DateTime `json:"at"` // Optional report data Data interface{} `json:"data,omitempty"` }
TaskReport task report swagger:model task.Report
func (*TaskReport) MarshalBinary ¶
func (m *TaskReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskReport) UnmarshalBinary ¶
func (m *TaskReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskReportedData ¶
type TaskReportedData = TaskJSONObj
type TaskResult ¶
type TaskResult struct { // When the Result was produced // Required: true // Format: date-time At *strfmt.DateTime `json:"at"` // Failure Failure interface{} `json:"failure,omitempty"` // Success Success interface{} `json:"success,omitempty"` }
TaskResult task result swagger:model task.Result
func (*TaskResult) MarshalBinary ¶
func (m *TaskResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskResult) UnmarshalBinary ¶
func (m *TaskResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSuccess ¶
type TaskSuccess struct {
// data
Data interface{} `json:"data,omitempty"`
}
TaskSuccess task success swagger:model task.Success
func (*TaskSuccess) MarshalBinary ¶
func (m *TaskSuccess) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSuccess) UnmarshalBinary ¶
func (m *TaskSuccess) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskTask ¶
type TaskTask struct { // Arguments for this Task Args interface{} `json:"args,omitempty"` // The number of times a Task has been attempted // Required: true Attempted *int64 `json:"attempted"` // Context for this Task Context interface{} `json:"context,omitempty"` // Unique identifier of a Task // Required: true ID *string `json:"id"` // The kind of Task; corresponds roughly with a function name // Required: true Kind *string `json:"kind"` // Information on when this Task was last claimed by a worker LastClaimed *TaskLastClaimed `json:"last_claimed,omitempty"` // When this Task was last enqueued // Required: true // Format: date-time LastEnqueuedAt *strfmt.DateTime `json:"last_enqueued_at"` // Metadata (data about data) // Required: true Metadata *CommonMetadata `json:"metadata"` // The priority of this Task (higher means higher priority) // Required: true Priority *int64 `json:"priority"` // How long a Worker has upon claiming this Task to finish or report back before it gets timed out by the Tasques server // Required: true ProcessingTimeout *string `json:"processing_timeout"` // The queue the Task is in // Required: true Queue *string `json:"queue"` // Only populated if this is a Task that was spawned/enqueued by a Recurring Task definition RecurringTaskID string `json:"recurring_task_id,omitempty"` // The number of times that a Task will be retried if it fails // Required: true RetryTimes *int64 `json:"retry_times"` // When this Task should run // Required: true // Format: date-time RunAt *strfmt.DateTime `json:"run_at"` // The state of a Task // Required: true State *string `json:"state"` }
TaskTask task task swagger:model task.Task
func (*TaskTask) MarshalBinary ¶
MarshalBinary interface implementation
func (*TaskTask) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files ¶
- common_body.go
- common_metadata.go
- common_version.go
- recurring_new_task.go
- recurring_task.go
- recurring_task_definition.go
- recurring_task_update.go
- task_args.go
- task_claim.go
- task_context.go
- task_failure.go
- task_json_obj.go
- task_last_claimed.go
- task_new_report.go
- task_new_task.go
- task_report.go
- task_reported_data.go
- task_result.go
- task_success.go
- task_task.go