Class: Hoodoo::Client::AugmentedArray

Inherits:

Array

• Object
• Array
• Hoodoo::Client::AugmentedArray

Includes:

AugmentedBase, PaginatedEnumeration

Defined in:

lib/hoodoo/client/augmented_array.rb

Overview

Ruby standard library Array subclass which mixes in Hoodoo::Client::AugmentedBase. See that for details.

Instance Attribute Summary

• #dataset_size ⇒ Object

  For lists, the (optional) total size of the data set, of which the contents of this Array will often only represent a single page.

• #estimated_dataset_size ⇒ Object

  For lists, the (optional) estimated size of the data set, of which the contents of this Array will often only represent a single page.

Attributes included from PaginatedEnumeration

#next_page_proc

Attributes included from AugmentedBase

#response_options

Method Summary

Methods included from PaginatedEnumeration

#enumerate_all

Methods included from AugmentedBase

#adds_errors_to?, #platform_errors, #set_platform_errors

Instance Attribute Details

#dataset_size ⇒ Object

For lists, the (optional) total size of the data set, of which the contents of this Array will often only represent a single page. If unknown, the value is nil, but as an alternative, an estimated size may be available in #estimated_dataset_size.

# File 'lib/hoodoo/client/augmented_array.rb', line 27

def dataset_size
  @dataset_size
end

#estimated_dataset_size ⇒ Object

For lists, the (optional) estimated size of the data set, of which the contents of this Array will often only represent a single page. If unknown, the value is nil. The accuracy of the estimation is unknown.

# File 'lib/hoodoo/client/augmented_array.rb', line 34

def estimated_dataset_size
  @estimated_dataset_size
end