1// Copyright 2016 The etcd 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
15package api
16
17import (
18	"github.com/coreos/etcd/etcdserver/membership"
19	"github.com/coreos/etcd/pkg/types"
20
21	"github.com/coreos/go-semver/semver"
22)
23
24// Cluster is an interface representing a collection of members in one etcd cluster.
25type Cluster interface {
26	// ID returns the cluster ID
27	ID() types.ID
28	// ClientURLs returns an aggregate set of all URLs on which this
29	// cluster is listening for client requests
30	ClientURLs() []string
31	// Members returns a slice of members sorted by their ID
32	Members() []*membership.Member
33	// Member retrieves a particular member based on ID, or nil if the
34	// member does not exist in the cluster
35	Member(id types.ID) *membership.Member
36	// IsIDRemoved checks whether the given ID has been removed from this
37	// cluster at some point in the past
38	IsIDRemoved(id types.ID) bool
39	// Version is the cluster-wide minimum major.minor version.
40	Version() *semver.Version
41}
42