m3admin

Documentation

Overview

Package m3admin is a generated GoMock package.

Index

• Variables
• func JSONPBMarshal(w io.Writer, msg proto.Message) error
• func JSONPBUnmarshal(r io.Reader, msg proto.Message) error
• type Client
  • func NewClient(clientOpts ...Option) Client
• type MockClient
  • func NewMockClient(ctrl *gomock.Controller) *MockClient
  • func (m *MockClient) DoHTTPJSONPBRequest(action, url string, request, response proto.Message, opts ...RequestOption) error
  • func (m *MockClient) DoHTTPRequest(action, url string, data *bytes.Buffer, opts ...RequestOption) (*http.Response, error)
  • func (m *MockClient) EXPECT() *MockClientMockRecorder
• type MockClientMockRecorder
  • func (mr *MockClientMockRecorder) DoHTTPJSONPBRequest(action, url, request, response interface{}, opts ...interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder) DoHTTPRequest(action, url, data interface{}, opts ...interface{}) *gomock.Call
• type Option
  • func WithEnvironment(e string) Option
  • func WithHTTPClient(cl *retryhttp.Client) Option
  • func WithLogger(l *zap.Logger) Option
  • func WithZone(z string) Option
• type RequestOption
  • func WithHeader(name, value string) RequestOption

Variables

var (
	// ErrNotOk indicates that HTTP status was not Ok
	ErrNotOk = errors.New("status not ok")

	// ErrNotFound indicates that HTTP status was not found
	ErrNotFound = errors.New("status not found")

	// ErrMethodNotAllowed indicates that HTTP status was method not allowed
	ErrMethodNotAllowed = errors.New("method not allowed")
)

Functions

func JSONPBMarshal

func JSONPBMarshal(w io.Writer, msg proto.Message) error

JSONPBMarshal marshals a JSON protobuf message, just using defaults for the marshaller currently.

func JSONPBUnmarshal

func JSONPBUnmarshal(r io.Reader, msg proto.Message) error

JSONPBUnmarshal unmarshals a JSON protobuf message, allowing for backwards compatible changes by allowing unknown fields to exist when unmarshalling response (new fields will get added and need to be able to be unmarshalled by an old operator calling endpoints on a new coordinator or DB node).

Types

type Client

type Client interface {
	DoHTTPRequest(action, url string, data *bytes.Buffer, opts ...RequestOption) (*http.Response, error)
	DoHTTPJSONPBRequest(action, url string, request, response proto.Message, opts ...RequestOption) error
}

Client is an m3admin client.

func NewClient

func NewClient(clientOpts ...Option) Client

NewClient returns a new m3admin client.

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) DoHTTPJSONPBRequest

func (m *MockClient) DoHTTPJSONPBRequest(action, url string, request, response proto.Message, opts ...RequestOption) error

DoHTTPJSONPBRequest mocks base method.

func (*MockClient) DoHTTPRequest

func (m *MockClient) DoHTTPRequest(action, url string, data *bytes.Buffer, opts ...RequestOption) (*http.Response, error)

DoHTTPRequest mocks base method.

func (*MockClient) EXPECT

func (m *MockClient) EXPECT() *MockClientMockRecorder

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

type MockClientMockRecorder

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

MockClientMockRecorder is the mock recorder for MockClient.

func (*MockClientMockRecorder) DoHTTPJSONPBRequest

func (mr *MockClientMockRecorder) DoHTTPJSONPBRequest(action, url, request, response interface{}, opts ...interface{}) *gomock.Call

DoHTTPJSONPBRequest indicates an expected call of DoHTTPJSONPBRequest.

func (*MockClientMockRecorder) DoHTTPRequest

func (mr *MockClientMockRecorder) DoHTTPRequest(action, url, data interface{}, opts ...interface{}) *gomock.Call

DoHTTPRequest indicates an expected call of DoHTTPRequest.

type Option

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

Option configures an m3admin client.

func WithEnvironment

func WithEnvironment(e string) Option

WithEnvironment controls the Cluster-Environment-Name header to m3coordinator.

func WithHTTPClient

func WithHTTPClient(cl *retryhttp.Client) Option

WithHTTPClient configures an http client for the m3admin client. If not set, go-retryablehttp's default client will be used. Note that the retry client's logger will be overridden with the stdlog-wrapped wrapped zap logger.

func WithLogger

func WithLogger(l *zap.Logger) Option

WithLogger configures a logger for the client. If not set a noop logger will be used.

func WithZone

func WithZone(z string) Option

WithZone controls the Cluster-Zone-Name header to m3coordinator.

type RequestOption

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

RequestOption defines a per-request option.

func WithHeader

func WithHeader(name, value string) RequestOption

WithHeader adds a header to a request. It can be specified multiple times.