istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/config/resource/origin.go (about)

     1  // Copyright Istio Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package resource
    16  
    17  import "istio.io/istio/pkg/cluster"
    18  
    19  // Origin of a resource. This is source-implementation dependent.
    20  type Origin interface {
    21  	FriendlyName() string
    22  	Namespace() Namespace
    23  	Reference() Reference
    24  
    25  	// FieldMap returns the flat map containing paths of the fields in the resource as keys,
    26  	// and their corresponding line numbers as values
    27  	FieldMap() map[string]int
    28  	Comparator() string
    29  
    30  	// ClusterName returns the cluster name where the resource is located
    31  	ClusterName() cluster.ID
    32  }
    33  
    34  // Reference provides more information about an Origin. This is also source-implementation dependent.
    35  type Reference interface {
    36  	String() string
    37  }