Class: Google::Apis::BooksV1::Volume

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/books_v1/classes.rb,
generated/google/apis/books_v1/representations.rb,
generated/google/apis/books_v1/representations.rb

Defined Under Namespace

Classes: AccessInfo, LayerInfo, RecommendedInfo, SaleInfo, SearchInfo, UserInfo, VolumeInfo

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Volume

Returns a new instance of Volume



2723
2724
2725
 
# File 'generated/google/apis/books_v1/classes.rb', line 2723

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_info ⇒ Google::Apis::BooksV1::Volume::AccessInfo

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.). Corresponds to the JSON property accessInfo

Returns:



2667
2668
2669
 
# File 'generated/google/apis/books_v1/classes.rb', line 2667

def access_info
  @access_info
end

#etag ⇒ String

Opaque identifier for a specific version of a volume resource. (In LITE projection) Corresponds to the JSON property etag

Returns:

  • (String) 


2673
2674
2675
 
# File 'generated/google/apis/books_v1/classes.rb', line 2673

def etag
  @etag
end

#id ⇒ String

Unique identifier for a volume. (In LITE projection.) Corresponds to the JSON property id

Returns:

  • (String) 


2678
2679
2680
 
# File 'generated/google/apis/books_v1/classes.rb', line 2678

def id
  @id
end

#kind ⇒ String

Resource type for a volume. (In LITE projection.) Corresponds to the JSON property kind

Returns:

  • (String) 


2683
2684
2685
 
# File 'generated/google/apis/books_v1/classes.rb', line 2683

def kind
  @kind
end

#layer_info ⇒ Google::Apis::BooksV1::Volume::LayerInfo

What layers exist in this volume and high level information about them. Corresponds to the JSON property layerInfo

Returns:



2688
2689
2690
 
# File 'generated/google/apis/books_v1/classes.rb', line 2688

def layer_info
  @layer_info
end

#recommended_info ⇒ Google::Apis::BooksV1::Volume::RecommendedInfo

Recommendation related information for this volume. Corresponds to the JSON property recommendedInfo

Returns:



2693
2694
2695
 
# File 'generated/google/apis/books_v1/classes.rb', line 2693

def recommended_info
  @recommended_info
end

#sale_info ⇒ Google::Apis::BooksV1::Volume::SaleInfo

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). Corresponds to the JSON property saleInfo

Returns:



2700
2701
2702
 
# File 'generated/google/apis/books_v1/classes.rb', line 2700

def sale_info
  @sale_info
end

#search_info ⇒ Google::Apis::BooksV1::Volume::SearchInfo

Search result information related to this volume. Corresponds to the JSON property searchInfo

Returns:



2705
2706
2707
 
# File 'generated/google/apis/books_v1/classes.rb', line 2705

def search_info
  @search_info
end

#self_link ⇒ String

URL to this resource. (In LITE projection.) Corresponds to the JSON property selfLink

Returns:

  • (String) 


2710
2711
2712
 
# File 'generated/google/apis/books_v1/classes.rb', line 2710

def self_link
  @self_link
end

#user_info ⇒ Google::Apis::BooksV1::Volume::UserInfo

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

Returns:



2716
2717
2718
 
# File 'generated/google/apis/books_v1/classes.rb', line 2716

def 
  @user_info
end

#volume_info ⇒ Google::Apis::BooksV1::Volume::VolumeInfo

General volume information. Corresponds to the JSON property volumeInfo

Returns:



2721
2722
2723
 
# File 'generated/google/apis/books_v1/classes.rb', line 2721

def volume_info
  @volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
 
# File 'generated/google/apis/books_v1/classes.rb', line 2728

def update!(**args)
  @access_info = args[:access_info] if args.key?(:access_info)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @layer_info = args[:layer_info] if args.key?(:layer_info)
  @recommended_info = args[:recommended_info] if args.key?(:recommended_info)
  @sale_info = args[:sale_info] if args.key?(:sale_info)
  @search_info = args[:search_info] if args.key?(:search_info)
  @self_link = args[:self_link] if args.key?(:self_link)
  @user_info = args[:user_info] if args.key?(:user_info)
  @volume_info = args[:volume_info] if args.key?(:volume_info)
end