rk_grpc_common_v1

package
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 8, 2021 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package rk_grpc_common_v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_v1_rk_common_service_proto protoreflect.FileDescriptor
View Source 
var File_v1_rk_gw_mapping_proto protoreflect.FileDescriptor
View Source 
var RkCommonService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "rk.api.v1.RkCommonService",
	HandlerType: (*RkCommonServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Healthy",
			Handler:    _RkCommonService_Healthy_Handler,
		},
		{
			MethodName: "Gc",
			Handler:    _RkCommonService_Gc_Handler,
		},
		{
			MethodName: "Info",
			Handler:    _RkCommonService_Info_Handler,
		},
		{
			MethodName: "Configs",
			Handler:    _RkCommonService_Configs_Handler,
		},
		{
			MethodName: "Apis",
			Handler:    _RkCommonService_Apis_Handler,
		},
		{
			MethodName: "Sys",
			Handler:    _RkCommonService_Sys_Handler,
		},
		{
			MethodName: "Req",
			Handler:    _RkCommonService_Req_Handler,
		},
		{
			MethodName: "Git",
			Handler:    _RkCommonService_Git_Handler,
		},
		{
			MethodName: "Entries",
			Handler:    _RkCommonService_Entries_Handler,
		},
		{
			MethodName: "Certs",
			Handler:    _RkCommonService_Certs_Handler,
		},
		{
			MethodName: "Logs",
			Handler:    _RkCommonService_Logs_Handler,
		},
		{
			MethodName: "Deps",
			Handler:    _RkCommonService_Deps_Handler,
		},
		{
			MethodName: "License",
			Handler:    _RkCommonService_License_Handler,
		},
		{
			MethodName: "Readme",
			Handler:    _RkCommonService_Readme_Handler,
		},
		{
			MethodName: "GwErrorMapping",
			Handler:    _RkCommonService_GwErrorMapping_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "v1/rk_common_service.proto",
}

RkCommonService_ServiceDesc is the grpc.ServiceDesc for RkCommonService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterRkCommonServiceHandler 

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

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

func RegisterRkCommonServiceHandlerClient 

func RegisterRkCommonServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client RkCommonServiceClient) error

RegisterRkCommonServiceHandlerClient registers the http handlers for service RkCommonService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "RkCommonServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "RkCommonServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "RkCommonServiceClient" to call the correct interceptors.

func RegisterRkCommonServiceHandlerFromEndpoint 

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

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

func RegisterRkCommonServiceHandlerServer 

func RegisterRkCommonServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server RkCommonServiceServer) error

RegisterRkCommonServiceHandlerServer registers the http handlers for service RkCommonService to "mux". UnaryRPC :call RkCommonServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterRkCommonServiceHandlerFromEndpoint instead.

func RegisterRkCommonServiceServer 

func RegisterRkCommonServiceServer(s grpc.ServiceRegistrar, srv RkCommonServiceServer)

Types

type ApisRequest 

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

func (*ApisRequest) Descriptor deprecated 

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

Deprecated: Use ApisRequest.ProtoReflect.Descriptor instead.

func (*ApisRequest) ProtoMessage 

func (*ApisRequest) ProtoMessage()

func (*ApisRequest) ProtoReflect 

func (x *ApisRequest) ProtoReflect() protoreflect.Message

func (*ApisRequest) Reset 

func (x *ApisRequest) Reset()

func (*ApisRequest) String 

func (x *ApisRequest) String() string

type CertsRequest 

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

func (*CertsRequest) Descriptor deprecated 

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

Deprecated: Use CertsRequest.ProtoReflect.Descriptor instead.

func (*CertsRequest) ProtoMessage 

func (*CertsRequest) ProtoMessage()

func (*CertsRequest) ProtoReflect 

func (x *CertsRequest) ProtoReflect() protoreflect.Message

func (*CertsRequest) Reset 

func (x *CertsRequest) Reset()

func (*CertsRequest) String 

func (x *CertsRequest) String() string

type ConfigsRequest 

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

func (*ConfigsRequest) Descriptor deprecated 

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

Deprecated: Use ConfigsRequest.ProtoReflect.Descriptor instead.

func (*ConfigsRequest) ProtoMessage 

func (*ConfigsRequest) ProtoMessage()

func (*ConfigsRequest) ProtoReflect 

func (x *ConfigsRequest) ProtoReflect() protoreflect.Message

func (*ConfigsRequest) Reset 

func (x *ConfigsRequest) Reset()

func (*ConfigsRequest) String 

func (x *ConfigsRequest) String() string

type DepsRequest 

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

func (*DepsRequest) Descriptor deprecated 

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

Deprecated: Use DepsRequest.ProtoReflect.Descriptor instead.

func (*DepsRequest) ProtoMessage 

func (*DepsRequest) ProtoMessage()

func (*DepsRequest) ProtoReflect 

func (x *DepsRequest) ProtoReflect() protoreflect.Message

func (*DepsRequest) Reset 

func (x *DepsRequest) Reset()

func (*DepsRequest) String 

func (x *DepsRequest) String() string

type EntriesRequest 

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

func (*EntriesRequest) Descriptor deprecated 

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

Deprecated: Use EntriesRequest.ProtoReflect.Descriptor instead.

func (*EntriesRequest) ProtoMessage 

func (*EntriesRequest) ProtoMessage()

func (*EntriesRequest) ProtoReflect 

func (x *EntriesRequest) ProtoReflect() protoreflect.Message

func (*EntriesRequest) Reset 

func (x *EntriesRequest) Reset()

func (*EntriesRequest) String 

func (x *EntriesRequest) String() string

type GcRequest 

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

func (*GcRequest) Descriptor deprecated 

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

Deprecated: Use GcRequest.ProtoReflect.Descriptor instead.

func (*GcRequest) ProtoMessage 

func (*GcRequest) ProtoMessage()

func (*GcRequest) ProtoReflect 

func (x *GcRequest) ProtoReflect() protoreflect.Message

func (*GcRequest) Reset 

func (x *GcRequest) Reset()

func (*GcRequest) String 

func (x *GcRequest) String() string

type GitRequest 

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

func (*GitRequest) Descriptor deprecated 

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

Deprecated: Use GitRequest.ProtoReflect.Descriptor instead.

func (*GitRequest) ProtoMessage 

func (*GitRequest) ProtoMessage()

func (*GitRequest) ProtoReflect 

func (x *GitRequest) ProtoReflect() protoreflect.Message

func (*GitRequest) Reset 

func (x *GitRequest) Reset()

func (*GitRequest) String 

func (x *GitRequest) String() string

type GrpcAPIService 

type GrpcAPIService struct {

	// Http Rule.
	Http *annotations.Http `protobuf:"bytes,1,opt,name=http,proto3" json:"http,omitempty"`
	// contains filtered or unexported fields
}

GrpcAPIService represents a stripped down version of google.api.Service . Compare to https://github.com/googleapis/googleapis/blob/master/google/api/service.proto The original imports 23 other protobuf files we are not interested in. If a significant subset (>50%) of these start being reproduced in this file we should swap to using the full generated version instead.

For the purposes of the gateway generator we only consider a small subset of all available features google supports in their service descriptions. Thanks to backwards compatibility guarantees by protobuf it is safe for us to remove the other fields.

func (*GrpcAPIService) Descriptor deprecated 

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

Deprecated: Use GrpcAPIService.ProtoReflect.Descriptor instead.

func (*GrpcAPIService) GetHttp 

func (x *GrpcAPIService) GetHttp() *annotations.Http

func (*GrpcAPIService) ProtoMessage 

func (*GrpcAPIService) ProtoMessage()

func (*GrpcAPIService) ProtoReflect 

func (x *GrpcAPIService) ProtoReflect() protoreflect.Message

func (*GrpcAPIService) Reset 

func (x *GrpcAPIService) Reset()

func (*GrpcAPIService) String 

func (x *GrpcAPIService) String() string

type GwErrorMappingRequest 

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

func (*GwErrorMappingRequest) Descriptor deprecated 

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

Deprecated: Use GwErrorMappingRequest.ProtoReflect.Descriptor instead.

func (*GwErrorMappingRequest) ProtoMessage 

func (*GwErrorMappingRequest) ProtoMessage()

func (*GwErrorMappingRequest) ProtoReflect 

func (x *GwErrorMappingRequest) ProtoReflect() protoreflect.Message

func (*GwErrorMappingRequest) Reset 

func (x *GwErrorMappingRequest) Reset()

func (*GwErrorMappingRequest) String 

func (x *GwErrorMappingRequest) String() string

type HealthyRequest 

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

func (*HealthyRequest) Descriptor deprecated 

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

Deprecated: Use HealthyRequest.ProtoReflect.Descriptor instead.

func (*HealthyRequest) ProtoMessage 

func (*HealthyRequest) ProtoMessage()

func (*HealthyRequest) ProtoReflect 

func (x *HealthyRequest) ProtoReflect() protoreflect.Message

func (*HealthyRequest) Reset 

func (x *HealthyRequest) Reset()

func (*HealthyRequest) String 

func (x *HealthyRequest) String() string

type InfoRequest 

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

func (*InfoRequest) Descriptor deprecated 

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

Deprecated: Use InfoRequest.ProtoReflect.Descriptor instead.

func (*InfoRequest) ProtoMessage 

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) ProtoReflect 

func (x *InfoRequest) ProtoReflect() protoreflect.Message

func (*InfoRequest) Reset 

func (x *InfoRequest) Reset()

func (*InfoRequest) String 

func (x *InfoRequest) String() string

type LicenseRequest 

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

func (*LicenseRequest) Descriptor deprecated 

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

Deprecated: Use LicenseRequest.ProtoReflect.Descriptor instead.

func (*LicenseRequest) ProtoMessage 

func (*LicenseRequest) ProtoMessage()

func (*LicenseRequest) ProtoReflect 

func (x *LicenseRequest) ProtoReflect() protoreflect.Message

func (*LicenseRequest) Reset 

func (x *LicenseRequest) Reset()

func (*LicenseRequest) String 

func (x *LicenseRequest) String() string

type LogsRequest 

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

func (*LogsRequest) Descriptor deprecated 

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

Deprecated: Use LogsRequest.ProtoReflect.Descriptor instead.

func (*LogsRequest) ProtoMessage 

func (*LogsRequest) ProtoMessage()

func (*LogsRequest) ProtoReflect 

func (x *LogsRequest) ProtoReflect() protoreflect.Message

func (*LogsRequest) Reset 

func (x *LogsRequest) Reset()

func (*LogsRequest) String 

func (x *LogsRequest) String() string

type ReadmeRequest 

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

func (*ReadmeRequest) Descriptor deprecated 

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

Deprecated: Use ReadmeRequest.ProtoReflect.Descriptor instead.

func (*ReadmeRequest) ProtoMessage 

func (*ReadmeRequest) ProtoMessage()

func (*ReadmeRequest) ProtoReflect 

func (x *ReadmeRequest) ProtoReflect() protoreflect.Message

func (*ReadmeRequest) Reset 

func (x *ReadmeRequest) Reset()

func (*ReadmeRequest) String 

func (x *ReadmeRequest) String() string

type ReqRequest 

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

func (*ReqRequest) Descriptor deprecated 

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

Deprecated: Use ReqRequest.ProtoReflect.Descriptor instead.

func (*ReqRequest) ProtoMessage 

func (*ReqRequest) ProtoMessage()

func (*ReqRequest) ProtoReflect 

func (x *ReqRequest) ProtoReflect() protoreflect.Message

func (*ReqRequest) Reset 

func (x *ReqRequest) Reset()

func (*ReqRequest) String 

func (x *ReqRequest) String() string

type RkCommonServiceClient 

type RkCommonServiceClient interface {
	// Get application healthy status
	Healthy(ctx context.Context, in *HealthyRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// Trigger Gc
	Gc(ctx context.Context, in *GcRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// Get application and process info
	Info(ctx context.Context, in *InfoRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List ConfigEntry
	Configs(ctx context.Context, in *ConfigsRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List API
	Apis(ctx context.Context, in *ApisRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// Get OS Stat
	Sys(ctx context.Context, in *SysRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List prometheus metrics of requests
	Req(ctx context.Context, in *ReqRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// Get git information
	Git(ctx context.Context, in *GitRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List all Entry
	Entries(ctx context.Context, in *EntriesRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List CertEntry
	Certs(ctx context.Context, in *CertsRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List logger related entries
	Logs(ctx context.Context, in *LogsRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List dependencies related application
	Deps(ctx context.Context, in *DepsRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// Get license related application
	License(ctx context.Context, in *LicenseRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List dependencies related application
	Readme(ctx context.Context, in *ReadmeRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
	// List grpc error to grpc-gateway error mappings.
	GwErrorMapping(ctx context.Context, in *GwErrorMappingRequest, opts ...grpc.CallOption) (*structpb.Struct, error)
}

RkCommonServiceClient is the client API for RkCommonService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewRkCommonServiceClient 

func NewRkCommonServiceClient(cc grpc.ClientConnInterface) RkCommonServiceClient

type RkCommonServiceServer 

type RkCommonServiceServer interface {
	// Get application healthy status
	Healthy(context.Context, *HealthyRequest) (*structpb.Struct, error)
	// Trigger Gc
	Gc(context.Context, *GcRequest) (*structpb.Struct, error)
	// Get application and process info
	Info(context.Context, *InfoRequest) (*structpb.Struct, error)
	// List ConfigEntry
	Configs(context.Context, *ConfigsRequest) (*structpb.Struct, error)
	// List API
	Apis(context.Context, *ApisRequest) (*structpb.Struct, error)
	// Get OS Stat
	Sys(context.Context, *SysRequest) (*structpb.Struct, error)
	// List prometheus metrics of requests
	Req(context.Context, *ReqRequest) (*structpb.Struct, error)
	// Get git information
	Git(context.Context, *GitRequest) (*structpb.Struct, error)
	// List all Entry
	Entries(context.Context, *EntriesRequest) (*structpb.Struct, error)
	// List CertEntry
	Certs(context.Context, *CertsRequest) (*structpb.Struct, error)
	// List logger related entries
	Logs(context.Context, *LogsRequest) (*structpb.Struct, error)
	// List dependencies related application
	Deps(context.Context, *DepsRequest) (*structpb.Struct, error)
	// Get license related application
	License(context.Context, *LicenseRequest) (*structpb.Struct, error)
	// List dependencies related application
	Readme(context.Context, *ReadmeRequest) (*structpb.Struct, error)
	// List grpc error to grpc-gateway error mappings.
	GwErrorMapping(context.Context, *GwErrorMappingRequest) (*structpb.Struct, error)
}

RkCommonServiceServer is the server API for RkCommonService service. All implementations should embed UnimplementedRkCommonServiceServer for forward compatibility

type SysRequest 

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

func (*SysRequest) Descriptor deprecated 

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

Deprecated: Use SysRequest.ProtoReflect.Descriptor instead.

func (*SysRequest) ProtoMessage 

func (*SysRequest) ProtoMessage()

func (*SysRequest) ProtoReflect 

func (x *SysRequest) ProtoReflect() protoreflect.Message

func (*SysRequest) Reset 

func (x *SysRequest) Reset()

func (*SysRequest) String 

func (x *SysRequest) String() string

type UnimplementedRkCommonServiceServer 

type UnimplementedRkCommonServiceServer struct {
}

UnimplementedRkCommonServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedRkCommonServiceServer) Apis 

func (UnimplementedRkCommonServiceServer) Apis(context.Context, *ApisRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Certs 

func (UnimplementedRkCommonServiceServer) Certs(context.Context, *CertsRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Configs 

func (UnimplementedRkCommonServiceServer) Configs(context.Context, *ConfigsRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Deps 

func (UnimplementedRkCommonServiceServer) Deps(context.Context, *DepsRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Entries 

func (UnimplementedRkCommonServiceServer) Entries(context.Context, *EntriesRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Gc 

func (UnimplementedRkCommonServiceServer) Gc(context.Context, *GcRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Git 

func (UnimplementedRkCommonServiceServer) Git(context.Context, *GitRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) GwErrorMapping 

func (UnimplementedRkCommonServiceServer) GwErrorMapping(context.Context, *GwErrorMappingRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Healthy 

func (UnimplementedRkCommonServiceServer) Healthy(context.Context, *HealthyRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Info 

func (UnimplementedRkCommonServiceServer) Info(context.Context, *InfoRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) License 

func (UnimplementedRkCommonServiceServer) License(context.Context, *LicenseRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Logs 

func (UnimplementedRkCommonServiceServer) Logs(context.Context, *LogsRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Readme 

func (UnimplementedRkCommonServiceServer) Readme(context.Context, *ReadmeRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Req 

func (UnimplementedRkCommonServiceServer) Req(context.Context, *ReqRequest) (*structpb.Struct, error)

func (UnimplementedRkCommonServiceServer) Sys 

func (UnimplementedRkCommonServiceServer) Sys(context.Context, *SysRequest) (*structpb.Struct, error)

type UnsafeRkCommonServiceServer 

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

UnsafeRkCommonServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RkCommonServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.