1 /* 2 Copyright 2023 The cert-manager Authors. 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations under the License. 15 */ 16 17 package signer 18 19 import ( 20 cmapi "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1" 21 cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1" 22 ) 23 24 // The SetCertificateRequestConditionError error is meant to be returned by the 25 // Sign function. When Sign returns this error, the caller (i.e., the certificate 26 // request controller) is expected to update the CertificateRequest with the 27 // condition contained in the error. 28 // 29 // The error wrapped by this error is the error can still be a signer.Permanent or 30 // signer.Pending error and will be handled accordingly. 31 // 32 // > This error should be returned only by the Sign function. 33 type SetCertificateRequestConditionError struct { 34 Err error 35 ConditionType cmapi.CertificateRequestConditionType 36 Status cmmeta.ConditionStatus 37 Reason string 38 } 39 40 var _ error = SetCertificateRequestConditionError{} 41 42 func (ve SetCertificateRequestConditionError) Unwrap() error { 43 return ve.Err 44 } 45 46 func (ve SetCertificateRequestConditionError) Error() string { 47 return ve.Err.Error() 48 } 49