Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=sources.knative.dev
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=sources.knative.dev
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type AwsSqsSource
- func (in *AwsSqsSource) DeepCopy() *AwsSqsSource
- func (in *AwsSqsSource) DeepCopyInto(out *AwsSqsSource)
- func (in *AwsSqsSource) DeepCopyObject() runtime.Object
- func (*AwsSqsSource) GetConditionSet() apis.ConditionSet
- func (s *AwsSqsSource) GetGroupVersionKind() schema.GroupVersionKind
- func (a *AwsSqsSource) GetStatus() *duckv1.Status
- type AwsSqsSourceList
- type AwsSqsSourceSpec
- type AwsSqsSourceStatus
- func (in *AwsSqsSourceStatus) DeepCopy() *AwsSqsSourceStatus
- func (in *AwsSqsSourceStatus) DeepCopyInto(out *AwsSqsSourceStatus)
- func (s *AwsSqsSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (s *AwsSqsSourceStatus) InitializeConditions()
- func (s *AwsSqsSourceStatus) IsReady() bool
- func (s *AwsSqsSourceStatus) MarkDeployed()
- func (s *AwsSqsSourceStatus) MarkDeploying(reason, messageFormat string, messageA ...interface{})
- func (s *AwsSqsSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})
- func (s *AwsSqsSourceStatus) MarkNotDeployed(reason, messageFormat string, messageA ...interface{})
- func (s *AwsSqsSourceStatus) MarkSink(uri string)
Constants ¶
const ( // AwsSqsSourceConditionReady has status True when the source is // ready to send events. AwsSqsSourceConditionReady = apis.ConditionReady // AwsSqsSourceConditionSinkProvided has status True when the // AwsSqsSource has been configured with a sink target. AwsSqsSourceConditionSinkProvided apis.ConditionType = "SinkProvided" // AwsSqsSourceConditionDeployed has status True when the // AwsSqsSource has had it's receive adapter deployment created. AwsSqsSourceConditionDeployed apis.ConditionType = "Deployed" )
const (
// AwsSqsSourceEventType is the AWS SQS CloudEvent type.
AwsSqsSourceEventType = "aws.sqs.message"
)
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "sources.knative.dev", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Kind ¶ added in v0.14.0
Kind takes an unqualified kind and returns back a Group qualified GroupKind
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AwsSqsSource ¶
type AwsSqsSource struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec AwsSqsSourceSpec `json:"spec,omitempty"` Status AwsSqsSourceStatus `json:"status,omitempty"` }
AwsSqsSource is the Schema for the AWS SQS API +k8s:openapi-gen=true
func (*AwsSqsSource) DeepCopy ¶
func (in *AwsSqsSource) DeepCopy() *AwsSqsSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AwsSqsSource.
func (*AwsSqsSource) DeepCopyInto ¶
func (in *AwsSqsSource) DeepCopyInto(out *AwsSqsSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AwsSqsSource) DeepCopyObject ¶
func (in *AwsSqsSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*AwsSqsSource) GetConditionSet ¶ added in v0.16.0
func (*AwsSqsSource) GetConditionSet() apis.ConditionSet
GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.
func (*AwsSqsSource) GetGroupVersionKind ¶ added in v0.13.0
func (s *AwsSqsSource) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns GroupVersionKind for AwsSqsSource
func (*AwsSqsSource) GetStatus ¶ added in v0.16.0
func (a *AwsSqsSource) GetStatus() *duckv1.Status
GetStatus retrieves the duck status for this resource. Implements the KRShaped interface.
type AwsSqsSourceList ¶
type AwsSqsSourceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []AwsSqsSource `json:"items"` }
AwsSqsSourceList contains a list of AwsSqsSource
func (*AwsSqsSourceList) DeepCopy ¶
func (in *AwsSqsSourceList) DeepCopy() *AwsSqsSourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AwsSqsSourceList.
func (*AwsSqsSourceList) DeepCopyInto ¶
func (in *AwsSqsSourceList) DeepCopyInto(out *AwsSqsSourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AwsSqsSourceList) DeepCopyObject ¶
func (in *AwsSqsSourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AwsSqsSourceSpec ¶
type AwsSqsSourceSpec struct { // QueueURL of the SQS queue that we will poll from. QueueURL string `json:"queueUrl"` // AwsCredsSecret is the credential to use to poll the AWS SQS // +optional AwsCredsSecret *corev1.SecretKeySelector `json:"awsCredsSecret,omitempty"` // Annotations to add to the pod, mostly used for Kube2IAM role // +optional Annotations map[string]string `json:"annotations,omitempty"` // Sink is a reference to an object that will resolve to a domain name to // use as the sink. This is where events will be received. // +optional Sink *corev1.ObjectReference `json:"sink,omitempty"` // TODO this is not the source duck anymore // ServiceAccoutName is the name of the ServiceAccount that will be used to // run the Receive Adapter Deployment. ServiceAccountName string `json:"serviceAccountName,omitempty"` }
AwsSqsSourceSpec defines the desired state of the source.
func (*AwsSqsSourceSpec) DeepCopy ¶
func (in *AwsSqsSourceSpec) DeepCopy() *AwsSqsSourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AwsSqsSourceSpec.
func (*AwsSqsSourceSpec) DeepCopyInto ¶
func (in *AwsSqsSourceSpec) DeepCopyInto(out *AwsSqsSourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AwsSqsSourceStatus ¶
type AwsSqsSourceStatus struct { // inherits duck/v1 SourceStatus, which currently provides: // * ObservedGeneration - the 'Generation' of the Service that was last // processed by the controller. // * Conditions - the latest available observations of a resource's current // state. // * SinkURI - the current active sink URI that has been configured for the // Source. duckv1.SourceStatus `json:",inline"` }
AwsSqsSourceStatus defines the observed state of the source.
func (*AwsSqsSourceStatus) DeepCopy ¶
func (in *AwsSqsSourceStatus) DeepCopy() *AwsSqsSourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AwsSqsSourceStatus.
func (*AwsSqsSourceStatus) DeepCopyInto ¶
func (in *AwsSqsSourceStatus) DeepCopyInto(out *AwsSqsSourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AwsSqsSourceStatus) GetCondition ¶
func (s *AwsSqsSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*AwsSqsSourceStatus) InitializeConditions ¶
func (s *AwsSqsSourceStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*AwsSqsSourceStatus) IsReady ¶
func (s *AwsSqsSourceStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*AwsSqsSourceStatus) MarkDeployed ¶
func (s *AwsSqsSourceStatus) MarkDeployed()
MarkDeployed sets the condition that the source has been deployed.
func (*AwsSqsSourceStatus) MarkDeploying ¶
func (s *AwsSqsSourceStatus) MarkDeploying(reason, messageFormat string, messageA ...interface{})
MarkDeploying sets the condition that the source is deploying.
func (*AwsSqsSourceStatus) MarkNoSink ¶
func (s *AwsSqsSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})
MarkNoSink sets the condition that the source does not have a sink configured.
func (*AwsSqsSourceStatus) MarkNotDeployed ¶
func (s *AwsSqsSourceStatus) MarkNotDeployed(reason, messageFormat string, messageA ...interface{})
MarkNotDeployed sets the condition that the source has not been deployed.
func (*AwsSqsSourceStatus) MarkSink ¶
func (s *AwsSqsSourceStatus) MarkSink(uri string)
MarkSink sets the condition that the source has a sink configured.