/
types.go
55 lines (46 loc) · 2.36 KB
/
types.go
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
// Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 client
import (
"context"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
)
// Finalizer checks and removes the finalizers of given resource.
type Finalizer interface {
// Finalize removes the resource finalizers (so it can be garbage collected).
Finalize(ctx context.Context, c client.Client, obj client.Object) error
// HasFinalizers checks whether the given resource has finalizers.
HasFinalizers(obj client.Object) (bool, error)
}
// Cleaner is capable of deleting and finalizing resources.
type Cleaner interface {
// Clean cleans the given resource(s). It first tries to delete them. If they are 'hanging'
// in deletion state and `FinalizeGracePeriodSeconds` is specified, then they are finalized
// once the `deletionTimestamp` is beyond that amount in the past.
Clean(ctx context.Context, c client.Client, obj runtime.Object, opts ...CleanOption) error
}
// GoneEnsurer ensures that resource(s) are gone.
type GoneEnsurer interface {
// EnsureGone ensures that the given resource is gone. If the resource is not gone, it will throw
// a NewObjectsRemaining error.
EnsureGone(ctx context.Context, c client.Client, obj runtime.Object, opts ...client.ListOption) error
}
// GoneEnsurerFunc is a function that implements GoneEnsurer.
type GoneEnsurerFunc func(ctx context.Context, c client.Client, obj runtime.Object, opts ...client.ListOption) error
// CleanOps are ops to clean.
type CleanOps interface {
// CleanAndEnsureGone cleans the resource(s) and ensures that it/they are gone afterwards.
CleanAndEnsureGone(ctx context.Context, c client.Client, obj runtime.Object, opts ...CleanOption) error
}