org

Documentation

Overview

Package org is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterOrgApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterOrgApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OrgApiClient) error
• func RegisterOrgApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterOrgApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OrgApiServer) error
• func RegisterOrgApiServer(s grpc.ServiceRegistrar, srv OrgApiServer)
• type ClientOptions
• type GetOrgRequest
  • func (*GetOrgRequest) Descriptor() ([]byte, []int)
  • func (*GetOrgRequest) ProtoMessage()
  • func (x *GetOrgRequest) ProtoReflect() protoreflect.Message
  • func (x *GetOrgRequest) Reset()
  • func (x *GetOrgRequest) String() string
• type GrpcClient
  • func NewClient(ctx context.Context, opts ...*ClientOptions) (*GrpcClient, error)
  • func (c *GrpcClient) Close()
• type Org
  • func (*Org) Descriptor() ([]byte, []int)
  • func (x *Org) GetDescription() string
  • func (x *Org) GetEmail() string
  • func (x *Org) GetMetadata() map[string]string
  • func (x *Org) GetName() string
  • func (*Org) ProtoMessage()
  • func (x *Org) ProtoReflect() protoreflect.Message
  • func (x *Org) Reset()
  • func (x *Org) String() string
• type OrgApiClient
  • func NewOrgApiClient(cc grpc.ClientConnInterface) OrgApiClient
• type OrgApiServer
• type UnimplementedOrgApiServer
  • func (UnimplementedOrgApiServer) GetOrg(context.Context, *GetOrgRequest) (*Org, error)
• type UnsafeOrgApiServer

Variables

var File_org_v1_org_proto protoreflect.FileDescriptor

var OrgApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blueapi.org.v1.OrgApi",
	HandlerType: (*OrgApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetOrg",
			Handler:    _OrgApi_GetOrg_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "org/v1/org.proto",
}

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

Functions

func RegisterOrgApiHandler

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

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

func RegisterOrgApiHandlerClient

func RegisterOrgApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OrgApiClient) error

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

func RegisterOrgApiHandlerFromEndpoint

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

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

func RegisterOrgApiHandlerServer

func RegisterOrgApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OrgApiServer) error

RegisterOrgApiHandlerServer registers the http handlers for service OrgApi to "mux". UnaryRPC :call OrgApiServer 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 RegisterOrgApiHandlerFromEndpoint instead.

func RegisterOrgApiServer

func RegisterOrgApiServer(s grpc.ServiceRegistrar, srv OrgApiServer)

Types

type ClientOptions

type ClientOptions struct {
	Conn *conn.GrpcClientConn
}

ClientOptions represents the optional options to NewClient.

type GetOrgRequest

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

Request message for OrgApi.GetOrg rpc.

func (*GetOrgRequest) Descriptor

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

Deprecated: Use GetOrgRequest.ProtoReflect.Descriptor instead.

func (*GetOrgRequest) ProtoMessage

func (*GetOrgRequest) ProtoMessage()

func (*GetOrgRequest) ProtoReflect

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

func (*GetOrgRequest) Reset

func (x *GetOrgRequest) Reset()

func (*GetOrgRequest) String

func (x *GetOrgRequest) String() string

type GrpcClient

type GrpcClient struct {
	OrgApiClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, opts ...*ClientOptions) (*GrpcClient, error)

NewClient returns a client connection to the 'org' service.

func (*GrpcClient) Close

func (c *GrpcClient) Close()

type Org

type Org struct {
	Name        string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Description string            `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Email       string            `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	Metadata    map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Org resource definition.

func (*Org) Descriptor

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

Deprecated: Use Org.ProtoReflect.Descriptor instead.

func (*Org) GetDescription

func (x *Org) GetDescription() string

func (*Org) GetEmail

func (x *Org) GetEmail() string

func (*Org) GetMetadata

func (x *Org) GetMetadata() map[string]string

func (*Org) GetName

func (x *Org) GetName() string

func (*Org) ProtoMessage

func (*Org) ProtoMessage()

func (*Org) ProtoReflect

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

func (*Org) Reset

func (x *Org) Reset()

func (*Org) String

func (x *Org) String() string

type OrgApiClient

type OrgApiClient interface {
	GetOrg(ctx context.Context, in *GetOrgRequest, opts ...grpc.CallOption) (*Org, error)
}

OrgApiClient is the client API for OrgApi 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 NewOrgApiClient

func NewOrgApiClient(cc grpc.ClientConnInterface) OrgApiClient

type OrgApiServer

type OrgApiServer interface {
	GetOrg(context.Context, *GetOrgRequest) (*Org, error)
	// contains filtered or unexported methods
}

OrgApiServer is the server API for OrgApi service. All implementations must embed UnimplementedOrgApiServer for forward compatibility

type UnimplementedOrgApiServer

type UnimplementedOrgApiServer struct {
}

UnimplementedOrgApiServer must be embedded to have forward compatible implementations.

func (UnimplementedOrgApiServer) GetOrg

func (UnimplementedOrgApiServer) GetOrg(context.Context, *GetOrgRequest) (*Org, error)

type UnsafeOrgApiServer

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

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