2020class AirQualityIndex extends \Google \Model
2121{
2222 /**
23+ * The index's numeric score. Examples: 10, 100. The value is not normalized
24+ * and should only be interpreted in the context of its related air-quality
25+ * index. For non-numeric indexes, this field will not be returned. Note: This
26+ * field should be used for calculations, graph display, etc. For displaying
27+ * the index score, you should use the AQI display field.
28+ *
2329 * @var int
2430 */
2531 public $ aqi ;
2632 /**
33+ * Textual representation of the index numeric score, that may include prefix
34+ * or suffix symbols, which usually represents the worst index score. Example:
35+ * >100 or 10+. Note: This field should be used when you want to display the
36+ * index score. For non-numeric indexes, this field is empty.
37+ *
2738 * @var string
2839 */
2940 public $ aqiDisplay ;
3041 /**
42+ * Textual classification of the index numeric score interpretation. For
43+ * example: "Excellent air quality".
44+ *
3145 * @var string
3246 */
3347 public $ category ;
3448 /**
49+ * The index's code. This field represents the index for programming purposes
50+ * by using snake case instead of spaces. Examples: "uaqi", "fra_atmo".
51+ *
3552 * @var string
3653 */
3754 public $ code ;
3855 protected $ colorType = Color::class;
3956 protected $ colorDataType = '' ;
4057 /**
58+ * A human readable representation of the index name. Example: "AQI (US)"
59+ *
4160 * @var string
4261 */
4362 public $ displayName ;
4463 /**
64+ * The chemical symbol of the dominant pollutant. For example: "CO".
65+ *
4566 * @var string
4667 */
4768 public $ dominantPollutant ;
4869
4970 /**
50- * @param int
71+ * The index's numeric score. Examples: 10, 100. The value is not normalized
72+ * and should only be interpreted in the context of its related air-quality
73+ * index. For non-numeric indexes, this field will not be returned. Note: This
74+ * field should be used for calculations, graph display, etc. For displaying
75+ * the index score, you should use the AQI display field.
76+ *
77+ * @param int $aqi
5178 */
5279 public function setAqi ($ aqi )
5380 {
@@ -61,7 +88,12 @@ public function getAqi()
6188 return $ this ->aqi ;
6289 }
6390 /**
64- * @param string
91+ * Textual representation of the index numeric score, that may include prefix
92+ * or suffix symbols, which usually represents the worst index score. Example:
93+ * >100 or 10+. Note: This field should be used when you want to display the
94+ * index score. For non-numeric indexes, this field is empty.
95+ *
96+ * @param string $aqiDisplay
6597 */
6698 public function setAqiDisplay ($ aqiDisplay )
6799 {
@@ -75,7 +107,10 @@ public function getAqiDisplay()
75107 return $ this ->aqiDisplay ;
76108 }
77109 /**
78- * @param string
110+ * Textual classification of the index numeric score interpretation. For
111+ * example: "Excellent air quality".
112+ *
113+ * @param string $category
79114 */
80115 public function setCategory ($ category )
81116 {
@@ -89,7 +124,10 @@ public function getCategory()
89124 return $ this ->category ;
90125 }
91126 /**
92- * @param string
127+ * The index's code. This field represents the index for programming purposes
128+ * by using snake case instead of spaces. Examples: "uaqi", "fra_atmo".
129+ *
130+ * @param string $code
93131 */
94132 public function setCode ($ code )
95133 {
@@ -103,7 +141,9 @@ public function getCode()
103141 return $ this ->code ;
104142 }
105143 /**
106- * @param Color
144+ * The color used to represent the AQI numeric score.
145+ *
146+ * @param Color $color
107147 */
108148 public function setColor (Color $ color )
109149 {
@@ -117,7 +157,9 @@ public function getColor()
117157 return $ this ->color ;
118158 }
119159 /**
120- * @param string
160+ * A human readable representation of the index name. Example: "AQI (US)"
161+ *
162+ * @param string $displayName
121163 */
122164 public function setDisplayName ($ displayName )
123165 {
@@ -131,7 +173,9 @@ public function getDisplayName()
131173 return $ this ->displayName ;
132174 }
133175 /**
134- * @param string
176+ * The chemical symbol of the dominant pollutant. For example: "CO".
177+ *
178+ * @param string $dominantPollutant
135179 */
136180 public function setDominantPollutant ($ dominantPollutant )
137181 {
0 commit comments