package google.example.library.v1

Get desktop application:
View/edit binary Protocol Buffers messages

This API represents a simple digital library. It lets you manage Shelf resources and Book resources in the library. It defines the following resource model: - The API has a collection of [Shelf][google.example.library.v1.Shelf] resources, named `shelves/*` - Each Shelf has a collection of [Book][google.example.library.v1.Book] resources, named `shelves/*/books/*`

• rpc CreateShelf (CreateShelfRequest, Shelf)

  library.proto:42

  Creates a shelf, and returns the new Shelf.

  message CreateShelfRequest

  library.proto:187

  Request message for LibraryService.CreateShelf.

  • optional Shelf shelf = 1

    The shelf to create.

• rpc GetShelf (GetShelfRequest, Shelf)

  library.proto:51

  Gets a shelf. Returns NOT_FOUND if the shelf does not exist.

  message GetShelfRequest

  library.proto:193

  Request message for LibraryService.GetShelf.

  • string name = 1

    The name of the shelf to retrieve.

• rpc ListShelves (ListShelvesRequest, ListShelvesResponse)

  library.proto:60

  Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

  message ListShelvesRequest

  library.proto:202

  Request message for LibraryService.ListShelves.

  • int32 page_size = 1

    Requested page size. Server may return fewer shelves than requested. If unspecified, server will pick an appropriate default.

  • string page_token = 2

    A token identifying a page of results the server should return. Typically, this is the value of [ListShelvesResponse.next_page_token][google.example.library.v1.ListShelvesResponse.next_page_token] returned from the previous call to `ListShelves` method.

  message ListShelvesResponse

  library.proto:215

  Response message for LibraryService.ListShelves.

  • repeated Shelf shelves = 1

    The list of shelves.

  • string next_page_token = 2

    A token to retrieve next page of results. Pass this value in the [ListShelvesRequest.page_token][google.example.library.v1.ListShelvesRequest.page_token] field in the subsequent call to `ListShelves` method to retrieve the next page of results.

• rpc DeleteShelf (DeleteShelfRequest, protobuf.Empty)

  library.proto:67

  Deletes a shelf. Returns NOT_FOUND if the shelf does not exist.

  message DeleteShelfRequest

  library.proto:228

  Request message for LibraryService.DeleteShelf.

  • string name = 1

    The name of the shelf to delete.

• rpc MergeShelves (MergeShelvesRequest, Shelf)

  library.proto:81

  Merges two shelves by adding all books from the shelf named `other_shelf_name` to shelf `name`, and deletes `other_shelf_name`. Returns the updated shelf. The book ids of the moved books may not be the same as the original books. Returns NOT_FOUND if either shelf does not exist. This call is a no-op if the specified shelves are the same.

  message MergeShelvesRequest

  library.proto:238

  Describes the shelf being removed (other_shelf_name) and updated (name) in this merge.

  • string name = 1

    The name of the shelf we're adding books to.

  • string other_shelf_name = 2

    The name of the shelf we're removing books from and deleting.

• rpc CreateBook (CreateBookRequest, Book)

  library.proto:90

  Creates a book, and returns the new Book.

  message CreateBookRequest

  library.proto:253

  Request message for LibraryService.CreateBook.

  • string name = 1

    The name of the shelf in which the book is created.

  • optional Book book = 2

    The book to create.

• rpc GetBook (GetBookRequest, Book)

  library.proto:99

  Gets a book. Returns NOT_FOUND if the book does not exist.

  message GetBookRequest

  library.proto:265

  Request message for LibraryService.GetBook.

  • string name = 1

    The name of the book to retrieve.

• rpc ListBooks (ListBooksRequest, ListBooksResponse)

  library.proto:109

  Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

  message ListBooksRequest

  library.proto:274

  Request message for LibraryService.ListBooks.

  • string name = 1

    The name of the shelf whose books we'd like to list.

  • int32 page_size = 2

    Requested page size. Server may return fewer books than requested. If unspecified, server will pick an appropriate default.

  • string page_token = 3

    A token identifying a page of results the server should return. Typically, this is the value of [ListBooksResponse.next_page_token][google.example.library.v1.ListBooksResponse.next_page_token]. returned from the previous call to `ListBooks` method.

  message ListBooksResponse

  library.proto:293

  Response message for LibraryService.ListBooks.

  • repeated Book books = 1

    The list of books.

  • string next_page_token = 2

    A token to retrieve next page of results. Pass this value in the [ListBooksRequest.page_token][google.example.library.v1.ListBooksRequest.page_token] field in the subsequent call to `ListBooks` method to retrieve the next page of results.

• rpc DeleteBook (DeleteBookRequest, protobuf.Empty)

  library.proto:117

  Deletes a book. Returns NOT_FOUND if the book does not exist.

  message DeleteBookRequest

  library.proto:315

  Request message for LibraryService.DeleteBook.

  • string name = 1

    The name of the book to delete.

• rpc UpdateBook (UpdateBookRequest, Book)

  library.proto:125

  Updates a book. Returns INVALID_ARGUMENT if the name of the book is non-empty and does not equal the existing name.

  message UpdateBookRequest

  library.proto:306

  Request message for LibraryService.UpdateBook.

  • string name = 1

    The name of the book to update.

  • optional Book book = 2

    The book to update with. The name must match or be empty.

• rpc MoveBook (MoveBookRequest, Book)

  library.proto:135

  Moves a book to another shelf, and returns the new book. The book id of the new book may not be the same as the original book.

  message MoveBookRequest

  library.proto:325

  Describes what book to move (name) and what shelf we're moving it to (other_shelf_name).

  • string name = 1

    The name of the book to move.

  • string other_shelf_name = 2

    The name of the destination shelf.

A single book in the library.

Used as response type in: LibraryService.CreateBook, LibraryService.GetBook, LibraryService.MoveBook, LibraryService.UpdateBook

Used as field type in: CreateBookRequest, ListBooksResponse, UpdateBookRequest

• string name = 1

  The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book.

• string author = 2

  The name of the book author.

• string title = 3

  The title of the book.

• bool read = 4

  Value indicating whether the book has been read.

A Shelf contains a collection of books with a theme.

Used as response type in: LibraryService.CreateShelf, LibraryService.GetShelf, LibraryService.MergeShelves

Used as field type in: CreateShelfRequest, ListShelvesResponse

• string name = 1

  The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf.

• string theme = 2

  The theme of the shelf