Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package +groupName=duck.knative.dev
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- func ValidateDestination(dest Destination, allowDeprecatedFields bool) *apis.FieldError
- type AddressStatus
- type Addressable
- func (a *Addressable) ConvertFrom(ctx context.Context, from apis.Convertible) error
- func (a *Addressable) ConvertTo(ctx context.Context, to apis.Convertible) error
- func (in *Addressable) DeepCopy() *Addressable
- func (in *Addressable) DeepCopyInto(out *Addressable)
- func (*Addressable) GetFullType() ducktypes.Populatable
- type AddressableType
- type AddressableTypeList
- type Binding
- type BindingList
- type BindingSpec
- type CloudEventOverrides
- type Conditions
- type Destination
- func (in *Destination) DeepCopy() *Destination
- func (in *Destination) DeepCopyInto(out *Destination)
- func (dest *Destination) GetRef() *corev1.ObjectReference
- func (dest *Destination) Validate(ctx context.Context) *apis.FieldError
- func (dest *Destination) ValidateDisallowDeprecated(ctx context.Context) *apis.FieldError
- type KResource
- type KResourceList
- type Source
- type SourceList
- type SourceSpec
- type SourceStatus
- type Status
- func (s *Status) ConvertTo(ctx context.Context, sink *Status)
- func (in *Status) DeepCopy() *Status
- func (in *Status) DeepCopyInto(out *Status)
- func (s *Status) GetCondition(t apis.ConditionType) *apis.Condition
- func (s *Status) GetConditions() apis.Conditions
- func (s *Status) SetConditions(c apis.Conditions)
Constants ¶
const ( // SourceConditionSinkProvided has status True when the Source // has been configured with a sink target that is resolvable. SourceConditionSinkProvided apis.ConditionType = "SinkProvided" )
Variables ¶
var ( // SchemeBuilder builds a scheme with the types known to the package. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme adds the types known to this package to an existing schema. AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: ducktypes.GroupName, Version: "v1beta1"}
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
func ValidateDestination ¶
func ValidateDestination(dest Destination, allowDeprecatedFields bool) *apis.FieldError
ValidateDestination validates Destination and either allows or disallows Deprecated* fields depending on the flag.
Types ¶
type AddressStatus ¶
type AddressStatus struct {
Address *Addressable `json:"address,omitempty"`
}
AddressStatus shows how we expect folks to embed Addressable in their Status field.
func (*AddressStatus) DeepCopy ¶
func (in *AddressStatus) DeepCopy() *AddressStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddressStatus.
func (*AddressStatus) DeepCopyInto ¶
func (in *AddressStatus) DeepCopyInto(out *AddressStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Addressable ¶
Addressable provides a generic mechanism for a custom resource definition to indicate a destination for message delivery.
Addressable is the schema for the destination information. This is typically stored in the object's `status`, as this information may be generated by the controller.
func (*Addressable) ConvertFrom ¶
func (a *Addressable) ConvertFrom(ctx context.Context, from apis.Convertible) error
ConvertFrom implements apis.Convertible
func (*Addressable) ConvertTo ¶
func (a *Addressable) ConvertTo(ctx context.Context, to apis.Convertible) error
ConvertTo implements apis.Convertible
func (*Addressable) DeepCopy ¶
func (in *Addressable) DeepCopy() *Addressable
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Addressable.
func (*Addressable) DeepCopyInto ¶
func (in *Addressable) DeepCopyInto(out *Addressable)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Addressable) GetFullType ¶
func (*Addressable) GetFullType() ducktypes.Populatable
GetFullType implements duck.Implementable
type AddressableType ¶
type AddressableType struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Status AddressStatus `json:"status"` }
AddressableType is a skeleton type wrapping Addressable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Addressable ObjectReferences and access the Addressable data. This is not a real resource.
func (*AddressableType) DeepCopy ¶
func (in *AddressableType) DeepCopy() *AddressableType
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddressableType.
func (*AddressableType) DeepCopyInto ¶
func (in *AddressableType) DeepCopyInto(out *AddressableType)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AddressableType) DeepCopyObject ¶
func (in *AddressableType) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*AddressableType) GetListType ¶
func (*AddressableType) GetListType() runtime.Object
GetListType implements apis.Listable
func (*AddressableType) Populate ¶
func (t *AddressableType) Populate()
Populate implements duck.Populatable
type AddressableTypeList ¶
type AddressableTypeList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []AddressableType `json:"items"` }
AddressableTypeList is a list of AddressableType resources
func (*AddressableTypeList) DeepCopy ¶
func (in *AddressableTypeList) DeepCopy() *AddressableTypeList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AddressableTypeList.
func (*AddressableTypeList) DeepCopyInto ¶
func (in *AddressableTypeList) DeepCopyInto(out *AddressableTypeList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AddressableTypeList) DeepCopyObject ¶
func (in *AddressableTypeList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Binding ¶
type Binding struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BindingSpec `json:"spec"` }
Binding is a duck type that specifies the partial schema to which all Binding implementations should adhere.
func (*Binding) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Binding.
func (*Binding) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Binding) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Binding) GetFullType ¶
func (*Binding) GetFullType() duck.Populatable
GetFullType implements duck.Implementable
func (*Binding) GetListType ¶
GetListType implements apis.Listable
type BindingList ¶
type BindingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Binding `json:"items"` }
BindingList is a list of Binding resources
func (*BindingList) DeepCopy ¶
func (in *BindingList) DeepCopy() *BindingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BindingList.
func (*BindingList) DeepCopyInto ¶
func (in *BindingList) DeepCopyInto(out *BindingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BindingList) DeepCopyObject ¶
func (in *BindingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BindingSpec ¶
type BindingSpec struct { // Subject references the resource(s) whose "runtime contract" should be // augmented by Binding implementations. Subject tracker.Reference `json:"subject"` }
BindingSpec specifies the spec portion of the Binding partial-schema.
func (*BindingSpec) DeepCopy ¶
func (in *BindingSpec) DeepCopy() *BindingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BindingSpec.
func (*BindingSpec) DeepCopyInto ¶
func (in *BindingSpec) DeepCopyInto(out *BindingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CloudEventOverrides ¶
type CloudEventOverrides struct { // Extensions specify what attribute are added or overridden on the // outbound event. Each `Extensions` key-value pair are set on the event as // an attribute extension independently. // +optional Extensions map[string]string `json:"extensions,omitempty"` }
CloudEventOverrides defines arguments for a Source that control the output format of the CloudEvents produced by the Source.
func (*CloudEventOverrides) DeepCopy ¶
func (in *CloudEventOverrides) DeepCopy() *CloudEventOverrides
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudEventOverrides.
func (*CloudEventOverrides) DeepCopyInto ¶
func (in *CloudEventOverrides) DeepCopyInto(out *CloudEventOverrides)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Conditions ¶
type Conditions apis.Conditions
Conditions is a simple wrapper around apis.Conditions to implement duck.Implementable.
func (Conditions) DeepCopy ¶
func (in Conditions) DeepCopy() Conditions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Conditions.
func (Conditions) DeepCopyInto ¶
func (in Conditions) DeepCopyInto(out *Conditions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Conditions) GetFullType ¶
func (*Conditions) GetFullType() ducktypes.Populatable
GetFullType implements duck.Implementable
type Destination ¶
type Destination struct { // Ref points to an Addressable. // +optional Ref *corev1.ObjectReference `json:"ref,omitempty"` // +optional DeprecatedAPIVersion string `json:"apiVersion,omitempty"` // +optional DeprecatedKind string `json:"kind,omitempty"` // +optional DeprecatedName string `json:"name,omitempty"` // +optional DeprecatedNamespace string `json:"namespace,omitempty"` // URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref. // +optional URI *apis.URL `json:"uri,omitempty"` }
Destination represents a target of an invocation over HTTP.
func (*Destination) DeepCopy ¶
func (in *Destination) DeepCopy() *Destination
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Destination.
func (*Destination) DeepCopyInto ¶
func (in *Destination) DeepCopyInto(out *Destination)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Destination) GetRef ¶
func (dest *Destination) GetRef() *corev1.ObjectReference
GetRef gets the ObjectReference from this Destination, if one is present. If no ref is present, then nil is returned. Note: this mostly exists to abstract away the deprecated ObjectReference fields. Once they are removed, then this method should probably be removed too.
func (*Destination) Validate ¶
func (dest *Destination) Validate(ctx context.Context) *apis.FieldError
func (*Destination) ValidateDisallowDeprecated ¶
func (dest *Destination) ValidateDisallowDeprecated(ctx context.Context) *apis.FieldError
type KResource ¶
type KResource struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Status Status `json:"status"` }
KResource is a skeleton type wrapping Conditions in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Conditions ObjectReferences and access the Conditions data. This is not a real resource.
func (*KResource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KResource.
func (*KResource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KResource) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KResource) GetListType ¶
GetListType implements apis.Listable
type KResourceList ¶
type KResourceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []KResource `json:"items"` }
KResourceList is a list of KResource resources
func (*KResourceList) DeepCopy ¶
func (in *KResourceList) DeepCopy() *KResourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KResourceList.
func (*KResourceList) DeepCopyInto ¶
func (in *KResourceList) DeepCopyInto(out *KResourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KResourceList) DeepCopyObject ¶
func (in *KResourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Source ¶
type Source struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec SourceSpec `json:"spec"` Status SourceStatus `json:"status"` }
Source is the minimum resource shape to adhere to the Source Specification. This duck type is intended to allow implementors of Sources and Importers to verify their own resources meet the expectations. This is not a real resource. NOTE: The Source Specification is in progress and the shape and names could be modified until it has been accepted.
func (*Source) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Source.
func (*Source) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Source) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Source) GetFullType ¶
func (*Source) GetFullType() ducktypes.Populatable
GetFullType implements duck.Implementable
func (*Source) GetListType ¶
GetListType implements apis.Listable
type SourceList ¶
type SourceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Source `json:"items"` }
SourceList is a list of Source resources
func (*SourceList) DeepCopy ¶
func (in *SourceList) DeepCopy() *SourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceList.
func (*SourceList) DeepCopyInto ¶
func (in *SourceList) DeepCopyInto(out *SourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SourceList) DeepCopyObject ¶
func (in *SourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SourceSpec ¶
type SourceSpec struct { // Sink is a reference to an object that will resolve to a domain name or a // URI directly to use as the sink. Sink Destination `json:"sink,omitempty"` // CloudEventOverrides defines overrides to control the output format and // modifications of the event sent to the sink. // +optional CloudEventOverrides *CloudEventOverrides `json:"ceOverrides,omitempty"` }
func (*SourceSpec) DeepCopy ¶
func (in *SourceSpec) DeepCopy() *SourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceSpec.
func (*SourceSpec) DeepCopyInto ¶
func (in *SourceSpec) DeepCopyInto(out *SourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SourceStatus ¶
type SourceStatus struct { // inherits duck/v1beta1 Status, 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. Status `json:",inline"` // SinkURI is the current active sink URI that has been configured for the // Source. // +optional SinkURI *apis.URL `json:"sinkUri,omitempty"` }
SourceStatus shows how we expect folks to embed Addressable in their Status field.
func (*SourceStatus) DeepCopy ¶
func (in *SourceStatus) DeepCopy() *SourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceStatus.
func (*SourceStatus) DeepCopyInto ¶
func (in *SourceStatus) DeepCopyInto(out *SourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SourceStatus) IsReady ¶
func (ss *SourceStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
type Status ¶
type Status struct { // ObservedGeneration is the 'Generation' of the Service that // was last processed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` // Conditions the latest available observations of a resource's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions Conditions `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // Annotations is additional Status fields for the Resource to save some // additional State as well as convey more information to the user. This is // roughly akin to Annotations on any k8s resource, just the reconciler conveying // richer information outwards. Annotations map[string]string `json:"annotations,omitempty"` }
Status shows how we expect folks to embed Conditions in their Status field. WARNING: Adding fields to this struct will add them to all Knative resources.
func (*Status) ConvertTo ¶
ConvertTo helps implement apis.Convertible for types embedding this Status.
func (*Status) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.
func (*Status) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Status) GetCondition ¶
func (s *Status) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition fetches the condition of the specified type.
func (*Status) GetConditions ¶
func (s *Status) GetConditions() apis.Conditions
GetConditions implements apis.ConditionsAccessor
func (*Status) SetConditions ¶
func (s *Status) SetConditions(c apis.Conditions)
SetConditions implements apis.ConditionsAccessor