Documentation
¶
Index ¶
- Constants
- Variables
- func AddCheckpoint(root string, jobID string, opts CheckpointOptions) (JobState, Checkpoint, error)
- func EnvironmentFingerprint(override string) string
- func Inspect(root string, jobID string) (JobState, []Event, error)
- type Approval
- type ApprovalOptions
- type Checkpoint
- type CheckpointOptions
- type Event
- type JobState
- func Approve(root string, jobID string, opts ApprovalOptions) (JobState, error)
- func Cancel(root string, jobID string, opts TransitionOptions) (JobState, error)
- func Pause(root string, jobID string, opts TransitionOptions) (JobState, error)
- func Resume(root string, jobID string, opts ResumeOptions) (JobState, error)
- func Status(root string, jobID string) (JobState, error)
- func Submit(root string, opts SubmitOptions) (JobState, error)
- type ResumeOptions
- type SubmitOptions
- type TransitionOptions
Constants ¶
View Source
const ( StatusRunning = "running" StatusPaused = "paused" StatusDecisionNeeded = "decision_needed" StatusBlocked = "blocked" StatusCompleted = "completed" StatusCancelled = "cancelled" )
View Source
const ( StopReasonNone = "none" StopReasonPausedByUser = "paused_by_user" StopReasonDecisionNeeded = "decision_needed" StopReasonBlocked = "blocked" StopReasonCompleted = "completed" StopReasonCancelledByUser = "cancelled_by_user" StopReasonEnvFingerprintMismatch = "env_fingerprint_mismatch" )
View Source
const ( CheckpointTypePlan = "plan" CheckpointTypeProgress = "progress" CheckpointTypeDecisionNeeded = "decision-needed" CheckpointTypeBlocked = "blocked" CheckpointTypeCompleted = "completed" )
Variables ¶
View Source
var ( ErrJobNotFound = errors.New("job not found") ErrInvalidTransition = errors.New("invalid transition") ErrApprovalRequired = errors.New("approval required") ErrEnvironmentMismatch = errors.New("environment fingerprint mismatch") ErrInvalidCheckpoint = errors.New("invalid checkpoint") ErrStateContention = errors.New("state contention") ErrPolicyEvaluationRequired = errors.New("policy evaluation required") ErrIdentityValidationMissing = errors.New("identity validation required") ErrIdentityRevoked = errors.New("identity revoked") ErrIdentityBindingMismatch = errors.New("identity binding mismatch") )
Functions ¶
func AddCheckpoint ¶
func AddCheckpoint(root string, jobID string, opts CheckpointOptions) (JobState, Checkpoint, error)
func EnvironmentFingerprint ¶
Types ¶
type Checkpoint ¶
type Checkpoint struct {
CheckpointID string `json:"checkpoint_id"`
CreatedAt time.Time `json:"created_at"`
Type string `json:"type"`
Summary string `json:"summary"`
RequiredAction string `json:"required_action,omitempty"`
ReasonCode string `json:"reason_code"`
Actor string `json:"actor,omitempty"`
}
func GetCheckpoint ¶
func GetCheckpoint(root string, jobID string, checkpointID string) (Checkpoint, error)
func ListCheckpoints ¶
func ListCheckpoints(root string, jobID string) ([]Checkpoint, error)
type CheckpointOptions ¶
type Event ¶
type Event struct {
SchemaID string `json:"schema_id"`
SchemaVersion string `json:"schema_version"`
CreatedAt time.Time `json:"created_at"`
JobID string `json:"job_id"`
Revision int64 `json:"revision"`
Type string `json:"type"`
Actor string `json:"actor,omitempty"`
ReasonCode string `json:"reason_code,omitempty"`
Payload map[string]any `json:"payload,omitempty"`
}
type JobState ¶
type JobState struct {
SchemaID string `json:"schema_id"`
SchemaVersion string `json:"schema_version"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
ProducerVersion string `json:"producer_version"`
JobID string `json:"job_id"`
Status string `json:"status"`
StopReason string `json:"stop_reason"`
StatusReasonCode string `json:"status_reason_code"`
EnvironmentFingerprint string `json:"environment_fingerprint"`
PolicyDigest string `json:"policy_digest,omitempty"`
PolicyRef string `json:"policy_ref,omitempty"`
Identity string `json:"identity,omitempty"`
Revision int64 `json:"revision"`
Checkpoints []Checkpoint `json:"checkpoints"`
Approvals []Approval `json:"approvals,omitempty"`
}
type ResumeOptions ¶
type ResumeOptions struct {
CurrentEnvironmentFingerprint string
AllowEnvironmentMismatch bool
PolicyDigest string
PolicyRef string
RequirePolicyEvaluation bool
Identity string
RequireIdentityValidation bool
IdentityValidationSource string
IdentityRevoked bool
Reason string
Actor string
Now time.Time
}
type SubmitOptions ¶
type TransitionOptions ¶
Click to show internal directories.
Click to hide internal directories.