@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LocationAsyncClient extends SdkClient
builder() method.
Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateTrackerConsumerResponse> |
associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
Creates an association between a geofence collection and a tracker resource.
|
default CompletableFuture<AssociateTrackerConsumerResponse> |
associateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest)
Creates an association between a geofence collection and a tracker resource.
|
default CompletableFuture<BatchDeleteDevicePositionHistoryResponse> |
batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)
Deletes the position history of one or more devices from a tracker resource.
|
default CompletableFuture<BatchDeleteDevicePositionHistoryResponse> |
batchDeleteDevicePositionHistory(Consumer<BatchDeleteDevicePositionHistoryRequest.Builder> batchDeleteDevicePositionHistoryRequest)
Deletes the position history of one or more devices from a tracker resource.
|
default CompletableFuture<BatchDeleteGeofenceResponse> |
batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
|
default CompletableFuture<BatchDeleteGeofenceResponse> |
batchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
|
default CompletableFuture<BatchEvaluateGeofencesResponse> |
batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
Evaluates device positions against the geofence geometries from a given geofence collection.
|
default CompletableFuture<BatchEvaluateGeofencesResponse> |
batchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest)
Evaluates device positions against the geofence geometries from a given geofence collection.
|
default CompletableFuture<BatchGetDevicePositionResponse> |
batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
Lists the latest device positions for requested devices.
|
default CompletableFuture<BatchGetDevicePositionResponse> |
batchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest)
Lists the latest device positions for requested devices.
|
default CompletableFuture<BatchPutGeofenceResponse> |
batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an
existing geofence if a geofence ID is included in the request.
|
default CompletableFuture<BatchPutGeofenceResponse> |
batchPutGeofence(Consumer<BatchPutGeofenceRequest.Builder> batchPutGeofenceRequest)
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an
existing geofence if a geofence ID is included in the request.
|
default CompletableFuture<BatchUpdateDevicePositionResponse> |
batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
Uploads position update data for one or more devices to a tracker resource.
|
default CompletableFuture<BatchUpdateDevicePositionResponse> |
batchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest)
Uploads position update data for one or more devices to a tracker resource.
|
static LocationAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
LocationAsyncClient. |
default CompletableFuture<CalculateRouteResponse> |
calculateRoute(CalculateRouteRequest calculateRouteRequest)
Calculates a route
given the following required parameters:
DeparturePosition and DestinationPosition. |
default CompletableFuture<CalculateRouteResponse> |
calculateRoute(Consumer<CalculateRouteRequest.Builder> calculateRouteRequest)
Calculates a route
given the following required parameters:
DeparturePosition and DestinationPosition. |
default CompletableFuture<CalculateRouteMatrixResponse> |
calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
Calculates a
route matrix given the following required parameters:
DeparturePositions and
DestinationPositions. |
default CompletableFuture<CalculateRouteMatrixResponse> |
calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest)
Calculates a
route matrix given the following required parameters:
DeparturePositions and
DestinationPositions. |
static LocationAsyncClient |
create()
Create a
LocationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateGeofenceCollectionResponse> |
createGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
|
default CompletableFuture<CreateGeofenceCollectionResponse> |
createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
|
default CompletableFuture<CreateMapResponse> |
createMap(Consumer<CreateMapRequest.Builder> createMapRequest)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global
location data providers.
|
default CompletableFuture<CreateMapResponse> |
createMap(CreateMapRequest createMapRequest)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global
location data providers.
|
default CompletableFuture<CreatePlaceIndexResponse> |
createPlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest)
Creates a place index resource in your AWS account.
|
default CompletableFuture<CreatePlaceIndexResponse> |
createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
Creates a place index resource in your AWS account.
|
default CompletableFuture<CreateRouteCalculatorResponse> |
createRouteCalculator(Consumer<CreateRouteCalculatorRequest.Builder> createRouteCalculatorRequest)
Creates a route calculator resource in your AWS account.
|
default CompletableFuture<CreateRouteCalculatorResponse> |
createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)
Creates a route calculator resource in your AWS account.
|
default CompletableFuture<CreateTrackerResponse> |
createTracker(Consumer<CreateTrackerRequest.Builder> createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of
devices.
|
default CompletableFuture<CreateTrackerResponse> |
createTracker(CreateTrackerRequest createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of
devices.
|
default CompletableFuture<DeleteGeofenceCollectionResponse> |
deleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest)
Deletes a geofence collection from your AWS account.
|
default CompletableFuture<DeleteGeofenceCollectionResponse> |
deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
Deletes a geofence collection from your AWS account.
|
default CompletableFuture<DeleteMapResponse> |
deleteMap(Consumer<DeleteMapRequest.Builder> deleteMapRequest)
Deletes a map resource from your AWS account.
|
default CompletableFuture<DeleteMapResponse> |
deleteMap(DeleteMapRequest deleteMapRequest)
Deletes a map resource from your AWS account.
|
default CompletableFuture<DeletePlaceIndexResponse> |
deletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest)
Deletes a place index resource from your AWS account.
|
default CompletableFuture<DeletePlaceIndexResponse> |
deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
Deletes a place index resource from your AWS account.
|
default CompletableFuture<DeleteRouteCalculatorResponse> |
deleteRouteCalculator(Consumer<DeleteRouteCalculatorRequest.Builder> deleteRouteCalculatorRequest)
Deletes a route calculator resource from your AWS account.
|
default CompletableFuture<DeleteRouteCalculatorResponse> |
deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)
Deletes a route calculator resource from your AWS account.
|
default CompletableFuture<DeleteTrackerResponse> |
deleteTracker(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest)
Deletes a tracker resource from your AWS account.
|
default CompletableFuture<DeleteTrackerResponse> |
deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
Deletes a tracker resource from your AWS account.
|
default CompletableFuture<DescribeGeofenceCollectionResponse> |
describeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
|
default CompletableFuture<DescribeGeofenceCollectionResponse> |
describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
|
default CompletableFuture<DescribeMapResponse> |
describeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest)
Retrieves the map resource details.
|
default CompletableFuture<DescribeMapResponse> |
describeMap(DescribeMapRequest describeMapRequest)
Retrieves the map resource details.
|
default CompletableFuture<DescribePlaceIndexResponse> |
describePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest)
Retrieves the place index resource details.
|
default CompletableFuture<DescribePlaceIndexResponse> |
describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
Retrieves the place index resource details.
|
default CompletableFuture<DescribeRouteCalculatorResponse> |
describeRouteCalculator(Consumer<DescribeRouteCalculatorRequest.Builder> describeRouteCalculatorRequest)
Retrieves the route calculator resource details.
|
default CompletableFuture<DescribeRouteCalculatorResponse> |
describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)
Retrieves the route calculator resource details.
|
default CompletableFuture<DescribeTrackerResponse> |
describeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest)
Retrieves the tracker resource details.
|
default CompletableFuture<DescribeTrackerResponse> |
describeTracker(DescribeTrackerRequest describeTrackerRequest)
Retrieves the tracker resource details.
|
default CompletableFuture<DisassociateTrackerConsumerResponse> |
disassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest)
Removes the association between a tracker resource and a geofence collection.
|
default CompletableFuture<DisassociateTrackerConsumerResponse> |
disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
Removes the association between a tracker resource and a geofence collection.
|
default CompletableFuture<GetDevicePositionResponse> |
getDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
|
default CompletableFuture<GetDevicePositionResponse> |
getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
|
default CompletableFuture<GetDevicePositionHistoryResponse> |
getDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default CompletableFuture<GetDevicePositionHistoryResponse> |
getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default GetDevicePositionHistoryPublisher |
getDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default GetDevicePositionHistoryPublisher |
getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
|
default CompletableFuture<GetGeofenceResponse> |
getGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
|
default CompletableFuture<GetGeofenceResponse> |
getGeofence(GetGeofenceRequest getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
|
default CompletableFuture<GetMapGlyphsResponse> |
getMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
|
default CompletableFuture<GetMapGlyphsResponse> |
getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
|
default CompletableFuture<GetMapSpritesResponse> |
getMapSprites(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest)
Retrieves the sprite sheet corresponding to a map resource.
|
default CompletableFuture<GetMapSpritesResponse> |
getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
Retrieves the sprite sheet corresponding to a map resource.
|
default CompletableFuture<GetMapStyleDescriptorResponse> |
getMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest)
Retrieves the map style descriptor from a map resource.
|
default CompletableFuture<GetMapStyleDescriptorResponse> |
getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
Retrieves the map style descriptor from a map resource.
|
default CompletableFuture<GetMapTileResponse> |
getMapTile(Consumer<GetMapTileRequest.Builder> getMapTileRequest)
Retrieves a vector data tile from the map resource.
|
default CompletableFuture<GetMapTileResponse> |
getMapTile(GetMapTileRequest getMapTileRequest)
Retrieves a vector data tile from the map resource.
|
default CompletableFuture<ListDevicePositionsResponse> |
listDevicePositions(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest)
A batch request to retrieve all device positions.
|
default CompletableFuture<ListDevicePositionsResponse> |
listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)
A batch request to retrieve all device positions.
|
default ListDevicePositionsPublisher |
listDevicePositionsPaginator(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest)
A batch request to retrieve all device positions.
|
default ListDevicePositionsPublisher |
listDevicePositionsPaginator(ListDevicePositionsRequest listDevicePositionsRequest)
A batch request to retrieve all device positions.
|
default CompletableFuture<ListGeofenceCollectionsResponse> |
listGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default CompletableFuture<ListGeofenceCollectionsResponse> |
listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default ListGeofenceCollectionsPublisher |
listGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default ListGeofenceCollectionsPublisher |
listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
|
default CompletableFuture<ListGeofencesResponse> |
listGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default CompletableFuture<ListGeofencesResponse> |
listGeofences(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default ListGeofencesPublisher |
listGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default ListGeofencesPublisher |
listGeofencesPaginator(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
|
default CompletableFuture<ListMapsResponse> |
listMaps(Consumer<ListMapsRequest.Builder> listMapsRequest)
Lists map resources in your AWS account.
|
default CompletableFuture<ListMapsResponse> |
listMaps(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
|
default ListMapsPublisher |
listMapsPaginator(Consumer<ListMapsRequest.Builder> listMapsRequest)
Lists map resources in your AWS account.
|
default ListMapsPublisher |
listMapsPaginator(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
|
default CompletableFuture<ListPlaceIndexesResponse> |
listPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)
Lists place index resources in your AWS account.
|
default CompletableFuture<ListPlaceIndexesResponse> |
listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists place index resources in your AWS account.
|
default ListPlaceIndexesPublisher |
listPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)
Lists place index resources in your AWS account.
|
default ListPlaceIndexesPublisher |
listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists place index resources in your AWS account.
|
default CompletableFuture<ListRouteCalculatorsResponse> |
listRouteCalculators(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
|
default CompletableFuture<ListRouteCalculatorsResponse> |
listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
|
default ListRouteCalculatorsPublisher |
listRouteCalculatorsPaginator(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
|
default ListRouteCalculatorsPublisher |
listRouteCalculatorsPaginator(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Location resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Location resource.
|
default CompletableFuture<ListTrackerConsumersResponse> |
listTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default CompletableFuture<ListTrackerConsumersResponse> |
listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default ListTrackerConsumersPublisher |
listTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default ListTrackerConsumersPublisher |
listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
|
default CompletableFuture<ListTrackersResponse> |
listTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest)
Lists tracker resources in your AWS account.
|
default CompletableFuture<ListTrackersResponse> |
listTrackers(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
|
default ListTrackersPublisher |
listTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest)
Lists tracker resources in your AWS account.
|
default ListTrackersPublisher |
listTrackersPaginator(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
|
default CompletableFuture<PutGeofenceResponse> |
putGeofence(Consumer<PutGeofenceRequest.Builder> putGeofenceRequest)
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a
geofence ID is included in the request.
|
default CompletableFuture<PutGeofenceResponse> |
putGeofence(PutGeofenceRequest putGeofenceRequest)
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a
geofence ID is included in the request.
|
default CompletableFuture<SearchPlaceIndexForPositionResponse> |
searchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest)
Reverse geocodes a given coordinate and returns a legible address.
|
default CompletableFuture<SearchPlaceIndexForPositionResponse> |
searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
Reverse geocodes a given coordinate and returns a legible address.
|
default CompletableFuture<SearchPlaceIndexForSuggestionsResponse> |
searchPlaceIndexForSuggestions(Consumer<SearchPlaceIndexForSuggestionsRequest.Builder> searchPlaceIndexForSuggestionsRequest)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
|
default CompletableFuture<SearchPlaceIndexForSuggestionsResponse> |
searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text.
|
default CompletableFuture<SearchPlaceIndexForTextResponse> |
searchPlaceIndexForText(Consumer<SearchPlaceIndexForTextRequest.Builder> searchPlaceIndexForTextRequest)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
interest.
|
default CompletableFuture<SearchPlaceIndexForTextResponse> |
searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
interest.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified Amazon Location resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Amazon Location resource.
|
default CompletableFuture<UpdateGeofenceCollectionResponse> |
updateGeofenceCollection(Consumer<UpdateGeofenceCollectionRequest.Builder> updateGeofenceCollectionRequest)
Updates the specified properties of a given geofence collection.
|
default CompletableFuture<UpdateGeofenceCollectionResponse> |
updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)
Updates the specified properties of a given geofence collection.
|
default CompletableFuture<UpdateMapResponse> |
updateMap(Consumer<UpdateMapRequest.Builder> updateMapRequest)
Updates the specified properties of a given map resource.
|
default CompletableFuture<UpdateMapResponse> |
updateMap(UpdateMapRequest updateMapRequest)
Updates the specified properties of a given map resource.
|
default CompletableFuture<UpdatePlaceIndexResponse> |
updatePlaceIndex(Consumer<UpdatePlaceIndexRequest.Builder> updatePlaceIndexRequest)
Updates the specified properties of a given place index resource.
|
default CompletableFuture<UpdatePlaceIndexResponse> |
updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)
Updates the specified properties of a given place index resource.
|
default CompletableFuture<UpdateRouteCalculatorResponse> |
updateRouteCalculator(Consumer<UpdateRouteCalculatorRequest.Builder> updateRouteCalculatorRequest)
Updates the specified properties for a given route calculator resource.
|
default CompletableFuture<UpdateRouteCalculatorResponse> |
updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)
Updates the specified properties for a given route calculator resource.
|
default CompletableFuture<UpdateTrackerResponse> |
updateTracker(Consumer<UpdateTrackerRequest.Builder> updateTrackerRequest)
Updates the specified properties of a given tracker resource.
|
default CompletableFuture<UpdateTrackerResponse> |
updateTracker(UpdateTrackerRequest updateTrackerRequest)
Updates the specified properties of a given tracker resource.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static LocationAsyncClient create()
LocationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LocationAsyncClientBuilder builder()
LocationAsyncClient.default CompletableFuture<AssociateTrackerConsumerResponse> associateTrackerConsumer(AssociateTrackerConsumerRequest associateTrackerConsumerRequest)
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
You can associate up to five geofence collections to each tracker resource.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
associateTrackerConsumerRequest - default CompletableFuture<AssociateTrackerConsumerResponse> associateTrackerConsumer(Consumer<AssociateTrackerConsumerRequest.Builder> associateTrackerConsumerRequest)
Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection.
You can associate up to five geofence collections to each tracker resource.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
This is a convenience which creates an instance of the AssociateTrackerConsumerRequest.Builder avoiding
the need to create one manually via AssociateTrackerConsumerRequest.builder()
associateTrackerConsumerRequest - A Consumer that will call methods on AssociateTrackerConsumerRequest.Builder to create a
request.default CompletableFuture<BatchDeleteDevicePositionHistoryResponse> batchDeleteDevicePositionHistory(BatchDeleteDevicePositionHistoryRequest batchDeleteDevicePositionHistoryRequest)
Deletes the position history of one or more devices from a tracker resource.
batchDeleteDevicePositionHistoryRequest - default CompletableFuture<BatchDeleteDevicePositionHistoryResponse> batchDeleteDevicePositionHistory(Consumer<BatchDeleteDevicePositionHistoryRequest.Builder> batchDeleteDevicePositionHistoryRequest)
Deletes the position history of one or more devices from a tracker resource.
This is a convenience which creates an instance of the BatchDeleteDevicePositionHistoryRequest.Builder
avoiding the need to create one manually via BatchDeleteDevicePositionHistoryRequest.builder()
batchDeleteDevicePositionHistoryRequest - A Consumer that will call methods on BatchDeleteDevicePositionHistoryRequest.Builder to
create a request.default CompletableFuture<BatchDeleteGeofenceResponse> batchDeleteGeofence(BatchDeleteGeofenceRequest batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
batchDeleteGeofenceRequest - default CompletableFuture<BatchDeleteGeofenceResponse> batchDeleteGeofence(Consumer<BatchDeleteGeofenceRequest.Builder> batchDeleteGeofenceRequest)
Deletes a batch of geofences from a geofence collection.
This operation deletes the resource permanently.
This is a convenience which creates an instance of the BatchDeleteGeofenceRequest.Builder avoiding the
need to create one manually via BatchDeleteGeofenceRequest.builder()
batchDeleteGeofenceRequest - A Consumer that will call methods on BatchDeleteGeofenceRequest.Builder to create a
request.default CompletableFuture<BatchEvaluateGeofencesResponse> batchEvaluateGeofences(BatchEvaluateGeofencesRequest batchEvaluateGeofencesRequest)
Evaluates device positions against the geofence geometries from a given geofence collection.
This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
Geofence evaluation uses the given device position. It does not account for the optional Accuracy of
a DevicePositionUpdate.
batchEvaluateGeofencesRequest - default CompletableFuture<BatchEvaluateGeofencesResponse> batchEvaluateGeofences(Consumer<BatchEvaluateGeofencesRequest.Builder> batchEvaluateGeofencesRequest)
Evaluates device positions against the geofence geometries from a given geofence collection.
This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER if Amazon Location determines that the tracked device has entered a geofenced area.
EXIT if Amazon Location determines that the tracked device has exited a geofenced area.
The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
Geofence evaluation uses the given device position. It does not account for the optional Accuracy of
a DevicePositionUpdate.
This is a convenience which creates an instance of the BatchEvaluateGeofencesRequest.Builder avoiding the
need to create one manually via BatchEvaluateGeofencesRequest.builder()
batchEvaluateGeofencesRequest - A Consumer that will call methods on BatchEvaluateGeofencesRequest.Builder to create a
request.default CompletableFuture<BatchGetDevicePositionResponse> batchGetDevicePosition(BatchGetDevicePositionRequest batchGetDevicePositionRequest)
Lists the latest device positions for requested devices.
batchGetDevicePositionRequest - default CompletableFuture<BatchGetDevicePositionResponse> batchGetDevicePosition(Consumer<BatchGetDevicePositionRequest.Builder> batchGetDevicePositionRequest)
Lists the latest device positions for requested devices.
This is a convenience which creates an instance of the BatchGetDevicePositionRequest.Builder avoiding the
need to create one manually via BatchGetDevicePositionRequest.builder()
batchGetDevicePositionRequest - A Consumer that will call methods on BatchGetDevicePositionRequest.Builder to create a
request.default CompletableFuture<BatchPutGeofenceResponse> batchPutGeofence(BatchPutGeofenceRequest batchPutGeofenceRequest)
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
batchPutGeofenceRequest - default CompletableFuture<BatchPutGeofenceResponse> batchPutGeofence(Consumer<BatchPutGeofenceRequest.Builder> batchPutGeofenceRequest)
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
This is a convenience which creates an instance of the BatchPutGeofenceRequest.Builder avoiding the need
to create one manually via BatchPutGeofenceRequest.builder()
batchPutGeofenceRequest - A Consumer that will call methods on BatchPutGeofenceRequest.Builder to create a request.default CompletableFuture<BatchUpdateDevicePositionResponse> batchUpdateDevicePosition(BatchUpdateDevicePositionRequest batchUpdateDevicePositionRequest)
Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
Position updates are handled based on the PositionFiltering property of the tracker. When
PositionFiltering is set to TimeBased, updates are evaluated against linked geofence
collections, and location data is stored at a maximum of one position per 30 second interval. If your update
frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device
ID.
When PositionFiltering is set to DistanceBased filtering, location data is stored and
evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased filtering, location data is stored and
evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For
example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set
to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0}
when accuracy is not provided on a DevicePositionUpdate.
batchUpdateDevicePositionRequest - default CompletableFuture<BatchUpdateDevicePositionResponse> batchUpdateDevicePosition(Consumer<BatchUpdateDevicePositionRequest.Builder> batchUpdateDevicePositionRequest)
Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.
Position updates are handled based on the PositionFiltering property of the tracker. When
PositionFiltering is set to TimeBased, updates are evaluated against linked geofence
collections, and location data is stored at a maximum of one position per 30 second interval. If your update
frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device
ID.
When PositionFiltering is set to DistanceBased filtering, location data is stored and
evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased filtering, location data is stored and
evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For
example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set
to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0}
when accuracy is not provided on a DevicePositionUpdate.
This is a convenience which creates an instance of the BatchUpdateDevicePositionRequest.Builder avoiding
the need to create one manually via BatchUpdateDevicePositionRequest.builder()
batchUpdateDevicePositionRequest - A Consumer that will call methods on BatchUpdateDevicePositionRequest.Builder to create a
request.default CompletableFuture<CalculateRouteResponse> calculateRoute(CalculateRouteRequest calculateRouteRequest)
Calculates a route
given the following required parameters: DeparturePosition and DestinationPosition.
Requires that you first create a
route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
Specifying a departure
time using either DepartureTime or DepartNow. This calculates a route based on
predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both
parameters returns a validation error.
Specifying a travel
mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
calculateRouteRequest - default CompletableFuture<CalculateRouteResponse> calculateRoute(Consumer<CalculateRouteRequest.Builder> calculateRouteRequest)
Calculates a route
given the following required parameters: DeparturePosition and DestinationPosition.
Requires that you first create a
route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
Specifying a departure
time using either DepartureTime or DepartNow. This calculates a route based on
predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both
parameters returns a validation error.
Specifying a travel
mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
This is a convenience which creates an instance of the CalculateRouteRequest.Builder avoiding the need to
create one manually via CalculateRouteRequest.builder()
calculateRouteRequest - A Consumer that will call methods on CalculateRouteRequest.Builder to create a request.default CompletableFuture<CalculateRouteMatrixResponse> calculateRouteMatrix(CalculateRouteMatrixRequest calculateRouteMatrixRequest)
Calculates a
route matrix given the following required parameters: DeparturePositions and
DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel
time and travel distance from each departure position to each destination position in the request. For example,
given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will
return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of
results returned (and routes calculated) will be the number of DeparturePositions times the number
of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
Additional options include:
Specifying a departure
time using either DepartureTime or DepartNow. This calculates routes based on
predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both
parameters returns a validation error.
Specifying a travel
mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
calculateRouteMatrixRequest - default CompletableFuture<CalculateRouteMatrixResponse> calculateRouteMatrix(Consumer<CalculateRouteMatrixRequest.Builder> calculateRouteMatrixRequest)
Calculates a
route matrix given the following required parameters: DeparturePositions and
DestinationPositions. CalculateRouteMatrix calculates routes and returns the travel
time and travel distance from each departure position to each destination position in the request. For example,
given departure positions A and B, and destination positions X and Y, CalculateRouteMatrix will
return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of
results returned (and routes calculated) will be the number of DeparturePositions times the number
of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
Requires that you first create a route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating routes.
Additional options include:
Specifying a departure
time using either DepartureTime or DepartNow. This calculates routes based on
predictive traffic data at the given time.
You can't specify both DepartureTime and DepartNow in a single request. Specifying both
parameters returns a validation error.
Specifying a travel
mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify
additional route preferences in CarModeOptions if traveling by Car, or
TruckModeOptions if traveling by Truck.
This is a convenience which creates an instance of the CalculateRouteMatrixRequest.Builder avoiding the
need to create one manually via CalculateRouteMatrixRequest.builder()
calculateRouteMatrixRequest - A Consumer that will call methods on CalculateRouteMatrixRequest.Builder to create a
request.default CompletableFuture<CreateGeofenceCollectionResponse> createGeofenceCollection(CreateGeofenceCollectionRequest createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
createGeofenceCollectionRequest - default CompletableFuture<CreateGeofenceCollectionResponse> createGeofenceCollection(Consumer<CreateGeofenceCollectionRequest.Builder> createGeofenceCollectionRequest)
Creates a geofence collection, which manages and stores geofences.
This is a convenience which creates an instance of the CreateGeofenceCollectionRequest.Builder avoiding
the need to create one manually via CreateGeofenceCollectionRequest.builder()
createGeofenceCollectionRequest - A Consumer that will call methods on CreateGeofenceCollectionRequest.Builder to create a
request.default CompletableFuture<CreateMapResponse> createMap(CreateMapRequest createMapRequest)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
createMapRequest - default CompletableFuture<CreateMapResponse> createMap(Consumer<CreateMapRequest.Builder> createMapRequest)
Creates a map resource in your AWS account, which provides map tiles of different styles sourced from global location data providers.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
This is a convenience which creates an instance of the CreateMapRequest.Builder avoiding the need to
create one manually via CreateMapRequest.builder()
createMapRequest - A Consumer that will call methods on CreateMapRequest.Builder to create a request.default CompletableFuture<CreatePlaceIndexResponse> createPlaceIndex(CreatePlaceIndexRequest createPlaceIndexRequest)
Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other
text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by
using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the
SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
createPlaceIndexRequest - default CompletableFuture<CreatePlaceIndexResponse> createPlaceIndex(Consumer<CreatePlaceIndexRequest.Builder> createPlaceIndexRequest)
Creates a place index resource in your AWS account. Use a place index resource to geocode addresses and other
text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by
using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the
SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
This is a convenience which creates an instance of the CreatePlaceIndexRequest.Builder avoiding the need
to create one manually via CreatePlaceIndexRequest.builder()
createPlaceIndexRequest - A Consumer that will call methods on CreatePlaceIndexRequest.Builder to create a request.default CompletableFuture<CreateRouteCalculatorResponse> createRouteCalculator(CreateRouteCalculatorRequest createRouteCalculatorRequest)
Creates a route calculator resource in your AWS account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
createRouteCalculatorRequest - default CompletableFuture<CreateRouteCalculatorResponse> createRouteCalculator(Consumer<CreateRouteCalculatorRequest.Builder> createRouteCalculatorRequest)
Creates a route calculator resource in your AWS account.
You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you may only use HERE as your geolocation provider. See section 82 of the AWS service terms for more details.
This is a convenience which creates an instance of the CreateRouteCalculatorRequest.Builder avoiding the
need to create one manually via CreateRouteCalculatorRequest.builder()
createRouteCalculatorRequest - A Consumer that will call methods on CreateRouteCalculatorRequest.Builder to create a
request.default CompletableFuture<CreateTrackerResponse> createTracker(CreateTrackerRequest createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
createTrackerRequest - default CompletableFuture<CreateTrackerResponse> createTracker(Consumer<CreateTrackerRequest.Builder> createTrackerRequest)
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
This is a convenience which creates an instance of the CreateTrackerRequest.Builder avoiding the need to
create one manually via CreateTrackerRequest.builder()
createTrackerRequest - A Consumer that will call methods on CreateTrackerRequest.Builder to create a request.default CompletableFuture<DeleteGeofenceCollectionResponse> deleteGeofenceCollection(DeleteGeofenceCollectionRequest deleteGeofenceCollectionRequest)
Deletes a geofence collection from your AWS account.
This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
deleteGeofenceCollectionRequest - default CompletableFuture<DeleteGeofenceCollectionResponse> deleteGeofenceCollection(Consumer<DeleteGeofenceCollectionRequest.Builder> deleteGeofenceCollectionRequest)
Deletes a geofence collection from your AWS account.
This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.
This is a convenience which creates an instance of the DeleteGeofenceCollectionRequest.Builder avoiding
the need to create one manually via DeleteGeofenceCollectionRequest.builder()
deleteGeofenceCollectionRequest - A Consumer that will call methods on DeleteGeofenceCollectionRequest.Builder to create a
request.default CompletableFuture<DeleteMapResponse> deleteMap(DeleteMapRequest deleteMapRequest)
Deletes a map resource from your AWS account.
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
deleteMapRequest - default CompletableFuture<DeleteMapResponse> deleteMap(Consumer<DeleteMapRequest.Builder> deleteMapRequest)
Deletes a map resource from your AWS account.
This operation deletes the resource permanently. If the map is being used in an application, the map may not render.
This is a convenience which creates an instance of the DeleteMapRequest.Builder avoiding the need to
create one manually via DeleteMapRequest.builder()
deleteMapRequest - A Consumer that will call methods on DeleteMapRequest.Builder to create a request.default CompletableFuture<DeletePlaceIndexResponse> deletePlaceIndex(DeletePlaceIndexRequest deletePlaceIndexRequest)
Deletes a place index resource from your AWS account.
This operation deletes the resource permanently.
deletePlaceIndexRequest - default CompletableFuture<DeletePlaceIndexResponse> deletePlaceIndex(Consumer<DeletePlaceIndexRequest.Builder> deletePlaceIndexRequest)
Deletes a place index resource from your AWS account.
This operation deletes the resource permanently.
This is a convenience which creates an instance of the DeletePlaceIndexRequest.Builder avoiding the need
to create one manually via DeletePlaceIndexRequest.builder()
deletePlaceIndexRequest - A Consumer that will call methods on DeletePlaceIndexRequest.Builder to create a request.default CompletableFuture<DeleteRouteCalculatorResponse> deleteRouteCalculator(DeleteRouteCalculatorRequest deleteRouteCalculatorRequest)
Deletes a route calculator resource from your AWS account.
This operation deletes the resource permanently.
deleteRouteCalculatorRequest - default CompletableFuture<DeleteRouteCalculatorResponse> deleteRouteCalculator(Consumer<DeleteRouteCalculatorRequest.Builder> deleteRouteCalculatorRequest)
Deletes a route calculator resource from your AWS account.
This operation deletes the resource permanently.
This is a convenience which creates an instance of the DeleteRouteCalculatorRequest.Builder avoiding the
need to create one manually via DeleteRouteCalculatorRequest.builder()
deleteRouteCalculatorRequest - A Consumer that will call methods on DeleteRouteCalculatorRequest.Builder to create a
request.default CompletableFuture<DeleteTrackerResponse> deleteTracker(DeleteTrackerRequest deleteTrackerRequest)
Deletes a tracker resource from your AWS account.
This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
deleteTrackerRequest - default CompletableFuture<DeleteTrackerResponse> deleteTracker(Consumer<DeleteTrackerRequest.Builder> deleteTrackerRequest)
Deletes a tracker resource from your AWS account.
This operation deletes the resource permanently. If the tracker resource is in use, you may encounter an error. Make sure that the target resource isn't a dependency for your applications.
This is a convenience which creates an instance of the DeleteTrackerRequest.Builder avoiding the need to
create one manually via DeleteTrackerRequest.builder()
deleteTrackerRequest - A Consumer that will call methods on DeleteTrackerRequest.Builder to create a request.default CompletableFuture<DescribeGeofenceCollectionResponse> describeGeofenceCollection(DescribeGeofenceCollectionRequest describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
describeGeofenceCollectionRequest - default CompletableFuture<DescribeGeofenceCollectionResponse> describeGeofenceCollection(Consumer<DescribeGeofenceCollectionRequest.Builder> describeGeofenceCollectionRequest)
Retrieves the geofence collection details.
This is a convenience which creates an instance of the DescribeGeofenceCollectionRequest.Builder avoiding
the need to create one manually via DescribeGeofenceCollectionRequest.builder()
describeGeofenceCollectionRequest - A Consumer that will call methods on DescribeGeofenceCollectionRequest.Builder to create a
request.default CompletableFuture<DescribeMapResponse> describeMap(DescribeMapRequest describeMapRequest)
Retrieves the map resource details.
describeMapRequest - default CompletableFuture<DescribeMapResponse> describeMap(Consumer<DescribeMapRequest.Builder> describeMapRequest)
Retrieves the map resource details.
This is a convenience which creates an instance of the DescribeMapRequest.Builder avoiding the need to
create one manually via DescribeMapRequest.builder()
describeMapRequest - A Consumer that will call methods on DescribeMapRequest.Builder to create a request.default CompletableFuture<DescribePlaceIndexResponse> describePlaceIndex(DescribePlaceIndexRequest describePlaceIndexRequest)
Retrieves the place index resource details.
describePlaceIndexRequest - default CompletableFuture<DescribePlaceIndexResponse> describePlaceIndex(Consumer<DescribePlaceIndexRequest.Builder> describePlaceIndexRequest)
Retrieves the place index resource details.
This is a convenience which creates an instance of the DescribePlaceIndexRequest.Builder avoiding the
need to create one manually via DescribePlaceIndexRequest.builder()
describePlaceIndexRequest - A Consumer that will call methods on DescribePlaceIndexRequest.Builder to create a
request.default CompletableFuture<DescribeRouteCalculatorResponse> describeRouteCalculator(DescribeRouteCalculatorRequest describeRouteCalculatorRequest)
Retrieves the route calculator resource details.
describeRouteCalculatorRequest - default CompletableFuture<DescribeRouteCalculatorResponse> describeRouteCalculator(Consumer<DescribeRouteCalculatorRequest.Builder> describeRouteCalculatorRequest)
Retrieves the route calculator resource details.
This is a convenience which creates an instance of the DescribeRouteCalculatorRequest.Builder avoiding
the need to create one manually via DescribeRouteCalculatorRequest.builder()
describeRouteCalculatorRequest - A Consumer that will call methods on DescribeRouteCalculatorRequest.Builder to create a
request.default CompletableFuture<DescribeTrackerResponse> describeTracker(DescribeTrackerRequest describeTrackerRequest)
Retrieves the tracker resource details.
describeTrackerRequest - default CompletableFuture<DescribeTrackerResponse> describeTracker(Consumer<DescribeTrackerRequest.Builder> describeTrackerRequest)
Retrieves the tracker resource details.
This is a convenience which creates an instance of the DescribeTrackerRequest.Builder avoiding the need
to create one manually via DescribeTrackerRequest.builder()
describeTrackerRequest - A Consumer that will call methods on DescribeTrackerRequest.Builder to create a request.default CompletableFuture<DisassociateTrackerConsumerResponse> disassociateTrackerConsumer(DisassociateTrackerConsumerRequest disassociateTrackerConsumerRequest)
Removes the association between a tracker resource and a geofence collection.
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
disassociateTrackerConsumerRequest - default CompletableFuture<DisassociateTrackerConsumerResponse> disassociateTrackerConsumer(Consumer<DisassociateTrackerConsumerRequest.Builder> disassociateTrackerConsumerRequest)
Removes the association between a tracker resource and a geofence collection.
Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.
This is a convenience which creates an instance of the DisassociateTrackerConsumerRequest.Builder
avoiding the need to create one manually via DisassociateTrackerConsumerRequest.builder()
disassociateTrackerConsumerRequest - A Consumer that will call methods on DisassociateTrackerConsumerRequest.Builder to create
a request.default CompletableFuture<GetDevicePositionResponse> getDevicePosition(GetDevicePositionRequest getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
getDevicePositionRequest - default CompletableFuture<GetDevicePositionResponse> getDevicePosition(Consumer<GetDevicePositionRequest.Builder> getDevicePositionRequest)
Retrieves a device's most recent position according to its sample time.
Device positions are deleted after 30 days.
This is a convenience which creates an instance of the GetDevicePositionRequest.Builder avoiding the need
to create one manually via GetDevicePositionRequest.builder()
getDevicePositionRequest - A Consumer that will call methods on GetDevicePositionRequest.Builder to create a request.default CompletableFuture<GetDevicePositionHistoryResponse> getDevicePositionHistory(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
getDevicePositionHistoryRequest - default CompletableFuture<GetDevicePositionHistoryResponse> getDevicePositionHistory(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
This is a convenience which creates an instance of the GetDevicePositionHistoryRequest.Builder avoiding
the need to create one manually via GetDevicePositionHistoryRequest.builder()
getDevicePositionHistoryRequest - A Consumer that will call methods on GetDevicePositionHistoryRequest.Builder to create a
request.default GetDevicePositionHistoryPublisher getDevicePositionHistoryPaginator(GetDevicePositionHistoryRequest getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.
getDevicePositionHistoryRequest - default GetDevicePositionHistoryPublisher getDevicePositionHistoryPaginator(Consumer<GetDevicePositionHistoryRequest.Builder> getDevicePositionHistoryRequest)
Retrieves the device position history from a tracker resource within a specified range of time.
Device positions are deleted after 30 days.
This is a variant of
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.GetDevicePositionHistoryPublisher publisher = client.getDevicePositionHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDevicePositionHistory(software.amazon.awssdk.services.location.model.GetDevicePositionHistoryRequest)
operation.
This is a convenience which creates an instance of the GetDevicePositionHistoryRequest.Builder avoiding
the need to create one manually via GetDevicePositionHistoryRequest.builder()
getDevicePositionHistoryRequest - A Consumer that will call methods on GetDevicePositionHistoryRequest.Builder to create a
request.default CompletableFuture<GetGeofenceResponse> getGeofence(GetGeofenceRequest getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
getGeofenceRequest - default CompletableFuture<GetGeofenceResponse> getGeofence(Consumer<GetGeofenceRequest.Builder> getGeofenceRequest)
Retrieves the geofence details from a geofence collection.
This is a convenience which creates an instance of the GetGeofenceRequest.Builder avoiding the need to
create one manually via GetGeofenceRequest.builder()
getGeofenceRequest - A Consumer that will call methods on GetGeofenceRequest.Builder to create a request.default CompletableFuture<GetMapGlyphsResponse> getMapGlyphs(GetMapGlyphsRequest getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
getMapGlyphsRequest - default CompletableFuture<GetMapGlyphsResponse> getMapGlyphs(Consumer<GetMapGlyphsRequest.Builder> getMapGlyphsRequest)
Retrieves glyphs used to display labels on a map.
This is a convenience which creates an instance of the GetMapGlyphsRequest.Builder avoiding the need to
create one manually via GetMapGlyphsRequest.builder()
getMapGlyphsRequest - A Consumer that will call methods on GetMapGlyphsRequest.Builder to create a request.default CompletableFuture<GetMapSpritesResponse> getMapSprites(GetMapSpritesRequest getMapSpritesRequest)
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
getMapSpritesRequest - default CompletableFuture<GetMapSpritesResponse> getMapSprites(Consumer<GetMapSpritesRequest.Builder> getMapSpritesRequest)
Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.
This is a convenience which creates an instance of the GetMapSpritesRequest.Builder avoiding the need to
create one manually via GetMapSpritesRequest.builder()
getMapSpritesRequest - A Consumer that will call methods on GetMapSpritesRequest.Builder to create a request.default CompletableFuture<GetMapStyleDescriptorResponse> getMapStyleDescriptor(GetMapStyleDescriptorRequest getMapStyleDescriptorRequest)
Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
getMapStyleDescriptorRequest - default CompletableFuture<GetMapStyleDescriptorResponse> getMapStyleDescriptor(Consumer<GetMapStyleDescriptorRequest.Builder> getMapStyleDescriptorRequest)
Retrieves the map style descriptor from a map resource.
The style descriptor contains specifications on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.
This is a convenience which creates an instance of the GetMapStyleDescriptorRequest.Builder avoiding the
need to create one manually via GetMapStyleDescriptorRequest.builder()
getMapStyleDescriptorRequest - A Consumer that will call methods on GetMapStyleDescriptorRequest.Builder to create a
request.default CompletableFuture<GetMapTileResponse> getMapTile(GetMapTileRequest getMapTileRequest)
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
getMapTileRequest - default CompletableFuture<GetMapTileResponse> getMapTile(Consumer<GetMapTileRequest.Builder> getMapTileRequest)
Retrieves a vector data tile from the map resource. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.
The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
This is a convenience which creates an instance of the GetMapTileRequest.Builder avoiding the need to
create one manually via GetMapTileRequest.builder()
getMapTileRequest - A Consumer that will call methods on GetMapTileRequest.Builder to create a request.default CompletableFuture<ListDevicePositionsResponse> listDevicePositions(ListDevicePositionsRequest listDevicePositionsRequest)
A batch request to retrieve all device positions.
listDevicePositionsRequest - default CompletableFuture<ListDevicePositionsResponse> listDevicePositions(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest)
A batch request to retrieve all device positions.
This is a convenience which creates an instance of the ListDevicePositionsRequest.Builder avoiding the
need to create one manually via ListDevicePositionsRequest.builder()
listDevicePositionsRequest - A Consumer that will call methods on ListDevicePositionsRequest.Builder to create a
request.default ListDevicePositionsPublisher listDevicePositionsPaginator(ListDevicePositionsRequest listDevicePositionsRequest)
A batch request to retrieve all device positions.
This is a variant of
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListDevicePositionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListDevicePositionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation.
listDevicePositionsRequest - default ListDevicePositionsPublisher listDevicePositionsPaginator(Consumer<ListDevicePositionsRequest.Builder> listDevicePositionsRequest)
A batch request to retrieve all device positions.
This is a variant of
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListDevicePositionsPublisher publisher = client.listDevicePositionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListDevicePositionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListDevicePositionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevicePositions(software.amazon.awssdk.services.location.model.ListDevicePositionsRequest)
operation.
This is a convenience which creates an instance of the ListDevicePositionsRequest.Builder avoiding the
need to create one manually via ListDevicePositionsRequest.builder()
listDevicePositionsRequest - A Consumer that will call methods on ListDevicePositionsRequest.Builder to create a
request.default CompletableFuture<ListGeofenceCollectionsResponse> listGeofenceCollections(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
listGeofenceCollectionsRequest - default CompletableFuture<ListGeofenceCollectionsResponse> listGeofenceCollections(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
This is a convenience which creates an instance of the ListGeofenceCollectionsRequest.Builder avoiding
the need to create one manually via ListGeofenceCollectionsRequest.builder()
listGeofenceCollectionsRequest - A Consumer that will call methods on ListGeofenceCollectionsRequest.Builder to create a
request.default ListGeofenceCollectionsPublisher listGeofenceCollectionsPaginator(ListGeofenceCollectionsRequest listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.
listGeofenceCollectionsRequest - default ListGeofenceCollectionsPublisher listGeofenceCollectionsPaginator(Consumer<ListGeofenceCollectionsRequest.Builder> listGeofenceCollectionsRequest)
Lists geofence collections in your AWS account.
This is a variant of
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListGeofenceCollectionsPublisher publisher = client.listGeofenceCollectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofenceCollections(software.amazon.awssdk.services.location.model.ListGeofenceCollectionsRequest)
operation.
This is a convenience which creates an instance of the ListGeofenceCollectionsRequest.Builder avoiding
the need to create one manually via ListGeofenceCollectionsRequest.builder()
listGeofenceCollectionsRequest - A Consumer that will call methods on ListGeofenceCollectionsRequest.Builder to create a
request.default CompletableFuture<ListGeofencesResponse> listGeofences(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
listGeofencesRequest - default CompletableFuture<ListGeofencesResponse> listGeofences(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)
Lists geofences stored in a given geofence collection.
This is a convenience which creates an instance of the ListGeofencesRequest.Builder avoiding the need to
create one manually via ListGeofencesRequest.builder()
listGeofencesRequest - A Consumer that will call methods on ListGeofencesRequest.Builder to create a request.default ListGeofencesPublisher listGeofencesPaginator(ListGeofencesRequest listGeofencesRequest)
Lists geofences stored in a given geofence collection.
This is a variant of listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofencesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListGeofencesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest) operation.
listGeofencesRequest - default ListGeofencesPublisher listGeofencesPaginator(Consumer<ListGeofencesRequest.Builder> listGeofencesRequest)
Lists geofences stored in a given geofence collection.
This is a variant of listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListGeofencesPublisher publisher = client.listGeofencesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListGeofencesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListGeofencesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeofences(software.amazon.awssdk.services.location.model.ListGeofencesRequest) operation.
This is a convenience which creates an instance of the ListGeofencesRequest.Builder avoiding the need to
create one manually via ListGeofencesRequest.builder()
listGeofencesRequest - A Consumer that will call methods on ListGeofencesRequest.Builder to create a request.default CompletableFuture<ListMapsResponse> listMaps(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
listMapsRequest - default CompletableFuture<ListMapsResponse> listMaps(Consumer<ListMapsRequest.Builder> listMapsRequest)
Lists map resources in your AWS account.
This is a convenience which creates an instance of the ListMapsRequest.Builder avoiding the need to
create one manually via ListMapsRequest.builder()
listMapsRequest - A Consumer that will call methods on ListMapsRequest.Builder to create a request.default ListMapsPublisher listMapsPaginator(ListMapsRequest listMapsRequest)
Lists map resources in your AWS account.
This is a variant of listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListMapsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListMapsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest) operation.
listMapsRequest - default ListMapsPublisher listMapsPaginator(Consumer<ListMapsRequest.Builder> listMapsRequest)
Lists map resources in your AWS account.
This is a variant of listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListMapsPublisher publisher = client.listMapsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListMapsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListMapsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMaps(software.amazon.awssdk.services.location.model.ListMapsRequest) operation.
This is a convenience which creates an instance of the ListMapsRequest.Builder avoiding the need to
create one manually via ListMapsRequest.builder()
listMapsRequest - A Consumer that will call methods on ListMapsRequest.Builder to create a request.default CompletableFuture<ListPlaceIndexesResponse> listPlaceIndexes(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists place index resources in your AWS account.
listPlaceIndexesRequest - default CompletableFuture<ListPlaceIndexesResponse> listPlaceIndexes(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)
Lists place index resources in your AWS account.
This is a convenience which creates an instance of the ListPlaceIndexesRequest.Builder avoiding the need
to create one manually via ListPlaceIndexesRequest.builder()
listPlaceIndexesRequest - A Consumer that will call methods on ListPlaceIndexesRequest.Builder to create a request.default ListPlaceIndexesPublisher listPlaceIndexesPaginator(ListPlaceIndexesRequest listPlaceIndexesRequest)
Lists place index resources in your AWS account.
This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest) operation.
listPlaceIndexesRequest - default ListPlaceIndexesPublisher listPlaceIndexesPaginator(Consumer<ListPlaceIndexesRequest.Builder> listPlaceIndexesRequest)
Lists place index resources in your AWS account.
This is a variant of
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListPlaceIndexesPublisher publisher = client.listPlaceIndexesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListPlaceIndexesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaceIndexes(software.amazon.awssdk.services.location.model.ListPlaceIndexesRequest) operation.
This is a convenience which creates an instance of the ListPlaceIndexesRequest.Builder avoiding the need
to create one manually via ListPlaceIndexesRequest.builder()
listPlaceIndexesRequest - A Consumer that will call methods on ListPlaceIndexesRequest.Builder to create a request.default CompletableFuture<ListRouteCalculatorsResponse> listRouteCalculators(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
listRouteCalculatorsRequest - default CompletableFuture<ListRouteCalculatorsResponse> listRouteCalculators(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
This is a convenience which creates an instance of the ListRouteCalculatorsRequest.Builder avoiding the
need to create one manually via ListRouteCalculatorsRequest.builder()
listRouteCalculatorsRequest - A Consumer that will call methods on ListRouteCalculatorsRequest.Builder to create a
request.default ListRouteCalculatorsPublisher listRouteCalculatorsPaginator(ListRouteCalculatorsRequest listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
This is a variant of
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation.
listRouteCalculatorsRequest - default ListRouteCalculatorsPublisher listRouteCalculatorsPaginator(Consumer<ListRouteCalculatorsRequest.Builder> listRouteCalculatorsRequest)
Lists route calculator resources in your AWS account.
This is a variant of
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListRouteCalculatorsPublisher publisher = client.listRouteCalculatorsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListRouteCalculatorsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRouteCalculators(software.amazon.awssdk.services.location.model.ListRouteCalculatorsRequest)
operation.
This is a convenience which creates an instance of the ListRouteCalculatorsRequest.Builder avoiding the
need to create one manually via ListRouteCalculatorsRequest.builder()
listRouteCalculatorsRequest - A Consumer that will call methods on ListRouteCalculatorsRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Location resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags that are applied to the specified Amazon Location resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListTrackerConsumersResponse> listTrackerConsumers(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
listTrackerConsumersRequest - default CompletableFuture<ListTrackerConsumersResponse> listTrackerConsumers(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
This is a convenience which creates an instance of the ListTrackerConsumersRequest.Builder avoiding the
need to create one manually via ListTrackerConsumersRequest.builder()
listTrackerConsumersRequest - A Consumer that will call methods on ListTrackerConsumersRequest.Builder to create a
request.default ListTrackerConsumersPublisher listTrackerConsumersPaginator(ListTrackerConsumersRequest listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.
listTrackerConsumersRequest - default ListTrackerConsumersPublisher listTrackerConsumersPaginator(Consumer<ListTrackerConsumersRequest.Builder> listTrackerConsumersRequest)
Lists geofence collections currently associated to the given tracker resource.
This is a variant of
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListTrackerConsumersPublisher publisher = client.listTrackerConsumersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListTrackerConsumersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackerConsumers(software.amazon.awssdk.services.location.model.ListTrackerConsumersRequest)
operation.
This is a convenience which creates an instance of the ListTrackerConsumersRequest.Builder avoiding the
need to create one manually via ListTrackerConsumersRequest.builder()
listTrackerConsumersRequest - A Consumer that will call methods on ListTrackerConsumersRequest.Builder to create a
request.default CompletableFuture<ListTrackersResponse> listTrackers(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
listTrackersRequest - default CompletableFuture<ListTrackersResponse> listTrackers(Consumer<ListTrackersRequest.Builder> listTrackersRequest)
Lists tracker resources in your AWS account.
This is a convenience which creates an instance of the ListTrackersRequest.Builder avoiding the need to
create one manually via ListTrackersRequest.builder()
listTrackersRequest - A Consumer that will call methods on ListTrackersRequest.Builder to create a request.default ListTrackersPublisher listTrackersPaginator(ListTrackersRequest listTrackersRequest)
Lists tracker resources in your AWS account.
This is a variant of listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListTrackersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest) operation.
listTrackersRequest - default ListTrackersPublisher listTrackersPaginator(Consumer<ListTrackersRequest.Builder> listTrackersRequest)
Lists tracker resources in your AWS account.
This is a variant of listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.location.paginators.ListTrackersPublisher publisher = client.listTrackersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.location.model.ListTrackersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.location.model.ListTrackersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrackers(software.amazon.awssdk.services.location.model.ListTrackersRequest) operation.
This is a convenience which creates an instance of the ListTrackersRequest.Builder avoiding the need to
create one manually via ListTrackersRequest.builder()
listTrackersRequest - A Consumer that will call methods on ListTrackersRequest.Builder to create a request.default CompletableFuture<PutGeofenceResponse> putGeofence(PutGeofenceRequest putGeofenceRequest)
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
putGeofenceRequest - default CompletableFuture<PutGeofenceResponse> putGeofence(Consumer<PutGeofenceRequest.Builder> putGeofenceRequest)
Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
This is a convenience which creates an instance of the PutGeofenceRequest.Builder avoiding the need to
create one manually via PutGeofenceRequest.builder()
putGeofenceRequest - A Consumer that will call methods on PutGeofenceRequest.Builder to create a request.default CompletableFuture<SearchPlaceIndexForPositionResponse> searchPlaceIndexForPosition(SearchPlaceIndexForPositionRequest searchPlaceIndexForPositionRequest)
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
searchPlaceIndexForPositionRequest - default CompletableFuture<SearchPlaceIndexForPositionResponse> searchPlaceIndexForPosition(Consumer<SearchPlaceIndexForPositionRequest.Builder> searchPlaceIndexForPositionRequest)
Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.
This is a convenience which creates an instance of the SearchPlaceIndexForPositionRequest.Builder
avoiding the need to create one manually via SearchPlaceIndexForPositionRequest.builder()
searchPlaceIndexForPositionRequest - A Consumer that will call methods on SearchPlaceIndexForPositionRequest.Builder to create
a request.default CompletableFuture<SearchPlaceIndexForSuggestionsResponse> searchPlaceIndexForSuggestions(SearchPlaceIndexForSuggestionsRequest searchPlaceIndexForSuggestionsRequest)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for suggested place names near a specified position by using BiasPosition, or filter
results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using
both BiasPosition and FilterBBox in the same command returns an error.
searchPlaceIndexForSuggestionsRequest - default CompletableFuture<SearchPlaceIndexForSuggestionsResponse> searchPlaceIndexForSuggestions(Consumer<SearchPlaceIndexForSuggestionsRequest.Builder> searchPlaceIndexForSuggestionsRequest)
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for suggested place names near a specified position by using BiasPosition, or filter
results within a bounding box by using FilterBBox. These parameters are mutually exclusive; using
both BiasPosition and FilterBBox in the same command returns an error.
This is a convenience which creates an instance of the SearchPlaceIndexForSuggestionsRequest.Builder
avoiding the need to create one manually via SearchPlaceIndexForSuggestionsRequest.builder()
searchPlaceIndexForSuggestionsRequest - A Consumer that will call methods on SearchPlaceIndexForSuggestionsRequest.Builder to
create a request.default CompletableFuture<SearchPlaceIndexForTextResponse> searchPlaceIndexForText(SearchPlaceIndexForTextRequest searchPlaceIndexForTextRequest)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for places near a given position using BiasPosition, or filter results within a
bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
searchPlaceIndexForTextRequest - default CompletableFuture<SearchPlaceIndexForTextResponse> searchPlaceIndexForText(Consumer<SearchPlaceIndexForTextRequest.Builder> searchPlaceIndexForTextRequest)
Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for places near a given position using BiasPosition, or filter results within a
bounding box using FilterBBox. Providing both parameters simultaneously returns an error.
Search results are returned in order of highest to lowest relevance.
This is a convenience which creates an instance of the SearchPlaceIndexForTextRequest.Builder avoiding
the need to create one manually via SearchPlaceIndexForTextRequest.builder()
searchPlaceIndexForTextRequest - A Consumer that will call methods on SearchPlaceIndexForTextRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
<p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
<p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Amazon Location resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified Amazon Location resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateGeofenceCollectionResponse> updateGeofenceCollection(UpdateGeofenceCollectionRequest updateGeofenceCollectionRequest)
Updates the specified properties of a given geofence collection.
updateGeofenceCollectionRequest - default CompletableFuture<UpdateGeofenceCollectionResponse> updateGeofenceCollection(Consumer<UpdateGeofenceCollectionRequest.Builder> updateGeofenceCollectionRequest)
Updates the specified properties of a given geofence collection.
This is a convenience which creates an instance of the UpdateGeofenceCollectionRequest.Builder avoiding
the need to create one manually via UpdateGeofenceCollectionRequest.builder()
updateGeofenceCollectionRequest - A Consumer that will call methods on UpdateGeofenceCollectionRequest.Builder to create a
request.default CompletableFuture<UpdateMapResponse> updateMap(UpdateMapRequest updateMapRequest)
Updates the specified properties of a given map resource.
updateMapRequest - default CompletableFuture<UpdateMapResponse> updateMap(Consumer<UpdateMapRequest.Builder> updateMapRequest)
Updates the specified properties of a given map resource.
This is a convenience which creates an instance of the UpdateMapRequest.Builder avoiding the need to
create one manually via UpdateMapRequest.builder()
updateMapRequest - A Consumer that will call methods on UpdateMapRequest.Builder to create a request.default CompletableFuture<UpdatePlaceIndexResponse> updatePlaceIndex(UpdatePlaceIndexRequest updatePlaceIndexRequest)
Updates the specified properties of a given place index resource.
updatePlaceIndexRequest - default CompletableFuture<UpdatePlaceIndexResponse> updatePlaceIndex(Consumer<UpdatePlaceIndexRequest.Builder> updatePlaceIndexRequest)
Updates the specified properties of a given place index resource.
This is a convenience which creates an instance of the UpdatePlaceIndexRequest.Builder avoiding the need
to create one manually via UpdatePlaceIndexRequest.builder()
updatePlaceIndexRequest - A Consumer that will call methods on UpdatePlaceIndexRequest.Builder to create a request.default CompletableFuture<UpdateRouteCalculatorResponse> updateRouteCalculator(UpdateRouteCalculatorRequest updateRouteCalculatorRequest)
Updates the specified properties for a given route calculator resource.
updateRouteCalculatorRequest - default CompletableFuture<UpdateRouteCalculatorResponse> updateRouteCalculator(Consumer<UpdateRouteCalculatorRequest.Builder> updateRouteCalculatorRequest)
Updates the specified properties for a given route calculator resource.
This is a convenience which creates an instance of the UpdateRouteCalculatorRequest.Builder avoiding the
need to create one manually via UpdateRouteCalculatorRequest.builder()
updateRouteCalculatorRequest - A Consumer that will call methods on UpdateRouteCalculatorRequest.Builder to create a
request.default CompletableFuture<UpdateTrackerResponse> updateTracker(UpdateTrackerRequest updateTrackerRequest)
Updates the specified properties of a given tracker resource.
updateTrackerRequest - default CompletableFuture<UpdateTrackerResponse> updateTracker(Consumer<UpdateTrackerRequest.Builder> updateTrackerRequest)
Updates the specified properties of a given tracker resource.
This is a convenience which creates an instance of the UpdateTrackerRequest.Builder avoiding the need to
create one manually via UpdateTrackerRequest.builder()
updateTrackerRequest - A Consumer that will call methods on UpdateTrackerRequest.Builder to create a request.Copyright © 2022. All rights reserved.