blob: b3fd8af3001effc5f04e47453fc54c949bb96fc3 [file] [log] [blame]
Matthias Andreas Benkard832a54e2019-01-29 09:27:38 +01001/*
2Copyright 2015 The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17package rest
18
19import (
20 "context"
21
22 "k8s.io/apimachinery/pkg/runtime"
23)
24
25// RESTExportStrategy is the interface that defines how to export a Kubernetes
26// object. An exported object is stripped of non-user-settable fields and
27// optionally, the identifying information related to the object's identity in
28// the cluster so that it can be loaded into a different namespace or entirely
29// different cluster without conflict.
30type RESTExportStrategy interface {
31 // Export strips fields that can not be set by the user. If 'exact' is false
32 // fields specific to the cluster are also stripped
33 Export(ctx context.Context, obj runtime.Object, exact bool) error
34}