api

Documentation

Overview

Package api is a generated protocol buffer package.

It is generated from these files:

github.com/tomogoma/usersms/pkg/api/status.proto

It has these top-level messages:

Request
Response

Index

• func RegisterStatusHandler(s server.Server, hdlr StatusHandler, opts ...server.HandlerOption)
• type Key
  • func (k Key) Value() []byte
• type Request
  • func (*Request) Descriptor() ([]byte, []int)
  • func (m *Request) GetAPIKey() string
  • func (*Request) ProtoMessage()
  • func (m *Request) Reset()
  • func (m *Request) String() string
• type Response
  • func (*Response) Descriptor() ([]byte, []int)
  • func (m *Response) GetCanonicalName() string
  • func (m *Response) GetDescription() string
  • func (m *Response) GetName() string
  • func (m *Response) GetVersion() string
  • func (*Response) ProtoMessage()
  • func (m *Response) Reset()
  • func (m *Response) String() string
• type Status
  • func (h *Status) Check(ctx context.Context, in *Request, out *Response) error
• type StatusClient
  • func NewStatusClient(serviceName string, c client.Client) StatusClient
• type StatusHandler

Functions

func RegisterStatusHandler

func RegisterStatusHandler(s server.Server, hdlr StatusHandler, opts ...server.HandlerOption)

Types

type Key

type Key struct {
	ID          string
	UserID      string
	Val         []byte
	Created     time.Time
	LastUpdated time.Time
}

func (Key) Value

func (k Key) Value() []byte

type Request

type Request struct {
	APIKey string `protobuf:"bytes,1,opt,name=APIKey" json:"APIKey,omitempty"`
}

func (*Request) Descriptor

func (*Request) Descriptor() ([]byte, []int)

func (*Request) GetAPIKey

func (m *Request) GetAPIKey() string

func (*Request) ProtoMessage

func (*Request) ProtoMessage()

func (*Request) Reset

func (m *Request) Reset()

func (*Request) String

func (m *Request) String() string

type Response

type Response struct {
	Name          string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Version       string `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
	Description   string `protobuf:"bytes,3,opt,name=description" json:"description,omitempty"`
	CanonicalName string `protobuf:"bytes,4,opt,name=canonicalName" json:"canonicalName,omitempty"`
}

func (*Response) Descriptor

func (*Response) Descriptor() ([]byte, []int)

func (*Response) GetCanonicalName

func (m *Response) GetCanonicalName() string

func (*Response) GetDescription

func (m *Response) GetDescription() string

func (*Response) GetName

func (m *Response) GetName() string

func (*Response) GetVersion

func (m *Response) GetVersion() string

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) Reset

func (m *Response) Reset()

func (*Response) String

func (m *Response) String() string

type Status

type Status struct {
	StatusHandler
}

func (*Status) Check

func (h *Status) Check(ctx context.Context, in *Request, out *Response) error

type StatusClient

type StatusClient interface {
	Check(ctx context.Context, in *Request, opts ...client.CallOption) (*Response, error)
}

func NewStatusClient

func NewStatusClient(serviceName string, c client.Client) StatusClient

type StatusHandler

type StatusHandler interface {
	Check(context.Context, *Request, *Response) error
}