public class PlacesRequestExecutor extends PaginatedRequestExecutor<Places>
PlacesApi
. Use this class if you want to obtain
places through fluent API in chained fashion, for instance:
KontaktCloud kontaktCloud = KontaktCloudFactory.create();
Places places = kontaktCloud.places().fetch()
.fromVenues(venueIds)
.maxResult(20)
.execute();
Constructor and Description |
---|
PlacesRequestExecutor(PlacesService placesService)
Constructs request executor initialized with corresponding service class.
|
Modifier and Type | Method and Description |
---|---|
PlacesRequestExecutor |
eTag(java.lang.String eTag)
Specifies HTTP entity tag purposed for caching REST API calls.
|
PlacesRequestExecutor |
filter(java.lang.String query)
Specifies the filter for requested data.
|
PlacesRequestExecutor |
fromVenues(java.util.List<java.util.UUID> venueIds)
Specifies venues for whose places belong to.
|
PlacesRequestExecutor |
fromVenues(java.util.UUID... venueIds)
Specifies venues for whose places belong to.
|
PlacesRequestExecutor |
maxResult(int maxResult)
Specifies the maximum size of response data collection.
|
PlacesRequestExecutor |
orderBy(OrderBy orderBy,
Order order)
Specifies the ordering of response data elements.
|
PlacesRequestExecutor |
startIndex(int startIndex)
Specifies the start index of requested data.
|
PlacesRequestExecutor |
withIds(java.util.List<java.util.UUID> ids)
Specifies places identifiers.
|
PlacesRequestExecutor |
withIds(java.util.UUID... ids)
Specifies places identifiers.
|
execute, execute
public PlacesRequestExecutor(PlacesService placesService)
placesService
- the places API service.public PlacesRequestExecutor withIds(java.util.UUID... ids)
ids
- places identifiers.public PlacesRequestExecutor withIds(java.util.List<java.util.UUID> ids)
ids
- places identifiers.public PlacesRequestExecutor fromVenues(java.util.UUID... venueIds)
venueIds
- venues identifiers.public PlacesRequestExecutor fromVenues(java.util.List<java.util.UUID> venueIds)
venueIds
- venues identifiers.public PlacesRequestExecutor startIndex(int startIndex)
startIndex
in class PaginatedRequestExecutor<Places>
startIndex
- the start index.public PlacesRequestExecutor maxResult(int maxResult)
maxResult
in class PaginatedRequestExecutor<Places>
maxResult
- the maximum response size value.public PlacesRequestExecutor filter(java.lang.String query)
filter
in class PaginatedRequestExecutor<Places>
query
- the query filter.public PlacesRequestExecutor orderBy(OrderBy orderBy, Order order)
orderBy
in class PaginatedRequestExecutor<Places>
orderBy
- the field type that specifies the order by column.order
- ascending or descending.public PlacesRequestExecutor eTag(java.lang.String eTag)
eTag
in class PaginatedRequestExecutor<Places>
eTag
- the entity tag value.