Class: Google::Apis::AirqualityV1::LookupCurrentConditionsRequest

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

Overview

The request definition of the air quality current conditions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LookupCurrentConditionsRequest

Returns a new instance of LookupCurrentConditionsRequest.



609
610
611
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 609

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

Instance Attribute Details

#custom_local_aqis ⇒ Array<Google::Apis::AirqualityV1::CustomLocalAqi>

Optional. Expresses a 'country/region to AQI' relationship. Pairs a country/ region with a desired AQI so that air quality data that is required for that country/region will be displayed according to the chosen AQI. This parameter can be used to specify a non-default AQI for a given country, for example, to get the US EPA index for Canada rather than the default index for Canada. Corresponds to the JSON property customLocalAqis

Returns:



571
572
573
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 571

def custom_local_aqis
  @custom_local_aqis
end

#extra_computations ⇒ Array<String>

Optional. Additional features that can be optionally enabled. Specifying extra computations will result in the relevant elements and fields to be returned in the response. Corresponds to the JSON property extraComputations

Returns:

  • (Array<String>) 


578
579
580
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 578

def extra_computations
  @extra_computations
end

#language_code ⇒ String

Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF standard. Default value is en. Corresponds to the JSON property languageCode

Returns:

  • (String) 


585
586
587
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 585

def language_code
  @language_code
end

#location ⇒ Google::Apis::AirqualityV1::LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property location

Returns:



593
594
595
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 593

def location
  @location
end

#uaqi_color_palette ⇒ String

Optional. Determines the color palette used for data provided by the ' Universal Air Quality Index' (UAQI). This color palette is relevant just for UAQI, other AQIs have a predetermined color palette that can't be controlled. Corresponds to the JSON property uaqiColorPalette

Returns:

  • (String) 


600
601
602
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 600

def uaqi_color_palette
  @uaqi_color_palette
end

#universal_aqi ⇒ Boolean Also known as: universal_aqi?

Optional. If set to true, the Universal AQI will be included in the 'indexes' field of the response. Default value is true. Corresponds to the JSON property universalAqi

Returns:

  • (Boolean) 


606
607
608
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 606

def universal_aqi
  @universal_aqi
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



614
615
616
617
618
619
620
621
 
# File 'lib/google/apis/airquality_v1/classes.rb', line 614

def update!(**args)
  @custom_local_aqis = args[:custom_local_aqis] if args.key?(:custom_local_aqis)
  @extra_computations = args[:extra_computations] if args.key?(:extra_computations)
  @language_code = args[:language_code] if args.key?(:language_code)
  @location = args[:location] if args.key?(:location)
  @uaqi_color_palette = args[:uaqi_color_palette] if args.key?(:uaqi_color_palette)
  @universal_aqi = args[:universal_aqi] if args.key?(:universal_aqi)
end