operations

Documentation

Index

• func Operations() map[string]Operation
• func Register(name string, op Operation) error
• type Base
  • func (b *Base) Do(ctx context.Context, request *OpsRequest) (*OpsResponse, error)
  • func (b *Base) Init(ctx context.Context) error
  • func (b *Base) IsReadonly(ctx context.Context) bool
  • func (b *Base) PreCheck(ctx context.Context, request *OpsRequest) error
  • func (b *Base) SetTimeout(timeout time.Duration)
• type FakeFuncType
• type FakeOperations
  • func NewFakeOperations(funcType FakeFuncType, fakeFunc interface{}) *FakeOperations
  • func (f *FakeOperations) Do(ctx context.Context, request *OpsRequest) (*OpsResponse, error)
  • func (f *FakeOperations) Init(ctx context.Context) error
  • func (f *FakeOperations) IsReadonly(ctx context.Context) bool
  • func (f *FakeOperations) PreCheck(ctx context.Context, request *OpsRequest) error
  • func (f *FakeOperations) SetTimeout(timeout time.Duration)
• type Operation
• type Ops
  • func (ops *Ops) Operations() map[string]Operation
  • func (ops *Ops) Register(name string, op Operation) error
• type OpsMetadata
• type OpsRequest
  • func (r *OpsRequest) GetBool(key string) bool
  • func (r *OpsRequest) GetString(key string) string
• type OpsResponse
  • func NewOpsResponse(operation util.OperationKind) *OpsResponse
  • func (resp *OpsResponse) WithError(err error) (*OpsResponse, error)
  • func (resp *OpsResponse) WithSuccess(msg string) (*OpsResponse, error)

Functions

func Operations

func Operations() map[string]Operation

func Register

func Register(name string, op Operation) error

Types

type Base

type Base struct {
	Timeout time.Duration
	Command []string
}

func (*Base) Do

func (b *Base) Do(ctx context.Context, request *OpsRequest) (*OpsResponse, error)

func (*Base) Init

func (b *Base) Init(ctx context.Context) error

func (*Base) IsReadonly

func (b *Base) IsReadonly(ctx context.Context) bool

func (*Base) PreCheck

func (b *Base) PreCheck(ctx context.Context, request *OpsRequest) error

func (*Base) SetTimeout

func (b *Base) SetTimeout(timeout time.Duration)

type FakeFuncType

type FakeFuncType string

const (
	FakeInit       FakeFuncType = "fake-init"
	FakeIsReadOnly FakeFuncType = "fake-is-read-only"
	FakePreCheck   FakeFuncType = "fake-pre-check"
	FakeDo         FakeFuncType = "fake-do"
	FakeDefault    FakeFuncType = "fake-default"
)

type FakeOperations

type FakeOperations struct {
	InitFunc       func(ctx context.Context) error
	IsReadOnlyFunc func(ctx context.Context) bool
	PreCheckFunc   func(ctx context.Context, request *OpsRequest) error
	DoFunc         func(ctx context.Context, request *OpsRequest) (*OpsResponse, error)
}

func NewFakeOperations

func NewFakeOperations(funcType FakeFuncType, fakeFunc interface{}) *FakeOperations

func (*FakeOperations) Do

func (f *FakeOperations) Do(ctx context.Context, request *OpsRequest) (*OpsResponse, error)

func (*FakeOperations) Init

func (f *FakeOperations) Init(ctx context.Context) error

func (*FakeOperations) IsReadonly

func (f *FakeOperations) IsReadonly(ctx context.Context) bool

func (*FakeOperations) PreCheck

func (f *FakeOperations) PreCheck(ctx context.Context, request *OpsRequest) error

func (*FakeOperations) SetTimeout

func (f *FakeOperations) SetTimeout(timeout time.Duration)

type Operation

type Operation interface {
	Init(context.Context) error
	SetTimeout(timeout time.Duration)
	IsReadonly(context.Context) bool
	PreCheck(context.Context, *OpsRequest) error
	Do(context.Context, *OpsRequest) (*OpsResponse, error)
}

type Ops

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

func (*Ops) Operations

func (ops *Ops) Operations() map[string]Operation

func (*Ops) Register

func (ops *Ops) Register(name string, op Operation) error

type OpsMetadata

type OpsMetadata struct {
	Operation util.OperationKind `json:"operation,omitempty"`
	StartTime string             `json:"startTime,omitempty"`
	EndTime   string             `json:"endTime,omitempty"`
	Extra     string             `json:"extra,omitempty"`
}

type OpsRequest

type OpsRequest struct {
	Data       []byte         `json:"data,omitempty"`
	Parameters map[string]any `json:"parameters,omitempty"`
}

OpsRequest is the request for Operation

func (*OpsRequest) GetBool

func (r *OpsRequest) GetBool(key string) bool

func (*OpsRequest) GetString

func (r *OpsRequest) GetString(key string) string

type OpsResponse

type OpsResponse struct {
	Data     map[string]any    `json:"data,omitempty"`
	Metadata map[string]string `json:"metadata,omitempty"`
}

OpsResponse is the response for Operation

func NewOpsResponse

func NewOpsResponse(operation util.OperationKind) *OpsResponse

func (*OpsResponse) WithError

func (resp *OpsResponse) WithError(err error) (*OpsResponse, error)

func (*OpsResponse) WithSuccess

func (resp *OpsResponse) WithSuccess(msg string) (*OpsResponse, error)