Class: Google::Apis::BooksV1::VolumeAnnotation

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: ContentRanges

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) ⇒ VolumeAnnotation

Returns a new instance of VolumeAnnotation.


4317
4318
4319
# File 'generated/google/apis/books_v1/classes.rb', line 4317

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

Instance Attribute Details

#annotation_data_idString

The annotation data id for this volume annotation. Corresponds to the JSON property annotationDataId

Returns:

  • (String)

4248
4249
4250
# File 'generated/google/apis/books_v1/classes.rb', line 4248

def annotation_data_id
  @annotation_data_id
end

Link to get data for this annotation. Corresponds to the JSON property annotationDataLink

Returns:

  • (String)

4253
4254
4255
# File 'generated/google/apis/books_v1/classes.rb', line 4253

def annotation_data_link
  @annotation_data_link
end

#annotation_typeString

The type of annotation this is. Corresponds to the JSON property annotationType

Returns:

  • (String)

4258
4259
4260
# File 'generated/google/apis/books_v1/classes.rb', line 4258

def annotation_type
  @annotation_type
end

#content_rangesGoogle::Apis::BooksV1::VolumeAnnotation::ContentRanges

The content ranges to identify the selected text. Corresponds to the JSON property contentRanges


4263
4264
4265
# File 'generated/google/apis/books_v1/classes.rb', line 4263

def content_ranges
  @content_ranges
end

#dataString

Data for this annotation. Corresponds to the JSON property data

Returns:

  • (String)

4268
4269
4270
# File 'generated/google/apis/books_v1/classes.rb', line 4268

def data
  @data
end

#deletedBoolean Also known as: deleted?

Indicates that this annotation is deleted. Corresponds to the JSON property deleted

Returns:

  • (Boolean)

4273
4274
4275
# File 'generated/google/apis/books_v1/classes.rb', line 4273

def deleted
  @deleted
end

#idString

Unique id of this volume annotation. Corresponds to the JSON property id

Returns:

  • (String)

4279
4280
4281
# File 'generated/google/apis/books_v1/classes.rb', line 4279

def id
  @id
end

#kindString

Resource Type Corresponds to the JSON property kind

Returns:

  • (String)

4284
4285
4286
# File 'generated/google/apis/books_v1/classes.rb', line 4284

def kind
  @kind
end

#layer_idString

The Layer this annotation is for. Corresponds to the JSON property layerId

Returns:

  • (String)

4289
4290
4291
# File 'generated/google/apis/books_v1/classes.rb', line 4289

def layer_id
  @layer_id
end

#page_idsArray<String>

Pages the annotation spans. Corresponds to the JSON property pageIds

Returns:

  • (Array<String>)

4294
4295
4296
# File 'generated/google/apis/books_v1/classes.rb', line 4294

def page_ids
  @page_ids
end

#selected_textString

Excerpt from the volume. Corresponds to the JSON property selectedText

Returns:

  • (String)

4299
4300
4301
# File 'generated/google/apis/books_v1/classes.rb', line 4299

def selected_text
  @selected_text
end

URL to this resource. Corresponds to the JSON property selfLink

Returns:

  • (String)

4304
4305
4306
# File 'generated/google/apis/books_v1/classes.rb', line 4304

def self_link
  @self_link
end

#updatedString

Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date- time format). Corresponds to the JSON property updated

Returns:

  • (String)

4310
4311
4312
# File 'generated/google/apis/books_v1/classes.rb', line 4310

def updated
  @updated
end

#volume_idString

The Volume this annotation is for. Corresponds to the JSON property volumeId

Returns:

  • (String)

4315
4316
4317
# File 'generated/google/apis/books_v1/classes.rb', line 4315

def volume_id
  @volume_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
# File 'generated/google/apis/books_v1/classes.rb', line 4322

def update!(**args)
  @annotation_data_id = args[:annotation_data_id] if args.key?(:annotation_data_id)
  @annotation_data_link = args[:annotation_data_link] if args.key?(:annotation_data_link)
  @annotation_type = args[:annotation_type] if args.key?(:annotation_type)
  @content_ranges = args[:content_ranges] if args.key?(:content_ranges)
  @data = args[:data] if args.key?(:data)
  @deleted = args[:deleted] if args.key?(:deleted)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @layer_id = args[:layer_id] if args.key?(:layer_id)
  @page_ids = args[:page_ids] if args.key?(:page_ids)
  @selected_text = args[:selected_text] if args.key?(:selected_text)
  @self_link = args[:self_link] if args.key?(:self_link)
  @updated = args[:updated] if args.key?(:updated)
  @volume_id = args[:volume_id] if args.key?(:volume_id)
end