models

package
v0.0.0-...-3852cca Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// BatchEventStatusWaiting captures enum value "Waiting"
	BatchEventStatusWaiting string = "Waiting"

	// BatchEventStatusRunning captures enum value "Running"
	BatchEventStatusRunning string = "Running"

	// BatchEventStatusSucceeded captures enum value "Succeeded"
	BatchEventStatusSucceeded string = "Succeeded"

	// BatchEventStatusStopping captures enum value "Stopping"
	BatchEventStatusStopping string = "Stopping"

	// BatchEventStatusStopped captures enum value "Stopped"
	BatchEventStatusStopped string = "Stopped"

	// BatchEventStatusFailed captures enum value "Failed"
	BatchEventStatusFailed string = "Failed"

	// BatchEventStatusDeadlineExceeded captures enum value "DeadlineExceeded"
	BatchEventStatusDeadlineExceeded string = "DeadlineExceeded"
)
View Source 
const (

	// BatchStatusStatusWaiting captures enum value "Waiting"
	BatchStatusStatusWaiting string = "Waiting"

	// BatchStatusStatusRunning captures enum value "Running"
	BatchStatusStatusRunning string = "Running"

	// BatchStatusStatusSucceeded captures enum value "Succeeded"
	BatchStatusStatusSucceeded string = "Succeeded"

	// BatchStatusStatusStopping captures enum value "Stopping"
	BatchStatusStatusStopping string = "Stopping"

	// BatchStatusStatusStopped captures enum value "Stopped"
	BatchStatusStatusStopped string = "Stopped"

	// BatchStatusStatusFailed captures enum value "Failed"
	BatchStatusStatusFailed string = "Failed"

	// BatchStatusStatusDeadlineExceeded captures enum value "DeadlineExceeded"
	BatchStatusStatusDeadlineExceeded string = "DeadlineExceeded"
)
View Source 
const (

	// JobStatusStatusWaiting captures enum value "Waiting"
	JobStatusStatusWaiting string = "Waiting"

	// JobStatusStatusRunning captures enum value "Running"
	JobStatusStatusRunning string = "Running"

	// JobStatusStatusSucceeded captures enum value "Succeeded"
	JobStatusStatusSucceeded string = "Succeeded"

	// JobStatusStatusStopping captures enum value "Stopping"
	JobStatusStatusStopping string = "Stopping"

	// JobStatusStatusStopped captures enum value "Stopped"
	JobStatusStatusStopped string = "Stopped"

	// JobStatusStatusFailed captures enum value "Failed"
	JobStatusStatusFailed string = "Failed"

	// JobStatusStatusDeadlineExceeded captures enum value "DeadlineExceeded"
	JobStatusStatusDeadlineExceeded string = "DeadlineExceeded"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchEvent 

type BatchEvent struct {

	// BatchName Optional Batch ID of a job
	// Example: 'batch1'
	BatchName string `json:"batchName,omitempty"`

	// BatchType Single job or multiple jobs batch
	// Example: \"job\
	BatchType string `json:"batchType,omitempty"`

	// Created timestamp
	// Example: 2006-01-02T15:04:05Z
	// Required: true
	Created *string `json:"created"`

	// Ended timestamp
	// Example: 2006-01-02T15:04:05Z
	Ended string `json:"ended,omitempty"`

	// JobId Optional ID of a job
	// Example: 'job1'
	JobID string `json:"jobId,omitempty"`

	// JobStatuses of the jobs in the batch
	JobStatuses []*JobStatus `json:"jobStatuses"`

	// Message, if any, of the job
	// Example: \"Error occurred\
	Message string `json:"message,omitempty"`

	// Name of the job
	// Example: calculator
	// Required: true
	Name *string `json:"name"`

	// Started timestamp
	// Example: 2006-01-02T15:04:05Z
	Started string `json:"started,omitempty"`

	// Status of the job
	// Example: Waiting
	// Enum: [Waiting Running Succeeded Stopping Stopped Failed DeadlineExceeded]
	Status string `json:"status,omitempty"`

	// event
	// Required: true
	Event *Event `json:"event"`
}

BatchEvent BatchEvent holds general information about batch event on change of status

swagger:model BatchEvent

func (*BatchEvent) ContextValidate 

func (m *BatchEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch event based on the context it is used

func (*BatchEvent) MarshalBinary 

func (m *BatchEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchEvent) UnmarshalBinary 

func (m *BatchEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchEvent) Validate 

func (m *BatchEvent) Validate(formats strfmt.Registry) error

Validate validates this batch event

type BatchScheduleDescription 

type BatchScheduleDescription struct {

	// JobScheduleDescriptions descriptions of jobs to schedule within the batch
	// Required: true
	JobScheduleDescriptions []*JobScheduleDescription `json:"jobScheduleDescriptions"`

	// default radix job component config
	DefaultRadixJobComponentConfig *RadixJobComponentConfig `json:"defaultRadixJobComponentConfig,omitempty"`
}

BatchScheduleDescription BatchScheduleDescription holds description about batch scheduling job

swagger:model BatchScheduleDescription

func (*BatchScheduleDescription) ContextValidate 

func (m *BatchScheduleDescription) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch schedule description based on the context it is used

func (*BatchScheduleDescription) MarshalBinary 

func (m *BatchScheduleDescription) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchScheduleDescription) UnmarshalBinary 

func (m *BatchScheduleDescription) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchScheduleDescription) Validate 

func (m *BatchScheduleDescription) Validate(formats strfmt.Registry) error

Validate validates this batch schedule description

type BatchStatus 

type BatchStatus struct {

	// BatchName Optional Batch ID of a job
	// Example: 'batch1'
	BatchName string `json:"batchName,omitempty"`

	// BatchType Single job or multiple jobs batch
	// Example: \"job\
	BatchType string `json:"batchType,omitempty"`

	// Created timestamp
	// Example: 2006-01-02T15:04:05Z
	// Required: true
	Created *string `json:"created"`

	// Ended timestamp
	// Example: 2006-01-02T15:04:05Z
	Ended string `json:"ended,omitempty"`

	// JobId Optional ID of a job
	// Example: 'job1'
	JobID string `json:"jobId,omitempty"`

	// JobStatuses of the jobs in the batch
	JobStatuses []*JobStatus `json:"jobStatuses"`

	// Message, if any, of the job
	// Example: \"Error occurred\
	Message string `json:"message,omitempty"`

	// Name of the job
	// Example: calculator
	// Required: true
	Name *string `json:"name"`

	// Started timestamp
	// Example: 2006-01-02T15:04:05Z
	Started string `json:"started,omitempty"`

	// Status of the job
	// Example: Waiting
	// Enum: [Waiting Running Succeeded Stopping Stopped Failed DeadlineExceeded]
	Status string `json:"status,omitempty"`
}

BatchStatus BatchStatus holds general information about batch status

swagger:model BatchStatus

func (*BatchStatus) ContextValidate 

func (m *BatchStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this batch status based on the context it is used

func (*BatchStatus) MarshalBinary 

func (m *BatchStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchStatus) UnmarshalBinary 

func (m *BatchStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchStatus) Validate 

func (m *BatchStatus) Validate(formats strfmt.Registry) error

Validate validates this batch status

type Event 

type Event string

Event event

swagger:model Event

func (Event) ContextValidate 

func (m Event) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this event based on context it is used

func (Event) Validate 

func (m Event) Validate(formats strfmt.Registry) error

Validate validates this event

type JobScheduleDescription 

type JobScheduleDescription struct {

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

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

	// JobId Optional ID of a job
	// Example: 'job1'
	JobID string `json:"jobId,omitempty"`

	// Payload holding json data to be mapped to component
	// Example: {'data':'value'}
	Payload string `json:"payload,omitempty"`

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

	// node
	Node *RadixNode `json:"node,omitempty"`

	// resources
	Resources *ResourceRequirements `json:"resources,omitempty"`
}

JobScheduleDescription JobScheduleDescription holds description about scheduling job

swagger:model JobScheduleDescription

func (*JobScheduleDescription) ContextValidate 

func (m *JobScheduleDescription) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this job schedule description based on the context it is used

func (*JobScheduleDescription) MarshalBinary 

func (m *JobScheduleDescription) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JobScheduleDescription) UnmarshalBinary 

func (m *JobScheduleDescription) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JobScheduleDescription) Validate 

func (m *JobScheduleDescription) Validate(formats strfmt.Registry) error

Validate validates this job schedule description

type JobStatus 

type JobStatus struct {

	// BatchName Optional Batch ID of a job
	// Example: 'batch1'
	BatchName string `json:"batchName,omitempty"`

	// Created timestamp
	// Example: 2006-01-02T15:04:05Z
	// Required: true
	Created *string `json:"created"`

	// Ended timestamp
	// Example: 2006-01-02T15:04:05Z
	Ended string `json:"ended,omitempty"`

	// JobId Optional ID of a job
	// Example: 'job1'
	JobID string `json:"jobId,omitempty"`

	// Message, if any, of the job
	// Example: \"Error occurred\
	Message string `json:"message,omitempty"`

	// Name of the job
	// Example: calculator
	// Required: true
	Name *string `json:"name"`

	// Started timestamp
	// Example: 2006-01-02T15:04:05Z
	Started string `json:"started,omitempty"`

	// Status of the job
	// Example: Waiting
	// Enum: [Waiting Running Succeeded Stopping Stopped Failed DeadlineExceeded]
	Status string `json:"status,omitempty"`
}

JobStatus JobStatus holds general information about job status

swagger:model JobStatus

func (*JobStatus) ContextValidate 

func (m *JobStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this job status based on context it is used

func (*JobStatus) MarshalBinary 

func (m *JobStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JobStatus) UnmarshalBinary 

func (m *JobStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JobStatus) Validate 

func (m *JobStatus) Validate(formats strfmt.Registry) error

Validate validates this job status

type RadixJobComponentConfig 

type RadixJobComponentConfig struct {

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

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

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

	// node
	Node *RadixNode `json:"node,omitempty"`

	// resources
	Resources *ResourceRequirements `json:"resources,omitempty"`
}

RadixJobComponentConfig RadixJobComponentConfig holds description of RadixJobComponent

swagger:model RadixJobComponentConfig

func (*RadixJobComponentConfig) ContextValidate 

func (m *RadixJobComponentConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this radix job component config based on the context it is used

func (*RadixJobComponentConfig) MarshalBinary 

func (m *RadixJobComponentConfig) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RadixJobComponentConfig) UnmarshalBinary 

func (m *RadixJobComponentConfig) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RadixJobComponentConfig) Validate 

func (m *RadixJobComponentConfig) Validate(formats strfmt.Registry) error

Validate validates this radix job component config

type RadixNode 

type RadixNode struct {

	// Defines rules for allowed GPU types.
	// More info: https://www.radix.equinor.com/references/reference-radix-config/#gpu
	// +optional
	Gpu string `json:"gpu,omitempty"`

	// Defines minimum number of required GPUs.
	// +optional
	GpuCount string `json:"gpuCount,omitempty"`
}

RadixNode RadixNode defines node attributes, where container should be scheduled

swagger:model RadixNode

func (*RadixNode) ContextValidate 

func (m *RadixNode) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this radix node based on context it is used

func (*RadixNode) MarshalBinary 

func (m *RadixNode) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RadixNode) UnmarshalBinary 

func (m *RadixNode) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RadixNode) Validate 

func (m *RadixNode) Validate(formats strfmt.Registry) error

Validate validates this radix node

type ResourceList 

type ResourceList map[string]string

ResourceList ResourceList defines a resource and a value.

swagger:model ResourceList

func (ResourceList) ContextValidate 

func (m ResourceList) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this resource list based on context it is used

func (ResourceList) Validate 

func (m ResourceList) Validate(formats strfmt.Registry) error

Validate validates this resource list

type ResourceRequirements 

type ResourceRequirements struct {

	// limits
	Limits ResourceList `json:"limits,omitempty"`

	// requests
	Requests ResourceList `json:"requests,omitempty"`
}

ResourceRequirements ResourceRequirements describes the compute resource requirements.

More info: https://www.radix.equinor.com/references/reference-radix-config/#resources-common

swagger:model ResourceRequirements

func (*ResourceRequirements) ContextValidate 

func (m *ResourceRequirements) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this resource requirements based on the context it is used

func (*ResourceRequirements) MarshalBinary 

func (m *ResourceRequirements) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceRequirements) UnmarshalBinary 

func (m *ResourceRequirements) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceRequirements) Validate 

func (m *ResourceRequirements) Validate(formats strfmt.Registry) error

Validate validates this resource requirements

type Status 

type Status struct {

	// Suggested HTTP return code for this status, 0 if not set.
	// Example: 404
	Code int64 `json:"code,omitempty"`

	// A human-readable description of the status of this operation.
	// Example: job job123 is not found
	Message string `json:"message,omitempty"`

	// Status of the operation.
	// One of: "Success" or "Failure".
	// Example: Failure
	Status string `json:"status,omitempty"`

	// reason
	Reason StatusReason `json:"reason,omitempty"`
}

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

swagger:model Status

func (*Status) ContextValidate 

func (m *Status) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this status based on the context it is used

func (*Status) MarshalBinary 

func (m *Status) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Status) UnmarshalBinary 

func (m *Status) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Status) Validate 

func (m *Status) Validate(formats strfmt.Registry) error

Validate validates this status

type StatusReason 

type StatusReason string

StatusReason status reason

swagger:model StatusReason

func (StatusReason) ContextValidate 

func (m StatusReason) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this status reason based on context it is used

func (StatusReason) Validate 

func (m StatusReason) Validate(formats strfmt.Registry) error

Validate validates this status reason

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.