Class: Google::Apis::ChromeuxreportV1::QueryRequest

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

Overview

Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryRequest

Returns a new instance of QueryRequest.



505
506
507
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 505

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

Instance Attribute Details

#effective_connection_type ⇒ String

The effective connection type is a query dimension that specifies the effective network class that the record's data should belong to. This field uses the values ["offline", "slow-2G", "2G", "3G", "4G"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types Note: If no effective connection type is specified, then a special record with aggregated data over all effective connection types will be returned. Corresponds to the JSON property effectiveConnectionType

Returns:

  • (String) 


475
476
477
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 475

def effective_connection_type
  @effective_connection_type
end

#form_factor ⇒ String

The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned. Corresponds to the JSON property formFactor

Returns:

  • (String) 


482
483
484
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 482

def form_factor
  @form_factor
end

#metrics ⇒ Array<String>

The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: [" first_contentful_paint", "first_input_delay", "largest_contentful_paint", " cumulative_layout_shift", "experimental_time_to_first_byte", " experimental_interaction_to_next_paint"] Corresponds to the JSON property metrics

Returns:

  • (Array<String>) 


491
492
493
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 491

def metrics
  @metrics
end

#origin ⇒ String

The url pattern "origin" refers to a url pattern that is the origin of a website. Examples: "https://example.com", "https://cloud.google.com" Corresponds to the JSON property origin

Returns:

  • (String) 


497
498
499
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 497

def origin
  @origin
end

#url ⇒ String

The url pattern "url" refers to a url pattern that is any arbitrary url. Examples: "https://example.com/", "https://cloud.google.com/why-google-cloud/" Corresponds to the JSON property url

Returns:

  • (String) 


503
504
505
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 503

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



510
511
512
513
514
515
516
 
# File 'lib/google/apis/chromeuxreport_v1/classes.rb', line 510

def update!(**args)
  @effective_connection_type = args[:effective_connection_type] if args.key?(:effective_connection_type)
  @form_factor = args[:form_factor] if args.key?(:form_factor)
  @metrics = args[:metrics] if args.key?(:metrics)
  @origin = args[:origin] if args.key?(:origin)
  @url = args[:url] if args.key?(:url)
end