get(name, x__xgafv=None)

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

Args:
  name: string, The name of the shelf to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Shelf contains a collection of books with a theme.
    "theme": "A String", # The theme of the shelf
    "name": "A String", # Output only. The resource name of the shelf.
        # Shelf names have the form `shelves/{shelf_id}`.
        # The name is ignored when creating a shelf.
  }

list(pageSize=None, pageToken=None, x__xgafv=None)

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

Args:
  pageSize: integer, Requested page size. Server may return fewer shelves than requested.
If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
ListShelvesResponse.next_page_token
returned from the previous call to `ListShelves` method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for LibraryAgent.ListShelves.
    "nextPageToken": "A String", # A token to retrieve next page of results.
        # Pass this value in the
        # ListShelvesRequest.page_token
        # field in the subsequent call to `ListShelves` method to retrieve the next
        # page of results.
    "shelves": [ # The list of shelves.
      { # A Shelf contains a collection of books with a theme.
        "theme": "A String", # The theme of the shelf
        "name": "A String", # Output only. The resource name of the shelf.
            # Shelf names have the form `shelves/{shelf_id}`.
            # The name is ignored when creating a shelf.
      },
    ],
  }

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

Library Agent API . shelves

Instance Methods

Method Details