iam

Documentation

Overview

Package iam is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterIamHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterIamHandlerClient(ctx context.Context, mux *runtime.ServeMux, client IamClient) error
• func RegisterIamHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterIamHandlerServer(ctx context.Context, mux *runtime.ServeMux, server IamServer) error
• func RegisterIamServer(s grpc.ServiceRegistrar, srv IamServer)
• type ClientOptions
• type GrpcClient
  • func NewClient(ctx context.Context, opts ...*ClientOptions) (*GrpcClient, error)
  • func (c *GrpcClient) Close()
• type IamClient
  • func NewIamClient(cc grpc.ClientConnInterface) IamClient
• type IamServer
• type UnimplementedIamServer
  • func (UnimplementedIamServer) WhoAmI(context.Context, *WhoAmIRequest) (*WhoAmIResponse, error)
• type UnsafeIamServer
• type WhoAmIRequest
  • func (*WhoAmIRequest) Descriptor() ([]byte, []int)
  • func (*WhoAmIRequest) ProtoMessage()
  • func (x *WhoAmIRequest) ProtoReflect() protoreflect.Message
  • func (x *WhoAmIRequest) Reset()
  • func (x *WhoAmIRequest) String() string
• type WhoAmIResponse
  • func (*WhoAmIResponse) Descriptor() ([]byte, []int)
  • func (x *WhoAmIResponse) GetName() string
  • func (*WhoAmIResponse) ProtoMessage()
  • func (x *WhoAmIResponse) ProtoReflect() protoreflect.Message
  • func (x *WhoAmIResponse) Reset()
  • func (x *WhoAmIResponse) String() string

Variables

var File_iam_v1_iam_proto protoreflect.FileDescriptor

var Iam_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blueapi.iam.v1.Iam",
	HandlerType: (*IamServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "WhoAmI",
			Handler:    _Iam_WhoAmI_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "iam/v1/iam.proto",
}

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

Functions

func RegisterIamHandler

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

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

func RegisterIamHandlerClient

func RegisterIamHandlerClient(ctx context.Context, mux *runtime.ServeMux, client IamClient) error

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

func RegisterIamHandlerFromEndpoint

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

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

func RegisterIamHandlerServer

func RegisterIamHandlerServer(ctx context.Context, mux *runtime.ServeMux, server IamServer) error

RegisterIamHandlerServer registers the http handlers for service Iam to "mux". UnaryRPC :call IamServer 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 RegisterIamHandlerFromEndpoint instead.

func RegisterIamServer

func RegisterIamServer(s grpc.ServiceRegistrar, srv IamServer)

Types

type ClientOptions

type ClientOptions struct {
	Conn *conn.GrpcClientConn
}

ClientOptions represents the optional options to NewClient.

type GrpcClient

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

func NewClient

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

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

func (*GrpcClient) Close

func (c *GrpcClient) Close()

type IamClient

type IamClient interface {
	// Gets information about the caller.
	WhoAmI(ctx context.Context, in *WhoAmIRequest, opts ...grpc.CallOption) (*WhoAmIResponse, error)
}

IamClient is the client API for Iam 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 NewIamClient

func NewIamClient(cc grpc.ClientConnInterface) IamClient

type IamServer

type IamServer interface {
	// Gets information about the caller.
	WhoAmI(context.Context, *WhoAmIRequest) (*WhoAmIResponse, error)
	// contains filtered or unexported methods
}

IamServer is the server API for Iam service. All implementations must embed UnimplementedIamServer for forward compatibility

type UnimplementedIamServer

type UnimplementedIamServer struct {
}

UnimplementedIamServer must be embedded to have forward compatible implementations.

func (UnimplementedIamServer) WhoAmI

func (UnimplementedIamServer) WhoAmI(context.Context, *WhoAmIRequest) (*WhoAmIResponse, error)

type UnsafeIamServer

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

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

type WhoAmIRequest

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

Request message for Iam.WhoAmI rpc.

func (*WhoAmIRequest) Descriptor

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

Deprecated: Use WhoAmIRequest.ProtoReflect.Descriptor instead.

func (*WhoAmIRequest) ProtoMessage

func (*WhoAmIRequest) ProtoMessage()

func (*WhoAmIRequest) ProtoReflect

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

func (*WhoAmIRequest) Reset

func (x *WhoAmIRequest) Reset()

func (*WhoAmIRequest) String

func (x *WhoAmIRequest) String() string

type WhoAmIResponse

type WhoAmIResponse struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Response message for Iam.WhoAmI rpc.

func (*WhoAmIResponse) Descriptor

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

Deprecated: Use WhoAmIResponse.ProtoReflect.Descriptor instead.

func (*WhoAmIResponse) GetName

func (x *WhoAmIResponse) GetName() string

func (*WhoAmIResponse) ProtoMessage

func (*WhoAmIResponse) ProtoMessage()

func (*WhoAmIResponse) ProtoReflect

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

func (*WhoAmIResponse) Reset

func (x *WhoAmIResponse) Reset()

func (*WhoAmIResponse) String

func (x *WhoAmIResponse) String() string