Documentation
¶
Overview ¶
Package v1user is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterUserServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterUserServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UserServiceClient) error
- func RegisterUserServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterUserServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UserServiceServer) error
- func RegisterUserServiceServer(s grpc.ServiceRegistrar, srv UserServiceServer)
- type CreateUserRequest
- type CreateUserResponse
- type GetUserRequest
- type GetUserResponse
- type ListUserRequest
- func (*ListUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListUserRequest) GetPage() int32
- func (x *ListUserRequest) GetSize() int32
- func (x *ListUserRequest) GetStatus() Status
- func (x *ListUserRequest) GetUserEmails() []string
- func (x *ListUserRequest) GetUserIds() []string
- func (x *ListUserRequest) GetUserName() []string
- func (*ListUserRequest) ProtoMessage()
- func (x *ListUserRequest) ProtoReflect() protoreflect.Message
- func (x *ListUserRequest) Reset()
- func (x *ListUserRequest) String() string
- type ListUserResponse
- func (*ListUserResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListUserResponse) GetTotal() int32
- func (x *ListUserResponse) GetUser() []*User
- func (*ListUserResponse) ProtoMessage()
- func (x *ListUserResponse) ProtoReflect() protoreflect.Message
- func (x *ListUserResponse) Reset()
- func (x *ListUserResponse) String() string
- type Status
- type UnimplementedUserServiceServer
- func (UnimplementedUserServiceServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
- func (UnimplementedUserServiceServer) GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
- func (UnimplementedUserServiceServer) ListUser(context.Context, *ListUserRequest) (*ListUserResponse, error)
- func (UnimplementedUserServiceServer) UpdatePasswordUser(context.Context, *UpdatePasswordUserRequest) (*UpdatePasswordUserResponse, error)
- func (UnimplementedUserServiceServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
- type UnsafeUserServiceServer
- type UpdatePasswordUserRequest
- func (*UpdatePasswordUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdatePasswordUserRequest) GetId() string
- func (x *UpdatePasswordUserRequest) GetPassword() string
- func (*UpdatePasswordUserRequest) ProtoMessage()
- func (x *UpdatePasswordUserRequest) ProtoReflect() protoreflect.Message
- func (x *UpdatePasswordUserRequest) Reset()
- func (x *UpdatePasswordUserRequest) String() string
- type UpdatePasswordUserResponse
- func (*UpdatePasswordUserResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdatePasswordUserResponse) GetUser() *User
- func (*UpdatePasswordUserResponse) ProtoMessage()
- func (x *UpdatePasswordUserResponse) ProtoReflect() protoreflect.Message
- func (x *UpdatePasswordUserResponse) Reset()
- func (x *UpdatePasswordUserResponse) String() string
- type UpdateUserRequest
- type UpdateUserResponse
- type User
- func (*User) Descriptor() ([]byte, []int)deprecated
- func (x *User) GetCreated() *timestamppb.Timestamp
- func (x *User) GetEmail() string
- func (x *User) GetId() string
- func (x *User) GetName() string
- func (x *User) GetPassword() string
- func (x *User) GetStatus() Status
- func (x *User) GetUpdated() *timestamppb.Timestamp
- func (*User) ProtoMessage()
- func (x *User) ProtoReflect() protoreflect.Message
- func (x *User) Reset()
- func (x *User) String() string
- type UserServiceClient
- type UserServiceServer
Constants ¶
const ( UserService_GetUser_FullMethodName = "/user.v1.UserService/GetUser" UserService_ListUser_FullMethodName = "/user.v1.UserService/ListUser" UserService_CreateUser_FullMethodName = "/user.v1.UserService/CreateUser" UserService_UpdateUser_FullMethodName = "/user.v1.UserService/UpdateUser" UserService_UpdatePasswordUser_FullMethodName = "/user.v1.UserService/UpdatePasswordUser" )
Variables ¶
var ( Status_name = map[int32]string{ 0: "STATUS_UNSPECIFIED", 1: "STATUS_ACTIVE", 2: "STATUS_INACTIVE", } Status_value = map[string]int32{ "STATUS_UNSPECIFIED": 0, "STATUS_ACTIVE": 1, "STATUS_INACTIVE": 2, } )
Enum value maps for Status.
var File_user_v1_user_proto protoreflect.FileDescriptor
var UserService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "user.v1.UserService", HandlerType: (*UserServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetUser", Handler: _UserService_GetUser_Handler, }, { MethodName: "ListUser", Handler: _UserService_ListUser_Handler, }, { MethodName: "CreateUser", Handler: _UserService_CreateUser_Handler, }, { MethodName: "UpdateUser", Handler: _UserService_UpdateUser_Handler, }, { MethodName: "UpdatePasswordUser", Handler: _UserService_UpdatePasswordUser_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "user/v1/user.proto", }
UserService_ServiceDesc is the grpc.ServiceDesc for UserService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterUserServiceHandler ¶
func RegisterUserServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterUserServiceHandler registers the http handlers for service UserService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterUserServiceHandlerClient ¶
func RegisterUserServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UserServiceClient) error
RegisterUserServiceHandlerClient registers the http handlers for service UserService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "UserServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "UserServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "UserServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterUserServiceHandlerFromEndpoint ¶
func RegisterUserServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterUserServiceHandlerFromEndpoint is same as RegisterUserServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterUserServiceHandlerServer ¶
func RegisterUserServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UserServiceServer) error
RegisterUserServiceHandlerServer registers the http handlers for service UserService to "mux". UnaryRPC :call UserServiceServer 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 RegisterUserServiceHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.
func RegisterUserServiceServer ¶
func RegisterUserServiceServer(s grpc.ServiceRegistrar, srv UserServiceServer)
Types ¶
type CreateUserRequest ¶
type CreateUserRequest struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*CreateUserRequest) Descriptor
deprecated
func (*CreateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.
func (*CreateUserRequest) GetUser ¶
func (x *CreateUserRequest) GetUser() *User
func (*CreateUserRequest) ProtoMessage ¶
func (*CreateUserRequest) ProtoMessage()
func (*CreateUserRequest) ProtoReflect ¶
func (x *CreateUserRequest) ProtoReflect() protoreflect.Message
func (*CreateUserRequest) Reset ¶
func (x *CreateUserRequest) Reset()
func (*CreateUserRequest) String ¶
func (x *CreateUserRequest) String() string
type CreateUserResponse ¶
type CreateUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*CreateUserResponse) Descriptor
deprecated
func (*CreateUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserResponse.ProtoReflect.Descriptor instead.
func (*CreateUserResponse) GetUser ¶
func (x *CreateUserResponse) GetUser() *User
func (*CreateUserResponse) ProtoMessage ¶
func (*CreateUserResponse) ProtoMessage()
func (*CreateUserResponse) ProtoReflect ¶
func (x *CreateUserResponse) ProtoReflect() protoreflect.Message
func (*CreateUserResponse) Reset ¶
func (x *CreateUserResponse) Reset()
func (*CreateUserResponse) String ¶
func (x *CreateUserResponse) String() string
type GetUserRequest ¶
type GetUserRequest struct { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` // contains filtered or unexported fields }
func (*GetUserRequest) Descriptor
deprecated
func (*GetUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.
func (*GetUserRequest) GetUserId ¶
func (x *GetUserRequest) GetUserId() string
func (*GetUserRequest) ProtoMessage ¶
func (*GetUserRequest) ProtoMessage()
func (*GetUserRequest) ProtoReflect ¶
func (x *GetUserRequest) ProtoReflect() protoreflect.Message
func (*GetUserRequest) Reset ¶
func (x *GetUserRequest) Reset()
func (*GetUserRequest) String ¶
func (x *GetUserRequest) String() string
type GetUserResponse ¶
type GetUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*GetUserResponse) Descriptor
deprecated
func (*GetUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetUserResponse.ProtoReflect.Descriptor instead.
func (*GetUserResponse) GetUser ¶
func (x *GetUserResponse) GetUser() *User
func (*GetUserResponse) ProtoMessage ¶
func (*GetUserResponse) ProtoMessage()
func (*GetUserResponse) ProtoReflect ¶
func (x *GetUserResponse) ProtoReflect() protoreflect.Message
func (*GetUserResponse) Reset ¶
func (x *GetUserResponse) Reset()
func (*GetUserResponse) String ¶
func (x *GetUserResponse) String() string
type ListUserRequest ¶
type ListUserRequest struct { Page int32 `protobuf:"varint,1,opt,name=page,proto3" json:"page,omitempty"` Size int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` UserIds []string `protobuf:"bytes,3,rep,name=user_ids,json=userIds,proto3" json:"user_ids,omitempty"` UserEmails []string `protobuf:"bytes,4,rep,name=user_emails,json=userEmails,proto3" json:"user_emails,omitempty"` UserName []string `protobuf:"bytes,5,rep,name=user_name,json=userName,proto3" json:"user_name,omitempty"` Status Status `protobuf:"varint,6,opt,name=status,proto3,enum=user.v1.Status" json:"status,omitempty"` // contains filtered or unexported fields }
func (*ListUserRequest) Descriptor
deprecated
func (*ListUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListUserRequest.ProtoReflect.Descriptor instead.
func (*ListUserRequest) GetPage ¶
func (x *ListUserRequest) GetPage() int32
func (*ListUserRequest) GetSize ¶
func (x *ListUserRequest) GetSize() int32
func (*ListUserRequest) GetStatus ¶
func (x *ListUserRequest) GetStatus() Status
func (*ListUserRequest) GetUserEmails ¶
func (x *ListUserRequest) GetUserEmails() []string
func (*ListUserRequest) GetUserIds ¶
func (x *ListUserRequest) GetUserIds() []string
func (*ListUserRequest) GetUserName ¶
func (x *ListUserRequest) GetUserName() []string
func (*ListUserRequest) ProtoMessage ¶
func (*ListUserRequest) ProtoMessage()
func (*ListUserRequest) ProtoReflect ¶
func (x *ListUserRequest) ProtoReflect() protoreflect.Message
func (*ListUserRequest) Reset ¶
func (x *ListUserRequest) Reset()
func (*ListUserRequest) String ¶
func (x *ListUserRequest) String() string
type ListUserResponse ¶
type ListUserResponse struct { User []*User `protobuf:"bytes,1,rep,name=user,proto3" json:"user,omitempty"` Total int32 `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"` // contains filtered or unexported fields }
func (*ListUserResponse) Descriptor
deprecated
func (*ListUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListUserResponse.ProtoReflect.Descriptor instead.
func (*ListUserResponse) GetTotal ¶
func (x *ListUserResponse) GetTotal() int32
func (*ListUserResponse) GetUser ¶
func (x *ListUserResponse) GetUser() []*User
func (*ListUserResponse) ProtoMessage ¶
func (*ListUserResponse) ProtoMessage()
func (*ListUserResponse) ProtoReflect ¶
func (x *ListUserResponse) ProtoReflect() protoreflect.Message
func (*ListUserResponse) Reset ¶
func (x *ListUserResponse) Reset()
func (*ListUserResponse) String ¶
func (x *ListUserResponse) String() string
type Status ¶
type Status int32
func (Status) Descriptor ¶
func (Status) Descriptor() protoreflect.EnumDescriptor
func (Status) EnumDescriptor
deprecated
func (Status) Number ¶
func (x Status) Number() protoreflect.EnumNumber
func (Status) Type ¶
func (Status) Type() protoreflect.EnumType
type UnimplementedUserServiceServer ¶
type UnimplementedUserServiceServer struct{}
UnimplementedUserServiceServer should be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedUserServiceServer) CreateUser ¶
func (UnimplementedUserServiceServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
func (UnimplementedUserServiceServer) GetUser ¶
func (UnimplementedUserServiceServer) GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
func (UnimplementedUserServiceServer) ListUser ¶
func (UnimplementedUserServiceServer) ListUser(context.Context, *ListUserRequest) (*ListUserResponse, error)
func (UnimplementedUserServiceServer) UpdatePasswordUser ¶
func (UnimplementedUserServiceServer) UpdatePasswordUser(context.Context, *UpdatePasswordUserRequest) (*UpdatePasswordUserResponse, error)
func (UnimplementedUserServiceServer) UpdateUser ¶
func (UnimplementedUserServiceServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
type UnsafeUserServiceServer ¶
type UnsafeUserServiceServer interface {
// contains filtered or unexported methods
}
UnsafeUserServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UserServiceServer will result in compilation errors.
type UpdatePasswordUserRequest ¶
type UpdatePasswordUserRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
func (*UpdatePasswordUserRequest) Descriptor
deprecated
func (*UpdatePasswordUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdatePasswordUserRequest.ProtoReflect.Descriptor instead.
func (*UpdatePasswordUserRequest) GetId ¶
func (x *UpdatePasswordUserRequest) GetId() string
func (*UpdatePasswordUserRequest) GetPassword ¶
func (x *UpdatePasswordUserRequest) GetPassword() string
func (*UpdatePasswordUserRequest) ProtoMessage ¶
func (*UpdatePasswordUserRequest) ProtoMessage()
func (*UpdatePasswordUserRequest) ProtoReflect ¶
func (x *UpdatePasswordUserRequest) ProtoReflect() protoreflect.Message
func (*UpdatePasswordUserRequest) Reset ¶
func (x *UpdatePasswordUserRequest) Reset()
func (*UpdatePasswordUserRequest) String ¶
func (x *UpdatePasswordUserRequest) String() string
type UpdatePasswordUserResponse ¶
type UpdatePasswordUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*UpdatePasswordUserResponse) Descriptor
deprecated
func (*UpdatePasswordUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdatePasswordUserResponse.ProtoReflect.Descriptor instead.
func (*UpdatePasswordUserResponse) GetUser ¶
func (x *UpdatePasswordUserResponse) GetUser() *User
func (*UpdatePasswordUserResponse) ProtoMessage ¶
func (*UpdatePasswordUserResponse) ProtoMessage()
func (*UpdatePasswordUserResponse) ProtoReflect ¶
func (x *UpdatePasswordUserResponse) ProtoReflect() protoreflect.Message
func (*UpdatePasswordUserResponse) Reset ¶
func (x *UpdatePasswordUserResponse) Reset()
func (*UpdatePasswordUserResponse) String ¶
func (x *UpdatePasswordUserResponse) String() string
type UpdateUserRequest ¶
type UpdateUserRequest struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*UpdateUserRequest) Descriptor
deprecated
func (*UpdateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.
func (*UpdateUserRequest) GetUser ¶
func (x *UpdateUserRequest) GetUser() *User
func (*UpdateUserRequest) ProtoMessage ¶
func (*UpdateUserRequest) ProtoMessage()
func (*UpdateUserRequest) ProtoReflect ¶
func (x *UpdateUserRequest) ProtoReflect() protoreflect.Message
func (*UpdateUserRequest) Reset ¶
func (x *UpdateUserRequest) Reset()
func (*UpdateUserRequest) String ¶
func (x *UpdateUserRequest) String() string
type UpdateUserResponse ¶
type UpdateUserResponse struct { User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*UpdateUserResponse) Descriptor
deprecated
func (*UpdateUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserResponse.ProtoReflect.Descriptor instead.
func (*UpdateUserResponse) GetUser ¶
func (x *UpdateUserResponse) GetUser() *User
func (*UpdateUserResponse) ProtoMessage ¶
func (*UpdateUserResponse) ProtoMessage()
func (*UpdateUserResponse) ProtoReflect ¶
func (x *UpdateUserResponse) ProtoReflect() protoreflect.Message
func (*UpdateUserResponse) Reset ¶
func (x *UpdateUserResponse) Reset()
func (*UpdateUserResponse) String ¶
func (x *UpdateUserResponse) String() string
type User ¶
type User struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"` Status Status `protobuf:"varint,5,opt,name=status,proto3,enum=user.v1.Status" json:"status,omitempty"` Created *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created,proto3" json:"created,omitempty"` Updated *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=updated,proto3" json:"updated,omitempty"` // contains filtered or unexported fields }
func (*User) Descriptor
deprecated
func (*User) GetCreated ¶
func (x *User) GetCreated() *timestamppb.Timestamp
func (*User) GetPassword ¶
func (*User) GetUpdated ¶
func (x *User) GetUpdated() *timestamppb.Timestamp
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) ProtoReflect ¶
func (x *User) ProtoReflect() protoreflect.Message
type UserServiceClient ¶
type UserServiceClient interface { GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*GetUserResponse, error) ListUser(ctx context.Context, in *ListUserRequest, opts ...grpc.CallOption) (*ListUserResponse, error) CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*CreateUserResponse, error) UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*UpdateUserResponse, error) UpdatePasswordUser(ctx context.Context, in *UpdatePasswordUserRequest, opts ...grpc.CallOption) (*UpdatePasswordUserResponse, error) }
UserServiceClient is the client API for UserService 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 NewUserServiceClient ¶
func NewUserServiceClient(cc grpc.ClientConnInterface) UserServiceClient
type UserServiceServer ¶
type UserServiceServer interface { GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error) ListUser(context.Context, *ListUserRequest) (*ListUserResponse, error) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error) UpdatePasswordUser(context.Context, *UpdatePasswordUserRequest) (*UpdatePasswordUserResponse, error) }
UserServiceServer is the server API for UserService service. All implementations should embed UnimplementedUserServiceServer for forward compatibility.