v1alpha1

package
v0.43.2 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group. +k8s:deepcopy-gen=package +groupName=sinks.knative.dev

Index

Constants

View Source 
const (
	// JobSinkConditionReady has status True when the JobSink is ready to send events.
	JobSinkConditionReady = apis.ConditionReady

	JobSinkConditionAddressable apis.ConditionType = "Addressable"

	// JobSinkConditionEventPoliciesReady has status True when all the applying EventPolicies for this
	// JobSink are ready.
	JobSinkConditionEventPoliciesReady apis.ConditionType = "EventPoliciesReady"
)

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var JobSinkCondSet = apis.NewLivingConditionSet(
	JobSinkConditionAddressable,
	JobSinkConditionEventPoliciesReady,
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: sinks.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func RegisterDefaults added in v0.43.0 

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func SetObjectDefaults_JobSink added in v0.43.0 

func SetObjectDefaults_JobSink(in *JobSink)

Types

type JobSink 

type JobSink struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   JobSinkSpec   `json:"spec,omitempty"`
	Status JobSinkStatus `json:"status,omitempty"`
}

JobSink is the Schema for the JobSink API.

func (*JobSink) ConvertFrom 

func (sink *JobSink) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements apis.Convertible Converts source from a higher version into v1beta2.JobSink

func (*JobSink) ConvertTo 

func (sink *JobSink) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements apis.Convertible Converts source from v1alpha1.JobSink into a higher version.

func (*JobSink) DeepCopy 

func (in *JobSink) DeepCopy() *JobSink

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobSink.

func (*JobSink) DeepCopyInto 

func (in *JobSink) DeepCopyInto(out *JobSink)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobSink) DeepCopyObject 

func (in *JobSink) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*JobSink) GetConditionSet 

func (*JobSink) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*JobSink) GetGroupVersionKind 

func (sink *JobSink) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*JobSink) GetStatus 

func (sink *JobSink) GetStatus() *duckv1.Status

GetStatus retrieves the status of the JobSink. Implements the KRShaped interface.

func (*JobSink) GetUntypedSpec 

func (sink *JobSink) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the JobSink.

func (*JobSink) SetDefaults 

func (sink *JobSink) SetDefaults(ctx context.Context)

func (*JobSink) SetJobStatusSelector 

func (e *JobSink) SetJobStatusSelector()

func (*JobSink) Validate 

func (sink *JobSink) Validate(ctx context.Context) *apis.FieldError

type JobSinkList 

type JobSinkList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []JobSink `json:"items"`
}

JobSinkList contains a list of JobSink.

func (*JobSinkList) DeepCopy 

func (in *JobSinkList) DeepCopy() *JobSinkList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobSinkList.

func (*JobSinkList) DeepCopyInto 

func (in *JobSinkList) DeepCopyInto(out *JobSinkList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobSinkList) DeepCopyObject 

func (in *JobSinkList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type JobSinkSpec 

type JobSinkSpec struct {
	// Job to run when an event occur.
	// +optional
	Job *batchv1.Job `json:"job,omitempty"`
}

JobSinkSpec defines the desired state of the JobSink.

func (*JobSinkSpec) DeepCopy 

func (in *JobSinkSpec) DeepCopy() *JobSinkSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobSinkSpec.

func (*JobSinkSpec) DeepCopyInto 

func (in *JobSinkSpec) DeepCopyInto(out *JobSinkSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobSinkSpec) Validate 

func (sink *JobSinkSpec) Validate(ctx context.Context) *apis.FieldError

type JobSinkStatus 

type JobSinkStatus struct {
	duckv1.Status `json:",inline"`

	// AddressStatus is the part where the JobSink fulfills the Addressable contract.
	// It exposes the endpoint as an URI to get events delivered.
	// +optional
	duckv1.AddressStatus `json:",inline"`

	// +optional
	JobStatus JobStatus `json:"job,omitempty"`

	// AppliedEventPoliciesStatus contains the list of EventPolicies which apply to this JobSink
	// +optional
	eventingduckv1.AppliedEventPoliciesStatus `json:",inline"`
}

JobSinkStatus defines the observed state of JobSink.

func (*JobSinkStatus) DeepCopy 

func (in *JobSinkStatus) DeepCopy() *JobSinkStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobSinkStatus.

func (*JobSinkStatus) DeepCopyInto 

func (in *JobSinkStatus) DeepCopyInto(out *JobSinkStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*JobSinkStatus) GetCondition 

func (s *JobSinkStatus) GetCondition(t apis.ConditionType) *apis.Condition

GetCondition returns the condition currently associated with the given type, or nil.

func (*JobSinkStatus) GetTopLevelCondition 

func (ps *JobSinkStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level Condition.

func (*JobSinkStatus) InitializeConditions 

func (s *JobSinkStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*JobSinkStatus) IsReady 

func (s *JobSinkStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*JobSinkStatus) MarkAddressableReady 

func (s *JobSinkStatus) MarkAddressableReady()

MarkAddressableReady marks the Addressable condition to True.

func (*JobSinkStatus) MarkEventPoliciesFailed 

func (s *JobSinkStatus) MarkEventPoliciesFailed(reason, messageFormat string, messageA ...interface{})

MarkEventPoliciesFailed marks the EventPoliciesReady condition to False with the given reason and message.

func (*JobSinkStatus) MarkEventPoliciesTrue 

func (s *JobSinkStatus) MarkEventPoliciesTrue()

MarkEventPoliciesTrue marks the EventPoliciesReady condition to True.

func (*JobSinkStatus) MarkEventPoliciesTrueWithReason 

func (s *JobSinkStatus) MarkEventPoliciesTrueWithReason(reason, messageFormat string, messageA ...interface{})

MarkEventPoliciesTrueWithReason marks the EventPoliciesReady condition to True with the given reason and message.

func (*JobSinkStatus) MarkEventPoliciesUnknown 

func (s *JobSinkStatus) MarkEventPoliciesUnknown(reason, messageFormat string, messageA ...interface{})

MarkEventPoliciesUnknown marks the EventPoliciesReady condition to Unknown with the given reason and message.

func (*JobSinkStatus) SetAddress 

func (s *JobSinkStatus) SetAddress(address *duckv1.Addressable)

type JobStatus 

type JobStatus struct {
	Selector string `json:"selector,omitempty"`
}

func (*JobStatus) DeepCopy 

func (in *JobStatus) DeepCopy() *JobStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JobStatus.

func (*JobStatus) DeepCopyInto 

func (in *JobStatus) DeepCopyInto(out *JobStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

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.