Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the xgboostjob v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/xgboost-operator/pkg/apis/xgboostjob +k8s:defaulter-gen=TypeMeta +groupName=xgboostjob.kubeflow.org
Package v1 contains API Schema definitions for the xgboostjob v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/xgboost-operator/pkg/apis/xgboostjob +k8s:defaulter-gen=TypeMeta +groupName=xgboostjob.kubeflow.org
Index ¶
Constants ¶
const ( // GroupName is the group name use in this package. GroupName = "kubeflow.org" // Kind is the kind name. Kind = "XGBoostJob" // GroupVersion is the version. GroupVersion = "v1" // Plural is the Plural for XGBoostJob. Plural = "xgboostjobs" // Singular is the singular for XGBoostJob. Singular = "xgboostjob" // XGBOOSTCRD is the CRD name for XGBoostJob. XGBoostCRD = "xgboostjobs.kubeflow.org" DefaultContainerName = "xgboostjob" DefaultContainerPortName = "xgboostjob-port" DefaultPort = 9999 )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "xgboostjob.kubeflow.org", Version: "v1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // SchemeGroupVersionKind is the GroupVersionKind of the resource. SchemeGroupVersionKind = SchemeGroupVersion.WithKind(Kind) // AddToScheme is required by pkg/client/... AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource is required by pkg/client/listers/...
Types ¶
type XGBoostJob ¶
type XGBoostJob struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec XGBoostJobSpec `json:"spec,omitempty"`
Status XGBoostJobStatus `json:"status,omitempty"`
}
XGBoostJob is the Schema for the xgboostjobs API +k8s:openapi-gen=true
func (*XGBoostJob) DeepCopy ¶
func (in *XGBoostJob) DeepCopy() *XGBoostJob
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new XGBoostJob.
func (*XGBoostJob) DeepCopyInto ¶
func (in *XGBoostJob) DeepCopyInto(out *XGBoostJob)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*XGBoostJob) DeepCopyObject ¶
func (in *XGBoostJob) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type XGBoostJobList ¶
type XGBoostJobList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []XGBoostJob `json:"items"`
}
XGBoostJobList contains a list of XGBoostJob
func (*XGBoostJobList) DeepCopy ¶
func (in *XGBoostJobList) DeepCopy() *XGBoostJobList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new XGBoostJobList.
func (*XGBoostJobList) DeepCopyInto ¶
func (in *XGBoostJobList) DeepCopyInto(out *XGBoostJobList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*XGBoostJobList) DeepCopyObject ¶
func (in *XGBoostJobList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type XGBoostJobReplicaType ¶
type XGBoostJobReplicaType commonv1.ReplicaType
XGBoostJobReplicaType is the type for XGBoostJobReplica.
const ( // XGBoostReplicaTypeMaster is the type for master replica. XGBoostReplicaTypeMaster XGBoostJobReplicaType = "Master" // XGBoostReplicaTypeWorker is the type for worker replicas. XGBoostReplicaTypeWorker XGBoostJobReplicaType = "Worker" )
type XGBoostJobSpec ¶
type XGBoostJobSpec struct {
// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
// Important: Run "make" to regenerate code after modifying this file
RunPolicy commonv1.RunPolicy `json:",inline"`
XGBReplicaSpecs map[commonv1.ReplicaType]*commonv1.ReplicaSpec `json:"xgbReplicaSpecs"`
}
XGBoostJobSpec defines the desired state of XGBoostJob
func (*XGBoostJobSpec) DeepCopy ¶
func (in *XGBoostJobSpec) DeepCopy() *XGBoostJobSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new XGBoostJobSpec.
func (*XGBoostJobSpec) DeepCopyInto ¶
func (in *XGBoostJobSpec) DeepCopyInto(out *XGBoostJobSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type XGBoostJobStatus ¶
type XGBoostJobStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
commonv1.JobStatus `json:",inline"`
}
XGBoostJobStatus defines the observed state of XGBoostJob
func (*XGBoostJobStatus) DeepCopy ¶
func (in *XGBoostJobStatus) DeepCopy() *XGBoostJobStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new XGBoostJobStatus.
func (*XGBoostJobStatus) DeepCopyInto ¶
func (in *XGBoostJobStatus) DeepCopyInto(out *XGBoostJobStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files