sigs.k8s.io/cluster-api-provider-aws@v1.5.5/pkg/annotations/annotations.go (about)

     1  /*
     2  Copyright 2022 The Kubernetes 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 annotations
    18  
    19  import (
    20  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    21  )
    22  
    23  // Set will set the value of an annotation on the supplied object. If there is no annotation it will be created.
    24  func Set(obj metav1.Object, name, value string) {
    25  	annotations := obj.GetAnnotations()
    26  	if annotations == nil {
    27  		annotations = map[string]string{}
    28  	}
    29  	annotations[name] = value
    30  	obj.SetAnnotations(annotations)
    31  }
    32  
    33  // Get will get the value of the supplied annotation.
    34  func Get(obj metav1.Object, name string) (value string, found bool) {
    35  	annotations := obj.GetAnnotations()
    36  	if len(annotations) == 0 {
    37  		return "", false
    38  	}
    39  
    40  	value, found = annotations[name]
    41  
    42  	return
    43  }
    44  
    45  // Has returns true if the supplied object has the supplied annotation.
    46  func Has(obj metav1.Object, name string) bool {
    47  	annotations := obj.GetAnnotations()
    48  	if len(annotations) == 0 {
    49  		return false
    50  	}
    51  
    52  	_, found := annotations[name]
    53  
    54  	return found
    55  }