Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package +groupName=duck.knative.dev
Index ¶
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type AddressStatus
- type Addressable
- func (a *Addressable) ConvertDown(ctx context.Context, from apis.Convertible) error
- func (a *Addressable) ConvertUp(ctx context.Context, to apis.Convertible) error
- func (in *Addressable) DeepCopy() *Addressable
- func (in *Addressable) DeepCopyInto(out *Addressable)
- func (*Addressable) GetFullType() duck.Populatable
- func (a Addressable) GetURL() apis.URL
- type AddressableType
- type AddressableTypeList
- type Binding
- type BindingList
- type BindingSpec
- type Condition
- type ConditionManager
- type ConditionSet
- type ConditionSeverity
- type ConditionType
- type Conditions
- type ConditionsAccessor
- type KResource
- type KResourceList
- type KResourceStatus
- type LegacyTarget
- type LegacyTargetList
- type LegacyTargetable
- type Status
- type Target
- type TargetList
- type TargetStatus
- type Targetable
Constants ¶
This section is empty.
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: duck.GroupName, Version: "v1alpha1"}
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 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 ¶
type Addressable struct { v1beta1.Addressable `json:",omitempty"` Hostname string `json:"hostname,omitempty"` }
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) ConvertDown ¶
func (a *Addressable) ConvertDown(ctx context.Context, from apis.Convertible) error
ConvertDown implements apis.Convertible
func (*Addressable) ConvertUp ¶
func (a *Addressable) ConvertUp(ctx context.Context, to apis.Convertible) error
ConvertUp 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() duck.Populatable
GetFullType implements duck.Implementable
func (Addressable) GetURL ¶
func (a Addressable) GetURL() apis.URL
GetURL returns the URL type for the Addressable.
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 Condition ¶
type Condition struct { // Type of condition. // +required Type ConditionType `json:"type" description:"type of status condition"` // Status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` // Severity with which to treat failures of this type of condition. // When this is not specified, it defaults to Error. // +optional Severity ConditionSeverity `json:"severity,omitempty" description:"how to interpret failures of this condition, one of Error, Warning, Info"` // LastTransitionTime is the last time the condition transitioned from one status to another. // We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic // differences (all other things held constant). // +optional LastTransitionTime apis.VolatileTime `json:"lastTransitionTime,omitempty" description:"last time the condition transit from one status to another"` // The reason for the condition's last transition. // +optional Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"` // A human readable message indicating details about the transition. // +optional Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"` }
Conditions defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties +k8s:deepcopy-gen=true
func (*Condition) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.
func (*Condition) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionManager ¶
type ConditionManager interface { // IsHappy looks at the happy condition and returns true if that condition is // set to true. IsHappy() bool // GetCondition finds and returns the Condition that matches the ConditionType // previously set on Conditions. GetCondition(t ConditionType) *Condition // SetCondition sets or updates the Condition on Conditions for Condition.Type. // If there is an update, Conditions are stored back sorted. SetCondition(new Condition) // MarkTrue sets the status of t to true, and then marks the happy condition to // true if all dependents are true. MarkTrue(t ConditionType) // MarkUnknown sets the status of t to Unknown and also sets the happy condition // to Unknown if no other dependent condition is in an error state. MarkUnknown(t ConditionType, reason, messageFormat string, messageA ...interface{}) // MarkFalse sets the status of t and the happy condition to False. MarkFalse(t ConditionType, reason, messageFormat string, messageA ...interface{}) // InitializeConditions updates all Conditions in the ConditionSet to Unknown // if not set. InitializeConditions() // InitializeCondition updates a Condition to Unknown if not set. InitializeCondition(t ConditionType) }
ConditionManager allows a resource to operate on its Conditions using higher order operations.
type ConditionSet ¶
type ConditionSet struct {
// contains filtered or unexported fields
}
ConditionSet is an abstract collection of the possible ConditionType values that a particular resource might expose. It also holds the "happy condition" for that resource, which we define to be one of Ready or Succeeded depending on whether it is a Living or Batch process respectively. +k8s:deepcopy-gen=false
func NewBatchConditionSet ¶
func NewBatchConditionSet(d ...ConditionType) ConditionSet
NewBatchConditionSet returns a ConditionSet to hold the conditions for the batch resource. ConditionSucceeded is used as the happy condition. The set of condition types provided are those of the terminal subconditions.
func NewLivingConditionSet ¶
func NewLivingConditionSet(d ...ConditionType) ConditionSet
NewLivingConditionSet returns a ConditionSet to hold the conditions for the living resource. ConditionReady is used as the happy condition. The set of condition types provided are those of the terminal subconditions.
func (ConditionSet) Manage ¶
func (r ConditionSet) Manage(status interface{}) ConditionManager
Manage creates a ConditionManager from a accessor object using the original ConditionSet as a reference. Status must be or point to a struct.
type ConditionSeverity ¶
type ConditionSeverity string
ConditionSeverity expresses the severity of a Condition Type failing.
const ( // ConditionSeverityError specifies that a failure of a condition type // should be viewed as an error. As "Error" is the default for conditions // we use the empty string (coupled with omitempty) to avoid confusion in // the case where the condition is in state "True" (aka nothing is wrong). ConditionSeverityError ConditionSeverity = "" // ConditionSeverityWarning specifies that a failure of a condition type // should be viewed as a warning, but that things could still work. ConditionSeverityWarning ConditionSeverity = "Warning" // ConditionSeverityInfo specifies that a failure of a condition type // should be viewed as purely informational, and that things could still work. ConditionSeverityInfo ConditionSeverity = "Info" )
type ConditionType ¶
type ConditionType string
ConditionType is a camel-cased condition type.
const ( // ConditionReady specifies that the resource is ready. // For long-running resources. ConditionReady ConditionType = "Ready" // ConditionSucceeded specifies that the resource has finished. // For resource which run to completion. ConditionSucceeded ConditionType = "Succeeded" )
type Conditions ¶
type Conditions []Condition
Conditions is the schema for the conditions portion of the payload
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() duck.Populatable
GetFullType implements duck.Implementable
type ConditionsAccessor ¶
type ConditionsAccessor interface { GetConditions() Conditions SetConditions(Conditions) }
Conditions is the interface for a Resource that implements the getter and setter for accessing a Condition collection. +k8s:deepcopy-gen=true
func NewReflectedConditionsAccessor ¶
func NewReflectedConditionsAccessor(status interface{}) ConditionsAccessor
NewReflectedConditionsAccessor uses reflection to return a ConditionsAccessor to access the field called "Conditions".
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 KResourceStatus ¶
type KResourceStatus Status
TODO: KResourceStatus is added for backwards compatibility for <= 0.4.0 releases. Remove later. KResourceStatus [Deprecated] use Status directly. Will be deleted ~0.6.0 release.
func (*KResourceStatus) DeepCopy ¶
func (in *KResourceStatus) DeepCopy() *KResourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KResourceStatus.
func (*KResourceStatus) DeepCopyInto ¶
func (in *KResourceStatus) DeepCopyInto(out *KResourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LegacyTarget ¶
type LegacyTarget struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Status LegacyTargetable `json:"status"` }
LegacyTarget is a skeleton type wrapping LegacyTargetable in the manner we want to support unless they get migrated into supporting Legacy. We will typically use this type to deserialize LegacyTargetable ObjectReferences and access the LegacyTargetable data. This is not a real resource. ** Do not use this for any new resources **
func (*LegacyTarget) DeepCopy ¶
func (in *LegacyTarget) DeepCopy() *LegacyTarget
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LegacyTarget.
func (*LegacyTarget) DeepCopyInto ¶
func (in *LegacyTarget) DeepCopyInto(out *LegacyTarget)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LegacyTarget) DeepCopyObject ¶
func (in *LegacyTarget) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*LegacyTarget) GetListType ¶
func (*LegacyTarget) GetListType() runtime.Object
GetListType implements apis.Listable
func (*LegacyTarget) Populate ¶
func (t *LegacyTarget) Populate()
Populate implements duck.Populatable
type LegacyTargetList ¶
type LegacyTargetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []LegacyTarget `json:"items"` }
LegacyTargetList is a list of LegacyTarget resources
func (*LegacyTargetList) DeepCopy ¶
func (in *LegacyTargetList) DeepCopy() *LegacyTargetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LegacyTargetList.
func (*LegacyTargetList) DeepCopyInto ¶
func (in *LegacyTargetList) DeepCopyInto(out *LegacyTargetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LegacyTargetList) DeepCopyObject ¶
func (in *LegacyTargetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type LegacyTargetable ¶
type LegacyTargetable struct {
DomainInternal string `json:"domainInternal,omitempty"`
}
LegacyTargetable left around until we migrate to Addressable in the dependent resources. Addressable has more structure in the way it defines the fields. LegacyTargetable only assumed a single string in the Status field and we're moving towards defining proper structs under Status rather than strings. This is to support existing resources until they migrate.
Do not use this for anything new, use Addressable ¶
LegacyTargetable is the old schema for the addressable portion of the payload
For new resources use Addressable.
func (*LegacyTargetable) DeepCopy ¶
func (in *LegacyTargetable) DeepCopy() *LegacyTargetable
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LegacyTargetable.
func (*LegacyTargetable) DeepCopyInto ¶
func (in *LegacyTargetable) DeepCopyInto(out *LegacyTargetable)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LegacyTargetable) GetFullType ¶
func (*LegacyTargetable) GetFullType() duck.Populatable
GetFullType implements duck.Implementable
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"` }
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) 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 ConditionType) *Condition
GetCondition fetches the condition of the specified type.
type Target ¶
type Target struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Status TargetStatus `json:"status"` }
Target is a skeleton type wrapping Targetable in the manner we expect resource writers defining compatible resources to embed it. We will typically use this type to deserialize Targetable ObjectReferences and access the Targetable data. This is not a real resource.
func (*Target) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Target.
func (*Target) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Target) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Target) GetListType ¶
GetListType implements apis.Listable
type TargetList ¶
type TargetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Target `json:"items"` }
TargetList is a list of Target resources
func (*TargetList) DeepCopy ¶
func (in *TargetList) DeepCopy() *TargetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetList.
func (*TargetList) DeepCopyInto ¶
func (in *TargetList) DeepCopyInto(out *TargetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TargetList) DeepCopyObject ¶
func (in *TargetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TargetStatus ¶
type TargetStatus struct {
Targetable *Targetable `json:"targetable,omitempty"`
}
TargetStatus shows how we expect folks to embed Targetable in their Status field.
func (*TargetStatus) DeepCopy ¶
func (in *TargetStatus) DeepCopy() *TargetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetStatus.
func (*TargetStatus) DeepCopyInto ¶
func (in *TargetStatus) DeepCopyInto(out *TargetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Targetable ¶
type Targetable struct {
DomainInternal string `json:"domainInternal,omitempty"`
}
Targetable is an earlier version of the Callable interface. Callable is a higher-level interface which implements Addressable but further promises that the destination may synchronously return response messages in reply to a message.
Targetable implementations should instead implement Addressable and include an `eventing.knative.dev/returns=any` annotation.
Targetable is retired; implement Addressable for now.
func (*Targetable) DeepCopy ¶
func (in *Targetable) DeepCopy() *Targetable
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Targetable.
func (*Targetable) DeepCopyInto ¶
func (in *Targetable) DeepCopyInto(out *Targetable)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Targetable) GetFullType ¶
func (*Targetable) GetFullType() duck.Populatable
GetFullType implements duck.Implementable