mirror of
https://github.com/optim-enterprises-bv/kubernetes.git
synced 2025-11-04 12:18:16 +00:00
778a50d00b
Will allow clients to transform internal objects to a version suitable for external output.
72 lines
2.4 KiB
Go
72 lines
2.4 KiB
Go
/*
|
|
Copyright 2014 Google Inc. All rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package runtime
|
|
|
|
// Decoder defines methods for deserializing API objects into a given type
|
|
type Decoder interface {
|
|
Decode(data []byte) (Object, error)
|
|
DecodeInto(data []byte, obj Object) error
|
|
}
|
|
|
|
// Encoder defines methods for serializing API objects into bytes
|
|
type Encoder interface {
|
|
Encode(obj Object) (data []byte, err error)
|
|
}
|
|
|
|
// Codec defines methods for serializing and deserializing API objects.
|
|
type Codec interface {
|
|
Decoder
|
|
Encoder
|
|
}
|
|
|
|
// ObjectConvertor converts an object to a different version.
|
|
type ObjectConvertor interface {
|
|
ConvertToVersion(in Object, outVersion string) (out Object, err error)
|
|
}
|
|
|
|
// ObjectTyper contains methods for extracting the APIVersion and Kind
|
|
// of objects.
|
|
type ObjectTyper interface {
|
|
DataVersionAndKind([]byte) (version, kind string, err error)
|
|
ObjectVersionAndKind(Object) (version, kind string, err error)
|
|
}
|
|
|
|
// ResourceVersioner provides methods for setting and retrieving
|
|
// the resource version from an API object.
|
|
type ResourceVersioner interface {
|
|
SetResourceVersion(obj Object, version string) error
|
|
ResourceVersion(obj Object) (string, error)
|
|
}
|
|
|
|
// SelfLinker provides methods for setting and retrieving the SelfLink field of an API object.
|
|
type SelfLinker interface {
|
|
SetSelfLink(obj Object, selfLink string) error
|
|
SelfLink(obj Object) (string, error)
|
|
|
|
// Knowing Name is sometimes necessary to use a SelfLinker.
|
|
Name(obj Object) (string, error)
|
|
}
|
|
|
|
// All api types must support the Object interface. It's deliberately tiny so that this is not an onerous
|
|
// burden. Implement it with a pointer reciever; this will allow us to use the go compiler to check the
|
|
// one thing about our objects that it's capable of checking for us.
|
|
type Object interface {
|
|
// This function is used only to enforce membership. It's never called.
|
|
// TODO: Consider mass rename in the future to make it do something useful.
|
|
IsAnAPIObject()
|
|
}
|