Class: Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult

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

Overview

The enum-like identifier for this rule. For instance "EnableKeepAlive" or " AvoidCssImport". Not localized.

Defined Under Namespace

Classes: UrlBlock

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

Returns a new instance of RuleResult



430
431
432
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 430

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

Instance Attribute Details

#beta ⇒ Boolean Also known as: beta?

Whether this rule is in 'beta'. Rules in beta are new rules that are being tested, which do not impact the overall score. Corresponds to the JSON property beta

Returns:

  • (Boolean) 


393
394
395
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 393

def beta
  @beta
end

#groups ⇒ Array<String>

List of rule groups that this rule belongs to. Each entry in the list is one of "SPEED", "USABILITY", or "SECURITY". Corresponds to the JSON property groups

Returns:

  • (Array<String>) 


400
401
402
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 400

def groups
  @groups
end

#localized_rule_name ⇒ String

Localized name of the rule, intended for presentation to a user. Corresponds to the JSON property localizedRuleName

Returns:

  • (String) 


405
406
407
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 405

def localized_rule_name
  @localized_rule_name
end

#rule_impact ⇒ Float

The impact (unbounded floating point value) that implementing the suggestions for this rule would have on making the page faster. Impact is comparable between rules to determine which rule's suggestions would have a higher or lower impact on making a page faster. For instance, if enabling compression would save 1MB, while optimizing images would save 500kB, the enable compression rule would have 2x the impact of the image optimization rule, all other things being equal. Corresponds to the JSON property ruleImpact

Returns:

  • (Float) 


416
417
418
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 416

def rule_impact
  @rule_impact
end

#summary ⇒ Google::Apis::PagespeedonlineV4::PagespeedApiFormatStringV4

A brief summary description for the rule, indicating at a high level what should be done to follow the rule and what benefit can be gained by doing so. Corresponds to the JSON property summary

Returns:



422
423
424
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 422

def summary
  @summary
end

#url_blocks ⇒ Array<Google::Apis::PagespeedonlineV4::PagespeedApiPagespeedResponseV4::FormattedResults::RuleResult::UrlBlock>

List of blocks of URLs. Each block may contain a heading and a list of URLs. Each URL may optionally include additional details. Corresponds to the JSON property urlBlocks

Returns:



428
429
430
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 428

def url_blocks
  @url_blocks
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



435
436
437
438
439
440
441
442
 
# File 'generated/google/apis/pagespeedonline_v4/classes.rb', line 435

def update!(**args)
  @beta = args[:beta] if args.key?(:beta)
  @groups = args[:groups] if args.key?(:groups)
  @localized_rule_name = args[:localized_rule_name] if args.key?(:localized_rule_name)
  @rule_impact = args[:rule_impact] if args.key?(:rule_impact)
  @summary = args[:summary] if args.key?(:summary)
  @url_blocks = args[:url_blocks] if args.key?(:url_blocks)
end