Documentation ¶
Overview ¶
Package user is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterUsersHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterUsersHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UsersClient) error
- func RegisterUsersHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterUsersHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UsersServer) error
- func RegisterUsersServer(s *grpc.Server, srv UsersServer)
- type CreateUserRequest
- func (*CreateUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateUserRequest) GetEmail() string
- func (x *CreateUserRequest) GetFirstName() string
- func (x *CreateUserRequest) GetGender() Gender
- func (x *CreateUserRequest) GetLastName() string
- func (x *CreateUserRequest) GetPassword() string
- func (*CreateUserRequest) ProtoMessage()
- func (x *CreateUserRequest) ProtoReflect() protoreflect.Message
- func (x *CreateUserRequest) Reset()
- func (x *CreateUserRequest) String() string
- type CreateUserResponse
- func (*CreateUserResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateUserResponse) GetUserId() string
- func (*CreateUserResponse) ProtoMessage()
- func (x *CreateUserResponse) ProtoReflect() protoreflect.Message
- func (x *CreateUserResponse) Reset()
- func (x *CreateUserResponse) String() string
- type DeleteUserRequest
- type DeleteUserResponse
- type FindUsersRequest
- func (*FindUsersRequest) Descriptor() ([]byte, []int)deprecated
- func (x *FindUsersRequest) GetGender() []Gender
- func (x *FindUsersRequest) GetLimit() int32
- func (x *FindUsersRequest) GetOffset() int32
- func (x *FindUsersRequest) GetSortBy() []string
- func (x *FindUsersRequest) GetStatus() []Status
- func (x *FindUsersRequest) GetUserId() []string
- func (*FindUsersRequest) ProtoMessage()
- func (x *FindUsersRequest) ProtoReflect() protoreflect.Message
- func (x *FindUsersRequest) Reset()
- func (x *FindUsersRequest) String() string
- type FindUsersResponse
- type Gender
- type GetUserRequest
- type GetUserResponse
- type Status
- type UnimplementedUsersServer
- func (*UnimplementedUsersServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
- func (*UnimplementedUsersServer) DeleteUser(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)
- func (*UnimplementedUsersServer) FindUsers(context.Context, *FindUsersRequest) (*FindUsersResponse, error)
- func (*UnimplementedUsersServer) GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
- func (*UnimplementedUsersServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
- type UpdateUserRequest
- func (*UpdateUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateUserRequest) GetAvatar() string
- func (x *UpdateUserRequest) GetFirstName() string
- func (x *UpdateUserRequest) GetGender() Gender
- func (x *UpdateUserRequest) GetLastName() string
- func (x *UpdateUserRequest) GetStatus() Status
- func (x *UpdateUserRequest) GetUpdateMask() *field_mask.FieldMask
- func (x *UpdateUserRequest) GetUserId() string
- func (*UpdateUserRequest) ProtoMessage()
- func (x *UpdateUserRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateUserRequest) Reset()
- func (x *UpdateUserRequest) String() string
- type UpdateUserResponse
- func (*UpdateUserResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateUserResponse) GetUserId() string
- func (*UpdateUserResponse) ProtoMessage()
- func (x *UpdateUserResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateUserResponse) Reset()
- func (x *UpdateUserResponse) String() string
- type User
- func (*User) Descriptor() ([]byte, []int)deprecated
- func (x *User) GetAvatar() string
- func (x *User) GetEmail() string
- func (x *User) GetEmailVerified() bool
- func (x *User) GetFirstName() string
- func (x *User) GetGender() Gender
- func (x *User) GetLastName() string
- func (x *User) GetStatus() Status
- func (x *User) GetUserId() string
- func (*User) ProtoMessage()
- func (x *User) ProtoReflect() protoreflect.Message
- func (x *User) Reset()
- func (x *User) String() string
- type UsersClient
- type UsersServer
Constants ¶
This section is empty.
Variables ¶
var ( Gender_name = map[int32]string{ 0: "GENDER_UNSPECIFIED", 1: "GENDER_MALE", 2: "GENDER_FEMALE", 3: "GENDER_OTHER", } Gender_value = map[string]int32{ "GENDER_UNSPECIFIED": 0, "GENDER_MALE": 1, "GENDER_FEMALE": 2, "GENDER_OTHER": 3, } )
Enum value maps for Gender.
var ( Status_name = map[int32]string{ 0: "STATUS_UNSPECIFIED", 1: "STATUS_INACTIVE", 2: "STATUS_ACTIVE", 3: "STATUS_LOCKED", 4: "STATUS_DELETED", } Status_value = map[string]int32{ "STATUS_UNSPECIFIED": 0, "STATUS_INACTIVE": 1, "STATUS_ACTIVE": 2, "STATUS_LOCKED": 3, "STATUS_DELETED": 4, } )
Enum value maps for Status.
var File_api_user_rpc_proto protoreflect.FileDescriptor
Functions ¶
func RegisterUsersHandler ¶
RegisterUsersHandler registers the http handlers for service Users to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterUsersHandlerClient ¶
func RegisterUsersHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UsersClient) error
RegisterUsersHandlerClient registers the http handlers for service Users to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "UsersClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "UsersClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "UsersClient" to call the correct interceptors.
func RegisterUsersHandlerFromEndpoint ¶
func RegisterUsersHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterUsersHandlerFromEndpoint is same as RegisterUsersHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterUsersHandlerServer ¶
func RegisterUsersHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UsersServer) error
RegisterUsersHandlerServer registers the http handlers for service Users to "mux". UnaryRPC :call UsersServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
func RegisterUsersServer ¶
func RegisterUsersServer(s *grpc.Server, srv UsersServer)
Types ¶
type CreateUserRequest ¶
type CreateUserRequest struct { Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"` Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` FirstName string `protobuf:"bytes,3,opt,name=first_name,json=firstName,proto3" json:"first_name,omitempty"` LastName string `protobuf:"bytes,4,opt,name=last_name,json=lastName,proto3" json:"last_name,omitempty"` Gender Gender `protobuf:"varint,5,opt,name=gender,proto3,enum=user.Gender" json:"gender,omitempty"` // contains filtered or unexported fields }
func (*CreateUserRequest) Descriptor
deprecated
func (*CreateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.
func (*CreateUserRequest) GetEmail ¶
func (x *CreateUserRequest) GetEmail() string
func (*CreateUserRequest) GetFirstName ¶
func (x *CreateUserRequest) GetFirstName() string
func (*CreateUserRequest) GetGender ¶
func (x *CreateUserRequest) GetGender() Gender
func (*CreateUserRequest) GetLastName ¶
func (x *CreateUserRequest) GetLastName() string
func (*CreateUserRequest) GetPassword ¶
func (x *CreateUserRequest) GetPassword() string
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 { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` // contains filtered or unexported fields }
func (*CreateUserResponse) Descriptor
deprecated
func (*CreateUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserResponse.ProtoReflect.Descriptor instead.
func (*CreateUserResponse) GetUserId ¶
func (x *CreateUserResponse) GetUserId() string
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 DeleteUserRequest ¶
type DeleteUserRequest struct { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` // contains filtered or unexported fields }
func (*DeleteUserRequest) Descriptor
deprecated
func (*DeleteUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.
func (*DeleteUserRequest) GetUserId ¶
func (x *DeleteUserRequest) GetUserId() string
func (*DeleteUserRequest) ProtoMessage ¶
func (*DeleteUserRequest) ProtoMessage()
func (*DeleteUserRequest) ProtoReflect ¶
func (x *DeleteUserRequest) ProtoReflect() protoreflect.Message
func (*DeleteUserRequest) Reset ¶
func (x *DeleteUserRequest) Reset()
func (*DeleteUserRequest) String ¶
func (x *DeleteUserRequest) String() string
type DeleteUserResponse ¶
type DeleteUserResponse struct {
// contains filtered or unexported fields
}
func (*DeleteUserResponse) Descriptor
deprecated
func (*DeleteUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteUserResponse.ProtoReflect.Descriptor instead.
func (*DeleteUserResponse) ProtoMessage ¶
func (*DeleteUserResponse) ProtoMessage()
func (*DeleteUserResponse) ProtoReflect ¶
func (x *DeleteUserResponse) ProtoReflect() protoreflect.Message
func (*DeleteUserResponse) Reset ¶
func (x *DeleteUserResponse) Reset()
func (*DeleteUserResponse) String ¶
func (x *DeleteUserResponse) String() string
type FindUsersRequest ¶
type FindUsersRequest struct { Offset int32 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"` Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"` UserId []string `protobuf:"bytes,3,rep,name=user_id,json=userId,proto3" json:"user_id,omitempty"` Gender []Gender `protobuf:"varint,4,rep,packed,name=gender,proto3,enum=user.Gender" json:"gender,omitempty"` Status []Status `protobuf:"varint,5,rep,packed,name=status,proto3,enum=user.Status" json:"status,omitempty"` SortBy []string `protobuf:"bytes,6,rep,name=sort_by,json=sortBy,proto3" json:"sort_by,omitempty"` // contains filtered or unexported fields }
func (*FindUsersRequest) Descriptor
deprecated
func (*FindUsersRequest) Descriptor() ([]byte, []int)
Deprecated: Use FindUsersRequest.ProtoReflect.Descriptor instead.
func (*FindUsersRequest) GetGender ¶
func (x *FindUsersRequest) GetGender() []Gender
func (*FindUsersRequest) GetLimit ¶
func (x *FindUsersRequest) GetLimit() int32
func (*FindUsersRequest) GetOffset ¶
func (x *FindUsersRequest) GetOffset() int32
func (*FindUsersRequest) GetSortBy ¶
func (x *FindUsersRequest) GetSortBy() []string
func (*FindUsersRequest) GetStatus ¶
func (x *FindUsersRequest) GetStatus() []Status
func (*FindUsersRequest) GetUserId ¶
func (x *FindUsersRequest) GetUserId() []string
func (*FindUsersRequest) ProtoMessage ¶
func (*FindUsersRequest) ProtoMessage()
func (*FindUsersRequest) ProtoReflect ¶
func (x *FindUsersRequest) ProtoReflect() protoreflect.Message
func (*FindUsersRequest) Reset ¶
func (x *FindUsersRequest) Reset()
func (*FindUsersRequest) String ¶
func (x *FindUsersRequest) String() string
type FindUsersResponse ¶
type FindUsersResponse struct { Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"` // contains filtered or unexported fields }
func (*FindUsersResponse) Descriptor
deprecated
func (*FindUsersResponse) Descriptor() ([]byte, []int)
Deprecated: Use FindUsersResponse.ProtoReflect.Descriptor instead.
func (*FindUsersResponse) GetUsers ¶
func (x *FindUsersResponse) GetUsers() []*User
func (*FindUsersResponse) ProtoMessage ¶
func (*FindUsersResponse) ProtoMessage()
func (*FindUsersResponse) ProtoReflect ¶
func (x *FindUsersResponse) ProtoReflect() protoreflect.Message
func (*FindUsersResponse) Reset ¶
func (x *FindUsersResponse) Reset()
func (*FindUsersResponse) String ¶
func (x *FindUsersResponse) String() string
type Gender ¶
type Gender int32
func (Gender) Descriptor ¶
func (Gender) Descriptor() protoreflect.EnumDescriptor
func (Gender) EnumDescriptor
deprecated
func (Gender) Number ¶
func (x Gender) Number() protoreflect.EnumNumber
func (Gender) Type ¶
func (Gender) Type() protoreflect.EnumType
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 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 UnimplementedUsersServer ¶
type UnimplementedUsersServer struct { }
UnimplementedUsersServer can be embedded to have forward compatible implementations.
func (*UnimplementedUsersServer) CreateUser ¶
func (*UnimplementedUsersServer) CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error)
func (*UnimplementedUsersServer) DeleteUser ¶
func (*UnimplementedUsersServer) DeleteUser(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error)
func (*UnimplementedUsersServer) FindUsers ¶
func (*UnimplementedUsersServer) FindUsers(context.Context, *FindUsersRequest) (*FindUsersResponse, error)
func (*UnimplementedUsersServer) GetUser ¶
func (*UnimplementedUsersServer) GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
func (*UnimplementedUsersServer) UpdateUser ¶
func (*UnimplementedUsersServer) UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error)
type UpdateUserRequest ¶
type UpdateUserRequest struct { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` FirstName string `protobuf:"bytes,2,opt,name=first_name,json=firstName,proto3" json:"first_name,omitempty"` LastName string `protobuf:"bytes,3,opt,name=last_name,json=lastName,proto3" json:"last_name,omitempty"` Gender Gender `protobuf:"varint,4,opt,name=gender,proto3,enum=user.Gender" json:"gender,omitempty"` Avatar string `protobuf:"bytes,5,opt,name=avatar,proto3" json:"avatar,omitempty"` Status Status `protobuf:"varint,6,opt,name=status,proto3,enum=user.Status" json:"status,omitempty"` UpdateMask *field_mask.FieldMask `protobuf:"bytes,7,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // contains filtered or unexported fields }
func (*UpdateUserRequest) Descriptor
deprecated
func (*UpdateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.
func (*UpdateUserRequest) GetAvatar ¶
func (x *UpdateUserRequest) GetAvatar() string
func (*UpdateUserRequest) GetFirstName ¶
func (x *UpdateUserRequest) GetFirstName() string
func (*UpdateUserRequest) GetGender ¶
func (x *UpdateUserRequest) GetGender() Gender
func (*UpdateUserRequest) GetLastName ¶
func (x *UpdateUserRequest) GetLastName() string
func (*UpdateUserRequest) GetStatus ¶
func (x *UpdateUserRequest) GetStatus() Status
func (*UpdateUserRequest) GetUpdateMask ¶
func (x *UpdateUserRequest) GetUpdateMask() *field_mask.FieldMask
func (*UpdateUserRequest) GetUserId ¶
func (x *UpdateUserRequest) GetUserId() string
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 { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` // contains filtered or unexported fields }
func (*UpdateUserResponse) Descriptor
deprecated
func (*UpdateUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserResponse.ProtoReflect.Descriptor instead.
func (*UpdateUserResponse) GetUserId ¶
func (x *UpdateUserResponse) GetUserId() string
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 { UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"` Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"` Gender Gender `protobuf:"varint,3,opt,name=gender,proto3,enum=user.Gender" json:"gender,omitempty"` Status Status `protobuf:"varint,4,opt,name=status,proto3,enum=user.Status" json:"status,omitempty"` FirstName string `protobuf:"bytes,5,opt,name=first_name,json=firstName,proto3" json:"first_name,omitempty"` LastName string `protobuf:"bytes,6,opt,name=last_name,json=lastName,proto3" json:"last_name,omitempty"` Avatar string `protobuf:"bytes,7,opt,name=avatar,proto3" json:"avatar,omitempty"` EmailVerified bool `protobuf:"varint,9,opt,name=email_verified,json=emailVerified,proto3" json:"email_verified,omitempty"` // contains filtered or unexported fields }
func (*User) Descriptor
deprecated
func (*User) GetEmailVerified ¶
func (*User) GetFirstName ¶
func (*User) GetLastName ¶
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) ProtoReflect ¶
func (x *User) ProtoReflect() protoreflect.Message
type UsersClient ¶
type UsersClient interface { // CreateUser create a new user. CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*CreateUserResponse, error) // GetUser get user detail. GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*GetUserResponse, error) // UpdateUser update user info. UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*UpdateUserResponse, error) // DeleteUser delete the user. DeleteUser(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*DeleteUserResponse, error) // FindUsers list all users. FindUsers(ctx context.Context, in *FindUsersRequest, opts ...grpc.CallOption) (*FindUsersResponse, error) }
UsersClient is the client API for Users service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewUsersClient ¶
func NewUsersClient(cc grpc.ClientConnInterface) UsersClient
type UsersServer ¶
type UsersServer interface { // CreateUser create a new user. CreateUser(context.Context, *CreateUserRequest) (*CreateUserResponse, error) // GetUser get user detail. GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error) // UpdateUser update user info. UpdateUser(context.Context, *UpdateUserRequest) (*UpdateUserResponse, error) // DeleteUser delete the user. DeleteUser(context.Context, *DeleteUserRequest) (*DeleteUserResponse, error) // FindUsers list all users. FindUsers(context.Context, *FindUsersRequest) (*FindUsersResponse, error) }
UsersServer is the server API for Users service.