Skip to content

Commit b79484b

Browse files
1 parent 86d6688 commit b79484b

18 files changed

Lines changed: 658 additions & 84 deletions

src/AirQuality/AdditionalInfo.php

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,22 @@
2020
class AdditionalInfo extends \Google\Model
2121
{
2222
/**
23+
* Text representing the pollutant's main health effects.
24+
*
2325
* @var string
2426
*/
2527
public $effects;
2628
/**
29+
* Text representing the pollutant's main emission sources.
30+
*
2731
* @var string
2832
*/
2933
public $sources;
3034

3135
/**
32-
* @param string
36+
* Text representing the pollutant's main health effects.
37+
*
38+
* @param string $effects
3339
*/
3440
public function setEffects($effects)
3541
{
@@ -43,7 +49,9 @@ public function getEffects()
4349
return $this->effects;
4450
}
4551
/**
46-
* @param string
52+
* Text representing the pollutant's main emission sources.
53+
*
54+
* @param string $sources
4755
*/
4856
public function setSources($sources)
4957
{

src/AirQuality/AirQualityIndex.php

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,61 @@
2020
class 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
{

src/AirQuality/Color.php

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,50 @@
2020
class Color extends \Google\Model
2121
{
2222
/**
23+
* The fraction of this color that should be applied to the pixel. That is,
24+
* the final pixel color is defined by the equation: `pixel color = alpha *
25+
* (this color) + (1.0 - alpha) * (background color)` This means that a value
26+
* of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to
27+
* a completely transparent color. This uses a wrapper message rather than a
28+
* simple float scalar so that it is possible to distinguish between a default
29+
* value and the value being unset. If omitted, this color object is rendered
30+
* as a solid color (as if the alpha value had been explicitly given a value
31+
* of 1.0).
32+
*
2333
* @var float
2434
*/
2535
public $alpha;
2636
/**
37+
* The amount of blue in the color as a value in the interval [0, 1].
38+
*
2739
* @var float
2840
*/
2941
public $blue;
3042
/**
43+
* The amount of green in the color as a value in the interval [0, 1].
44+
*
3145
* @var float
3246
*/
3347
public $green;
3448
/**
49+
* The amount of red in the color as a value in the interval [0, 1].
50+
*
3551
* @var float
3652
*/
3753
public $red;
3854

3955
/**
40-
* @param float
56+
* The fraction of this color that should be applied to the pixel. That is,
57+
* the final pixel color is defined by the equation: `pixel color = alpha *
58+
* (this color) + (1.0 - alpha) * (background color)` This means that a value
59+
* of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to
60+
* a completely transparent color. This uses a wrapper message rather than a
61+
* simple float scalar so that it is possible to distinguish between a default
62+
* value and the value being unset. If omitted, this color object is rendered
63+
* as a solid color (as if the alpha value had been explicitly given a value
64+
* of 1.0).
65+
*
66+
* @param float $alpha
4167
*/
4268
public function setAlpha($alpha)
4369
{
@@ -51,7 +77,9 @@ public function getAlpha()
5177
return $this->alpha;
5278
}
5379
/**
54-
* @param float
80+
* The amount of blue in the color as a value in the interval [0, 1].
81+
*
82+
* @param float $blue
5583
*/
5684
public function setBlue($blue)
5785
{
@@ -65,7 +93,9 @@ public function getBlue()
6593
return $this->blue;
6694
}
6795
/**
68-
* @param float
96+
* The amount of green in the color as a value in the interval [0, 1].
97+
*
98+
* @param float $green
6999
*/
70100
public function setGreen($green)
71101
{
@@ -79,7 +109,9 @@ public function getGreen()
79109
return $this->green;
80110
}
81111
/**
82-
* @param float
112+
* The amount of red in the color as a value in the interval [0, 1].
113+
*
114+
* @param float $red
83115
*/
84116
public function setRed($red)
85117
{

src/AirQuality/Concentration.php

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,53 @@
2020
class Concentration extends \Google\Model
2121
{
2222
/**
23+
* Unspecified concentration unit.
24+
*/
25+
public const UNITS_UNIT_UNSPECIFIED = 'UNIT_UNSPECIFIED';
26+
/**
27+
* The ppb (parts per billion) concentration unit.
28+
*/
29+
public const UNITS_PARTS_PER_BILLION = 'PARTS_PER_BILLION';
30+
/**
31+
* The "µg/m^3" (micrograms per cubic meter) concentration unit.
32+
*/
33+
public const UNITS_MICROGRAMS_PER_CUBIC_METER = 'MICROGRAMS_PER_CUBIC_METER';
34+
/**
35+
* Units for measuring this pollutant concentration.
36+
*
2337
* @var string
2438
*/
2539
public $units;
2640
/**
41+
* Value of the pollutant concentration.
42+
*
2743
* @var float
2844
*/
2945
public $value;
3046

3147
/**
32-
* @param string
48+
* Units for measuring this pollutant concentration.
49+
*
50+
* Accepted values: UNIT_UNSPECIFIED, PARTS_PER_BILLION,
51+
* MICROGRAMS_PER_CUBIC_METER
52+
*
53+
* @param self::UNITS_* $units
3354
*/
3455
public function setUnits($units)
3556
{
3657
$this->units = $units;
3758
}
3859
/**
39-
* @return string
60+
* @return self::UNITS_*
4061
*/
4162
public function getUnits()
4263
{
4364
return $this->units;
4465
}
4566
/**
46-
* @param float
67+
* Value of the pollutant concentration.
68+
*
69+
* @param float $value
4770
*/
4871
public function setValue($value)
4972
{

src/AirQuality/CustomLocalAqi.php

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,26 @@
2020
class CustomLocalAqi extends \Google\Model
2121
{
2222
/**
23+
* The AQI to associate the country/region with. Value should be a [valid
24+
* index](/maps/documentation/air-quality/laqis) code.
25+
*
2326
* @var string
2427
*/
2528
public $aqi;
2629
/**
30+
* The country/region requiring the custom AQI. Value should be provided using
31+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
32+
* code.
33+
*
2734
* @var string
2835
*/
2936
public $regionCode;
3037

3138
/**
32-
* @param string
39+
* The AQI to associate the country/region with. Value should be a [valid
40+
* index](/maps/documentation/air-quality/laqis) code.
41+
*
42+
* @param string $aqi
3343
*/
3444
public function setAqi($aqi)
3545
{
@@ -43,7 +53,11 @@ public function getAqi()
4353
return $this->aqi;
4454
}
4555
/**
46-
* @param string
56+
* The country/region requiring the custom AQI. Value should be provided using
57+
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
58+
* code.
59+
*
60+
* @param string $regionCode
4761
*/
4862
public function setRegionCode($regionCode)
4963
{

0 commit comments

Comments
 (0)