Class: Google::Apis::PagespeedonlineV5::LighthouseResultV5

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pagespeedonline_v5/classes.rb,
lib/google/apis/pagespeedonline_v5/representations.rb,
lib/google/apis/pagespeedonline_v5/representations.rb

Overview

The Lighthouse result object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LighthouseResultV5

Returns a new instance of LighthouseResultV5.



481
482
483
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 481

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

Instance Attribute Details

#audits ⇒ Hash<String,Google::Apis::PagespeedonlineV5::LighthouseAuditResultV5>

Map of audits in the LHR. Corresponds to the JSON property audits

Returns:



409
410
411
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 409

def audits
  @audits
end

#categories ⇒ Google::Apis::PagespeedonlineV5::Categories

The categories in a Lighthouse run. Corresponds to the JSON property categories

Returns:



414
415
416
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 414

def categories
  @categories
end

#category_groups ⇒ Hash<String,Google::Apis::PagespeedonlineV5::CategoryGroupV5>

Map of category groups in the LHR. Corresponds to the JSON property categoryGroups

Returns:



419
420
421
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 419

def category_groups
  @category_groups
end

#config_settings ⇒ Google::Apis::PagespeedonlineV5::ConfigSettings

Message containing the configuration settings for the Lighthouse run. Corresponds to the JSON property configSettings

Returns:



424
425
426
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 424

def config_settings
  @config_settings
end

#environment ⇒ Google::Apis::PagespeedonlineV5::Environment

Message containing environment configuration for a Lighthouse run. Corresponds to the JSON property environment

Returns:



429
430
431
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 429

def environment
  @environment
end

#fetch_time ⇒ String

The time that this run was fetched. Corresponds to the JSON property fetchTime

Returns:

  • (String) 


434
435
436
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 434

def fetch_time
  @fetch_time
end

#final_url ⇒ String

The final resolved url that was audited. Corresponds to the JSON property finalUrl

Returns:

  • (String) 


439
440
441
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 439

def final_url
  @final_url
end

#i18n ⇒ Google::Apis::PagespeedonlineV5::I18n

Message containing the i18n data for the LHR - Version 1. Corresponds to the JSON property i18n

Returns:



444
445
446
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 444

def i18n
  @i18n
end

#lighthouse_version ⇒ String

The lighthouse version that was used to generate this LHR. Corresponds to the JSON property lighthouseVersion

Returns:

  • (String) 


449
450
451
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 449

def lighthouse_version
  @lighthouse_version
end

#requested_url ⇒ String

The original requested url. Corresponds to the JSON property requestedUrl

Returns:

  • (String) 


454
455
456
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 454

def requested_url
  @requested_url
end

#run_warnings ⇒ Array<Object>

List of all run warnings in the LHR. Will always output to at least []. Corresponds to the JSON property runWarnings

Returns:

  • (Array<Object>) 


459
460
461
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 459

def run_warnings
  @run_warnings
end

#runtime_error ⇒ Google::Apis::PagespeedonlineV5::RuntimeError

Message containing a runtime error config. Corresponds to the JSON property runtimeError

Returns:



464
465
466
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 464

def runtime_error
  @runtime_error
end

#stack_packs ⇒ Array<Google::Apis::PagespeedonlineV5::StackPack>

The Stack Pack advice strings. Corresponds to the JSON property stackPacks

Returns:



469
470
471
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 469

def stack_packs
  @stack_packs
end

#timing ⇒ Google::Apis::PagespeedonlineV5::Timing

Message containing the performance timing data for the Lighthouse run. Corresponds to the JSON property timing

Returns:



474
475
476
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 474

def timing
  @timing
end

#user_agent ⇒ String

The user agent that was used to run this LHR. Corresponds to the JSON property userAgent

Returns:

  • (String) 


479
480
481
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 479

def user_agent
  @user_agent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/google/apis/pagespeedonline_v5/classes.rb', line 486

def update!(**args)
  @audits = args[:audits] if args.key?(:audits)
  @categories = args[:categories] if args.key?(:categories)
  @category_groups = args[:category_groups] if args.key?(:category_groups)
  @config_settings = args[:config_settings] if args.key?(:config_settings)
  @environment = args[:environment] if args.key?(:environment)
  @fetch_time = args[:fetch_time] if args.key?(:fetch_time)
  @final_url = args[:final_url] if args.key?(:final_url)
  @i18n = args[:i18n] if args.key?(:i18n)
  @lighthouse_version = args[:lighthouse_version] if args.key?(:lighthouse_version)
  @requested_url = args[:requested_url] if args.key?(:requested_url)
  @run_warnings = args[:run_warnings] if args.key?(:run_warnings)
  @runtime_error = args[:runtime_error] if args.key?(:runtime_error)
  @stack_packs = args[:stack_packs] if args.key?(:stack_packs)
  @timing = args[:timing] if args.key?(:timing)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
end