client

Documentation

Index

• func MediaTypeFromGR(gr schema.GroupResource) (mediaType string, err error)
• func PrefixFromGR(gr schema.GroupResource) (prefix string, err error)
• type Client
  • func NewClient(conf Config) (Client, error)
• type Config
• type KeyValue
• type Op
• type OpOption
  • func WithGR(gr schema.GroupResource) OpOption
  • func WithKeysOnly() OpOption
  • func WithName(name, namespace string) OpOption
  • func WithPageLimit(pageLimit int64) OpOption
  • func WithResponse(response func(kv *KeyValue) error) OpOption
  • func WithRevision(revision int64) OpOption

Functions

func MediaTypeFromGR

func MediaTypeFromGR(gr schema.GroupResource) (mediaType string, err error)

MediaTypeFromGR returns the media type of the given GroupResource.

func PrefixFromGR

func PrefixFromGR(gr schema.GroupResource) (prefix string, err error)

PrefixFromGR returns the prefix of the given GroupResource.

Types

type Client

type Client interface {
	// Get is a method that retrieves a key-value pair from the etcd server.
	// It returns the revision of the key-value pair
	Get(ctx context.Context, prefix string, opOpts ...OpOption) (rev int64, err error)

	// Watch is a method that watches for changes to a key-value pair on the etcd server.
	Watch(ctx context.Context, prefix string, opOpts ...OpOption) error

	// Delete is a method that deletes a key-value pair from the etcd server.
	Delete(ctx context.Context, prefix string, opOpts ...OpOption) error

	// Put is a method that sets a key-value pair on the etcd server.
	Put(ctx context.Context, prefix string, value []byte, opOpts ...OpOption) error
}

Client is an interface that defines the operations that can be performed on an etcd client.

func NewClient

func NewClient(conf Config) (Client, error)

NewClient creates a new etcd client.

type Config

type Config = clientv3.Config

type KeyValue

type KeyValue struct {
	Key       []byte
	Value     []byte
	PrevValue []byte
}

KeyValue is the key-value pair.

type Op

type Op struct {
	// contains filtered or unexported fields
}

Op is the option for the operation.

type OpOption

type OpOption func(*Op)

OpOption is the option for the operation.

func WithGR

func WithGR(gr schema.GroupResource) OpOption

WithGR sets the gr for the target.

func WithKeysOnly

func WithKeysOnly() OpOption

WithKeysOnly sets the keys only for the target.

func WithName

func WithName(name, namespace string) OpOption

WithName sets the name and namespace for the target.

func WithPageLimit

func WithPageLimit(pageLimit int64) OpOption

WithPageLimit sets the page limit for the target.

func WithResponse

func WithResponse(response func(kv *KeyValue) error) OpOption

WithResponse sets the response callback for the target.

func WithRevision

func WithRevision(revision int64) OpOption

WithRevision sets the revision for the target.