store

Documentation

Index

• Variables
• type Job
  • func (*Job) Descriptor() ([]byte, []int)
  • func (x *Job) GetDescription() string
  • func (x *Job) GetName() string
  • func (x *Job) GetNextScheduledRun() *timestamp.Timestamp
  • func (x *Job) GetPluginId() string
  • func (*Job) ProtoMessage()
  • func (x *Job) ProtoReflect() protoreflect.Message
  • func (x *Job) Reset()
  • func (x *Job) String() string
• type JobRun
  • func (*JobRun) Descriptor() ([]byte, []int)
  • func (x *JobRun) GetCompletedCount() uint32
  • func (x *JobRun) GetCreateTime() *timestamp.Timestamp
  • func (x *JobRun) GetEndTime() *timestamp.Timestamp
  • func (x *JobRun) GetJobName() string
  • func (x *JobRun) GetJobPluginId() string
  • func (x *JobRun) GetPrivateId() string
  • func (x *JobRun) GetServerId() string
  • func (x *JobRun) GetStatus() string
  • func (x *JobRun) GetTotalCount() uint32
  • func (x *JobRun) GetUpdateTime() *timestamp.Timestamp
  • func (*JobRun) ProtoMessage()
  • func (x *JobRun) ProtoReflect() protoreflect.Message
  • func (x *JobRun) Reset()
  • func (x *JobRun) String() string

Variables

var File_controller_storage_job_store_v1_job_proto protoreflect.FileDescriptor

Types

type Job

type Job struct {

	// plugin_id is the primary key of the plugin that registered and owns the job
	// @inject_tag: `gorm:"primary_key"`
	PluginId string `protobuf:"bytes,1,opt,name=plugin_id,json=pluginId,proto3" json:"plugin_id,omitempty" gorm:"primary_key"`
	// The name of the job.
	// @inject_tag: `gorm:"primary_key"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty" gorm:"primary_key"`
	// The human friendly description of the job.
	// @inject_tag: `gorm:"not_null"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty" gorm:"not_null"`
	// next_scheduled_run is the time that the next run should be created.
	// @inject_tag: `gorm:"default:current_timestamp"`
	NextScheduledRun *timestamp.Timestamp `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Job) Descriptor

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetDescription

func (x *Job) GetDescription() string

func (*Job) GetName

func (x *Job) GetName() string

func (*Job) GetNextScheduledRun

func (x *Job) GetNextScheduledRun() *timestamp.Timestamp

func (*Job) GetPluginId

func (x *Job) GetPluginId() string

func (*Job) ProtoMessage

func (*Job) ProtoMessage()

func (*Job) ProtoReflect

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

func (*Job) Reset

func (x *Job) Reset()

func (*Job) String

func (x *Job) String() string

type JobRun

type JobRun struct {

	// private_id is used to access the job run but not intended to be available via the API
	// @inject_tag: `gorm:"primary_key;default:null"`
	PrivateId string `protobuf:"bytes,1,opt,name=private_id,json=privateId,proto3" json:"private_id,omitempty" gorm:"primary_key;default:null"`
	// The job_plugin_id is the id of the plugin that owns the job.
	// @inject_tag: `gorm:"not_null"`
	JobPluginId string `protobuf:"bytes,2,opt,name=job_plugin_id,json=jobPluginId,proto3" json:"job_plugin_id,omitempty" gorm:"not_null"`
	// The job_name is the name of the job and must be set.
	// @inject_tag: `gorm:"not_null"`
	JobName string `protobuf:"bytes,3,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty" gorm:"not_null"`
	// The server_id of the server running the job and must be set.
	// @inject_tag: `gorm:"not_null"`
	ServerId string `protobuf:"bytes,4,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty" gorm:"not_null"`
	// The create_time is set by the database.
	// @inject_tag: `gorm:"default:current_timestamp"`
	CreateTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty" gorm:"default:current_timestamp"`
	// The update_time is set by the database.
	// @inject_tag: `gorm:"default:current_timestamp"`
	UpdateTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty" gorm:"default:current_timestamp"`
	// The end_time is set when the job run completes.
	// @inject_tag: `gorm:"default:null"`
	EndTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty" gorm:"default:null"`
	// completed_count is set during an update to indicate the current progress.
	// @inject_tag: `gorm:"default:0"`
	CompletedCount uint32 `protobuf:"varint,8,opt,name=completed_count,json=completedCount,proto3" json:"completed_count,omitempty" gorm:"default:0"`
	// total_count is set during an update to indicate the progress goal.
	// @inject_tag: `gorm:"default:0"`
	TotalCount uint32 `protobuf:"varint,9,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty" gorm:"default:0"`
	// status of the job run (running, completed, failed or interrupted).
	// @inject_tag: `gorm:"not_null"`
	Status string `protobuf:"bytes,10,opt,name=status,proto3" json:"status,omitempty" gorm:"not_null"`
	// contains filtered or unexported fields
}

func (*JobRun) Descriptor

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

Deprecated: Use JobRun.ProtoReflect.Descriptor instead.

func (*JobRun) GetCompletedCount

func (x *JobRun) GetCompletedCount() uint32

func (*JobRun) GetCreateTime

func (x *JobRun) GetCreateTime() *timestamp.Timestamp

func (*JobRun) GetEndTime

func (x *JobRun) GetEndTime() *timestamp.Timestamp

func (*JobRun) GetJobName

func (x *JobRun) GetJobName() string

func (*JobRun) GetJobPluginId

func (x *JobRun) GetJobPluginId() string

func (*JobRun) GetPrivateId

func (x *JobRun) GetPrivateId() string

func (*JobRun) GetServerId

func (x *JobRun) GetServerId() string

func (*JobRun) GetStatus

func (x *JobRun) GetStatus() string

func (*JobRun) GetTotalCount

func (x *JobRun) GetTotalCount() uint32

func (*JobRun) GetUpdateTime

func (x *JobRun) GetUpdateTime() *timestamp.Timestamp

func (*JobRun) ProtoMessage

func (*JobRun) ProtoMessage()

func (*JobRun) ProtoReflect

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

func (*JobRun) Reset

func (x *JobRun) Reset()

func (*JobRun) String

func (x *JobRun) String() string