vitess.io/vitess@v0.16.2/go/vt/vtadmin/http/debug/debug.go (about)

     1  /*
     2  Copyright 2021 The Vitess 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 debug
    18  
    19  import "vitess.io/vitess/go/vt/vtadmin/cluster"
    20  
    21  // API defines the interface needed to provide debug info for a vtadmin.API.
    22  // This is implemented by a private wrapper struct in package vtadmin, to
    23  // prevent debug needs from polluting the public interface of the actual API.
    24  type API interface {
    25  	// Cluster returns a cluster by id, with the same semantics as a map lookup.
    26  	Cluster(id string) (*cluster.Cluster, bool)
    27  	// Clusters returns a slice of all clusters in the API.
    28  	Clusters() []*cluster.Cluster
    29  }