2023-11-08 15:36:20 +00:00
|
|
|
# API Reference for ArangoMLBatchJob V1Alpha1
|
|
|
|
|
|
|
|
## Spec
|
|
|
|
|
2023-12-11 19:53:25 +00:00
|
|
|
### .spec
|
|
|
|
|
|
|
|
Type: `batch.Job` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/batchjob_spec.go#L33)</sup>
|
|
|
|
|
|
|
|
Links:
|
|
|
|
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobSpec)
|
|
|
|
|
2023-11-08 15:36:20 +00:00
|
|
|
## Status
|
|
|
|
|
2023-12-11 19:53:25 +00:00
|
|
|
### .status
|
|
|
|
|
|
|
|
Type: `batch.JobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/batchjob_status.go#L37)</sup>
|
|
|
|
|
|
|
|
Links:
|
|
|
|
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobStatus)
|
|
|
|
|
|
|
|
***
|
|
|
|
|
2023-11-24 08:18:21 +00:00
|
|
|
### .status.conditions
|
|
|
|
|
2023-12-11 19:53:25 +00:00
|
|
|
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/batchjob_status.go#L33)</sup>
|
2023-11-24 08:18:21 +00:00
|
|
|
|
|
|
|
Conditions specific to the entire batch job
|
|
|
|
|
2023-12-11 19:53:25 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
### .status.ref.name
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/object.go#L46)</sup>
|
|
|
|
|
|
|
|
Name of the object
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .status.ref.namespace
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/object.go#L49)</sup>
|
|
|
|
|
|
|
|
Namespace of the object. Should default to the namespace of the parent object
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
### .status.ref.uid
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/shared/v1/object.go#L52)</sup>
|
|
|
|
|
|
|
|
UID keeps the information about object UID
|
|
|
|
|