cert-manager/pkg/controller/acmeorders/selectors/selector.go
Jake Sanders f194d9b732
Add godoc comments
Signed-off-by: Jake Sanders <i@am.so-aweso.me>
2021-05-05 15:59:02 +01:00

35 lines
1.2 KiB
Go

/*
Copyright 2020 The cert-manager Authors.
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 selectors
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// Selector determines whether a kubernetes object matches the
// criteria checked by the implementation.
type Selector interface {
// Matches returns the number of matches that this selector
// has with the given object metadata and dnsName.
// The greater the returned number, the more 'specific' of a
// match this meta/dnsName pair has with this selector.
// In some cases, the selector may 'match' (i.e. the bool == true),
// but the number of matches may be zero (i.e. for a label selector,
// where an empty selector matches all).
Matches(meta metav1.ObjectMeta, dnsName string) (bool, int)
}