1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
// This file is @generated by prost-build.
/// RawExtension is used to hold extensions in external versions.
///
/// To use this, make a field which has RawExtension as its type in your external, versioned
/// struct, and Object in your internal struct. You also need to register your
/// various plugin types.
///
/// // Internal package:
///
/// type MyAPIObject struct {
/// runtime.TypeMeta `json:",inline"`
/// MyPlugin runtime.Object `json:"myPlugin"`
/// }
///
/// type PluginA struct {
/// AOption string `json:"aOption"`
/// }
///
/// // External package:
///
/// type MyAPIObject struct {
/// runtime.TypeMeta `json:",inline"`
/// MyPlugin runtime.RawExtension `json:"myPlugin"`
/// }
///
/// type PluginA struct {
/// AOption string `json:"aOption"`
/// }
///
/// // On the wire, the JSON will look something like this:
///
/// {
/// "kind":"MyAPIObject",
/// "apiVersion":"v1",
/// "myPlugin": {
/// "kind":"PluginA",
/// "aOption":"foo",
/// },
/// }
///
/// So what happens? Decode first uses json or yaml to unmarshal the serialized data into
/// your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked.
/// The next step is to copy (using pkg/conversion) into the internal struct. The runtime
/// package's DefaultScheme has conversion functions installed which will unpack the
/// JSON stored in RawExtension, turning it into the correct object type, and storing it
/// in the Object. (TODO: In the case where the object is of an unknown type, a
/// runtime.Unknown object will be created and stored.)
///
/// +k8s:deepcopy-gen=true
/// +protobuf=true
/// +k8s:openapi-gen=true
/// TypeMeta is shared by all top level objects. The proper way to use it is to inline it in your type,
/// like this:
///
/// type MyAwesomeAPIObject struct {
/// runtime.TypeMeta `json:",inline"`
/// ... // other fields
/// }
///
/// func (obj *MyAwesomeAPIObject) SetGroupVersionKind(gvk *metav1.GroupVersionKind) { metav1.UpdateTypeMeta(obj,gvk) }; GroupVersionKind() *GroupVersionKind
///
/// TypeMeta is provided here for convenience. You may use it directly from this package or define
/// your own with the same fields.
///
/// +k8s:deepcopy-gen=false
/// +protobuf=true
/// +k8s:openapi-gen=true
/// Unknown allows api objects with unknown types to be passed-through. This can be used
/// to deal with the API objects from a plug-in. Unknown objects still have functioning
/// TypeMeta features-- kind, version, etc.
/// TODO: Make this object have easy access to field based accessors and settors for
/// metadata and field mutatation.
///
/// +k8s:deepcopy-gen=true
/// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
/// +protobuf=true
/// +k8s:openapi-gen=true