elements

Documentation

Overview

Package elements contains builders for elements of a component version, aka resources, sources and references. The package itself contains builders for resource/source metadata and component references.

The sub package artifactblob contains packages for building technology specific blob resources/sources. When added to a component version they result in local blobs.

The sub package artifactaccess contains packages for building technology specific access specification based referential resources/sources. When added to a component version they result in external access specifications.

Index

• func Reference(name, comp, vers string, opts ...ReferenceOption) (*compdesc.ComponentReference, error)
• func ResourceMeta(name, typ string, opts ...ResourceMetaOption) (*compdesc.ResourceMeta, error)
• func SourceMeta(name, typ string, opts ...SourceMetaOption) (*compdesc.SourceMeta, error)
• func WithSourceRef(sel ...string) *srcref
• type ArtifactOption
• type CommonOption
  • func WithExtraIdentity(extras ...string) CommonOption
  • func WithLabel(name string, value interface{}, opts ...metav1.LabelOption) CommonOption
  • func WithVersion(v string) CommonOption
• type ReferenceOption
• type ResourceMetaOption
  • func WithExternalRelation(flag ...bool) ResourceMetaOption
  • func WithLocalRelation(flag ...bool) ResourceMetaOption
• type ResourceReferenceOption
  • func WithDigest(algo, norm, value string) ResourceReferenceOption
• type SourceMetaOption

Functions

func Reference

func Reference(name, comp, vers string, opts ...ReferenceOption) (*compdesc.ComponentReference, error)

func ResourceMeta

func ResourceMeta(name, typ string, opts ...ResourceMetaOption) (*compdesc.ResourceMeta, error)

func SourceMeta

func SourceMeta(name, typ string, opts ...SourceMetaOption) (*compdesc.SourceMeta, error)

func WithSourceRef

func WithSourceRef(sel ...string) *srcref

WithSourceRef adds a source reference to a resource meta object. this is a sequence of name/value pairs. Optionally, additional labels can be added with srcref.WithLabel.

Types

type ArtifactOption

type ArtifactOption interface {
	ResourceMetaOption
	SourceMetaOption
}

type CommonOption

type CommonOption interface {
	ResourceMetaOption
	SourceMetaOption
	ReferenceOption
}

func WithExtraIdentity

func WithExtraIdentity(extras ...string) CommonOption

WithExtraIdentity adds extra identity properties.

func WithLabel

func WithLabel(name string, value interface{}, opts ...metav1.LabelOption) CommonOption

func WithVersion

func WithVersion(v string) CommonOption

WithVersion sets the version of the element.

type ReferenceOption

type ReferenceOption interface {
	ApplyToReference(reference *compdesc.ComponentReference) error
}

type ResourceMetaOption

type ResourceMetaOption interface {
	ApplyToResourceMeta(*compdesc.ResourceMeta) error
}

func WithExternalRelation

func WithExternalRelation(flag ...bool) ResourceMetaOption

WithExternalRelation sets the resource relation to metav1.ExternalRelation.

func WithLocalRelation

func WithLocalRelation(flag ...bool) ResourceMetaOption

WithLocalRelation sets the resource relation to metav1.LocalRelation.

type ResourceReferenceOption

type ResourceReferenceOption interface {
	ResourceMetaOption
	ReferenceOption
}

func WithDigest

func WithDigest(algo, norm, value string) ResourceReferenceOption

WithDigest sets digest information. at least one value should be set.

type SourceMetaOption

type SourceMetaOption interface {
	ApplyToSourceMeta(*compdesc.SourceMeta) error
}