import "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
helpers.go unstructured.go unstructured_list.go zz_generated.deepcopy.go
UnstructuredJSONScheme is capable of converting JSON data into the Unstructured type, which can be used for generic access to objects without a predefined scheme. TODO: move into serializer/json.
NestedBool returns the bool value of a nested field. Returns false if value is not found and an error if not a bool.
NestedFieldCopy returns a deep copy of the value of a nested field. Returns false if the value is missing. No error is returned for a nil field.
Note: fields passed to this function are treated as keys within the passed object; no array/slice syntax is supported.
NestedFieldNoCopy returns a reference to a nested field. Returns false if value is not found and an error if unable to traverse obj.
Note: fields passed to this function are treated as keys within the passed object; no array/slice syntax is supported.
NestedFloat64 returns the float64 value of a nested field. Returns false if value is not found and an error if not a float64.
NestedInt64 returns the int64 value of a nested field. Returns false if value is not found and an error if not an int64.
NestedMap returns a deep copy of map[string]interface{} value of a nested field. Returns false if value is not found and an error if not a map[string]interface{}.
NestedSlice returns a deep copy of []interface{} value of a nested field. Returns false if value is not found and an error if not a []interface{}.
NestedString returns the string value of a nested field. Returns false if value is not found and an error if not a string.
func NestedStringMap(obj map[string]interface{}, fields ...string) (map[string]string, bool, error)
NestedStringMap returns a copy of map[string]string value of a nested field. Returns false if value is not found and an error if not a map[string]interface{} or contains non-string values in the map.
NestedStringSlice returns a copy of []string value of a nested field. Returns false if value is not found and an error if not a []interface{} or contains non-string items in the slice.
RemoveNestedField removes the nested field from the obj.
SetNestedField sets the value of a nested field to a deep copy of the value provided. Returns an error if value cannot be set because one of the nesting levels is not a map[string]interface{}.
func SetNestedMap(obj map[string]interface{}, value map[string]interface{}, fields ...string) error
SetNestedMap sets the map[string]interface{} value of a nested field. Returns an error if value cannot be set because one of the nesting levels is not a map[string]interface{}.
SetNestedSlice sets the slice value of a nested field. Returns an error if value cannot be set because one of the nesting levels is not a map[string]interface{}.
func SetNestedStringMap(obj map[string]interface{}, value map[string]string, fields ...string) error
SetNestedStringMap sets the map[string]string value of a nested field. Returns an error if value cannot be set because one of the nesting levels is not a map[string]interface{}.
SetNestedStringSlice sets the string slice value of a nested field. Returns an error if value cannot be set because one of the nesting levels is not a map[string]interface{}.
type Unstructured struct {
// Object is a JSON compatible map with string, float, int, bool, []interface{}, or
// map[string]interface{}
// children.
Object map[string]interface{}
}Unstructured allows objects that do not have Golang structs registered to be manipulated generically. This can be used to deal with the API objects from a plug-in. Unstructured objects still have functioning TypeMeta features-- kind, version, etc.
WARNING: This object has accessors for the v1 standard metadata. You *MUST NOT* use this type if you are dealing with objects that are not in the server meta v1 schema.
TODO: make the serialization part of this type distinct from the field accessors. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:deepcopy-gen=true
func (in *Unstructured) DeepCopy() *Unstructured
func (in *Unstructured) DeepCopyInto(out *Unstructured)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *Unstructured) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (u *Unstructured) GetAPIVersion() string
func (u *Unstructured) GetAnnotations() map[string]string
func (u *Unstructured) GetClusterName() string
func (u *Unstructured) GetContinue() string
func (u *Unstructured) GetCreationTimestamp() metav1.Time
func (u *Unstructured) GetDeletionGracePeriodSeconds() *int64
func (u *Unstructured) GetDeletionTimestamp() *metav1.Time
func (u *Unstructured) GetFinalizers() []string
func (u *Unstructured) GetGenerateName() string
func (u *Unstructured) GetGeneration() int64
func (u *Unstructured) GetKind() string
func (u *Unstructured) GetLabels() map[string]string
func (u *Unstructured) GetManagedFields() []metav1.ManagedFieldsEntry
func (u *Unstructured) GetName() string
func (u *Unstructured) GetNamespace() string
func (obj *Unstructured) GetObjectKind() schema.ObjectKind
func (u *Unstructured) GetOwnerReferences() []metav1.OwnerReference
func (u *Unstructured) GetRemainingItemCount() *int64
func (u *Unstructured) GetResourceVersion() string
func (u *Unstructured) GetSelfLink() string
func (u *Unstructured) GetUID() types.UID
func (u *Unstructured) GroupVersionKind() schema.GroupVersionKind
func (obj *Unstructured) IsList() bool
func (u *Unstructured) MarshalJSON() ([]byte, error)
MarshalJSON ensures that the unstructured object produces proper JSON when passed to Go's standard JSON library.
func (in *Unstructured) NewEmptyInstance() runtime.Unstructured
NewEmptyInstance returns a new instance of the concrete type containing only kind/apiVersion and no other data. This should be called instead of reflect.New() for unstructured types because the go type alone does not preserve kind/apiVersion info.
func (u *Unstructured) SetAPIVersion(version string)
func (u *Unstructured) SetAnnotations(annotations map[string]string)
func (u *Unstructured) SetClusterName(clusterName string)
func (u *Unstructured) SetContinue(c string)
func (u *Unstructured) SetCreationTimestamp(timestamp metav1.Time)
func (u *Unstructured) SetDeletionGracePeriodSeconds(deletionGracePeriodSeconds *int64)
func (u *Unstructured) SetDeletionTimestamp(timestamp *metav1.Time)
func (u *Unstructured) SetFinalizers(finalizers []string)
func (u *Unstructured) SetGenerateName(generateName string)
func (u *Unstructured) SetGeneration(generation int64)
func (u *Unstructured) SetGroupVersionKind(gvk schema.GroupVersionKind)
func (u *Unstructured) SetKind(kind string)
func (u *Unstructured) SetLabels(labels map[string]string)
func (u *Unstructured) SetManagedFields(managedFields []metav1.ManagedFieldsEntry)
func (u *Unstructured) SetName(name string)
func (u *Unstructured) SetNamespace(namespace string)
func (u *Unstructured) SetOwnerReferences(references []metav1.OwnerReference)
func (u *Unstructured) SetRemainingItemCount(c *int64)
func (u *Unstructured) SetResourceVersion(resourceVersion string)
func (u *Unstructured) SetSelfLink(selfLink string)
func (u *Unstructured) SetUID(uid types.UID)
func (obj *Unstructured) SetUnstructuredContent(content map[string]interface{})
func (obj *Unstructured) ToList() (*UnstructuredList, error)
func (u *Unstructured) UnmarshalJSON(b []byte) error
UnmarshalJSON ensures that the unstructured object properly decodes JSON when passed to Go's standard JSON library.
func (obj *Unstructured) UnstructuredContent() map[string]interface{}
type UnstructuredList struct {
Object map[string]interface{}
// Items is a list of unstructured objects.
Items []Unstructured `json:"items"`
}UnstructuredList allows lists that do not have Golang structs registered to be manipulated generically. This can be used to deal with the API lists from a plug-in. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +k8s:deepcopy-gen=true
func (u *UnstructuredList) DeepCopy() *UnstructuredList
func (in *UnstructuredList) DeepCopyInto(out *UnstructuredList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *UnstructuredList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (u *UnstructuredList) GetAPIVersion() string
func (u *UnstructuredList) GetContinue() string
func (u *UnstructuredList) GetKind() string
func (u *UnstructuredList) GetObjectKind() schema.ObjectKind
func (u *UnstructuredList) GetRemainingItemCount() *int64
func (u *UnstructuredList) GetResourceVersion() string
func (u *UnstructuredList) GetSelfLink() string
func (u *UnstructuredList) GroupVersionKind() schema.GroupVersionKind
func (u *UnstructuredList) IsList() bool
func (u *UnstructuredList) MarshalJSON() ([]byte, error)
MarshalJSON ensures that the unstructured list object produces proper JSON when passed to Go's standard JSON library.
func (u *UnstructuredList) NewEmptyInstance() runtime.Unstructured
NewEmptyInstance returns a new instance of the concrete type containing only kind/apiVersion and no other data. This should be called instead of reflect.New() for unstructured types because the go type alone does not preserve kind/apiVersion info.
func (u *UnstructuredList) SetAPIVersion(version string)
func (u *UnstructuredList) SetContinue(c string)
func (u *UnstructuredList) SetGroupVersionKind(gvk schema.GroupVersionKind)
func (u *UnstructuredList) SetKind(kind string)
func (u *UnstructuredList) SetRemainingItemCount(c *int64)
func (u *UnstructuredList) SetResourceVersion(version string)
func (u *UnstructuredList) SetSelfLink(selfLink string)
func (obj *UnstructuredList) SetUnstructuredContent(content map[string]interface{})
SetUnstructuredContent obeys the conventions of List and keeps Items and the items array in sync. If items is not an array of objects in the incoming map, then any mismatched item will be removed.
func (u *UnstructuredList) UnmarshalJSON(b []byte) error
UnmarshalJSON ensures that the unstructured list object properly decodes JSON when passed to Go's standard JSON library.
func (u *UnstructuredList) UnstructuredContent() map[string]interface{}
UnstructuredContent returns a map contain an overlay of the Items field onto the Object field. Items always overwrites overlay.
| Path | Synopsis |
|---|---|
| unstructuredscheme |
Package unstructured imports 13 packages (graph) and is imported by 2289 packages. Updated 2020-09-17. Refresh now. Tools for package owners.