shard

Documentation

Index

• Constants
• Variables
• type Name
  • func New(name string) Name
  • func (n Name) Empty() bool
  • func (n Name) Path() string
  • func (n Name) String() string

Constants

const (
	// AnnotationKey is the name of the annotation key used to denote an object's shard name.
	AnnotationKey = "kcp.io/shard"
)

Variables

var (
	// Wildcard is the name indicating cross-shards requests.
	Wildcard = Name("*")
)

Types

type Name

type Name string

Name hold the name of a shard. It is used by the cache-server to assign resources to a particular shard.

func New

func New(name string) Name

New returns a new instance of Name from a string.

func (Name) Empty

func (n Name) Empty() bool

Empty returns true if the name of the shard is empty.

func (Name) Path

func (n Name) Path() string

Path returns a path segment for the shard to access its API.

func (Name) String

func (n Name) String() string

String returns the string representation of the shard name.