com.google.api.services.pagespeedonline.v5.model

Class ConfigSettings

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pagespeedonline.v5.model.ConfigSettings

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ConfigSettings
extends com.google.api.client.json.GenericJson

Message containing the configuration settings for the Lighthouse run.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the PageSpeed Insights API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ConfigSettings()

Method Summary

Modifier and Type	Method and Description
ConfigSettings	clone()
String	getChannel() How Lighthouse was run, e.g.
String	getEmulatedFormFactor() The form factor the emulation should use.
String	getFormFactor() How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.
String	getLocale() The locale setting.
Object	getOnlyCategories() List of categories of audits the run should conduct.
ConfigSettings	set(String fieldName, Object value)
ConfigSettings	setChannel(String channel) How Lighthouse was run, e.g.
ConfigSettings	setEmulatedFormFactor(String emulatedFormFactor) The form factor the emulation should use.
ConfigSettings	setFormFactor(String formFactor) How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.
ConfigSettings	setLocale(String locale) The locale setting.
ConfigSettings	setOnlyCategories(Object onlyCategories) List of categories of audits the run should conduct.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ConfigSettings

public ConfigSettings()

Method Detail

getChannel

public String getChannel()

How Lighthouse was run, e.g. from the Chrome extension or from the npm module.

Returns:

value or null for none

setChannel

public ConfigSettings setChannel(String channel)

How Lighthouse was run, e.g. from the Chrome extension or from the npm module.

Parameters:

channel - channel or null for none

getEmulatedFormFactor

public String getEmulatedFormFactor()

The form factor the emulation should use. This field is deprecated, form_factor should be used instead.

Returns:

value or null for none

setEmulatedFormFactor

public ConfigSettings setEmulatedFormFactor(String emulatedFormFactor)

The form factor the emulation should use. This field is deprecated, form_factor should be used instead.

Parameters:

emulatedFormFactor - emulatedFormFactor or null for none

getFormFactor

public String getFormFactor()

How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.

Returns:

value or null for none

setFormFactor

public ConfigSettings setFormFactor(String formFactor)

How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.

Parameters:

formFactor - formFactor or null for none

getLocale

public String getLocale()

The locale setting.

Returns:

value or null for none

setLocale

public ConfigSettings setLocale(String locale)

The locale setting.

Parameters:

locale - locale or null for none

getOnlyCategories

public Object getOnlyCategories()

List of categories of audits the run should conduct.

Returns:

value or null for none

setOnlyCategories

public ConfigSettings setOnlyCategories(Object onlyCategories)

List of categories of audits the run should conduct.

Parameters:

onlyCategories - onlyCategories or null for none

set

public ConfigSettings set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ConfigSettings clone()

Overrides:

clone in class com.google.api.client.json.GenericJson