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.


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

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

Instance Attribute Details

#access_infoGoogle::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


2636
2637
2638
# File 'generated/google/apis/books_v1/classes.rb', line 2636

def access_info
  @access_info
end

#etagString

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

Returns:

  • (String)

2642
2643
2644
# File 'generated/google/apis/books_v1/classes.rb', line 2642

def etag
  @etag
end

#idString

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

Returns:

  • (String)

2647
2648
2649
# File 'generated/google/apis/books_v1/classes.rb', line 2647

def id
  @id
end

#kindString

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

Returns:

  • (String)

2652
2653
2654
# File 'generated/google/apis/books_v1/classes.rb', line 2652

def kind
  @kind
end

#layer_infoGoogle::Apis::BooksV1::Volume::LayerInfo

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


2657
2658
2659
# File 'generated/google/apis/books_v1/classes.rb', line 2657

def layer_info
  @layer_info
end

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


2662
2663
2664
# File 'generated/google/apis/books_v1/classes.rb', line 2662

def recommended_info
  @recommended_info
end

#sale_infoGoogle::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


2669
2670
2671
# File 'generated/google/apis/books_v1/classes.rb', line 2669

def sale_info
  @sale_info
end

#search_infoGoogle::Apis::BooksV1::Volume::SearchInfo

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


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

def search_info
  @search_info
end

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

Returns:

  • (String)

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

def self_link
  @self_link
end

#user_infoGoogle::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


2685
2686
2687
# File 'generated/google/apis/books_v1/classes.rb', line 2685

def 
  @user_info
end

#volume_infoGoogle::Apis::BooksV1::Volume::VolumeInfo

General volume information. Corresponds to the JSON property volumeInfo


2690
2691
2692
# File 'generated/google/apis/books_v1/classes.rb', line 2690

def volume_info
  @volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
# File 'generated/google/apis/books_v1/classes.rb', line 2697

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