Class: AnalyticsOps::Reports::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/analytics_ops/reports/result.rb,
sig/analytics_ops.rbs

Overview

Immutable normalized Data API response.

Constant Summary collapse

MAX_ROWS =

Returns:

  • (Integer) 
Definition::MAX_STANDARD_LIMIT
MAX_CELL_BYTES =

Returns:

  • (Integer) 
1_048_576

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, kind:, dimension_headers:, metric_headers:, rows:, row_count:, metadata:) ⇒ Result

Returns a new instance of Result.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/analytics_ops/reports/result.rb', line 12

def initialize(name:, kind:, dimension_headers:, metric_headers:, rows:, row_count:, metadata:)
  @name = string(name, "name")
  @kind = kind_value(kind)
  @dimension_headers = normalize_headers(dimension_headers, "dimension_headers")
  @metric_headers = normalize_headers(metric_headers, "metric_headers")
  @headers = Canonical.immutable(@dimension_headers + @metric_headers)
  validate_header_uniqueness!
  @rows = normalized_rows(rows)
  @row_count = count(row_count)
  @metadata = normalized_metadata(metadata)
  freeze
end

Instance Attribute Details

#dimension_headers ⇒ Array[String] (readonly)

Returns the value of attribute dimension_headers.

Returns:

  • (Array[String]) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def dimension_headers
  @dimension_headers
end

#headers ⇒ Array[String] (readonly)

Returns the value of attribute headers.

Returns:

  • (Array[String]) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def headers
  @headers
end

#kind ⇒ String (readonly)

Returns the value of attribute kind.

Returns:

  • (String) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def kind
  @kind
end

#metadata ⇒ record (readonly)

Returns the value of attribute metadata.

Returns:

  • (record) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def metadata
  @metadata
end

#metric_headers ⇒ Array[String] (readonly)

Returns the value of attribute metric_headers.

Returns:

  • (Array[String]) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def metric_headers
  @metric_headers
end

#name ⇒ String (readonly)

Returns the value of attribute name.

Returns:

  • (String) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def name
  @name
end

#row_count ⇒ Integer (readonly)

Returns the value of attribute row_count.

Returns:

  • (Integer) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def row_count
  @row_count
end

#rows ⇒ Array[record] (readonly)

Returns the value of attribute rows.

Returns:

  • (Array[record]) 


10
11
12
 
# File 'lib/analytics_ops/reports/result.rb', line 10

def rows
  @rows
end

Instance Method Details

#to_h ⇒ record

Returns:

  • (record) 


25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/analytics_ops/reports/result.rb', line 25

def to_h
  {
    "name" => name,
    "kind" => kind,
    "dimension_headers" => dimension_headers,
    "metric_headers" => metric_headers,
    "rows" => rows,
    "row_count" => row_count,
    "metadata" => metadata
  }
end