Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Execution ¶
type Execution struct {
// when the execution finished running
// Format: date-time
FinishedAt strfmt.DateTime `json:"finished_at,omitempty"`
// job name
// Example: job_1
JobName string `json:"job_name,omitempty"`
// name of the node that executed the command
// Example: dkron1
NodeName string `json:"node_name,omitempty"`
// partial output of the command execution
// Example: Hello from Dkron
Output string `json:"output,omitempty"`
// start time of the execution
// Format: date-time
StartedAt strfmt.DateTime `json:"started_at,omitempty"`
// the execution run successfuly
Success bool `json:"success,omitempty"`
}
Execution An execution represents a timed job run.
swagger:model execution
func (*Execution) ContextValidate ¶
ContextValidate validates this execution based on context it is used
func (*Execution) MarshalBinary ¶
MarshalBinary interface implementation
func (*Execution) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Job ¶
type Job struct {
// Concurrency policy for the job allow/forbid
// Example: allow
Concurrency string `json:"concurrency,omitempty"`
// Array containing the jobs that depends on this one
// Example: ["dependent_job"]
// Read Only: true
DependentJobs []string `json:"dependent_jobs"`
// Disabled state of the job
Disabled bool `json:"disabled,omitempty"`
// Nice name for the job. Optional.
Displayname string `json:"displayname,omitempty"`
// Number of failed executions
// Read Only: true
ErrorCount int64 `json:"error_count,omitempty"`
// Executor plugin used to run the job
// Example: shell
Executor string `json:"executor,omitempty"`
// Executor plugin parameters
// Example: {"command":"echo 'Hello from Dkron'"}
ExecutorConfig map[string]string `json:"executor_config,omitempty"`
// Last time this job failed
// Read Only: true
// Format: date-time
LastError strfmt.DateTime `json:"last_error,omitempty"`
// Last time this job executed successfully
// Read Only: true
// Format: date-time
LastSuccess strfmt.DateTime `json:"last_success,omitempty"`
// Extra metadata tags for this job
// Example: {"office":"Barcelona"}
Metadata map[string]string `json:"metadata,omitempty"`
// Name for the job. Use only lower case letters (unicode), digits, underscore and dash.
// Example: job1
// Required: true
Name *string `json:"name"`
// Time of the next job execution
// Read Only: true
// Format: date-time
Next strfmt.DateTime `json:"next,omitempty"`
// Owner of the job
// Example: Platform Team
Owner string `json:"owner,omitempty"`
// Email of the owner
// Example: platform@example.com
OwnerEmail string `json:"owner_email,omitempty"`
// The name/id of the job that will trigger the execution of this job
// Example: parent_job
ParentJob string `json:"parent_job,omitempty"`
// processors
Processors Processors `json:"processors,omitempty"`
// Number of times to retry a failed job execution
// Example: 2
Retries int64 `json:"retries,omitempty"`
// Cron expression for the job.
// Example: @every 10s
// Required: true
Schedule *string `json:"schedule"`
// Status of the job
// Example: success
// Read Only: true
Status string `json:"status,omitempty"`
// Number of successful executions
// Read Only: true
SuccessCount int64 `json:"success_count,omitempty"`
// Target nodes tags of this job
// Example: {"server":"true"}
Tags map[string]string `json:"tags,omitempty"`
// Timezone where the job will be executed. By default and when field is set to empty string, the job will run in local time.
// Example: Europe/Berlin
Timezone string `json:"timezone,omitempty"`
}
Job A Job represents a scheduled task to execute.
swagger:model job
func (*Job) ContextValidate ¶
ContextValidate validate this job based on the context it is used
func (*Job) MarshalBinary ¶
MarshalBinary interface implementation
func (*Job) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Member ¶
type Member struct {
// IP Address
// Example: 192.168.1.137
Addr string `json:"Addr,omitempty"`
// Serf delegate protocol current version this node can understand or speak
// Example: 4
DelegateCur int64 `json:"DelegateCur,omitempty"`
// Serf delegate protocol maximum version this node can understand or speak
// Example: 5
DelegateMax int64 `json:"DelegateMax,omitempty"`
// Serf delegate protocol minimum version this node can understand or speak
DelegateMin int64 `json:"DelegateMin,omitempty"`
// Node name
// Example: dkron1
Name string `json:"Name,omitempty"`
// Port number
// Example: 8946
Port int64 `json:"Port,omitempty"`
// Serf protocol current version this node can understand or speak
// Example: 2
ProtocolCur int64 `json:"ProtocolCur,omitempty"`
// Serf protocol maximum version this node can understand or speak
// Example: 2
ProtocolMax int64 `json:"ProtocolMax,omitempty"`
// Serf protocol minimum version this node can understand or speak
// Example: 5
ProtocolMin int64 `json:"ProtocolMin,omitempty"`
// The serf status of the node see: https://godoc.org/github.com/hashicorp/serf/serf#MemberStatus
// Example: 1
Status int64 `json:"Status,omitempty"`
// Tags asociated with this node
// Example: {"rpc_addr":"192.168.1.137:6868","server":"true","version\"":"1.0.0"}
Tags map[string]string `json:"Tags,omitempty"`
}
Member A member represents a cluster member node.
swagger:model member
func (*Member) ContextValidate ¶
ContextValidate validates this member based on context it is used
func (*Member) MarshalBinary ¶
MarshalBinary interface implementation
func (*Member) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Processors ¶
Processors Processor plugins used to process executions results of this job Example: {"files":{"forward":true}}
swagger:model processors
func (Processors) ContextValidate ¶
ContextValidate validates this processors based on context it is used
type Restore ¶
type Restore string
Restore Each job restore result. Example: success create job_1
swagger:model restore
func (Restore) ContextValidate ¶
ContextValidate validates this restore based on context it is used
type Status ¶
type Status struct {
// Node basic details
// Read Only: true
Agent map[string]interface{} `json:"agent,omitempty"`
// Serf status
// Read Only: true
Serf map[string]interface{} `json:"serf,omitempty"`
// Tags asociated with this node
// Read Only: true
Tags map[string]string `json:"tags,omitempty"`
}
Status Status represents details about the node.
swagger:model status
func (*Status) ContextValidate ¶
ContextValidate validate this status based on the context it is used
func (*Status) MarshalBinary ¶
MarshalBinary interface implementation
func (*Status) UnmarshalBinary ¶
UnmarshalBinary interface implementation