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.



2961
2962
2963
 
# File 'generated/google/apis/books_v1/classes.rb', line 2961

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:



2905
2906
2907
 
# File 'generated/google/apis/books_v1/classes.rb', line 2905

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) 


2911
2912
2913
 
# File 'generated/google/apis/books_v1/classes.rb', line 2911

def etag
  @etag
end

#id ⇒ String

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

Returns:

  • (String) 


2916
2917
2918
 
# File 'generated/google/apis/books_v1/classes.rb', line 2916

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


2921
2922
2923
 
# File 'generated/google/apis/books_v1/classes.rb', line 2921

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:



2926
2927
2928
 
# File 'generated/google/apis/books_v1/classes.rb', line 2926

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:



2931
2932
2933
 
# File 'generated/google/apis/books_v1/classes.rb', line 2931

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:



2938
2939
2940
 
# File 'generated/google/apis/books_v1/classes.rb', line 2938

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:



2943
2944
2945
 
# File 'generated/google/apis/books_v1/classes.rb', line 2943

def search_info
  @search_info
end

#self_link ⇒ String

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

Returns:

  • (String) 


2948
2949
2950
 
# File 'generated/google/apis/books_v1/classes.rb', line 2948

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:



2954
2955
2956
 
# File 'generated/google/apis/books_v1/classes.rb', line 2954

def 
  @user_info
end

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

General volume information. Corresponds to the JSON property volumeInfo

Returns:



2959
2960
2961
 
# File 'generated/google/apis/books_v1/classes.rb', line 2959

def volume_info
  @volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
 
# File 'generated/google/apis/books_v1/classes.rb', line 2966

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