jobv1

package
v0.0.0-...-3511abf Latest Latest
Warning

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

Go to latest
Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_EXPERIMENT",
		2: "TYPE_NOTEBOOK",
		3: "TYPE_TENSORBOARD",
		4: "TYPE_SHELL",
		5: "TYPE_COMMAND",
		6: "TYPE_CHECKPOINT_GC",
		7: "TYPE_EXTERNAL",
	}
	Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":   0,
		"TYPE_EXPERIMENT":    1,
		"TYPE_NOTEBOOK":      2,
		"TYPE_TENSORBOARD":   3,
		"TYPE_SHELL":         4,
		"TYPE_COMMAND":       5,
		"TYPE_CHECKPOINT_GC": 6,
		"TYPE_EXTERNAL":      7,
	}
)

Enum value maps for Type.

View Source
var (
	State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STATE_QUEUED",
		2: "STATE_SCHEDULED",
		3: "STATE_SCHEDULED_BACKFILLED",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED":          0,
		"STATE_QUEUED":               1,
		"STATE_SCHEDULED":            2,
		"STATE_SCHEDULED_BACKFILLED": 3,
	}
)

Enum value maps for State.

View Source
var File_determined_job_v1_job_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AggregateQueueStats

type AggregateQueueStats struct {

	// The date of this entry.
	PeriodStart string `protobuf:"bytes,1,opt,name=period_start,json=periodStart,proto3" json:"period_start,omitempty"`
	// The total number of seconds queued.
	Seconds float32 `protobuf:"fixed32,2,opt,name=seconds,proto3" json:"seconds,omitempty"`
	// contains filtered or unexported fields
}

Aggregate statistics for a queue.

func (*AggregateQueueStats) Descriptor deprecated

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

Deprecated: Use AggregateQueueStats.ProtoReflect.Descriptor instead.

func (*AggregateQueueStats) GetPeriodStart

func (x *AggregateQueueStats) GetPeriodStart() string

func (*AggregateQueueStats) GetSeconds

func (x *AggregateQueueStats) GetSeconds() float32

func (*AggregateQueueStats) ProtoMessage

func (*AggregateQueueStats) ProtoMessage()

func (*AggregateQueueStats) ProtoReflect

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

func (*AggregateQueueStats) Reset

func (x *AggregateQueueStats) Reset()

func (*AggregateQueueStats) String

func (x *AggregateQueueStats) String() string

type Job

type Job struct {

	// Job summary.
	Summary *JobSummary `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
	// Job type.
	Type Type `protobuf:"varint,2,opt,name=type,proto3,enum=determined.job.v1.Type" json:"type,omitempty"`
	// The time when the job was submitted by the user.
	SubmissionTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=submission_time,json=submissionTime,proto3" json:"submission_time,omitempty"`
	// The username of the user who submitted the job.
	Username string `protobuf:"bytes,4,opt,name=username,proto3" json:"username,omitempty"`
	// The id of the user who submitted the job.
	UserId int32 `protobuf:"varint,15,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Associated resource pool.
	ResourcePool string `protobuf:"bytes,5,opt,name=resource_pool,json=resourcePool,proto3" json:"resource_pool,omitempty"`
	// Whether the job is preemptible.
	IsPreemptible bool `protobuf:"varint,6,opt,name=is_preemptible,json=isPreemptible,proto3" json:"is_preemptible,omitempty"`
	// The job priority in priority scheduler.
	Priority int32 `protobuf:"varint,7,opt,name=priority,proto3" json:"priority,omitempty"`
	// The job weight in fairshare scheduler.
	Weight float64 `protobuf:"fixed64,8,opt,name=weight,proto3" json:"weight,omitempty"`
	// Entity ID.
	EntityId string `protobuf:"bytes,9,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// Job type.
	JobId string `protobuf:"bytes,10,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Number of requested slots.
	RequestedSlots int32 `protobuf:"varint,11,opt,name=requested_slots,json=requestedSlots,proto3" json:"requested_slots,omitempty"`
	// Number of allocated slots.
	AllocatedSlots int32 `protobuf:"varint,12,opt,name=allocated_slots,json=allocatedSlots,proto3" json:"allocated_slots,omitempty"`
	// Job name.
	Name string `protobuf:"bytes,13,opt,name=name,proto3" json:"name,omitempty"`
	// Job's progress from 0 to 1.
	Progress float32 `protobuf:"fixed32,14,opt,name=progress,proto3" json:"progress,omitempty"`
	// Job's workspace id.
	WorkspaceId int32 `protobuf:"varint,16,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`
	// contains filtered or unexported fields
}

Job represents a user submitted work that is not in a terminal state.

func (*Job) Descriptor deprecated

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetAllocatedSlots

func (x *Job) GetAllocatedSlots() int32

func (*Job) GetEntityId

func (x *Job) GetEntityId() string

func (*Job) GetIsPreemptible

func (x *Job) GetIsPreemptible() bool

func (*Job) GetJobId

func (x *Job) GetJobId() string

func (*Job) GetName

func (x *Job) GetName() string

func (*Job) GetPriority

func (x *Job) GetPriority() int32

func (*Job) GetProgress

func (x *Job) GetProgress() float32

func (*Job) GetRequestedSlots

func (x *Job) GetRequestedSlots() int32

func (*Job) GetResourcePool

func (x *Job) GetResourcePool() string

func (*Job) GetSubmissionTime

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

func (*Job) GetSummary

func (x *Job) GetSummary() *JobSummary

func (*Job) GetType

func (x *Job) GetType() Type

func (*Job) GetUserId

func (x *Job) GetUserId() int32

func (*Job) GetUsername

func (x *Job) GetUsername() string

func (*Job) GetWeight

func (x *Job) GetWeight() float64

func (*Job) GetWorkspaceId

func (x *Job) GetWorkspaceId() int32

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 JobSummary

type JobSummary struct {

	// The scheduling state of the job.
	State State `protobuf:"varint,1,opt,name=state,proto3,enum=determined.job.v1.State" json:"state,omitempty"`
	// The number of jobs ahead of this one in the queue.
	JobsAhead int32 `protobuf:"varint,2,opt,name=jobs_ahead,json=jobsAhead,proto3" json:"jobs_ahead,omitempty"`
	// contains filtered or unexported fields
}

Job summary.

func (*JobSummary) Descriptor deprecated

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

Deprecated: Use JobSummary.ProtoReflect.Descriptor instead.

func (*JobSummary) GetJobsAhead

func (x *JobSummary) GetJobsAhead() int32

func (*JobSummary) GetState

func (x *JobSummary) GetState() State

func (*JobSummary) ProtoMessage

func (*JobSummary) ProtoMessage()

func (*JobSummary) ProtoReflect

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

func (*JobSummary) Reset

func (x *JobSummary) Reset()

func (*JobSummary) String

func (x *JobSummary) String() string

type LimitedJob

type LimitedJob struct {

	// Job summary.
	Summary *JobSummary `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
	// Job type.
	Type Type `protobuf:"varint,2,opt,name=type,proto3,enum=determined.job.v1.Type" json:"type,omitempty"`
	// Associated resource pool.
	ResourcePool string `protobuf:"bytes,5,opt,name=resource_pool,json=resourcePool,proto3" json:"resource_pool,omitempty"`
	// Whether the job is preemptible.
	IsPreemptible bool `protobuf:"varint,6,opt,name=is_preemptible,json=isPreemptible,proto3" json:"is_preemptible,omitempty"`
	// The job priority in priority scheduler.
	Priority int32 `protobuf:"varint,7,opt,name=priority,proto3" json:"priority,omitempty"`
	// The job weight in fairshare scheduler.
	Weight float64 `protobuf:"fixed64,8,opt,name=weight,proto3" json:"weight,omitempty"`
	// Job type.
	JobId string `protobuf:"bytes,10,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Number of requested slots.
	RequestedSlots int32 `protobuf:"varint,11,opt,name=requested_slots,json=requestedSlots,proto3" json:"requested_slots,omitempty"`
	// Number of allocated slots.
	AllocatedSlots int32 `protobuf:"varint,12,opt,name=allocated_slots,json=allocatedSlots,proto3" json:"allocated_slots,omitempty"`
	// Job's progress from 0 to 1.
	Progress float32 `protobuf:"fixed32,14,opt,name=progress,proto3" json:"progress,omitempty"`
	// Job's workspace id.
	WorkspaceId int32 `protobuf:"varint,16,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`
	// contains filtered or unexported fields
}

LimitedJob is a Job with omitted fields.

func (*LimitedJob) Descriptor deprecated

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

Deprecated: Use LimitedJob.ProtoReflect.Descriptor instead.

func (*LimitedJob) GetAllocatedSlots

func (x *LimitedJob) GetAllocatedSlots() int32

func (*LimitedJob) GetIsPreemptible

func (x *LimitedJob) GetIsPreemptible() bool

func (*LimitedJob) GetJobId

func (x *LimitedJob) GetJobId() string

func (*LimitedJob) GetPriority

func (x *LimitedJob) GetPriority() int32

func (*LimitedJob) GetProgress

func (x *LimitedJob) GetProgress() float32

func (*LimitedJob) GetRequestedSlots

func (x *LimitedJob) GetRequestedSlots() int32

func (*LimitedJob) GetResourcePool

func (x *LimitedJob) GetResourcePool() string

func (*LimitedJob) GetSummary

func (x *LimitedJob) GetSummary() *JobSummary

func (*LimitedJob) GetType

func (x *LimitedJob) GetType() Type

func (*LimitedJob) GetWeight

func (x *LimitedJob) GetWeight() float64

func (*LimitedJob) GetWorkspaceId

func (x *LimitedJob) GetWorkspaceId() int32

func (*LimitedJob) ProtoMessage

func (*LimitedJob) ProtoMessage()

func (*LimitedJob) ProtoReflect

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

func (*LimitedJob) Reset

func (x *LimitedJob) Reset()

func (*LimitedJob) String

func (x *LimitedJob) String() string

type QueueControl

type QueueControl struct {

	// Job id.
	JobId string `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// The action to perform.
	//
	// Types that are assignable to Action:
	//
	//	*QueueControl_AheadOf
	//	*QueueControl_BehindOf
	//	*QueueControl_ResourcePool
	//	*QueueControl_Priority
	//	*QueueControl_Weight
	Action isQueueControl_Action `protobuf_oneof:"action"`
	// contains filtered or unexported fields
}

Describes a message to control jobs in a queue.

func (*QueueControl) Descriptor deprecated

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

Deprecated: Use QueueControl.ProtoReflect.Descriptor instead.

func (*QueueControl) GetAction

func (m *QueueControl) GetAction() isQueueControl_Action

func (*QueueControl) GetAheadOf

func (x *QueueControl) GetAheadOf() string

func (*QueueControl) GetBehindOf

func (x *QueueControl) GetBehindOf() string

func (*QueueControl) GetJobId

func (x *QueueControl) GetJobId() string

func (*QueueControl) GetPriority

func (x *QueueControl) GetPriority() int32

func (*QueueControl) GetResourcePool

func (x *QueueControl) GetResourcePool() string

func (*QueueControl) GetWeight

func (x *QueueControl) GetWeight() float32

func (*QueueControl) ProtoMessage

func (*QueueControl) ProtoMessage()

func (*QueueControl) ProtoReflect

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

func (*QueueControl) Reset

func (x *QueueControl) Reset()

func (*QueueControl) String

func (x *QueueControl) String() string

type QueueControl_AheadOf

type QueueControl_AheadOf struct {
	// The desired job position in the queue in terms of another job.
	AheadOf string `protobuf:"bytes,2,opt,name=ahead_of,json=aheadOf,proto3,oneof"`
}

type QueueControl_BehindOf

type QueueControl_BehindOf struct {
	// The desired job position in the queue in terms of another job.
	BehindOf string `protobuf:"bytes,4,opt,name=behind_of,json=behindOf,proto3,oneof"`
}

type QueueControl_Priority

type QueueControl_Priority struct {
	// The desired job priority in priority scheduler.
	Priority int32 `protobuf:"varint,5,opt,name=priority,proto3,oneof"`
}

type QueueControl_ResourcePool

type QueueControl_ResourcePool struct {
	// Name of the target resource_pool to move the job to.
	ResourcePool string `protobuf:"bytes,3,opt,name=resource_pool,json=resourcePool,proto3,oneof"`
}

type QueueControl_Weight

type QueueControl_Weight struct {
	// The desired job weight in fairshare scheduler.
	Weight float32 `protobuf:"fixed32,6,opt,name=weight,proto3,oneof"`
}

type QueueStats

type QueueStats struct {

	// Number of queued jobs in the queue.
	QueuedCount int32 `protobuf:"varint,1,opt,name=queued_count,json=queuedCount,proto3" json:"queued_count,omitempty"`
	// Number of scheduled jobs in the queue.
	ScheduledCount int32 `protobuf:"varint,2,opt,name=scheduled_count,json=scheduledCount,proto3" json:"scheduled_count,omitempty"`
	// contains filtered or unexported fields
}

Statistics for a queue.

func (*QueueStats) Descriptor deprecated

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

Deprecated: Use QueueStats.ProtoReflect.Descriptor instead.

func (*QueueStats) GetQueuedCount

func (x *QueueStats) GetQueuedCount() int32

func (*QueueStats) GetScheduledCount

func (x *QueueStats) GetScheduledCount() int32

func (*QueueStats) ProtoMessage

func (*QueueStats) ProtoMessage()

func (*QueueStats) ProtoReflect

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

func (*QueueStats) Reset

func (x *QueueStats) Reset()

func (*QueueStats) String

func (x *QueueStats) String() string

type RBACJob

type RBACJob struct {

	// job represent one of the possible representations of a job.
	//
	// Types that are assignable to Job:
	//
	//	*RBACJob_Full
	//	*RBACJob_Limited
	Job isRBACJob_Job `protobuf_oneof:"job"`
	// contains filtered or unexported fields
}

RBACJob is a job that can have either a limited or a full representation of a job.

func (*RBACJob) Descriptor deprecated

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

Deprecated: Use RBACJob.ProtoReflect.Descriptor instead.

func (*RBACJob) GetFull

func (x *RBACJob) GetFull() *Job

func (*RBACJob) GetJob

func (m *RBACJob) GetJob() isRBACJob_Job

func (*RBACJob) GetLimited

func (x *RBACJob) GetLimited() *LimitedJob

func (*RBACJob) ProtoMessage

func (*RBACJob) ProtoMessage()

func (*RBACJob) ProtoReflect

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

func (*RBACJob) Reset

func (x *RBACJob) Reset()

func (*RBACJob) String

func (x *RBACJob) String() string

type RBACJob_Full

type RBACJob_Full struct {
	// Full representation.
	Full *Job `protobuf:"bytes,1,opt,name=full,proto3,oneof"`
}

type RBACJob_Limited

type RBACJob_Limited struct {
	// Limited representation for lower access levels.
	Limited *LimitedJob `protobuf:"bytes,2,opt,name=limited,proto3,oneof"`
}

type State

type State int32

Job state.

const (
	// Unspecified state.
	State_STATE_UNSPECIFIED State = 0
	// Job is queued and waiting to be schedlued.
	State_STATE_QUEUED State = 1
	// Job is scheduled.
	State_STATE_SCHEDULED State = 2
	// Job is scheduled as a backfill.
	State_STATE_SCHEDULED_BACKFILLED State = 3
)

func (State) Descriptor

func (State) Descriptor() protoreflect.EnumDescriptor

func (State) Enum

func (x State) Enum() *State

func (State) EnumDescriptor deprecated

func (State) EnumDescriptor() ([]byte, []int)

Deprecated: Use State.Descriptor instead.

func (State) Number

func (x State) Number() protoreflect.EnumNumber

func (State) String

func (x State) String() string

func (State) Type

func (State) Type() protoreflect.EnumType

type Type

type Type int32

Job type.

const (
	// Unspecified state.
	Type_TYPE_UNSPECIFIED Type = 0
	// Experiement Job.
	Type_TYPE_EXPERIMENT Type = 1
	// Jupyter Notebook Job.
	Type_TYPE_NOTEBOOK Type = 2
	// TensorBoard Job.
	Type_TYPE_TENSORBOARD Type = 3
	// Shell Job.
	Type_TYPE_SHELL Type = 4
	// Command Job.
	Type_TYPE_COMMAND Type = 5
	// CheckpointGC Job.
	Type_TYPE_CHECKPOINT_GC Type = 6
	// External Job.
	Type_TYPE_EXTERNAL Type = 7
)

func (Type) Descriptor

func (Type) Descriptor() protoreflect.EnumDescriptor

func (Type) Enum

func (x Type) Enum() *Type

func (Type) EnumDescriptor deprecated

func (Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Type.Descriptor instead.

func (Type) Number

func (x Type) Number() protoreflect.EnumNumber

func (Type) String

func (x Type) String() string

func (Type) Type

func (Type) Type() protoreflect.EnumType

Jump to

Keyboard shortcuts

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