cmd/bpa-operator/vendor/k8s.io/apimachinery/pkg/types/namespacedname.go

   1 /*
   2 Copyright 2015 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 types
  18
  19 import (
  20         "fmt"
  21 )
  22
  23 // NamespacedName comprises a resource name, with a mandatory namespace,
  24 // rendered as "<namespace>/<name>".  Being a type captures intent and
  25 // helps make sure that UIDs, namespaced names and non-namespaced names
  26 // do not get conflated in code.  For most use cases, namespace and name
  27 // will already have been format validated at the API entry point, so we
  28 // don't do that here.  Where that's not the case (e.g. in testing),
  29 // consider using NamespacedNameOrDie() in testing.go in this package.
  30
  31 type NamespacedName struct {
  32         Namespace string
  33         Name      string
  34 }
  35
  36 const (
  37         Separator = '/'
  38 )
  39
  40 // String returns the general purpose string representation
  41 func (n NamespacedName) String() string {
  42         return fmt.Sprintf("%s%c%s", n.Namespace, Separator, n.Name)
  43 }