pkg: github.com/knative/pkg/apis/duck/v1alpha1 Index | Files

package v1alpha1

import "github.com/knative/pkg/apis/duck/v1alpha1"

+k8s:deepcopy-gen=package +groupName=duck.knative.dev

Index

Package Files

addressable_types.go condition_set.go conditions_types.go doc.go legacy_targetable_types.go register.go retired_targetable_types.go zz_generated.deepcopy.go

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

func Kind Uses

func Kind(kind string) schema.GroupKind

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

func Resource Uses

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

type AddressStatus Uses

type AddressStatus struct {
    Address *Addressable `json:"address,omitempty"`
}

AddressStatus shows how we expect folks to embed Addressable in their Status field.

func (*AddressStatus) DeepCopy Uses

func (in *AddressStatus) DeepCopy() *AddressStatus

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

func (*AddressStatus) DeepCopyInto Uses

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 Uses

type Addressable struct {
    v1beta1.Addressable `json:",omitempty"`

    Hostname string `json:"hostname,omitempty"`
}

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 Uses

func (a *Addressable) ConvertDown(ctx context.Context, from apis.Convertible) error

ConvertDown implements apis.Convertible

func (*Addressable) ConvertUp Uses

func (a *Addressable) ConvertUp(ctx context.Context, to apis.Convertible) error

ConvertUp implements apis.Convertible

func (*Addressable) DeepCopy Uses

func (in *Addressable) DeepCopy() *Addressable

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

func (*Addressable) DeepCopyInto Uses

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 Uses

func (*Addressable) GetFullType() duck.Populatable

GetFullType implements duck.Implementable

func (Addressable) GetURL Uses

func (a Addressable) GetURL() apis.URL

GetURL returns the URL type for the Addressable.

type AddressableType Uses

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 Uses

func (in *AddressableType) DeepCopy() *AddressableType

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

func (*AddressableType) DeepCopyInto Uses

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 Uses

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

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

func (*AddressableType) GetListType Uses

func (*AddressableType) GetListType() runtime.Object

GetListType implements apis.Listable

func (*AddressableType) Populate Uses

func (t *AddressableType) Populate()

Populate implements duck.Populatable

type AddressableTypeList Uses

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 Uses

func (in *AddressableTypeList) DeepCopy() *AddressableTypeList

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

func (*AddressableTypeList) DeepCopyInto Uses

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 Uses

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

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

type Condition Uses

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 Uses

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto Uses

func (in *Condition) DeepCopyInto(out *Condition)

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

func (*Condition) IsFalse Uses

func (c *Condition) IsFalse() bool

IsFalse is true if the condition is False

func (*Condition) IsTrue Uses

func (c *Condition) IsTrue() bool

IsTrue is true if the condition is True

func (*Condition) IsUnknown Uses

func (c *Condition) IsUnknown() bool

IsUnknown is true if the condition is Unknown

type ConditionManager Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

type Conditions []Condition

Conditions is the schema for the conditions portion of the payload

func (Conditions) DeepCopy Uses

func (in Conditions) DeepCopy() Conditions

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

func (Conditions) DeepCopyInto Uses

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 Uses

func (*Conditions) GetFullType() duck.Populatable

GetFullType implements duck.Implementable

type ConditionsAccessor Uses

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 Uses

func NewReflectedConditionsAccessor(status interface{}) ConditionsAccessor

NewReflectedConditionsAccessor uses reflection to return a ConditionsAccessor to access the field called "Conditions".

type KResource Uses

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 Uses

func (in *KResource) DeepCopy() *KResource

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

func (*KResource) DeepCopyInto Uses

func (in *KResource) DeepCopyInto(out *KResource)

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

func (*KResource) DeepCopyObject Uses

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

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

func (*KResource) GetListType Uses

func (*KResource) GetListType() runtime.Object

GetListType implements apis.Listable

func (*KResource) Populate Uses

func (t *KResource) Populate()

Populate implements duck.Populatable

type KResourceList Uses

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 Uses

func (in *KResourceList) DeepCopy() *KResourceList

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

func (*KResourceList) DeepCopyInto Uses

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 Uses

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

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

type KResourceStatus Uses

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 Uses

func (in *KResourceStatus) DeepCopy() *KResourceStatus

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

func (*KResourceStatus) DeepCopyInto Uses

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 Uses

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 Uses

func (in *LegacyTarget) DeepCopy() *LegacyTarget

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

func (*LegacyTarget) DeepCopyInto Uses

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 Uses

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

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

func (*LegacyTarget) GetListType Uses

func (*LegacyTarget) GetListType() runtime.Object

GetListType implements apis.Listable

func (*LegacyTarget) Populate Uses

func (t *LegacyTarget) Populate()

Populate implements duck.Populatable

type LegacyTargetList Uses

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 Uses

func (in *LegacyTargetList) DeepCopy() *LegacyTargetList

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

func (*LegacyTargetList) DeepCopyInto Uses

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 Uses

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

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

type LegacyTargetable Uses

type LegacyTargetable struct {
    DomainInternal string `json:"domainInternal,omitempty"`
}

LegacyTargetable is the old schema for the addressable portion of the payload

For new resources use Addressable.

func (*LegacyTargetable) DeepCopy Uses

func (in *LegacyTargetable) DeepCopy() *LegacyTargetable

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

func (*LegacyTargetable) DeepCopyInto Uses

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 Uses

func (*LegacyTargetable) GetFullType() duck.Populatable

GetFullType implements duck.Implementable

type Status Uses

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 Uses

func (in *Status) DeepCopy() *Status

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

func (*Status) DeepCopyInto Uses

func (in *Status) DeepCopyInto(out *Status)

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

func (*Status) GetCondition Uses

func (s *Status) GetCondition(t ConditionType) *Condition

GetCondition fetches the condition of the specified type.

type Target Uses

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 Uses

func (in *Target) DeepCopy() *Target

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

func (*Target) DeepCopyInto Uses

func (in *Target) DeepCopyInto(out *Target)

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

func (*Target) DeepCopyObject Uses

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

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

func (*Target) GetListType Uses

func (*Target) GetListType() runtime.Object

GetListType implements apis.Listable

func (*Target) Populate Uses

func (t *Target) Populate()

Populate implements duck.Populatable

type TargetList Uses

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 Uses

func (in *TargetList) DeepCopy() *TargetList

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

func (*TargetList) DeepCopyInto Uses

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 Uses

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

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

type TargetStatus Uses

type TargetStatus struct {
    Targetable *Targetable `json:"targetable,omitempty"`
}

TargetStatus shows how we expect folks to embed Targetable in their Status field.

func (*TargetStatus) DeepCopy Uses

func (in *TargetStatus) DeepCopy() *TargetStatus

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

func (*TargetStatus) DeepCopyInto Uses

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 Uses

type Targetable struct {
    DomainInternal string `json:"domainInternal,omitempty"`
}

Targetable is retired; implement Addressable for now.

func (*Targetable) DeepCopy Uses

func (in *Targetable) DeepCopy() *Targetable

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

func (*Targetable) DeepCopyInto Uses

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 Uses

func (*Targetable) GetFullType() duck.Populatable

GetFullType implements duck.Implementable

Package v1alpha1 imports 13 packages (graph) and is imported by 13 packages. Updated 2019-09-15. Refresh now. Tools for package owners.