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.


3061
3062
3063
# File 'generated/google/apis/books_v1/classes.rb', line 3061

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


3005
3006
3007
# File 'generated/google/apis/books_v1/classes.rb', line 3005

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)

3011
3012
3013
# File 'generated/google/apis/books_v1/classes.rb', line 3011

def etag
  @etag
end

#idString

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

Returns:

  • (String)

3016
3017
3018
# File 'generated/google/apis/books_v1/classes.rb', line 3016

def id
  @id
end

#kindString

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

Returns:

  • (String)

3021
3022
3023
# File 'generated/google/apis/books_v1/classes.rb', line 3021

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


3026
3027
3028
# File 'generated/google/apis/books_v1/classes.rb', line 3026

def layer_info
  @layer_info
end

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


3031
3032
3033
# File 'generated/google/apis/books_v1/classes.rb', line 3031

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


3038
3039
3040
# File 'generated/google/apis/books_v1/classes.rb', line 3038

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


3043
3044
3045
# File 'generated/google/apis/books_v1/classes.rb', line 3043

def search_info
  @search_info
end

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

Returns:

  • (String)

3048
3049
3050
# File 'generated/google/apis/books_v1/classes.rb', line 3048

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


3054
3055
3056
# File 'generated/google/apis/books_v1/classes.rb', line 3054

def 
  @user_info
end

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

General volume information. Corresponds to the JSON property volumeInfo


3059
3060
3061
# File 'generated/google/apis/books_v1/classes.rb', line 3059

def volume_info
  @volume_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'generated/google/apis/books_v1/classes.rb', line 3066

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