books  v1
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_books_api::Volume Class Reference

#include <volume.h>

Inheritance diagram for google_books_api::Volume:

Classes

class  VolumeAccessInfo
 
class  VolumeLayerInfo
 
class  VolumeRecommendedInfo
 
class  VolumeSaleInfo
 
class  VolumeSearchInfo
 
class  VolumeUserInfo
 
class  VolumeVolumeInfo
 

Public Member Functions

 Volume (const Json::Value &storage)
 
 Volume (Json::Value *storage)
 
virtual ~Volume ()
 
const StringPiece GetTypeName () const
 
bool has_access_info () const
 
void clear_access_info ()
 
const VolumeAccessInfo get_access_info () const
 
VolumeAccessInfo mutable_accessInfo ()
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_layer_info () const
 
void clear_layer_info ()
 
const VolumeLayerInfo get_layer_info () const
 
VolumeLayerInfo mutable_layerInfo ()
 
bool has_recommended_info () const
 
void clear_recommended_info ()
 
const VolumeRecommendedInfo get_recommended_info () const
 
VolumeRecommendedInfo mutable_recommendedInfo ()
 
bool has_sale_info () const
 
void clear_sale_info ()
 
const VolumeSaleInfo get_sale_info () const
 
VolumeSaleInfo mutable_saleInfo ()
 
bool has_search_info () const
 
void clear_search_info ()
 
const VolumeSearchInfo get_search_info () const
 
VolumeSearchInfo mutable_searchInfo ()
 
bool has_self_link () const
 
void clear_self_link ()
 
const StringPiece get_self_link () const
 
void set_self_link (const StringPiece &value)
 
bool has_user_info () const
 
void clear_user_info ()
 
const VolumeUserInfo get_user_info () const
 
VolumeUserInfo mutable_userInfo ()
 
bool has_volume_info () const
 
void clear_volume_info ()
 
const VolumeVolumeInfo get_volume_info () const
 
VolumeVolumeInfo mutable_volumeInfo ()
 

Static Public Member Functions

static VolumeNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ Volume() [1/2]

google_books_api::Volume::Volume ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ Volume() [2/2]

google_books_api::Volume::Volume ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~Volume()

google_books_api::Volume::~Volume ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_access_info()

void google_books_api::Volume::clear_access_info ( )
inline

Clears the 'accessInfo' attribute.

◆ clear_etag()

void google_books_api::Volume::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_id()

void google_books_api::Volume::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_books_api::Volume::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_layer_info()

void google_books_api::Volume::clear_layer_info ( )
inline

Clears the 'layerInfo' attribute.

◆ clear_recommended_info()

void google_books_api::Volume::clear_recommended_info ( )
inline

Clears the 'recommendedInfo' attribute.

◆ clear_sale_info()

void google_books_api::Volume::clear_sale_info ( )
inline

Clears the 'saleInfo' attribute.

◆ clear_search_info()

void google_books_api::Volume::clear_search_info ( )
inline

Clears the 'searchInfo' attribute.

◆ clear_self_link()

void google_books_api::Volume::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_user_info()

void google_books_api::Volume::clear_user_info ( )
inline

Clears the 'userInfo' attribute.

◆ clear_volume_info()

void google_books_api::Volume::clear_volume_info ( )
inline

Clears the 'volumeInfo' attribute.

◆ get_access_info()

const VolumeAccessInfo google_books_api::Volume::get_access_info ( ) const
inline

Get a reference to the value of the 'accessInfo' attribute.

◆ get_etag()

const StringPiece google_books_api::Volume::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_id()

const StringPiece google_books_api::Volume::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_books_api::Volume::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_layer_info()

const VolumeLayerInfo google_books_api::Volume::get_layer_info ( ) const
inline

Get a reference to the value of the 'layerInfo' attribute.

◆ get_recommended_info()

const VolumeRecommendedInfo google_books_api::Volume::get_recommended_info ( ) const
inline

Get a reference to the value of the 'recommendedInfo' attribute.

◆ get_sale_info()

const VolumeSaleInfo google_books_api::Volume::get_sale_info ( ) const
inline

Get a reference to the value of the 'saleInfo' attribute.

◆ get_search_info()

const VolumeSearchInfo google_books_api::Volume::get_search_info ( ) const
inline

Get a reference to the value of the 'searchInfo' attribute.

◆ get_self_link()

const StringPiece google_books_api::Volume::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_user_info()

const VolumeUserInfo google_books_api::Volume::get_user_info ( ) const
inline

Get a reference to the value of the 'userInfo' attribute.

◆ get_volume_info()

const VolumeVolumeInfo google_books_api::Volume::get_volume_info ( ) const
inline

Get a reference to the value of the 'volumeInfo' attribute.

◆ GetTypeName()

const StringPiece google_books_api::Volume::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_books_api::Volume

◆ has_access_info()

bool google_books_api::Volume::has_access_info ( ) const
inline

Determine if the 'accessInfo' attribute was set.

Returns
true if the 'accessInfo' attribute was set.

◆ has_etag()

bool google_books_api::Volume::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_id()

bool google_books_api::Volume::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_books_api::Volume::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_layer_info()

bool google_books_api::Volume::has_layer_info ( ) const
inline

Determine if the 'layerInfo' attribute was set.

Returns
true if the 'layerInfo' attribute was set.

◆ has_recommended_info()

bool google_books_api::Volume::has_recommended_info ( ) const
inline

Determine if the 'recommendedInfo' attribute was set.

Returns
true if the 'recommendedInfo' attribute was set.

◆ has_sale_info()

bool google_books_api::Volume::has_sale_info ( ) const
inline

Determine if the 'saleInfo' attribute was set.

Returns
true if the 'saleInfo' attribute was set.

◆ has_search_info()

bool google_books_api::Volume::has_search_info ( ) const
inline

Determine if the 'searchInfo' attribute was set.

Returns
true if the 'searchInfo' attribute was set.

◆ has_self_link()

bool google_books_api::Volume::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_user_info()

bool google_books_api::Volume::has_user_info ( ) const
inline

Determine if the 'userInfo' attribute was set.

Returns
true if the 'userInfo' attribute was set.

◆ has_volume_info()

bool google_books_api::Volume::has_volume_info ( ) const
inline

Determine if the 'volumeInfo' attribute was set.

Returns
true if the 'volumeInfo' attribute was set.

◆ mutable_accessInfo()

VolumeAccessInfo google_books_api::Volume::mutable_accessInfo ( )
inline

Gets a reference to a mutable value of the 'accessInfo' property.

Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).

Returns
The result can be modified to change the attribute value.

◆ mutable_layerInfo()

VolumeLayerInfo google_books_api::Volume::mutable_layerInfo ( )
inline

Gets a reference to a mutable value of the 'layerInfo' property.

What layers exist in this volume and high level information about them.

Returns
The result can be modified to change the attribute value.

◆ mutable_recommendedInfo()

VolumeRecommendedInfo google_books_api::Volume::mutable_recommendedInfo ( )
inline

Gets a reference to a mutable value of the 'recommendedInfo' property.

Recommendation related information for this volume.

Returns
The result can be modified to change the attribute value.

◆ mutable_saleInfo()

VolumeSaleInfo google_books_api::Volume::mutable_saleInfo ( )
inline

Gets a reference to a mutable value of the 'saleInfo' property.

Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).

Returns
The result can be modified to change the attribute value.

◆ mutable_searchInfo()

VolumeSearchInfo google_books_api::Volume::mutable_searchInfo ( )
inline

Gets a reference to a mutable value of the 'searchInfo' property.

Search result information related to this volume.

Returns
The result can be modified to change the attribute value.

◆ mutable_userInfo()

VolumeUserInfo google_books_api::Volume::mutable_userInfo ( )
inline

Gets a reference to a mutable value of the 'userInfo' property.

User specific information related to this volume. (e.g. page this user last read or whether they purchased this book).

Returns
The result can be modified to change the attribute value.

◆ mutable_volumeInfo()

VolumeVolumeInfo google_books_api::Volume::mutable_volumeInfo ( )
inline

Gets a reference to a mutable value of the 'volumeInfo' property.

General volume information.

Returns
The result can be modified to change the attribute value.

◆ New()

Volume * google_books_api::Volume::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_etag()

void google_books_api::Volume::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

Opaque identifier for a specific version of a volume resource. (In LITE projection).

Parameters
[in]valueThe new value.

◆ set_id()

void google_books_api::Volume::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

Unique identifier for a volume. (In LITE projection.).

Parameters
[in]valueThe new value.

◆ set_kind()

void google_books_api::Volume::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Resource type for a volume. (In LITE projection.).

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_books_api::Volume::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

URL to this resource. (In LITE projection.).

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: