placement

Documentation

Overview

Package placement is a generated GoMock package.

Index

• type Client
  • func NewClient(opts ...Option) (Client, error)
• type MockClient
  • func NewMockClient(ctrl *gomock.Controller) *MockClient
  • func (m *MockClient) Add(instances []*placementpb.Instance) error
  • func (m *MockClient) Delete() error
  • func (m *MockClient) EXPECT() *MockClientMockRecorder
  • func (m *MockClient) Get() (placement.Placement, error)
  • func (m *MockClient) Init(request *admin.PlacementInitRequest) error
  • func (m *MockClient) Remove(instanceIds []string) error
  • func (m *MockClient) Replace(leavingInstanceID string, newInstance placementpb.Instance) error
  • func (m *MockClient) Set(request *admin.PlacementSetRequest) error
• type MockClientMockRecorder
  • func (mr *MockClientMockRecorder) Add(instances interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder) Delete() *gomock.Call
  • func (mr *MockClientMockRecorder) Get() *gomock.Call
  • func (mr *MockClientMockRecorder) Init(request interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder) Remove(instanceIds interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder) Replace(leavingInstanceID, newInstance interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder) Set(request interface{}) *gomock.Call
• type Option
  • func WithClient(cl m3admin.Client) Option
  • func WithLogger(logger *zap.Logger) Option
  • func WithURL(u string) Option

Types

type Client

type Client interface {
	// Init will initialize a placement give a valid placement request
	Init(request *admin.PlacementInitRequest) error
	// Set will forcefully override a placement with a given value.
	Set(request *admin.PlacementSetRequest) error
	// Get will provide the current placement
	Get() (placement m3placement.Placement, err error)
	// Delete will delete the current placement
	Delete() error
	// Add will add an instance to the placement
	Add(instances []*placementpb.Instance) error
	// Remove removes instances with the given IDs from the placement.
	Remove(instanceIds []string) error
	// Replace replaces one instance with another.
	Replace(leavingInstanceID string, newInstance placementpb.Instance) error
}

Client provides the interface to interact with the placement API

func NewClient

func NewClient(opts ...Option) (Client, error)

NewClient is the constructor the Placement interface

type MockClient

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

MockClient is a mock of Client interface.

func NewMockClient

func NewMockClient(ctrl *gomock.Controller) *MockClient

NewMockClient creates a new mock instance.

func (*MockClient) Add

func (m *MockClient) Add(instances []*placementpb.Instance) error

Add mocks base method.

func (*MockClient) Delete

func (m *MockClient) Delete() error

Delete mocks base method.

func (*MockClient) EXPECT

func (m *MockClient) EXPECT() *MockClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClient) Get

func (m *MockClient) Get() (placement.Placement, error)

Get mocks base method.

func (*MockClient) Init

func (m *MockClient) Init(request *admin.PlacementInitRequest) error

Init mocks base method.

func (*MockClient) Remove

func (m *MockClient) Remove(instanceIds []string) error

Remove mocks base method.

func (*MockClient) Replace

func (m *MockClient) Replace(leavingInstanceID string, newInstance placementpb.Instance) error

Replace mocks base method.

func (*MockClient) Set

func (m *MockClient) Set(request *admin.PlacementSetRequest) error

Set mocks base method.

type MockClientMockRecorder

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

MockClientMockRecorder is the mock recorder for MockClient.

func (*MockClientMockRecorder) Add

func (mr *MockClientMockRecorder) Add(instances interface{}) *gomock.Call

Add indicates an expected call of Add.

func (*MockClientMockRecorder) Delete

func (mr *MockClientMockRecorder) Delete() *gomock.Call

Delete indicates an expected call of Delete.

func (*MockClientMockRecorder) Get

func (mr *MockClientMockRecorder) Get() *gomock.Call

Get indicates an expected call of Get.

func (*MockClientMockRecorder) Init

func (mr *MockClientMockRecorder) Init(request interface{}) *gomock.Call

Init indicates an expected call of Init.

func (*MockClientMockRecorder) Remove

func (mr *MockClientMockRecorder) Remove(instanceIds interface{}) *gomock.Call

Remove indicates an expected call of Remove.

func (*MockClientMockRecorder) Replace

func (mr *MockClientMockRecorder) Replace(leavingInstanceID, newInstance interface{}) *gomock.Call

Replace indicates an expected call of Replace.

func (*MockClientMockRecorder) Set

func (mr *MockClientMockRecorder) Set(request interface{}) *gomock.Call

Set indicates an expected call of Set.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option provides an interface that can be used for setter options with the constructor

func WithClient

func WithClient(cl m3admin.Client) Option

WithClient configures an m3admin client.

func WithLogger

func WithLogger(logger *zap.Logger) Option

WithLogger is a setter to override the default logger

func WithURL

func WithURL(u string) Option

WithURL is a setter to override the default URL