v1

package
v0.33.0 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the control-api v1 API group +kubebuilder:object:generate=true +kubebuilder:skip +groupName=user.appuio.io

Index

Constants

View Source 
const (
	// ConditionRedeemed is set when the invitation has been redeemed
	ConditionRedeemed = "Redeemed"
	// ConditionEmailSent is set when the invitation email has been sent
	ConditionEmailSent        = "EmailSent"
	ConditionReasonSendFailed = "SendFailed"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "user.appuio.io", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
)

Functions

func AddToScheme 

func AddToScheme(s *runtime.Scheme) error

AddToScheme adds the types in this group-version to the given scheme.

func Convert_url_Values_To__RedeemOptions added in v0.13.0 

func Convert_url_Values_To__RedeemOptions(in, out interface{}, _ conversion.Scope) error

Types

type Invitation 

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

	// Spec holds the desired invitation state
	Spec InvitationSpec `json:"spec,omitempty"`
	// Status holds the invitation specific status
	Status InvitationStatus `json:"status,omitempty"`
}

Invitation is a representation of an APPUiO Cloud Invitation

func (*Invitation) DeepCopy 

func (in *Invitation) DeepCopy() *Invitation

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

func (*Invitation) DeepCopyInto 

func (in *Invitation) DeepCopyInto(out *Invitation)

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

func (*Invitation) DeepCopyObject 

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

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

func (*Invitation) GetGroupVersionResource 

func (o *Invitation) GetGroupVersionResource() schema.GroupVersionResource

GetGroupVersionResource returns the GroupVersionResource for this resource. The resource should be the all lowercase and pluralized kind

func (*Invitation) GetObjectMeta 

func (o *Invitation) GetObjectMeta() *metav1.ObjectMeta

GetObjectMeta returns the objects meta reference.

func (*Invitation) IsRedeemed added in v0.13.0 

func (o *Invitation) IsRedeemed() bool

IsRedeemed returns true if the invitation has been redeemed

func (*Invitation) IsStorageVersion 

func (o *Invitation) IsStorageVersion() bool

IsStorageVersion returns true if the object is also the internal version -- i.e. is the type defined for the API group or an alias to this object. If false, the resource is expected to implement MultiVersionObject interface.

func (*Invitation) NamespaceScoped 

func (o *Invitation) NamespaceScoped() bool

NamespaceScoped returns true if the object is namespaced

func (*Invitation) New 

func (o *Invitation) New() runtime.Object

New returns a new instance of the resource

func (*Invitation) NewList 

func (o *Invitation) NewList() runtime.Object

NewList return a new list instance of the resource

func (*Invitation) SecretStorageGetStatus 

func (o *Invitation) SecretStorageGetStatus() status.StatusSubResource

SecretStorageGetStatus returns the status of the resource

type InvitationList 

type InvitationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Invitation `json:"items"`
}

InvitationList contains a list of Invitations

func (*InvitationList) DeepCopy 

func (in *InvitationList) DeepCopy() *InvitationList

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

func (*InvitationList) DeepCopyInto 

func (in *InvitationList) DeepCopyInto(out *InvitationList)

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

func (*InvitationList) DeepCopyObject 

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

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

func (*InvitationList) GetListMeta 

func (in *InvitationList) GetListMeta() *metav1.ListMeta

GetListMeta returns the list meta reference.

type InvitationRedeemRequest added in v0.21.0 

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

	// Token is the token to redeem the invitation
	Token string `json:"token"`
}

+kubebuilder:object:root=true InvitationRedeemRequest is a request to redeem an invitation

func (*InvitationRedeemRequest) DeepCopy added in v0.21.0 

func (in *InvitationRedeemRequest) DeepCopy() *InvitationRedeemRequest

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

func (*InvitationRedeemRequest) DeepCopyInto added in v0.21.0 

func (in *InvitationRedeemRequest) DeepCopyInto(out *InvitationRedeemRequest)

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

func (*InvitationRedeemRequest) DeepCopyObject added in v0.21.0 

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

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

func (*InvitationRedeemRequest) GetGroupVersionResource added in v0.21.0 

func (o *InvitationRedeemRequest) GetGroupVersionResource() schema.GroupVersionResource

GetGroupVersionResource returns the GroupVersionResource for this resource. The resource should be the all lowercase and pluralized kind

func (*InvitationRedeemRequest) GetObjectMeta added in v0.21.0 

func (o *InvitationRedeemRequest) GetObjectMeta() *metav1.ObjectMeta

GetObjectMeta returns the objects meta reference.

func (*InvitationRedeemRequest) IsStorageVersion added in v0.21.0 

func (o *InvitationRedeemRequest) IsStorageVersion() bool

IsStorageVersion returns true if the object is also the internal version -- i.e. is the type defined for the API group or an alias to this object. If false, the resource is expected to implement MultiVersionObject interface.

func (*InvitationRedeemRequest) NamespaceScoped added in v0.21.0 

func (o *InvitationRedeemRequest) NamespaceScoped() bool

NamespaceScoped returns true if the object is namespaced

func (*InvitationRedeemRequest) New added in v0.21.0 

func (o *InvitationRedeemRequest) New() runtime.Object

New returns a new instance of the resource

func (*InvitationRedeemRequest) NewList added in v0.21.0 

func (o *InvitationRedeemRequest) NewList() runtime.Object

NewList return a new list instance of the resource

type InvitationRedeemRequestList added in v0.21.0 

type InvitationRedeemRequestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []InvitationRedeemRequest `json:"items"`
}

+kubebuilder:object:root=true InvitationList contains a list of Invitations

func (*InvitationRedeemRequestList) DeepCopy added in v0.21.0 

func (in *InvitationRedeemRequestList) DeepCopy() *InvitationRedeemRequestList

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

func (*InvitationRedeemRequestList) DeepCopyInto added in v0.21.0 

func (in *InvitationRedeemRequestList) DeepCopyInto(out *InvitationRedeemRequestList)

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

func (*InvitationRedeemRequestList) DeepCopyObject added in v0.21.0 

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

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

func (*InvitationRedeemRequestList) GetListMeta added in v0.21.0 

func (in *InvitationRedeemRequestList) GetListMeta() *metav1.ListMeta

GetListMeta returns the list meta reference.

type InvitationSpec 

type InvitationSpec struct {
	// Note is a free-form text field to add a note to the invitation
	Note string `json:"note,omitempty"`
	// Email is the email address of the invited user, used to send the invitation
	Email string `json:"email,omitempty"`
	// TargetRefs is a list of references to the target resources
	TargetRefs []TargetRef `json:"targetRefs,omitempty"`
}

InvitationSpec defines the desired state of the Invitation

func (*InvitationSpec) DeepCopy 

func (in *InvitationSpec) DeepCopy() *InvitationSpec

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

func (*InvitationSpec) DeepCopyInto 

func (in *InvitationSpec) DeepCopyInto(out *InvitationSpec)

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

type InvitationStatus 

type InvitationStatus struct {
	// Token is the invitation token
	Token string `json:"token"`
	// ValidUntil is the time when the invitation expires
	ValidUntil metav1.Time `json:"validUntil"`
	// Conditions is a list of conditions for the invitation
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// TargetStatuses is a list of statuses for the target resources
	TargetStatuses []TargetStatus `json:"targetStatuses,omitempty"`
	// RedeemedBy is the user who redeemed the invitation
	RedeemedBy string `json:"redeemedBy,omitempty"`
}

InvitationStatus defines the observed state of the Invitation

func (*InvitationStatus) DeepCopy 

func (in *InvitationStatus) DeepCopy() *InvitationStatus

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

func (*InvitationStatus) DeepCopyInto 

func (in *InvitationStatus) DeepCopyInto(out *InvitationStatus)

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

func (*InvitationStatus) SecretStorageCopyTo 

func (s *InvitationStatus) SecretStorageCopyTo(parent status.ObjectWithStatusSubResource)

CopyTo copies the status to the given parent resource

func (InvitationStatus) SubResourceName 

func (s InvitationStatus) SubResourceName() string

type RedeemOptions added in v0.13.0 

type RedeemOptions struct {
	metav1.TypeMeta `json:",inline"`

	Token string `json:"token"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*RedeemOptions) ConvertFromUrlValues added in v0.13.0 

func (o *RedeemOptions) ConvertFromUrlValues(values *url.Values) error

apiserver-runtime tracks its own version of the query parameter scheme. Just registering the conversion functions to the scheme is not enough. It also needs to implement the resource.QueryParameterObject interface.

func (*RedeemOptions) DeepCopy added in v0.13.0 

func (in *RedeemOptions) DeepCopy() *RedeemOptions

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

func (*RedeemOptions) DeepCopyInto added in v0.13.0 

func (in *RedeemOptions) DeepCopyInto(out *RedeemOptions)

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

func (*RedeemOptions) DeepCopyObject added in v0.13.0 

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

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

type TargetRef 

type TargetRef struct {
	// APIGroup is the API group of the target resource
	APIGroup string `json:"apiGroup,omitempty"`
	// Kind is the kind of the target resource
	Kind string `json:"kind,omitempty"`
	// Name is the name of the target resource
	Name string `json:"name,omitempty"`
	// Namespace is the namespace of the target resource
	Namespace string `json:"namespace,omitempty"`
}

TargetRef is a reference to a target resource

func (*TargetRef) DeepCopy 

func (in *TargetRef) DeepCopy() *TargetRef

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

func (*TargetRef) DeepCopyInto 

func (in *TargetRef) DeepCopyInto(out *TargetRef)

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

type TargetStatus added in v0.13.0 

type TargetStatus struct {
	Condition metav1.Condition `json:"condition"`
	TargetRef TargetRef        `json:"targetRef"`
}

TargetStatus is the status of a target resource

func (*TargetStatus) DeepCopy added in v0.13.0 

func (in *TargetStatus) DeepCopy() *TargetStatus

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

func (*TargetStatus) DeepCopyInto added in v0.13.0 

func (in *TargetStatus) DeepCopyInto(out *TargetStatus)

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.