v1

Documentation

Index

• type BatchStatus
• type JobStatus
• type PodStatus
• type ReplicaStatus

Types

type BatchStatus

type BatchStatus struct {
	//JobStatus Batch job status
	JobStatus
	// JobStatuses of the jobs in the batch
	// required: false
	JobStatuses []JobStatus `json:"jobStatuses,omitempty"`

	// BatchType Single job or multiple jobs batch
	//
	// required: false
	// example: "job"
	BatchType string `json:"batchType,omitempty"`
}

BatchStatus holds general information about batch status swagger:model BatchStatus

type JobStatus

type JobStatus struct {
	// JobId Optional ID of a job
	//
	// required: false
	// example: 'job1'
	JobId string `json:"jobId,omitempty"`
	// BatchName Optional Batch ID of a job
	//
	// required: false
	// example: 'batch1'
	BatchName string `json:"batchName,omitempty"`

	// Name of the job
	// required: true
	// example: calculator
	Name string `json:"name"`

	// Created timestamp
	//
	// required: true
	// example: 2006-01-02T15:04:05Z
	Created string `json:"created"`

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

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

	// Status of the job
	//
	// required: false
	// Enum: Waiting,Running,Succeeded,Stopping,Stopped,Failed,DeadlineExceeded
	// example: Waiting
	Status string `json:"status,omitempty"`

	// Message, if any, of the job
	//
	// required: false
	// example: "Error occurred"
	Message string `json:"message,omitempty"`

	// Updated timestamp when the status was updated
	//
	// required: false
	// example: 2006-01-02T15:04:05Z
	Updated string `json:"updated,omitempty"`

	// PodStatuses for each pod of the job
	// required: false
	PodStatuses []PodStatus `json:"podStatuses,omitempty"`
}

JobStatus holds general information about job status swagger:model JobStatus

type PodStatus

type PodStatus struct {
	// Pod name
	//
	// required: true
	// example: server-78fc8857c4-hm76l
	Name string `json:"name"`

	// Created timestamp
	//
	// required: false
	// example: 2006-01-02T15:04:05Z
	Created string `json:"created,omitempty"`

	// The time at which the batch job's pod startedAt
	//
	// required: false
	// example: 2006-01-02T15:04:05Z
	StartTime string `json:"startTime,omitempty"`

	// The time at which the batch job's pod finishedAt.
	//
	// required: false
	// example: 2006-01-02T15:04:05Z
	EndTime string `json:"endTime,omitempty"`

	// Container started timestamp
	//
	// required: false
	// example: 2006-01-02T15:04:05Z
	ContainerStarted string `json:"containerStarted,omitempty"`

	// Status describes the component container status
	//
	// required: false
	Status ReplicaStatus `json:"replicaStatus,omitempty"`

	// StatusMessage provides message describing the status of a component container inside a pod
	//
	// required: false
	StatusMessage string `json:"statusMessage,omitempty"`

	// RestartCount count of restarts of a component container inside a pod
	//
	// required: false
	RestartCount int32 `json:"restartCount,omitempty"`

	// The image the container is running.
	//
	// required: false
	// example: radixdev.azurecr.io/app-server:cdgkg
	Image string `json:"image,omitempty"`

	// ImageID of the container's image.
	//
	// required: false
	// example: radixdev.azurecr.io/app-server@sha256:d40cda01916ef63da3607c03785efabc56eb2fc2e0dab0726b1a843e9ded093f
	ImageId string `json:"imageId,omitempty"`

	// The index of the pod in the re-starts
	PodIndex int `json:"podIndex,omitempty"`

	// Exit status from the last termination of the container
	ExitCode int32 `json:"exitCode"`

	// A brief CamelCase message indicating details about why the job is in this phase
	Reason string `json:"reason,omitempty"`
}

PodStatus contains details for the current status of the job's pods. swagger:model PodStatus

type ReplicaStatus

type ReplicaStatus struct {
	// Status of the container
	// - Pending = Container in Waiting state and the reason is ContainerCreating
	// - Failed = Container is failed
	// - Failing = Container is failed
	// - Running = Container in Running state
	// - Succeeded = Container in Succeeded state
	// - Terminated = Container in Terminated state
	//
	// required: true
	// enum: Pending,Succeeded,Failing,Failed,Running,Terminated,Starting
	// example: Running
	Status string `json:"status"`
}

ReplicaStatus describes the status of a component container inside a pod swagger:model ReplicaStatus