serve

Documentation

Overview

Package serve is a generated protocol buffer package.

It is generated from these files:

serve.proto

It has these top-level messages:

GetFileRequest
GetFileResponse
GetAnnotationsRequest
GetAnnotationsResponse
GetFilesRequest
GetFilesResponse
GetPackagesRequest
GetPackagesResponse

Package serve is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• func RegisterGorefHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterGorefHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterGorefServer(s *grpc.Server, srv GorefServer)
• type GetAnnotationsRequest
  • func (*GetAnnotationsRequest) Descriptor() ([]byte, []int)
  • func (m *GetAnnotationsRequest) GetPath() string
  • func (*GetAnnotationsRequest) ProtoMessage()
  • func (m *GetAnnotationsRequest) Reset()
  • func (m *GetAnnotationsRequest) String() string
• type GetAnnotationsResponse
  • func (*GetAnnotationsResponse) Descriptor() ([]byte, []int)
  • func (m *GetAnnotationsResponse) GetAnnotation() []*goref.Ref
  • func (m *GetAnnotationsResponse) GetPath() string
  • func (*GetAnnotationsResponse) ProtoMessage()
  • func (m *GetAnnotationsResponse) Reset()
  • func (m *GetAnnotationsResponse) String() string
• type GetFileRequest
  • func (*GetFileRequest) Descriptor() ([]byte, []int)
  • func (m *GetFileRequest) GetPath() string
  • func (*GetFileRequest) ProtoMessage()
  • func (m *GetFileRequest) Reset()
  • func (m *GetFileRequest) String() string
• type GetFileResponse
  • func (*GetFileResponse) Descriptor() ([]byte, []int)
  • func (m *GetFileResponse) GetContents() string
  • func (m *GetFileResponse) GetPath() string
  • func (*GetFileResponse) ProtoMessage()
  • func (m *GetFileResponse) Reset()
  • func (m *GetFileResponse) String() string
• type GetFilesRequest
  • func (*GetFilesRequest) Descriptor() ([]byte, []int)
  • func (m *GetFilesRequest) GetPackage() string
  • func (*GetFilesRequest) ProtoMessage()
  • func (m *GetFilesRequest) Reset()
  • func (m *GetFilesRequest) String() string
• type GetFilesResponse
  • func (*GetFilesResponse) Descriptor() ([]byte, []int)
  • func (m *GetFilesResponse) GetFilename() []string
  • func (m *GetFilesResponse) GetPackage() string
  • func (*GetFilesResponse) ProtoMessage()
  • func (m *GetFilesResponse) Reset()
  • func (m *GetFilesResponse) String() string
• type GetPackagesRequest
  • func (*GetPackagesRequest) Descriptor() ([]byte, []int)
  • func (m *GetPackagesRequest) GetIncludeVendor() bool
  • func (m *GetPackagesRequest) GetPrefix() string
  • func (*GetPackagesRequest) ProtoMessage()
  • func (m *GetPackagesRequest) Reset()
  • func (m *GetPackagesRequest) String() string
• type GetPackagesResponse
  • func (*GetPackagesResponse) Descriptor() ([]byte, []int)
  • func (m *GetPackagesResponse) GetPackage() []string
  • func (*GetPackagesResponse) ProtoMessage()
  • func (m *GetPackagesResponse) Reset()
  • func (m *GetPackagesResponse) String() string
• type GorefClient
  • func NewGorefClient(cc *grpc.ClientConn) GorefClient
• type GorefServer

Functions

func RegisterGorefHandler

func RegisterGorefHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterGorefHandler registers the http handlers for service Goref to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterGorefHandlerFromEndpoint

func RegisterGorefHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterGorefHandlerFromEndpoint is same as RegisterGorefHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterGorefServer

func RegisterGorefServer(s *grpc.Server, srv GorefServer)

Types

type GetAnnotationsRequest

type GetAnnotationsRequest struct {
	Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
}

func (*GetAnnotationsRequest) Descriptor

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

func (*GetAnnotationsRequest) GetPath

func (m *GetAnnotationsRequest) GetPath() string

func (*GetAnnotationsRequest) ProtoMessage

func (*GetAnnotationsRequest) ProtoMessage()

func (*GetAnnotationsRequest) Reset

func (m *GetAnnotationsRequest) Reset()

func (*GetAnnotationsRequest) String

func (m *GetAnnotationsRequest) String() string

type GetAnnotationsResponse

type GetAnnotationsResponse struct {
	Path       string       `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
	Annotation []*goref.Ref `protobuf:"bytes,2,rep,name=annotation" json:"annotation,omitempty"`
}

func (*GetAnnotationsResponse) Descriptor

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

func (*GetAnnotationsResponse) GetAnnotation

func (m *GetAnnotationsResponse) GetAnnotation() []*goref.Ref

func (*GetAnnotationsResponse) GetPath

func (m *GetAnnotationsResponse) GetPath() string

func (*GetAnnotationsResponse) ProtoMessage

func (*GetAnnotationsResponse) ProtoMessage()

func (*GetAnnotationsResponse) Reset

func (m *GetAnnotationsResponse) Reset()

func (*GetAnnotationsResponse) String

func (m *GetAnnotationsResponse) String() string

type GetFileRequest

type GetFileRequest struct {
	Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
}

func (*GetFileRequest) Descriptor

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

func (*GetFileRequest) GetPath

func (m *GetFileRequest) GetPath() string

func (*GetFileRequest) ProtoMessage

func (*GetFileRequest) ProtoMessage()

func (*GetFileRequest) Reset

func (m *GetFileRequest) Reset()

func (*GetFileRequest) String

func (m *GetFileRequest) String() string

type GetFileResponse

type GetFileResponse struct {
	Path     string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
	Contents string `protobuf:"bytes,2,opt,name=contents" json:"contents,omitempty"`
}

func (*GetFileResponse) Descriptor

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

func (*GetFileResponse) GetContents

func (m *GetFileResponse) GetContents() string

func (*GetFileResponse) GetPath

func (m *GetFileResponse) GetPath() string

func (*GetFileResponse) ProtoMessage

func (*GetFileResponse) ProtoMessage()

func (*GetFileResponse) Reset

func (m *GetFileResponse) Reset()

func (*GetFileResponse) String

func (m *GetFileResponse) String() string

type GetFilesRequest

type GetFilesRequest struct {
	Package string `protobuf:"bytes,1,opt,name=package" json:"package,omitempty"`
}

func (*GetFilesRequest) Descriptor

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

func (*GetFilesRequest) GetPackage

func (m *GetFilesRequest) GetPackage() string

func (*GetFilesRequest) ProtoMessage

func (*GetFilesRequest) ProtoMessage()

func (*GetFilesRequest) Reset

func (m *GetFilesRequest) Reset()

func (*GetFilesRequest) String

func (m *GetFilesRequest) String() string

type GetFilesResponse

type GetFilesResponse struct {
	Package  string   `protobuf:"bytes,1,opt,name=package" json:"package,omitempty"`
	Filename []string `protobuf:"bytes,2,rep,name=filename" json:"filename,omitempty"`
}

func (*GetFilesResponse) Descriptor

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

func (*GetFilesResponse) GetFilename

func (m *GetFilesResponse) GetFilename() []string

func (*GetFilesResponse) GetPackage

func (m *GetFilesResponse) GetPackage() string

func (*GetFilesResponse) ProtoMessage

func (*GetFilesResponse) ProtoMessage()

func (*GetFilesResponse) Reset

func (m *GetFilesResponse) Reset()

func (*GetFilesResponse) String

func (m *GetFilesResponse) String() string

type GetPackagesRequest

type GetPackagesRequest struct {
	Prefix        string `protobuf:"bytes,1,opt,name=prefix" json:"prefix,omitempty"`
	IncludeVendor bool   `protobuf:"varint,2,opt,name=includeVendor" json:"includeVendor,omitempty"`
}

func (*GetPackagesRequest) Descriptor

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

func (*GetPackagesRequest) GetIncludeVendor

func (m *GetPackagesRequest) GetIncludeVendor() bool

func (*GetPackagesRequest) GetPrefix

func (m *GetPackagesRequest) GetPrefix() string

func (*GetPackagesRequest) ProtoMessage

func (*GetPackagesRequest) ProtoMessage()

func (*GetPackagesRequest) Reset

func (m *GetPackagesRequest) Reset()

func (*GetPackagesRequest) String

func (m *GetPackagesRequest) String() string

type GetPackagesResponse

type GetPackagesResponse struct {
	Package []string `protobuf:"bytes,1,rep,name=package" json:"package,omitempty"`
}

func (*GetPackagesResponse) Descriptor

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

func (*GetPackagesResponse) GetPackage

func (m *GetPackagesResponse) GetPackage() []string

func (*GetPackagesResponse) ProtoMessage

func (*GetPackagesResponse) ProtoMessage()

func (*GetPackagesResponse) Reset

func (m *GetPackagesResponse) Reset()

func (*GetPackagesResponse) String

func (m *GetPackagesResponse) String() string

type GorefClient

type GorefClient interface {
	GetFile(ctx context.Context, in *GetFileRequest, opts ...grpc.CallOption) (*GetFileResponse, error)
	GetAnnotations(ctx context.Context, in *GetAnnotationsRequest, opts ...grpc.CallOption) (*GetAnnotationsResponse, error)
	GetFiles(ctx context.Context, in *GetFilesRequest, opts ...grpc.CallOption) (*GetFilesResponse, error)
	GetPackages(ctx context.Context, in *GetPackagesRequest, opts ...grpc.CallOption) (*GetPackagesResponse, error)
}

func NewGorefClient

func NewGorefClient(cc *grpc.ClientConn) GorefClient

type GorefServer

type GorefServer interface {
	GetFile(context.Context, *GetFileRequest) (*GetFileResponse, error)
	GetAnnotations(context.Context, *GetAnnotationsRequest) (*GetAnnotationsResponse, error)
	GetFiles(context.Context, *GetFilesRequest) (*GetFilesResponse, error)
	GetPackages(context.Context, *GetPackagesRequest) (*GetPackagesResponse, error)
}