Documentation
¶
Index ¶
- Variables
- func ConvertTag(in unikornv1.Tag) openapi.Tag
- func ConvertTags(in unikornv1.TagList) openapi.TagList
- func GenerateTag(in openapi.Tag) unikornv1.Tag
- func GenerateTagList(in *openapi.TagList) unikornv1.TagList
- func LogUpdate(ctx context.Context, current, required metav1.Object) error
- func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.OrganizationScopedResourceReadMetadata
- func ProjectScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.ProjectScopedResourceReadMetadata
- func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.ResourceReadMetadata
- func UpdateObjectMetadata(required, current metav1.Object, mutators ...MetadataMutationFunc) error
- type MetadataMutationFunc
- type ObjectMetadata
Constants ¶
This section is empty.
Variables ¶
var (
ErrAnnotation = errors.New("a required annotation was missing")
)
Functions ¶
func OrganizationScopedResourceReadMetadata ¶
func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.OrganizationScopedResourceReadMetadata
OrganizationScopedResourceReadMetadata extracts organization scoped metdata from a resource for GET APIS.
func ProjectScopedResourceReadMetadata ¶
func ProjectScopedResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.ProjectScopedResourceReadMetadata
ProjectScopedResourceReadMetadata extracts project scoped metdata from a resource for GET APIs.
func ResourceReadMetadata ¶
ResourceReadMetadata extracts generic metadata from a resource for GET APIs.
func UpdateObjectMetadata ¶
func UpdateObjectMetadata(required, current metav1.Object, mutators ...MetadataMutationFunc) error
UpdateObjectMetadata abstracts away metadata updates.
Types ¶
type MetadataMutationFunc ¶ added in v1.4.0
MetadataMutationFunc is used to mutate metadata on update.
type ObjectMetadata ¶
type ObjectMetadata metav1.ObjectMeta
ObjectMetadata implements a builder pattern.
func NewObjectMetadata ¶
func NewObjectMetadata(metadata *openapi.ResourceWriteMetadata, namespace string) *ObjectMetadata
NewObjectMetadata requests the bare minimum to build an object metadata object.
func (*ObjectMetadata) Get ¶
func (o *ObjectMetadata) Get() metav1.ObjectMeta
Get renders the object metadata ready for inclusion into a Kubernetes resource.
func (*ObjectMetadata) WithLabel ¶
func (o *ObjectMetadata) WithLabel(key, value string) *ObjectMetadata
WithLabel allows non-generic labels to be attached to a resource.
func (*ObjectMetadata) WithOrganization ¶
func (o *ObjectMetadata) WithOrganization(id string) *ObjectMetadata
WithOrganization adds an organization for scoped resources.
func (*ObjectMetadata) WithProject ¶
func (o *ObjectMetadata) WithProject(id string) *ObjectMetadata
WithProject adds a project for scoped resources.