Documentation
¶
Overview ¶
Package v1 is the v1 version of the API.
Index ¶
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type BackfillRequest
- type BackfillRequestList
- type BackfillRequestSpec
- type BackfillRequestStatus
- type Phase
- type StreamClass
- func (in *StreamClass) DeepCopy() *StreamClass
- func (in *StreamClass) DeepCopyInto(out *StreamClass)
- func (in *StreamClass) DeepCopyObject() runtime.Object
- func (in *StreamClass) MetricsTags() map[string]string
- func (in *StreamClass) StateString() string
- func (in *StreamClass) TargetResourceGvk() schema.GroupVersionKind
- type StreamClassList
- type StreamClassSpec
- type StreamClassStatus
- type StreamingJobTemplate
- type StreamingJobTemplateList
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeBuilder initializes a scheme builder SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: nexusapi.GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type BackfillRequest ¶
type BackfillRequest struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec BackfillRequestSpec `json:"spec,omitempty"`
Status BackfillRequestStatus `json:"status,omitempty"`
}
BackfillRequest is the Schema for the backfill request API +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:subresource:status +kubebuilder:resource:scope=Namespaced,shortName=bfr +kubebuilder:object:root=true +kubebuilder:printcolumn:name="StreamClass",type=string,JSONPath=`.spec.streamClass` +kubebuilder:printcolumn:name="StreamId",type=string,JSONPath=`.spec.streamId` +kubebuilder:printcolumn:name="Completed",type=string,JSONPath=`.spec.completed` +kubebuilder:selectablefield:JSONPath=.spec.completed
func (*BackfillRequest) DeepCopy ¶
func (in *BackfillRequest) DeepCopy() *BackfillRequest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackfillRequest.
func (*BackfillRequest) DeepCopyInto ¶
func (in *BackfillRequest) DeepCopyInto(out *BackfillRequest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackfillRequest) DeepCopyObject ¶
func (in *BackfillRequest) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BackfillRequest) JobConfigurator ¶
func (in *BackfillRequest) JobConfigurator() (job.Configurator, error)
JobConfigurator returns a JobConfigurator for the BackfillRequest
type BackfillRequestList ¶
type BackfillRequestList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []BackfillRequest `json:"items"`
}
BackfillRequestList contains a list of BackfillRequest resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*BackfillRequestList) DeepCopy ¶
func (in *BackfillRequestList) DeepCopy() *BackfillRequestList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackfillRequestList.
func (*BackfillRequestList) DeepCopyInto ¶
func (in *BackfillRequestList) DeepCopyInto(out *BackfillRequestList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackfillRequestList) DeepCopyObject ¶
func (in *BackfillRequestList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackfillRequestSpec ¶
type BackfillRequestSpec struct {
// StreamClass is the name of the stream class to backfill
StreamClass string `json:"streamClass"`
// StreamId is the ID of the stream to backfill
StreamId string `json:"streamId"`
// Completed indicates whether the backfill request has been completed
// +kubebuilder:default=false
Completed bool `json:"completed,omitempty"`
}
BackfillRequestSpec defines the desired state of a backfill request
func (*BackfillRequestSpec) DeepCopy ¶
func (in *BackfillRequestSpec) DeepCopy() *BackfillRequestSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackfillRequestSpec.
func (*BackfillRequestSpec) DeepCopyInto ¶
func (in *BackfillRequestSpec) DeepCopyInto(out *BackfillRequestSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackfillRequestStatus ¶
type BackfillRequestStatus struct {
// Phase represents the current phase of the backfill request
Phase Phase `json:"phase,omitempty"`
// Conditions represent the latest available observations
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
BackfillRequestStatus defines the observed state of a backfill request
func (*BackfillRequestStatus) DeepCopy ¶
func (in *BackfillRequestStatus) DeepCopy() *BackfillRequestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackfillRequestStatus.
func (*BackfillRequestStatus) DeepCopyInto ¶
func (in *BackfillRequestStatus) DeepCopyInto(out *BackfillRequestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Phase ¶
type Phase string
Phase represents the current phase of the stream class +kubebuilder:validation:Enum=Pending;Ready;Failed;Stopped
type StreamClass ¶
type StreamClass struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec StreamClassSpec `json:"spec,omitempty"`
Status StreamClassStatus `json:"status,omitempty"`
}
StreamClass is the Schema for the stream class API +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,shortName=sc +kubebuilder:object:root=true +kubebuilder:printcolumn:name="ApiGroupRef",type=string,JSONPath=`.spec.apiGroupRef` +kubebuilder:printcolumn:name="ApiVersion",type=string,JSONPath=`.spec.apiVersion` +kubebuilder:printcolumn:name="KindRef",type=string,JSONPath=`.spec.kindRef` +kubebuilder:printcolumn:name="PluralName",type=string,JSONPath=`.spec.pluralName` +kubebuilder:printcolumn:name="Phase",type=string,JSONPath=`.status.phase`
func (*StreamClass) DeepCopy ¶
func (in *StreamClass) DeepCopy() *StreamClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamClass.
func (*StreamClass) DeepCopyInto ¶
func (in *StreamClass) DeepCopyInto(out *StreamClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StreamClass) DeepCopyObject ¶
func (in *StreamClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*StreamClass) MetricsTags ¶
func (in *StreamClass) MetricsTags() map[string]string
MetricsTags returns the metrics tags for the StreamClass
func (*StreamClass) StateString ¶
func (in *StreamClass) StateString() string
StateString returns a string representation of the current state
func (*StreamClass) TargetResourceGvk ¶
func (in *StreamClass) TargetResourceGvk() schema.GroupVersionKind
TargetResourceGvk returns the GroupVersionKind of the target resource
type StreamClassList ¶
type StreamClassList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []StreamClass `json:"items"`
}
StreamClassList contains a list of StreamClass resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*StreamClassList) DeepCopy ¶
func (in *StreamClassList) DeepCopy() *StreamClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamClassList.
func (*StreamClassList) DeepCopyInto ¶
func (in *StreamClassList) DeepCopyInto(out *StreamClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StreamClassList) DeepCopyObject ¶
func (in *StreamClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StreamClassSpec ¶
type StreamClassSpec struct {
// APIGroupRef is the api group of the stream class to watch for
APIGroupRef string `json:"apiGroupRef,omitempty"`
// APIVersion is the API version of the stream class to watch for
APIVersion string `json:"apiVersion"`
// KindRef is the kind of the stream class to watch for
KindRef string `json:"kindRef"`
// PluralName is the plural name of the stream class to watch for
PluralName string `json:"pluralName"`
// SecretRefs is a list of fields to be extracted from the secret
SecretRefs []string `json:"secretRefs,omitempty"`
}
StreamClassSpec defines the desired state of a stream class to watch
func (*StreamClassSpec) DeepCopy ¶
func (in *StreamClassSpec) DeepCopy() *StreamClassSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamClassSpec.
func (*StreamClassSpec) DeepCopyInto ¶
func (in *StreamClassSpec) DeepCopyInto(out *StreamClassSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StreamClassStatus ¶
type StreamClassStatus struct {
// Phase represents the current phase of the stream class
Phase Phase `json:"phase,omitempty"`
// Conditions represent the latest available observations
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
StreamClassStatus defines the observed state of a stream class
func (*StreamClassStatus) DeepCopy ¶
func (in *StreamClassStatus) DeepCopy() *StreamClassStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamClassStatus.
func (*StreamClassStatus) DeepCopyInto ¶
func (in *StreamClassStatus) DeepCopyInto(out *StreamClassStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StreamingJobTemplate ¶
type StreamingJobTemplate struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec batchv1.Job `json:"spec,omitempty"`
}
StreamingJobTemplate is a schema for streaming job templates +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:scope=Namespaced,shortName=sjt +kubebuilder:subresource:status +kubebuilder:object:root=true +kubebuilder:printcolumn:name="MemoryLimit",type=string,JSONPath=`.spec.spec.template.spec.containers[0].resources.limits.memory` +kubebuilder:printcolumn:name="CpuLimit",type=string,JSONPath=`.spec.spec.template.spec.containers[0].resources.limits.cpu` +kubebuilder:printcolumn:name="Image",type=string,JSONPath=`.spec.spec.template.spec.containers[0].image`
func (*StreamingJobTemplate) DeepCopy ¶
func (in *StreamingJobTemplate) DeepCopy() *StreamingJobTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamingJobTemplate.
func (*StreamingJobTemplate) DeepCopyInto ¶
func (in *StreamingJobTemplate) DeepCopyInto(out *StreamingJobTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StreamingJobTemplate) DeepCopyObject ¶
func (in *StreamingJobTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StreamingJobTemplateList ¶
type StreamingJobTemplateList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []StreamingJobTemplate `json:"items"`
}
StreamingJobTemplateList contains a list of Job resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*StreamingJobTemplateList) DeepCopy ¶
func (in *StreamingJobTemplateList) DeepCopy() *StreamingJobTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StreamingJobTemplateList.
func (*StreamingJobTemplateList) DeepCopyInto ¶
func (in *StreamingJobTemplateList) DeepCopyInto(out *StreamingJobTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StreamingJobTemplateList) DeepCopyObject ¶
func (in *StreamingJobTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.