bookv1

package
v0.0.0-...-04c85bf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var BookService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "acme.book.v1.BookService",
	HandlerType: (*BookServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListBooks",
			Handler:    _BookService_ListBooks_Handler,
		},
		{
			MethodName: "BatchGetBooks",
			Handler:    _BookService_BatchGetBooks_Handler,
		},
		{
			MethodName: "GetBook",
			Handler:    _BookService_GetBook_Handler,
		},
		{
			MethodName: "CreateBook",
			Handler:    _BookService_CreateBook_Handler,
		},
		{
			MethodName: "UpdateBook",
			Handler:    _BookService_UpdateBook_Handler,
		},
		{
			MethodName: "DeleteBook",
			Handler:    _BookService_DeleteBook_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "acme/book/v1/service.proto",
}

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

View Source
var File_acme_book_v1_request_response_proto protoreflect.FileDescriptor
View Source
var File_acme_book_v1_resource_proto protoreflect.FileDescriptor
View Source
var File_acme_book_v1_service_proto protoreflect.FileDescriptor

Functions

func RegisterBookServiceServer

func RegisterBookServiceServer(s grpc.ServiceRegistrar, srv BookServiceServer)

Types

type BatchGetBooksRequest

type BatchGetBooksRequest struct {

	// The ids of the requested books.
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

The standard BatchGet request definition.

func (*BatchGetBooksRequest) Descriptor deprecated

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

Deprecated: Use BatchGetBooksRequest.ProtoReflect.Descriptor instead.

func (*BatchGetBooksRequest) GetIds

func (x *BatchGetBooksRequest) GetIds() []string

func (*BatchGetBooksRequest) ProtoMessage

func (*BatchGetBooksRequest) ProtoMessage()

func (*BatchGetBooksRequest) ProtoReflect

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

func (*BatchGetBooksRequest) Reset

func (x *BatchGetBooksRequest) Reset()

func (*BatchGetBooksRequest) String

func (x *BatchGetBooksRequest) String() string

type BatchGetBooksResponse

type BatchGetBooksResponse struct {

	// The retrieved books.
	Books []*Book `protobuf:"bytes,1,rep,name=books,proto3" json:"books,omitempty"`
	// contains filtered or unexported fields
}

The standard BatchGet response definition.

func (*BatchGetBooksResponse) Descriptor deprecated

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

Deprecated: Use BatchGetBooksResponse.ProtoReflect.Descriptor instead.

func (*BatchGetBooksResponse) GetBooks

func (x *BatchGetBooksResponse) GetBooks() []*Book

func (*BatchGetBooksResponse) ProtoMessage

func (*BatchGetBooksResponse) ProtoMessage()

func (*BatchGetBooksResponse) ProtoReflect

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

func (*BatchGetBooksResponse) Reset

func (x *BatchGetBooksResponse) Reset()

func (*BatchGetBooksResponse) String

func (x *BatchGetBooksResponse) String() string

type Book

type Book struct {

	// The unique book id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Indicates when the book was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Indicates when the book was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The unique id of the parent shelf resource.
	ShelfId string `protobuf:"bytes,4,opt,name=shelf_id,json=shelfId,proto3" json:"shelf_id,omitempty"`
	// The display name for the book.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

The default Book resource representation.

func (*Book) Descriptor deprecated

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

Deprecated: Use Book.ProtoReflect.Descriptor instead.

func (*Book) GetCreateTime

func (x *Book) GetCreateTime() *timestamppb.Timestamp

func (*Book) GetDisplayName

func (x *Book) GetDisplayName() string

func (*Book) GetId

func (x *Book) GetId() string

func (*Book) GetShelfId

func (x *Book) GetShelfId() string

func (*Book) GetUpdateTime

func (x *Book) GetUpdateTime() *timestamppb.Timestamp

func (*Book) ProtoMessage

func (*Book) ProtoMessage()

func (*Book) ProtoReflect

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

func (*Book) Reset

func (x *Book) Reset()

func (*Book) String

func (x *Book) String() string

type BookServiceClient

type BookServiceClient interface {
	// ListBooks retrieves a list of book resources from the server.
	ListBooks(ctx context.Context, in *ListBooksRequest, opts ...grpc.CallOption) (*ListBooksResponse, error)
	// BatchGetBooks retrieves multiple book resources from the server.
	BatchGetBooks(ctx context.Context, in *BatchGetBooksRequest, opts ...grpc.CallOption) (*BatchGetBooksResponse, error)
	// GetBook retrieves a single book resource from the server.
	GetBook(ctx context.Context, in *GetBookRequest, opts ...grpc.CallOption) (*GetBookResponse, error)
	// CreateBook creates a new book resource on the server.
	CreateBook(ctx context.Context, in *CreateBookRequest, opts ...grpc.CallOption) (*CreateBookResponse, error)
	// UpdateBook updates the book resource on the server.
	UpdateBook(ctx context.Context, in *UpdateBookRequest, opts ...grpc.CallOption) (*UpdateBookResponse, error)
	// DeleteBook deletes the book resource from the server.
	DeleteBook(ctx context.Context, in *DeleteBookRequest, opts ...grpc.CallOption) (*DeleteBookResponse, error)
}

BookServiceClient is the client API for BookService 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.

type BookServiceServer

type BookServiceServer interface {
	// ListBooks retrieves a list of book resources from the server.
	ListBooks(context.Context, *ListBooksRequest) (*ListBooksResponse, error)
	// BatchGetBooks retrieves multiple book resources from the server.
	BatchGetBooks(context.Context, *BatchGetBooksRequest) (*BatchGetBooksResponse, error)
	// GetBook retrieves a single book resource from the server.
	GetBook(context.Context, *GetBookRequest) (*GetBookResponse, error)
	// CreateBook creates a new book resource on the server.
	CreateBook(context.Context, *CreateBookRequest) (*CreateBookResponse, error)
	// UpdateBook updates the book resource on the server.
	UpdateBook(context.Context, *UpdateBookRequest) (*UpdateBookResponse, error)
	// DeleteBook deletes the book resource from the server.
	DeleteBook(context.Context, *DeleteBookRequest) (*DeleteBookResponse, error)
}

BookServiceServer is the server API for BookService service. All implementations should embed UnimplementedBookServiceServer for forward compatibility

type CreateBookRequest

type CreateBookRequest struct {

	// The book to create.
	Book *Book `protobuf:"bytes,1,opt,name=book,proto3" json:"book,omitempty"`
	// The unique id of the parent shelf where the book is to be created.
	ShelfId string `protobuf:"bytes,4,opt,name=shelf_id,json=shelfId,proto3" json:"shelf_id,omitempty"`
	// contains filtered or unexported fields
}

The standard Create request definition.

func (*CreateBookRequest) Descriptor deprecated

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

Deprecated: Use CreateBookRequest.ProtoReflect.Descriptor instead.

func (*CreateBookRequest) GetBook

func (x *CreateBookRequest) GetBook() *Book

func (*CreateBookRequest) GetShelfId

func (x *CreateBookRequest) GetShelfId() string

func (*CreateBookRequest) ProtoMessage

func (*CreateBookRequest) ProtoMessage()

func (*CreateBookRequest) ProtoReflect

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

func (*CreateBookRequest) Reset

func (x *CreateBookRequest) Reset()

func (*CreateBookRequest) String

func (x *CreateBookRequest) String() string

type CreateBookResponse

type CreateBookResponse struct {

	// The created book.
	Book *Book `protobuf:"bytes,1,opt,name=book,proto3" json:"book,omitempty"`
	// contains filtered or unexported fields
}

The standard Create response definition.

func (*CreateBookResponse) Descriptor deprecated

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

Deprecated: Use CreateBookResponse.ProtoReflect.Descriptor instead.

func (*CreateBookResponse) GetBook

func (x *CreateBookResponse) GetBook() *Book

func (*CreateBookResponse) ProtoMessage

func (*CreateBookResponse) ProtoMessage()

func (*CreateBookResponse) ProtoReflect

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

func (*CreateBookResponse) Reset

func (x *CreateBookResponse) Reset()

func (*CreateBookResponse) String

func (x *CreateBookResponse) String() string

type DeleteBookRequest

type DeleteBookRequest struct {

	// The id of the book to be deleted.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

The standard Delete request definition.

func (*DeleteBookRequest) Descriptor deprecated

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

Deprecated: Use DeleteBookRequest.ProtoReflect.Descriptor instead.

func (*DeleteBookRequest) GetId

func (x *DeleteBookRequest) GetId() string

func (*DeleteBookRequest) ProtoMessage

func (*DeleteBookRequest) ProtoMessage()

func (*DeleteBookRequest) ProtoReflect

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

func (*DeleteBookRequest) Reset

func (x *DeleteBookRequest) Reset()

func (*DeleteBookRequest) String

func (x *DeleteBookRequest) String() string

type DeleteBookResponse

type DeleteBookResponse struct {

	// The deleted book.
	Book *Book `protobuf:"bytes,1,opt,name=book,proto3" json:"book,omitempty"`
	// contains filtered or unexported fields
}

The standard Delete response definition.

func (*DeleteBookResponse) Descriptor deprecated

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

Deprecated: Use DeleteBookResponse.ProtoReflect.Descriptor instead.

func (*DeleteBookResponse) GetBook

func (x *DeleteBookResponse) GetBook() *Book

func (*DeleteBookResponse) ProtoMessage

func (*DeleteBookResponse) ProtoMessage()

func (*DeleteBookResponse) ProtoReflect

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

func (*DeleteBookResponse) Reset

func (x *DeleteBookResponse) Reset()

func (*DeleteBookResponse) String

func (x *DeleteBookResponse) String() string

type GetBookRequest

type GetBookRequest struct {

	// The id of the requested book.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

The standard Get request definition.

func (*GetBookRequest) Descriptor deprecated

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

Deprecated: Use GetBookRequest.ProtoReflect.Descriptor instead.

func (*GetBookRequest) GetId

func (x *GetBookRequest) GetId() string

func (*GetBookRequest) ProtoMessage

func (*GetBookRequest) ProtoMessage()

func (*GetBookRequest) ProtoReflect

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

func (*GetBookRequest) Reset

func (x *GetBookRequest) Reset()

func (*GetBookRequest) String

func (x *GetBookRequest) String() string

type GetBookResponse

type GetBookResponse struct {

	// The retrieved book.
	Book *Book `protobuf:"bytes,1,opt,name=book,proto3" json:"book,omitempty"`
	// contains filtered or unexported fields
}

The standard Get response definition.

func (*GetBookResponse) Descriptor deprecated

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

Deprecated: Use GetBookResponse.ProtoReflect.Descriptor instead.

func (*GetBookResponse) GetBook

func (x *GetBookResponse) GetBook() *Book

func (*GetBookResponse) ProtoMessage

func (*GetBookResponse) ProtoMessage()

func (*GetBookResponse) ProtoReflect

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

func (*GetBookResponse) Reset

func (x *GetBookResponse) Reset()

func (*GetBookResponse) String

func (x *GetBookResponse) String() string

type ListBooksRequest

type ListBooksRequest struct {

	// Only retrieve books after this time.
	AfterTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=after_time,json=afterTime,proto3" json:"after_time,omitempty"`
	// Only retrieve books before this time.
	BeforeTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=before_time,json=beforeTime,proto3" json:"before_time,omitempty"`
	// The start index for pagination.
	Start uint64 `protobuf:"varint,3,opt,name=start,proto3" json:"start,omitempty"`
	// The maximum number of books to return.
	MaxSize uint64 `protobuf:"varint,4,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// The unique id of the parent shelf for which to list the books.
	ShelfId string `protobuf:"bytes,5,opt,name=shelf_id,json=shelfId,proto3" json:"shelf_id,omitempty"`
	// contains filtered or unexported fields
}

The standard List request definition.

func (*ListBooksRequest) Descriptor deprecated

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

Deprecated: Use ListBooksRequest.ProtoReflect.Descriptor instead.

func (*ListBooksRequest) GetAfterTime

func (x *ListBooksRequest) GetAfterTime() *timestamppb.Timestamp

func (*ListBooksRequest) GetBeforeTime

func (x *ListBooksRequest) GetBeforeTime() *timestamppb.Timestamp

func (*ListBooksRequest) GetMaxSize

func (x *ListBooksRequest) GetMaxSize() uint64

func (*ListBooksRequest) GetShelfId

func (x *ListBooksRequest) GetShelfId() string

func (*ListBooksRequest) GetStart

func (x *ListBooksRequest) GetStart() uint64

func (*ListBooksRequest) ProtoMessage

func (*ListBooksRequest) ProtoMessage()

func (*ListBooksRequest) ProtoReflect

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

func (*ListBooksRequest) Reset

func (x *ListBooksRequest) Reset()

func (*ListBooksRequest) String

func (x *ListBooksRequest) String() string

type ListBooksResponse

type ListBooksResponse struct {

	// The retrieved list of books.
	Books []*Book `protobuf:"bytes,1,rep,name=books,proto3" json:"books,omitempty"`
	// True if more books are available.
	Next bool `protobuf:"varint,2,opt,name=next,proto3" json:"next,omitempty"`
	// contains filtered or unexported fields
}

The standard List response definition.

func (*ListBooksResponse) Descriptor deprecated

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

Deprecated: Use ListBooksResponse.ProtoReflect.Descriptor instead.

func (*ListBooksResponse) GetBooks

func (x *ListBooksResponse) GetBooks() []*Book

func (*ListBooksResponse) GetNext

func (x *ListBooksResponse) GetNext() bool

func (*ListBooksResponse) ProtoMessage

func (*ListBooksResponse) ProtoMessage()

func (*ListBooksResponse) ProtoReflect

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

func (*ListBooksResponse) Reset

func (x *ListBooksResponse) Reset()

func (*ListBooksResponse) String

func (x *ListBooksResponse) String() string

type UnimplementedBookServiceServer

type UnimplementedBookServiceServer struct {
}

UnimplementedBookServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedBookServiceServer) BatchGetBooks

func (UnimplementedBookServiceServer) CreateBook

func (UnimplementedBookServiceServer) DeleteBook

func (UnimplementedBookServiceServer) GetBook

func (UnimplementedBookServiceServer) ListBooks

func (UnimplementedBookServiceServer) UpdateBook

type UnsafeBookServiceServer

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

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

type UpdateBookRequest

type UpdateBookRequest struct {

	// The id of the book to be updated.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The book which replaces the book on the server.
	Book *Book `protobuf:"bytes,2,opt,name=book,proto3" json:"book,omitempty"`
	// The update mask applied to the book. See https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The standard Update request definition.

func (*UpdateBookRequest) Descriptor deprecated

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

Deprecated: Use UpdateBookRequest.ProtoReflect.Descriptor instead.

func (*UpdateBookRequest) GetBook

func (x *UpdateBookRequest) GetBook() *Book

func (*UpdateBookRequest) GetId

func (x *UpdateBookRequest) GetId() string

func (*UpdateBookRequest) GetUpdateMask

func (x *UpdateBookRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateBookRequest) ProtoMessage

func (*UpdateBookRequest) ProtoMessage()

func (*UpdateBookRequest) ProtoReflect

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

func (*UpdateBookRequest) Reset

func (x *UpdateBookRequest) Reset()

func (*UpdateBookRequest) String

func (x *UpdateBookRequest) String() string

type UpdateBookResponse

type UpdateBookResponse struct {

	// The updated book.
	Book *Book `protobuf:"bytes,1,opt,name=book,proto3" json:"book,omitempty"`
	// contains filtered or unexported fields
}

The standard Update response definition.

func (*UpdateBookResponse) Descriptor deprecated

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

Deprecated: Use UpdateBookResponse.ProtoReflect.Descriptor instead.

func (*UpdateBookResponse) GetBook

func (x *UpdateBookResponse) GetBook() *Book

func (*UpdateBookResponse) ProtoMessage

func (*UpdateBookResponse) ProtoMessage()

func (*UpdateBookResponse) ProtoReflect

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

func (*UpdateBookResponse) Reset

func (x *UpdateBookResponse) Reset()

func (*UpdateBookResponse) String

func (x *UpdateBookResponse) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL