composite

package

v2.2.0 Latest Latest Go to latest Published: Feb 17, 2026 License: Apache-2.0 Imports: 10 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crossplane/crossplane-runtime

Links

Open Source Insights

Documentation ¶

Overview ¶

Package composite contains an unstructured composite resource.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(*Unstructured)

An Option modifies an unstructured composite resource.

func WithConditions ¶

func WithConditions(c ...xpv1.Condition) Option

WithConditions sets the supplied conditions on the composite resource.

func WithGroupVersionKind ¶

func WithGroupVersionKind(gvk schema.GroupVersionKind) Option

WithGroupVersionKind sets the GroupVersionKind of the composite resource.

func WithSchema ¶

func WithSchema(s Schema) Option

WithSchema sets the schema of the composite resource.

type Schema ¶

type Schema int

Schema specifies the schema version of a composite resource's Crossplane machinery fields.

const (
	// SchemaModern indicates a modern Namespaced or Cluster scope composite
	// resource. Modern composite resources nest all Crossplane machinery fields
	// under spec.crossplane and status.crossplane, and can't be claimed.
	SchemaModern Schema = iota

	// SchemaLegacy indicates a LegacyCluster scope composite resource. Legacy
	// composite resources don't nest Crossplane machinery fields - they're set
	// directly under spec and status. Legacy composite resources can be claimed.
	SchemaLegacy
)

type Unstructured ¶

type Unstructured struct {
	unstructured.Unstructured

	Schema Schema
}

An Unstructured composite resource.

func New ¶

func New(opts ...Option) *Unstructured

New returns a new unstructured composite resource.

func (*Unstructured) DeepCopy ¶

func (in *Unstructured) DeepCopy() *Unstructured

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

func (*Unstructured) DeepCopyInto ¶

func (in *Unstructured) DeepCopyInto(out *Unstructured)

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

func (*Unstructured) DeepCopyObject ¶

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

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

func (*Unstructured) GetClaimConditionTypes ¶

func (c *Unstructured) GetClaimConditionTypes() []xpv1.ConditionType

GetClaimConditionTypes of this composite resource.

func (*Unstructured) GetClaimReference ¶

func (c *Unstructured) GetClaimReference() *reference.Claim

GetClaimReference of this composite resource.

func (*Unstructured) GetCompositionReference ¶

func (c *Unstructured) GetCompositionReference() *corev1.ObjectReference

GetCompositionReference of this composite resource.

func (*Unstructured) GetCompositionRevisionReference ¶

func (c *Unstructured) GetCompositionRevisionReference() *corev1.LocalObjectReference

GetCompositionRevisionReference of this composite resource.

func (*Unstructured) GetCompositionRevisionSelector ¶

func (c *Unstructured) GetCompositionRevisionSelector() *metav1.LabelSelector

GetCompositionRevisionSelector of this resource claim.

func (*Unstructured) GetCompositionSelector ¶

func (c *Unstructured) GetCompositionSelector() *metav1.LabelSelector

GetCompositionSelector of this composite resource.

func (*Unstructured) GetCompositionUpdatePolicy ¶

func (c *Unstructured) GetCompositionUpdatePolicy() *xpv1.UpdatePolicy

GetCompositionUpdatePolicy of this composite resource.

func (*Unstructured) GetCondition ¶

func (c *Unstructured) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this composite resource.

func (*Unstructured) GetConditions ¶

func (c *Unstructured) GetConditions() []xpv1.Condition

GetConditions of this composite resource.

func (*Unstructured) GetConnectionDetailsLastPublishedTime ¶

func (c *Unstructured) GetConnectionDetailsLastPublishedTime() *metav1.Time

GetConnectionDetailsLastPublishedTime of this composite resource.

func (*Unstructured) GetObservedGeneration ¶

func (c *Unstructured) GetObservedGeneration() int64

GetObservedGeneration of this composite resource claim.

func (*Unstructured) GetReference ¶

func (c *Unstructured) GetReference() *reference.Composite

GetReference returns reference to this composite.

func (*Unstructured) GetResourceReferences ¶

func (c *Unstructured) GetResourceReferences() []corev1.ObjectReference

GetResourceReferences of this composite resource.

func (*Unstructured) GetUnstructured ¶

func (c *Unstructured) GetUnstructured() *unstructured.Unstructured

GetUnstructured returns the underlying *unstructured.Unstructured.

func (*Unstructured) GetWriteConnectionSecretToReference ¶

func (c *Unstructured) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this composite resource.

func (*Unstructured) SetClaimConditionTypes ¶

func (c *Unstructured) SetClaimConditionTypes(in ...xpv1.ConditionType) error

SetClaimConditionTypes of this composite resource. You cannot set system condition types such as Ready, Synced or Healthy as claim conditions.

func (*Unstructured) SetClaimReference ¶

func (c *Unstructured) SetClaimReference(ref *reference.Claim)

SetClaimReference of this composite resource.

func (*Unstructured) SetCompositionReference ¶

func (c *Unstructured) SetCompositionReference(ref *corev1.ObjectReference)

SetCompositionReference of this composite resource.

func (*Unstructured) SetCompositionRevisionReference ¶

func (c *Unstructured) SetCompositionRevisionReference(ref *corev1.LocalObjectReference)

SetCompositionRevisionReference of this composite resource.

func (*Unstructured) SetCompositionRevisionSelector ¶

func (c *Unstructured) SetCompositionRevisionSelector(sel *metav1.LabelSelector)

SetCompositionRevisionSelector of this resource claim.

func (*Unstructured) SetCompositionSelector ¶

func (c *Unstructured) SetCompositionSelector(sel *metav1.LabelSelector)

SetCompositionSelector of this composite resource.

func (*Unstructured) SetCompositionUpdatePolicy ¶

func (c *Unstructured) SetCompositionUpdatePolicy(p *xpv1.UpdatePolicy)

SetCompositionUpdatePolicy of this composite resource.

func (*Unstructured) SetConditions ¶

func (c *Unstructured) SetConditions(conditions ...xpv1.Condition)

SetConditions of this composite resource.

func (*Unstructured) SetConnectionDetailsLastPublishedTime ¶

func (c *Unstructured) SetConnectionDetailsLastPublishedTime(t *metav1.Time)

SetConnectionDetailsLastPublishedTime of this composite resource.

func (*Unstructured) SetObservedGeneration ¶

func (c *Unstructured) SetObservedGeneration(generation int64)

SetObservedGeneration of this composite resource claim.

func (*Unstructured) SetResourceReferences ¶

func (c *Unstructured) SetResourceReferences(refs []corev1.ObjectReference)

SetResourceReferences of this composite resource.

func (*Unstructured) SetWriteConnectionSecretToReference ¶

func (c *Unstructured) SetWriteConnectionSecretToReference(ref *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this composite resource.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL