common

Documentation

Index

• type BatchScheduleDescription
• type JobScheduleDescription
• type ProgressStatus
  • func (p ProgressStatus) String() string
• type RadixJobComponentConfig
• type Status
• type StatusReason

Types

type BatchScheduleDescription

type BatchScheduleDescription struct {
	// JobScheduleDescriptions descriptions of jobs to schedule within the batch
	//
	// required: true
	JobScheduleDescriptions []JobScheduleDescription `json:"jobScheduleDescriptions" yaml:"jobScheduleDescriptions"`

	// DefaultRadixJobComponentConfig default resources configuration
	//
	// required: false
	DefaultRadixJobComponentConfig *RadixJobComponentConfig `json:"defaultRadixJobComponentConfig,omitempty" yaml:"defaultRadixJobComponentConfig,omitempty"`
}

BatchScheduleDescription holds description about batch scheduling job swagger:model BatchScheduleDescription

type JobScheduleDescription

type JobScheduleDescription struct {
	// JobId Optional ID of a job
	//
	// required: false
	// example: 'job1'
	JobId string `json:"jobId,omitempty"`

	// Payload holding json data to be mapped to component
	//
	// required: false
	// example: {'data':'value'}
	Payload string `json:"payload"`

	// RadixJobComponentConfig holding data relating to resource configuration
	//
	// required: false
	RadixJobComponentConfig `json:",inline"`
}

JobScheduleDescription holds description about scheduling job swagger:model JobScheduleDescription

type ProgressStatus

type ProgressStatus int

ProgressStatus Enumeration of the statuses of a job or step

const (
	// Running Active
	Running ProgressStatus = iota

	// Succeeded JobStatus/step succeeded
	Succeeded

	// Failed JobStatus/step failed
	Failed

	// Waiting JobStatus/step pending
	Waiting

	// Stopping job
	Stopping

	// Stopped job
	Stopped

	// DeadlineExceeded job
	DeadlineExceeded

	// Active job, one or more pods are not ready
	Active
)

func (ProgressStatus) String

func (p ProgressStatus) String() string

type RadixJobComponentConfig

type RadixJobComponentConfig struct {
	// Resource describes the compute resource requirements.
	//
	// required: false
	Resources *v1.ResourceRequirements `json:"resources,omitempty"`
	// Node defines node attributes, where container should be scheduled
	//
	// required: false
	Node *v1.RadixNode `json:"node,omitempty"`

	// TimeLimitSeconds defines maximum job run time. Corresponds to ActiveDeadlineSeconds in K8s.
	//
	// required: false
	TimeLimitSeconds *int64 `json:"timeLimitSeconds,omitempty"`

	// BackoffLimit defines attempts to restart job if it fails. Corresponds to BackoffLimit in K8s.
	//
	// required: false
	BackoffLimit *int32 `json:"backoffLimit,omitempty"`

	// ImageTagName defines the image tag name to use for the job image
	//
	// required: false
	ImageTagName string `json:"imageTagName,omitempty"`
}

RadixJobComponentConfig holds description of RadixJobComponent

type Status

type Status struct {

	// Status of the operation.
	// One of: "Success" or "Failure".
	// example: Failure
	Status string `json:"status,omitempty"`
	// A human-readable description of the status of this operation.
	// required: false
	// example: job job123 is not found
	Message string `json:"message,omitempty"`
	// A machine-readable description of why this operation is in the
	// "Failure" status. If this value is empty there
	// is no information available. A Reason clarifies an HTTP status
	// code but does not override it.
	// required: false
	// example: NotFound
	Reason StatusReason `json:"reason,omitempty"`

	// Suggested HTTP return code for this status, 0 if not set.
	// required: false
	// example: 404
	Code int `json:"code,omitempty"`
}

Status is a return value for calls that don't return other objects or when a request returns an error swagger:model Status

type StatusReason

type StatusReason string

const (
	StatusSuccess = "Success"
	StatusFailure = "Failure"
	// StatusReasonUnknown means the server has declined to indicate a specific reason.
	// Status code 500.
	StatusReasonUnknown StatusReason = "InternalError"
	// StatusReasonNotFound means one or more resources required for this operation
	// could not be found.
	// Status code 404
	StatusReasonNotFound StatusReason = "NotFound"
	// StatusReasonInvalid means the requested create or update operation cannot be
	// completed due to invalid data provided as part of the request. The client may
	// need to alter the request.
	// Status code 422
	StatusReasonInvalid StatusReason = "Invalid"
)