go_api

Documentation

Overview

Package go_api is a generated protocol buffer package.

It is generated from these files:

github.com/micro/go-micro/api/proto/api.proto

It has these top-level messages:

Pair
Request
Response
Event

Index

• type Event
  • func (*Event) Descriptor() ([]byte, []int)
  • func (m *Event) GetData() string
  • func (m *Event) GetHeader() map[string]*Pair
  • func (m *Event) GetId() string
  • func (m *Event) GetName() string
  • func (m *Event) GetTimestamp() int64
  • func (*Event) ProtoMessage()
  • func (m *Event) Reset()
  • func (m *Event) String() string
  • func (m *Event) XXX_DiscardUnknown()
  • func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *Event) XXX_Merge(src proto.Message)
  • func (m *Event) XXX_Size() int
  • func (m *Event) XXX_Unmarshal(b []byte) error
• type Pair
  • func (*Pair) Descriptor() ([]byte, []int)
  • func (m *Pair) GetKey() string
  • func (m *Pair) GetValues() []string
  • func (*Pair) ProtoMessage()
  • func (m *Pair) Reset()
  • func (m *Pair) String() string
  • func (m *Pair) XXX_DiscardUnknown()
  • func (m *Pair) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *Pair) XXX_Merge(src proto.Message)
  • func (m *Pair) XXX_Size() int
  • func (m *Pair) XXX_Unmarshal(b []byte) error
• type Request
  • func (*Request) Descriptor() ([]byte, []int)
  • func (m *Request) GetBody() string
  • func (m *Request) GetGet() map[string]*Pair
  • func (m *Request) GetHeader() map[string]*Pair
  • func (m *Request) GetMethod() string
  • func (m *Request) GetPath() string
  • func (m *Request) GetPost() map[string]*Pair
  • func (m *Request) GetUrl() string
  • func (*Request) ProtoMessage()
  • func (m *Request) Reset()
  • func (m *Request) String() string
  • func (m *Request) XXX_DiscardUnknown()
  • func (m *Request) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *Request) XXX_Merge(src proto.Message)
  • func (m *Request) XXX_Size() int
  • func (m *Request) XXX_Unmarshal(b []byte) error
• type Response
  • func (*Response) Descriptor() ([]byte, []int)
  • func (m *Response) GetBody() string
  • func (m *Response) GetHeader() map[string]*Pair
  • func (m *Response) GetStatusCode() int32
  • func (*Response) ProtoMessage()
  • func (m *Response) Reset()
  • func (m *Response) String() string
  • func (m *Response) XXX_DiscardUnknown()
  • func (m *Response) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *Response) XXX_Merge(src proto.Message)
  • func (m *Response) XXX_Size() int
  • func (m *Response) XXX_Unmarshal(b []byte) error

Types

type Event

type Event struct {
	// e.g login
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// uuid
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// unix timestamp of event
	Timestamp int64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// event headers
	Header map[string]*Pair `` /* 153-byte string literal not displayed */
	// the event data
	Data                 string   `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A HTTP event as RPC Forwarded by the event handler

func (*Event) Descriptor

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

func (*Event) GetData

func (m *Event) GetData() string

func (*Event) GetHeader

func (m *Event) GetHeader() map[string]*Pair

func (*Event) GetId

func (m *Event) GetId() string

func (*Event) GetName

func (m *Event) GetName() string

func (*Event) GetTimestamp

func (m *Event) GetTimestamp() int64

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) Reset

func (m *Event) Reset()

func (*Event) String

func (m *Event) String() string

func (*Event) XXX_DiscardUnknown

func (m *Event) XXX_DiscardUnknown()

func (*Event) XXX_Marshal

func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Event) XXX_Merge

func (dst *Event) XXX_Merge(src proto.Message)

func (*Event) XXX_Size

func (m *Event) XXX_Size() int

func (*Event) XXX_Unmarshal

func (m *Event) XXX_Unmarshal(b []byte) error

type Pair

type Pair struct {
	Key                  string   `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Values               []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Pair) Descriptor

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

func (*Pair) GetKey

func (m *Pair) GetKey() string

func (*Pair) GetValues

func (m *Pair) GetValues() []string

func (*Pair) ProtoMessage

func (*Pair) ProtoMessage()

func (*Pair) Reset

func (m *Pair) Reset()

func (*Pair) String

func (m *Pair) String() string

func (*Pair) XXX_DiscardUnknown

func (m *Pair) XXX_DiscardUnknown()

func (*Pair) XXX_Marshal

func (m *Pair) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Pair) XXX_Merge

func (dst *Pair) XXX_Merge(src proto.Message)

func (*Pair) XXX_Size

func (m *Pair) XXX_Size() int

func (*Pair) XXX_Unmarshal

func (m *Pair) XXX_Unmarshal(b []byte) error

type Request

type Request struct {
	Method               string           `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	Path                 string           `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	Header               map[string]*Pair `` /* 153-byte string literal not displayed */
	Get                  map[string]*Pair `` /* 147-byte string literal not displayed */
	Post                 map[string]*Pair `` /* 149-byte string literal not displayed */
	Body                 string           `protobuf:"bytes,6,opt,name=body,proto3" json:"body,omitempty"`
	Url                  string           `protobuf:"bytes,7,opt,name=url,proto3" json:"url,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

A HTTP request as RPC Forward by the api handler

func (*Request) Descriptor

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

func (*Request) GetBody

func (m *Request) GetBody() string

func (*Request) GetGet

func (m *Request) GetGet() map[string]*Pair

func (*Request) GetHeader

func (m *Request) GetHeader() map[string]*Pair

func (*Request) GetMethod

func (m *Request) GetMethod() string

func (*Request) GetPath

func (m *Request) GetPath() string

func (*Request) GetPost

func (m *Request) GetPost() map[string]*Pair

func (*Request) GetUrl

func (m *Request) GetUrl() string

func (*Request) ProtoMessage

func (*Request) ProtoMessage()

func (*Request) Reset

func (m *Request) Reset()

func (*Request) String

func (m *Request) String() string

func (*Request) XXX_DiscardUnknown

func (m *Request) XXX_DiscardUnknown()

func (*Request) XXX_Marshal

func (m *Request) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Request) XXX_Merge

func (dst *Request) XXX_Merge(src proto.Message)

func (*Request) XXX_Size

func (m *Request) XXX_Size() int

func (*Request) XXX_Unmarshal

func (m *Request) XXX_Unmarshal(b []byte) error

type Response

type Response struct {
	StatusCode           int32            `protobuf:"varint,1,opt,name=statusCode,proto3" json:"statusCode,omitempty"`
	Header               map[string]*Pair `` /* 153-byte string literal not displayed */
	Body                 string           `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

A HTTP response as RPC Expected response for the api handler

func (*Response) Descriptor

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

func (*Response) GetBody

func (m *Response) GetBody() string

func (*Response) GetHeader

func (m *Response) GetHeader() map[string]*Pair

func (*Response) GetStatusCode

func (m *Response) GetStatusCode() int32

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) Reset

func (m *Response) Reset()

func (*Response) String

func (m *Response) String() string

func (*Response) XXX_DiscardUnknown

func (m *Response) XXX_DiscardUnknown()

func (*Response) XXX_Marshal

func (m *Response) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Response) XXX_Merge

func (dst *Response) XXX_Merge(src proto.Message)

func (*Response) XXX_Size

func (m *Response) XXX_Size() int

func (*Response) XXX_Unmarshal

func (m *Response) XXX_Unmarshal(b []byte) error