wellknownconfiguration

Documentation

Overview

Package wellknownconfiguration is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Constants
• Variables
• func RegisterWellKnownServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterWellKnownServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WellKnownServiceClient) error
• func RegisterWellKnownServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterWellKnownServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WellKnownServiceServer) error
• func RegisterWellKnownServiceServer(s grpc.ServiceRegistrar, srv WellKnownServiceServer)
• type GetWellKnownConfigurationRequest
  • func (*GetWellKnownConfigurationRequest) Descriptor() ([]byte, []int)
  • func (*GetWellKnownConfigurationRequest) ProtoMessage()
  • func (x *GetWellKnownConfigurationRequest) ProtoReflect() protoreflect.Message
  • func (x *GetWellKnownConfigurationRequest) Reset()
  • func (x *GetWellKnownConfigurationRequest) String() string
• type GetWellKnownConfigurationResponse
  • func (*GetWellKnownConfigurationResponse) Descriptor() ([]byte, []int)
  • func (x *GetWellKnownConfigurationResponse) GetConfiguration() *structpb.Struct
  • func (*GetWellKnownConfigurationResponse) ProtoMessage()
  • func (x *GetWellKnownConfigurationResponse) ProtoReflect() protoreflect.Message
  • func (x *GetWellKnownConfigurationResponse) Reset()
  • func (x *GetWellKnownConfigurationResponse) String() string
• type UnimplementedWellKnownServiceServer
  • func (UnimplementedWellKnownServiceServer) GetWellKnownConfiguration(context.Context, *GetWellKnownConfigurationRequest) (*GetWellKnownConfigurationResponse, error)
• type UnsafeWellKnownServiceServer
• type WellKnownConfig
  • func (*WellKnownConfig) Descriptor() ([]byte, []int)
  • func (x *WellKnownConfig) GetConfiguration() map[string]*structpb.Struct
  • func (*WellKnownConfig) ProtoMessage()
  • func (x *WellKnownConfig) ProtoReflect() protoreflect.Message
  • func (x *WellKnownConfig) Reset()
  • func (x *WellKnownConfig) String() string
• type WellKnownServiceClient
  • func NewWellKnownServiceClient(cc grpc.ClientConnInterface) WellKnownServiceClient
• type WellKnownServiceServer

Constants

const (
	WellKnownService_GetWellKnownConfiguration_FullMethodName = "/wellknownconfiguration.WellKnownService/GetWellKnownConfiguration"
)

Variables

var File_wellknownconfiguration_wellknown_configuration_proto protoreflect.FileDescriptor

var WellKnownService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "wellknownconfiguration.WellKnownService",
	HandlerType: (*WellKnownServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetWellKnownConfiguration",
			Handler:    _WellKnownService_GetWellKnownConfiguration_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "wellknownconfiguration/wellknown_configuration.proto",
}

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

Functions

func RegisterWellKnownServiceHandler

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

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

func RegisterWellKnownServiceHandlerClient

func RegisterWellKnownServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WellKnownServiceClient) error

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

func RegisterWellKnownServiceHandlerFromEndpoint

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

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

func RegisterWellKnownServiceHandlerServer

func RegisterWellKnownServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WellKnownServiceServer) error

RegisterWellKnownServiceHandlerServer registers the http handlers for service WellKnownService to "mux". UnaryRPC :call WellKnownServiceServer 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 RegisterWellKnownServiceHandlerFromEndpoint instead.

func RegisterWellKnownServiceServer

func RegisterWellKnownServiceServer(s grpc.ServiceRegistrar, srv WellKnownServiceServer)

Types

type GetWellKnownConfigurationRequest

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

func (*GetWellKnownConfigurationRequest) Descriptor

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

Deprecated: Use GetWellKnownConfigurationRequest.ProtoReflect.Descriptor instead.

func (*GetWellKnownConfigurationRequest) ProtoMessage

func (*GetWellKnownConfigurationRequest) ProtoMessage()

func (*GetWellKnownConfigurationRequest) ProtoReflect

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

func (*GetWellKnownConfigurationRequest) Reset

func (x *GetWellKnownConfigurationRequest) Reset()

func (*GetWellKnownConfigurationRequest) String

func (x *GetWellKnownConfigurationRequest) String() string

type GetWellKnownConfigurationResponse

type GetWellKnownConfigurationResponse struct {
	Configuration *structpb.Struct `protobuf:"bytes,1,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWellKnownConfigurationResponse) Descriptor

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

Deprecated: Use GetWellKnownConfigurationResponse.ProtoReflect.Descriptor instead.

func (*GetWellKnownConfigurationResponse) GetConfiguration

func (x *GetWellKnownConfigurationResponse) GetConfiguration() *structpb.Struct

func (*GetWellKnownConfigurationResponse) ProtoMessage

func (*GetWellKnownConfigurationResponse) ProtoMessage()

func (*GetWellKnownConfigurationResponse) ProtoReflect

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

func (*GetWellKnownConfigurationResponse) Reset

func (x *GetWellKnownConfigurationResponse) Reset()

func (*GetWellKnownConfigurationResponse) String

func (x *GetWellKnownConfigurationResponse) String() string

type UnimplementedWellKnownServiceServer

type UnimplementedWellKnownServiceServer struct {
}

UnimplementedWellKnownServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedWellKnownServiceServer) GetWellKnownConfiguration

func (UnimplementedWellKnownServiceServer) GetWellKnownConfiguration(context.Context, *GetWellKnownConfigurationRequest) (*GetWellKnownConfigurationResponse, error)

type UnsafeWellKnownServiceServer

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

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

type WellKnownConfig

type WellKnownConfig struct {
	Configuration map[string]*structpb.Struct `` /* 167-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WellKnownConfig) Descriptor

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

Deprecated: Use WellKnownConfig.ProtoReflect.Descriptor instead.

func (*WellKnownConfig) GetConfiguration

func (x *WellKnownConfig) GetConfiguration() map[string]*structpb.Struct

func (*WellKnownConfig) ProtoMessage

func (*WellKnownConfig) ProtoMessage()

func (*WellKnownConfig) ProtoReflect

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

func (*WellKnownConfig) Reset

func (x *WellKnownConfig) Reset()

func (*WellKnownConfig) String

func (x *WellKnownConfig) String() string

type WellKnownServiceClient

type WellKnownServiceClient interface {
	GetWellKnownConfiguration(ctx context.Context, in *GetWellKnownConfigurationRequest, opts ...grpc.CallOption) (*GetWellKnownConfigurationResponse, error)
}

WellKnownServiceClient is the client API for WellKnownService 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 NewWellKnownServiceClient

func NewWellKnownServiceClient(cc grpc.ClientConnInterface) WellKnownServiceClient

type WellKnownServiceServer

type WellKnownServiceServer interface {
	GetWellKnownConfiguration(context.Context, *GetWellKnownConfigurationRequest) (*GetWellKnownConfigurationResponse, error)
	// contains filtered or unexported methods
}

WellKnownServiceServer is the server API for WellKnownService service. All implementations must embed UnimplementedWellKnownServiceServer for forward compatibility