reflectionv1

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Mar 22, 2023 License: MIT Imports: 16 Imported by: 0

Documentation

Overview

Package reflectionv1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var File_reflection_v1_service_proto protoreflect.FileDescriptor
View Source
var ReflectionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "reflection.v1.ReflectionService",
	HandlerType: (*ReflectionServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "GetInfo",
			Handler:       _ReflectionService_GetInfo_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "reflection/v1/service.proto",
}

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

Functions

func RegisterReflectionServiceHandler

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

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

func RegisterReflectionServiceHandlerClient

func RegisterReflectionServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ReflectionServiceClient) error

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

func RegisterReflectionServiceHandlerFromEndpoint

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

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

func RegisterReflectionServiceHandlerServer

func RegisterReflectionServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ReflectionServiceServer) error

RegisterReflectionServiceHandlerServer registers the http handlers for service ReflectionService to "mux". UnaryRPC :call ReflectionServiceServer 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 RegisterReflectionServiceHandlerFromEndpoint instead.

func RegisterReflectionServiceServer

func RegisterReflectionServiceServer(s grpc.ServiceRegistrar, srv ReflectionServiceServer)

Types

type ErrorResponse

type ErrorResponse struct {

	// This field uses the error codes defined in grpc::StatusCode.
	ErrorCode    int32  `protobuf:"varint,1,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"`
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

The error code and error message sent by the server when an error occurs.

func (*ErrorResponse) Descriptor deprecated

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

Deprecated: Use ErrorResponse.ProtoReflect.Descriptor instead.

func (*ErrorResponse) GetErrorCode

func (x *ErrorResponse) GetErrorCode() int32

func (*ErrorResponse) GetErrorMessage

func (x *ErrorResponse) GetErrorMessage() string

func (*ErrorResponse) ProtoMessage

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) ProtoReflect

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

func (*ErrorResponse) Reset

func (x *ErrorResponse) Reset()

func (*ErrorResponse) String

func (x *ErrorResponse) String() string

type ExtensionNumberResponse

type ExtensionNumberResponse struct {

	// Full name of the base type, including the package name. The format
	// is <package>.<type>
	BaseTypeName    string  `protobuf:"bytes,1,opt,name=base_type_name,json=baseTypeName,proto3" json:"base_type_name,omitempty"`
	ExtensionNumber []int32 `protobuf:"varint,2,rep,packed,name=extension_number,json=extensionNumber,proto3" json:"extension_number,omitempty"`
	// contains filtered or unexported fields
}

A list of extension numbers sent by the server answering all_extension_numbers_of_type request.

func (*ExtensionNumberResponse) Descriptor deprecated

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

Deprecated: Use ExtensionNumberResponse.ProtoReflect.Descriptor instead.

func (*ExtensionNumberResponse) GetBaseTypeName

func (x *ExtensionNumberResponse) GetBaseTypeName() string

func (*ExtensionNumberResponse) GetExtensionNumber

func (x *ExtensionNumberResponse) GetExtensionNumber() []int32

func (*ExtensionNumberResponse) ProtoMessage

func (*ExtensionNumberResponse) ProtoMessage()

func (*ExtensionNumberResponse) ProtoReflect

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

func (*ExtensionNumberResponse) Reset

func (x *ExtensionNumberResponse) Reset()

func (*ExtensionNumberResponse) String

func (x *ExtensionNumberResponse) String() string

type ExtensionRequest

type ExtensionRequest struct {

	// Fully-qualified type name. The format should be <package>.<type>
	ContainingType  string `protobuf:"bytes,1,opt,name=containing_type,json=containingType,proto3" json:"containing_type,omitempty"`
	ExtensionNumber int32  `protobuf:"varint,2,opt,name=extension_number,json=extensionNumber,proto3" json:"extension_number,omitempty"`
	// contains filtered or unexported fields
}

The type name and extension number sent by the client when requesting file_containing_extension.

func (*ExtensionRequest) Descriptor deprecated

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

Deprecated: Use ExtensionRequest.ProtoReflect.Descriptor instead.

func (*ExtensionRequest) GetContainingType

func (x *ExtensionRequest) GetContainingType() string

func (*ExtensionRequest) GetExtensionNumber

func (x *ExtensionRequest) GetExtensionNumber() int32

func (*ExtensionRequest) ProtoMessage

func (*ExtensionRequest) ProtoMessage()

func (*ExtensionRequest) ProtoReflect

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

func (*ExtensionRequest) Reset

func (x *ExtensionRequest) Reset()

func (*ExtensionRequest) String

func (x *ExtensionRequest) String() string

type FileDescriptorResponse

type FileDescriptorResponse struct {

	// Serialized FileDescriptorProto messages. We avoid taking a dependency on
	// descriptor.proto, which uses proto2 only features, by making them opaque
	// bytes instead.
	FileDescriptorProto [][]byte `protobuf:"bytes,1,rep,name=file_descriptor_proto,json=fileDescriptorProto,proto3" json:"file_descriptor_proto,omitempty"`
	// contains filtered or unexported fields
}

Serialized FileDescriptorProto messages sent by the server answering a file_by_filename, file_containing_symbol, or file_containing_extension request.

func (*FileDescriptorResponse) Descriptor deprecated

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

Deprecated: Use FileDescriptorResponse.ProtoReflect.Descriptor instead.

func (*FileDescriptorResponse) GetFileDescriptorProto

func (x *FileDescriptorResponse) GetFileDescriptorProto() [][]byte

func (*FileDescriptorResponse) ProtoMessage

func (*FileDescriptorResponse) ProtoMessage()

func (*FileDescriptorResponse) ProtoReflect

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

func (*FileDescriptorResponse) Reset

func (x *FileDescriptorResponse) Reset()

func (*FileDescriptorResponse) String

func (x *FileDescriptorResponse) String() string

type GetInfoRequest

type GetInfoRequest struct {
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// To use reflection service, the client should set one of the following
	// fields in message_request. The server distinguishes requests by their
	// defined field and then handles them using corresponding methods.
	//
	// Types that are assignable to MessageRequest:
	//	*GetInfoRequest_FileByFilename
	//	*GetInfoRequest_FileContainingSymbol
	//	*GetInfoRequest_FileContainingExtension
	//	*GetInfoRequest_AllExtensionNumbersOfType
	//	*GetInfoRequest_ListServices
	MessageRequest isGetInfoRequest_MessageRequest `protobuf_oneof:"message_request"`
	// contains filtered or unexported fields
}

The message sent by the client when calling GetInfo method.

func (*GetInfoRequest) Descriptor deprecated

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

Deprecated: Use GetInfoRequest.ProtoReflect.Descriptor instead.

func (*GetInfoRequest) GetAllExtensionNumbersOfType

func (x *GetInfoRequest) GetAllExtensionNumbersOfType() string

func (*GetInfoRequest) GetFileByFilename

func (x *GetInfoRequest) GetFileByFilename() string

func (*GetInfoRequest) GetFileContainingExtension

func (x *GetInfoRequest) GetFileContainingExtension() *ExtensionRequest

func (*GetInfoRequest) GetFileContainingSymbol

func (x *GetInfoRequest) GetFileContainingSymbol() string

func (*GetInfoRequest) GetHost

func (x *GetInfoRequest) GetHost() string

func (*GetInfoRequest) GetListServices

func (x *GetInfoRequest) GetListServices() string

func (*GetInfoRequest) GetMessageRequest

func (m *GetInfoRequest) GetMessageRequest() isGetInfoRequest_MessageRequest

func (*GetInfoRequest) ProtoMessage

func (*GetInfoRequest) ProtoMessage()

func (*GetInfoRequest) ProtoReflect

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

func (*GetInfoRequest) Reset

func (x *GetInfoRequest) Reset()

func (*GetInfoRequest) String

func (x *GetInfoRequest) String() string

type GetInfoRequest_AllExtensionNumbersOfType

type GetInfoRequest_AllExtensionNumbersOfType struct {
	// Finds the tag numbers used by all known extensions of the given message
	// type, and appends them to ExtensionNumberResponse in an undefined order.
	// Its corresponding method is best-effort: it's not guaranteed that the
	// reflection service will implement this method, and it's not guaranteed
	// that this method will provide all extensions. Returns
	// StatusCode::UNIMPLEMENTED if it's not implemented.
	// This field should be a fully-qualified type name. The format is
	// <package>.<type>
	AllExtensionNumbersOfType string `protobuf:"bytes,6,opt,name=all_extension_numbers_of_type,json=allExtensionNumbersOfType,proto3,oneof"`
}

type GetInfoRequest_FileByFilename

type GetInfoRequest_FileByFilename struct {
	// Find a proto file by the file name.
	FileByFilename string `protobuf:"bytes,3,opt,name=file_by_filename,json=fileByFilename,proto3,oneof"`
}

type GetInfoRequest_FileContainingExtension

type GetInfoRequest_FileContainingExtension struct {
	// Find the proto file which defines an extension extending the given
	// message type with the given field number.
	FileContainingExtension *ExtensionRequest `protobuf:"bytes,5,opt,name=file_containing_extension,json=fileContainingExtension,proto3,oneof"`
}

type GetInfoRequest_FileContainingSymbol

type GetInfoRequest_FileContainingSymbol struct {
	// Find the proto file that declares the given fully-qualified symbol name.
	// This field should be a fully-qualified symbol name
	// (e.g. <package>.<service>[.<method>] or <package>.<type>).
	FileContainingSymbol string `protobuf:"bytes,4,opt,name=file_containing_symbol,json=fileContainingSymbol,proto3,oneof"`
}

type GetInfoRequest_ListServices

type GetInfoRequest_ListServices struct {
	// List the full names of registered services. The content will not be
	// checked.
	ListServices string `protobuf:"bytes,7,opt,name=list_services,json=listServices,proto3,oneof"`
}

type GetInfoResponse

type GetInfoResponse struct {
	ValidHost       string          `protobuf:"bytes,1,opt,name=valid_host,json=validHost,proto3" json:"valid_host,omitempty"`
	OriginalRequest *GetInfoRequest `protobuf:"bytes,2,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
	// The server sets one of the following fields according to the message_request
	// in the request.
	//
	// Types that are assignable to MessageResponse:
	//	*GetInfoResponse_FileDescriptorResponse
	//	*GetInfoResponse_AllExtensionNumbersResponse
	//	*GetInfoResponse_ListServicesResponse
	//	*GetInfoResponse_ErrorResponse
	MessageResponse isGetInfoResponse_MessageResponse `protobuf_oneof:"message_response"`
	// contains filtered or unexported fields
}

The message sent by the server to answer ServerReflectionInfo method.

func (*GetInfoResponse) Descriptor deprecated

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

Deprecated: Use GetInfoResponse.ProtoReflect.Descriptor instead.

func (*GetInfoResponse) GetAllExtensionNumbersResponse

func (x *GetInfoResponse) GetAllExtensionNumbersResponse() *ExtensionNumberResponse

func (*GetInfoResponse) GetErrorResponse

func (x *GetInfoResponse) GetErrorResponse() *ErrorResponse

func (*GetInfoResponse) GetFileDescriptorResponse

func (x *GetInfoResponse) GetFileDescriptorResponse() *FileDescriptorResponse

func (*GetInfoResponse) GetListServicesResponse

func (x *GetInfoResponse) GetListServicesResponse() *ListServiceResponse

func (*GetInfoResponse) GetMessageResponse

func (m *GetInfoResponse) GetMessageResponse() isGetInfoResponse_MessageResponse

func (*GetInfoResponse) GetOriginalRequest

func (x *GetInfoResponse) GetOriginalRequest() *GetInfoRequest

func (*GetInfoResponse) GetValidHost

func (x *GetInfoResponse) GetValidHost() string

func (*GetInfoResponse) ProtoMessage

func (*GetInfoResponse) ProtoMessage()

func (*GetInfoResponse) ProtoReflect

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

func (*GetInfoResponse) Reset

func (x *GetInfoResponse) Reset()

func (*GetInfoResponse) String

func (x *GetInfoResponse) String() string

type GetInfoResponse_AllExtensionNumbersResponse

type GetInfoResponse_AllExtensionNumbersResponse struct {
	// This message is used to answer all_extension_numbers_of_type requests.
	AllExtensionNumbersResponse *ExtensionNumberResponse `protobuf:"bytes,5,opt,name=all_extension_numbers_response,json=allExtensionNumbersResponse,proto3,oneof"`
}

type GetInfoResponse_ErrorResponse

type GetInfoResponse_ErrorResponse struct {
	// This message is used when an error occurs.
	ErrorResponse *ErrorResponse `protobuf:"bytes,7,opt,name=error_response,json=errorResponse,proto3,oneof"`
}

type GetInfoResponse_FileDescriptorResponse

type GetInfoResponse_FileDescriptorResponse struct {
	// This message is used to answer file_by_filename, file_containing_symbol,
	// file_containing_extension requests with transitive dependencies.
	// As the repeated label is not allowed in oneof fields, we use a
	// FileDescriptorResponse message to encapsulate the repeated fields.
	// The reflection service is allowed to avoid sending FileDescriptorProtos
	// that were previously sent in response to earlier requests in the stream.
	FileDescriptorResponse *FileDescriptorResponse `protobuf:"bytes,4,opt,name=file_descriptor_response,json=fileDescriptorResponse,proto3,oneof"`
}

type GetInfoResponse_ListServicesResponse

type GetInfoResponse_ListServicesResponse struct {
	// This message is used to answer list_services requests.
	ListServicesResponse *ListServiceResponse `protobuf:"bytes,6,opt,name=list_services_response,json=listServicesResponse,proto3,oneof"`
}

type ListServiceResponse

type ListServiceResponse struct {

	// The information of each service may be expanded in the future, so we use
	// ServiceResponse message to encapsulate it.
	Service []*ServiceResponse `protobuf:"bytes,1,rep,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

A list of ServiceResponse sent by the server answering list_services request.

func (*ListServiceResponse) Descriptor deprecated

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

Deprecated: Use ListServiceResponse.ProtoReflect.Descriptor instead.

func (*ListServiceResponse) GetService

func (x *ListServiceResponse) GetService() []*ServiceResponse

func (*ListServiceResponse) ProtoMessage

func (*ListServiceResponse) ProtoMessage()

func (*ListServiceResponse) ProtoReflect

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

func (*ListServiceResponse) Reset

func (x *ListServiceResponse) Reset()

func (*ListServiceResponse) String

func (x *ListServiceResponse) String() string

type ReflectionServiceClient

type ReflectionServiceClient interface {
	// The reflection service is structured as a bidirectional stream, ensuring
	// all related requests go to a single server.
	GetInfo(ctx context.Context, opts ...grpc.CallOption) (ReflectionService_GetInfoClient, error)
}

ReflectionServiceClient is the client API for ReflectionService 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.

type ReflectionServiceServer

type ReflectionServiceServer interface {
	// The reflection service is structured as a bidirectional stream, ensuring
	// all related requests go to a single server.
	GetInfo(ReflectionService_GetInfoServer) error
}

ReflectionServiceServer is the server API for ReflectionService service. All implementations should embed UnimplementedReflectionServiceServer for forward compatibility

type ReflectionService_GetInfoClient

type ReflectionService_GetInfoClient interface {
	Send(*GetInfoRequest) error
	Recv() (*GetInfoResponse, error)
	grpc.ClientStream
}

type ReflectionService_GetInfoServer

type ReflectionService_GetInfoServer interface {
	Send(*GetInfoResponse) error
	Recv() (*GetInfoRequest, error)
	grpc.ServerStream
}

type ServiceResponse

type ServiceResponse struct {

	// Full name of a registered service, including its package name. The format
	// is <package>.<service>
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The information of a single service used by ListServiceResponse to answer list_services request.

func (*ServiceResponse) Descriptor deprecated

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

Deprecated: Use ServiceResponse.ProtoReflect.Descriptor instead.

func (*ServiceResponse) GetName

func (x *ServiceResponse) GetName() string

func (*ServiceResponse) ProtoMessage

func (*ServiceResponse) ProtoMessage()

func (*ServiceResponse) ProtoReflect

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

func (*ServiceResponse) Reset

func (x *ServiceResponse) Reset()

func (*ServiceResponse) String

func (x *ServiceResponse) String() string

type UnimplementedReflectionServiceServer

type UnimplementedReflectionServiceServer struct {
}

UnimplementedReflectionServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedReflectionServiceServer) GetInfo

type UnsafeReflectionServiceServer

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL