Skip to content

Commit 5a792d9

Browse files
awsmobilesdkeeatonaws
awsmobilesdk
and
eeatonaws
authored
feat(aws-android-sdk-location): update models to latest (#2975)
Co-authored-by: Erica Eaton <[email protected]>
1 parent 22dbc7b commit 5a792d9

17 files changed

+797
-92
lines changed

‎aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/AmazonLocation.java‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
/**
2323
* Interface for accessing AWS Location service
2424
* <p>
25-
* Suite of geospatial services including Maps, Places, Routes, Tracking, and
26-
* Geofencing
25+
* "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
2726
* </p>
2827
**/
2928
public interface AmazonLocation {
@@ -403,7 +402,12 @@ BatchUpdateDevicePositionResult batchUpdateDevicePosition(
403402
* <code>Car</code>, or <code>TruckModeOptions</code> if traveling by
404403
* <code>Truck</code>.
405404
* </p>
406-
* </li>
405+
* <note>
406+
* <p>
407+
* If you specify <code>walking</code> for the travel mode and your data
408+
* provider is Esri, the start and destination must be within 40km.
409+
* </p>
410+
* </note></li>
407411
* </ul>
408412
*
409413
* @param calculateRouteRequest

‎aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/AmazonLocationClient.java‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@
3535
* client are blocking, and will not return until the service call completes.
3636
* <p>
3737
* <p>
38-
* Suite of geospatial services including Maps, Places, Routes, Tracking, and
39-
* Geofencing
38+
* "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"
4039
* </p>
4140
*/
4241
public class AmazonLocationClient extends AmazonWebServiceClient implements AmazonLocation {
@@ -856,7 +855,12 @@ public BatchUpdateDevicePositionResult batchUpdateDevicePosition(
856855
* <code>Car</code>, or <code>TruckModeOptions</code> if traveling by
857856
* <code>Truck</code>.
858857
* </p>
859-
* </li>
858+
* <note>
859+
* <p>
860+
* If you specify <code>walking</code> for the travel mode and your data
861+
* provider is Esri, the start and destination must be within 40km.
862+
* </p>
863+
* </note></li>
860864
* </ul>
861865
*
862866
* @param calculateRouteRequest

‎aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/BatchPutGeofenceRequestEntry.java‎

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,14 @@ public class BatchPutGeofenceRequestEntry implements Serializable {
3737

3838
/**
3939
* <p>
40-
* Contains the polygon details to specify the position of the geofence.
40+
* Contains the details of the position of the geofence. Can be either a
41+
* polygon or a circle. Including both will return a validation error.
4142
* </p>
4243
* <note>
4344
* <p>
4445
* Each <a href=
4546
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
46-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
47+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
4748
* </p>
4849
* </note>
4950
*/
@@ -114,25 +115,27 @@ public BatchPutGeofenceRequestEntry withGeofenceId(String geofenceId) {
114115

115116
/**
116117
* <p>
117-
* Contains the polygon details to specify the position of the geofence.
118+
* Contains the details of the position of the geofence. Can be either a
119+
* polygon or a circle. Including both will return a validation error.
118120
* </p>
119121
* <note>
120122
* <p>
121123
* Each <a href=
122124
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
123-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
125+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
124126
* </p>
125127
* </note>
126128
*
127129
* @return <p>
128-
* Contains the polygon details to specify the position of the
129-
* geofence.
130+
* Contains the details of the position of the geofence. Can be
131+
* either a polygon or a circle. Including both will return a
132+
* validation error.
130133
* </p>
131134
* <note>
132135
* <p>
133136
* Each <a href=
134137
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
135-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
138+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
136139
* </p>
137140
* </note>
138141
*/
@@ -142,25 +145,27 @@ public GeofenceGeometry getGeometry() {
142145

143146
/**
144147
* <p>
145-
* Contains the polygon details to specify the position of the geofence.
148+
* Contains the details of the position of the geofence. Can be either a
149+
* polygon or a circle. Including both will return a validation error.
146150
* </p>
147151
* <note>
148152
* <p>
149153
* Each <a href=
150154
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
151-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
155+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
152156
* </p>
153157
* </note>
154158
*
155159
* @param geometry <p>
156-
* Contains the polygon details to specify the position of the
157-
* geofence.
160+
* Contains the details of the position of the geofence. Can be
161+
* either a polygon or a circle. Including both will return a
162+
* validation error.
158163
* </p>
159164
* <note>
160165
* <p>
161166
* Each <a href=
162167
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
163-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
168+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
164169
* </p>
165170
* </note>
166171
*/
@@ -170,28 +175,30 @@ public void setGeometry(GeofenceGeometry geometry) {
170175

171176
/**
172177
* <p>
173-
* Contains the polygon details to specify the position of the geofence.
178+
* Contains the details of the position of the geofence. Can be either a
179+
* polygon or a circle. Including both will return a validation error.
174180
* </p>
175181
* <note>
176182
* <p>
177183
* Each <a href=
178184
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
179-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
185+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
180186
* </p>
181187
* </note>
182188
* <p>
183189
* Returns a reference to this object so that method calls can be chained
184190
* together.
185191
*
186192
* @param geometry <p>
187-
* Contains the polygon details to specify the position of the
188-
* geofence.
193+
* Contains the details of the position of the geofence. Can be
194+
* either a polygon or a circle. Including both will return a
195+
* validation error.
189196
* </p>
190197
* <note>
191198
* <p>
192199
* Each <a href=
193200
* "https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html"
194-
* >geofence polygon</a> can have a maximum of 1,000 vertices.
201+
* > geofence polygon</a> can have a maximum of 1,000 vertices.
195202
* </p>
196203
* </note>
197204
* @return A reference to this updated object so that method calls can be

‎aws-android-sdk-location/src/main/java/com/amazonaws/services/geo/model/CalculateRouteRequest.java‎

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,12 @@
6161
* preferences in <code>CarModeOptions</code> if traveling by <code>Car</code>,
6262
* or <code>TruckModeOptions</code> if traveling by <code>Truck</code>.
6363
* </p>
64-
* </li>
64+
* <note>
65+
* <p>
66+
* If you specify <code>walking</code> for the travel mode and your data
67+
* provider is Esri, the start and destination must be within 40km.
68+
* </p>
69+
* </note></li>
6570
* </ul>
6671
*/
6772
public class CalculateRouteRequest extends AmazonWebServiceRequest implements Serializable {
@@ -216,7 +221,9 @@ public class CalculateRouteRequest extends AmazonWebServiceRequest implements Se
216221
/**
217222
* <p>
218223
* Specifies the mode of transport when calculating a route. Used in
219-
* estimating the speed of travel and road compatibility.
224+
* estimating the speed of travel and road compatibility. You can choose
225+
* <code>Car</code>, <code>Truck</code>, or <code>Walking</code> as options
226+
* for the <code>TravelMode</code>.
220227
* </p>
221228
* <p>
222229
* The <code>TravelMode</code> you specify also determines how you specify
@@ -1462,7 +1469,9 @@ public CalculateRouteRequest withIncludeLegGeometry(Boolean includeLegGeometry)
14621469
/**
14631470
* <p>
14641471
* Specifies the mode of transport when calculating a route. Used in
1465-
* estimating the speed of travel and road compatibility.
1472+
* estimating the speed of travel and road compatibility. You can choose
1473+
* <code>Car</code>, <code>Truck</code>, or <code>Walking</code> as options
1474+
* for the <code>TravelMode</code>.
14661475
* </p>
14671476
* <p>
14681477
* The <code>TravelMode</code> you specify also determines how you specify
@@ -1491,7 +1500,9 @@ public CalculateRouteRequest withIncludeLegGeometry(Boolean includeLegGeometry)
14911500
*
14921501
* @return <p>
14931502
* Specifies the mode of transport when calculating a route. Used in
1494-
* estimating the speed of travel and road compatibility.
1503+
* estimating the speed of travel and road compatibility. You can
1504+
* choose <code>Car</code>, <code>Truck</code>, or
1505+
* <code>Walking</code> as options for the <code>TravelMode</code>.
14951506
* </p>
14961507
* <p>
14971508
* The <code>TravelMode</code> you specify also determines how you
@@ -1523,7 +1534,9 @@ public String getTravelMode() {
15231534
/**
15241535
* <p>
15251536
* Specifies the mode of transport when calculating a route. Used in
1526-
* estimating the speed of travel and road compatibility.
1537+
* estimating the speed of travel and road compatibility. You can choose
1538+
* <code>Car</code>, <code>Truck</code>, or <code>Walking</code> as options
1539+
* for the <code>TravelMode</code>.
15271540
* </p>
15281541
* <p>
15291542
* The <code>TravelMode</code> you specify also determines how you specify
@@ -1552,7 +1565,10 @@ public String getTravelMode() {
15521565
*
15531566
* @param travelMode <p>
15541567
* Specifies the mode of transport when calculating a route. Used
1555-
* in estimating the speed of travel and road compatibility.
1568+
* in estimating the speed of travel and road compatibility. You
1569+
* can choose <code>Car</code>, <code>Truck</code>, or
1570+
* <code>Walking</code> as options for the
1571+
* <code>TravelMode</code>.
15561572
* </p>
15571573
* <p>
15581574
* The <code>TravelMode</code> you specify also determines how
@@ -1584,7 +1600,9 @@ public void setTravelMode(String travelMode) {
15841600
/**
15851601
* <p>
15861602
* Specifies the mode of transport when calculating a route. Used in
1587-
* estimating the speed of travel and road compatibility.
1603+
* estimating the speed of travel and road compatibility. You can choose
1604+
* <code>Car</code>, <code>Truck</code>, or <code>Walking</code> as options
1605+
* for the <code>TravelMode</code>.
15881606
* </p>
15891607
* <p>
15901608
* The <code>TravelMode</code> you specify also determines how you specify
@@ -1616,7 +1634,10 @@ public void setTravelMode(String travelMode) {
16161634
*
16171635
* @param travelMode <p>
16181636
* Specifies the mode of transport when calculating a route. Used
1619-
* in estimating the speed of travel and road compatibility.
1637+
* in estimating the speed of travel and road compatibility. You
1638+
* can choose <code>Car</code>, <code>Truck</code>, or
1639+
* <code>Walking</code> as options for the
1640+
* <code>TravelMode</code>.
16201641
* </p>
16211642
* <p>
16221643
* The <code>TravelMode</code> you specify also determines how
@@ -1651,7 +1672,9 @@ public CalculateRouteRequest withTravelMode(String travelMode) {
16511672
/**
16521673
* <p>
16531674
* Specifies the mode of transport when calculating a route. Used in
1654-
* estimating the speed of travel and road compatibility.
1675+
* estimating the speed of travel and road compatibility. You can choose
1676+
* <code>Car</code>, <code>Truck</code>, or <code>Walking</code> as options
1677+
* for the <code>TravelMode</code>.
16551678
* </p>
16561679
* <p>
16571680
* The <code>TravelMode</code> you specify also determines how you specify
@@ -1680,7 +1703,10 @@ public CalculateRouteRequest withTravelMode(String travelMode) {
16801703
*
16811704
* @param travelMode <p>
16821705
* Specifies the mode of transport when calculating a route. Used
1683-
* in estimating the speed of travel and road compatibility.
1706+
* in estimating the speed of travel and road compatibility. You
1707+
* can choose <code>Car</code>, <code>Truck</code>, or
1708+
* <code>Walking</code> as options for the
1709+
* <code>TravelMode</code>.
16841710
* </p>
16851711
* <p>
16861712
* The <code>TravelMode</code> you specify also determines how
@@ -1712,7 +1738,9 @@ public void setTravelMode(TravelMode travelMode) {
17121738
/**
17131739
* <p>
17141740
* Specifies the mode of transport when calculating a route. Used in
1715-
* estimating the speed of travel and road compatibility.
1741+
* estimating the speed of travel and road compatibility. You can choose
1742+
* <code>Car</code>, <code>Truck</code>, or <code>Walking</code> as options
1743+
* for the <code>TravelMode</code>.
17161744
* </p>
17171745
* <p>
17181746
* The <code>TravelMode</code> you specify also determines how you specify
@@ -1744,7 +1772,10 @@ public void setTravelMode(TravelMode travelMode) {
17441772
*
17451773
* @param travelMode <p>
17461774
* Specifies the mode of transport when calculating a route. Used
1747-
* in estimating the speed of travel and road compatibility.
1775+
* in estimating the speed of travel and road compatibility. You
1776+
* can choose <code>Car</code>, <code>Truck</code>, or
1777+
* <code>Walking</code> as options for the
1778+
* <code>TravelMode</code>.
17481779
* </p>
17491780
* <p>
17501781
* The <code>TravelMode</code> you specify also determines how

0 commit comments

Comments
 (0)