public class ReceiversRequestExecutor extends PaginatedRequestExecutor<Receivers>
ReceiversApi
. Use this class if you want to obtain
receivers through fluent API in chained fashion, for instance:
KontaktCloud kontaktCloud = KontaktCloudFactory.create();
Receivers receivers = kontaktCloud.receivers().fetch()
.fromPlaces(placeIDs)
.maxResult(10)
.execute();
Constructor and Description |
---|
ReceiversRequestExecutor(ReceiversService receiversService)
Constructs request executor initialized with corresponding service class.
|
Modifier and Type | Method and Description |
---|---|
ReceiversRequestExecutor |
eTag(java.lang.String eTag)
Specifies HTTP entity tag purposed for caching REST API calls.
|
Receivers |
execute()
Executes created request synchronously.
|
void |
execute(CloudCallback<Receivers> callback)
Executes created request asynchronously and invokes callback with the result.
|
ReceiversRequestExecutor |
filter(java.lang.String query)
Specifies the filter for requested data.
|
ReceiversRequestExecutor |
fromPlaces(java.util.List<java.util.UUID> placeIds)
Specifies places for whose receivers belong to.
|
ReceiversRequestExecutor |
fromPlaces(java.util.UUID... placeIds)
Specifies places for whose receivers belong to.
|
ReceiversRequestExecutor |
maxResult(int maxResult)
Specifies the maximum size of response data collection.
|
ReceiversRequestExecutor |
orderBy(OrderBy orderBy,
Order order)
Specifies the ordering of response data elements.
|
ReceiversRequestExecutor |
startIndex(int startIndex)
Specifies the start index of requested data.
|
ReceiversRequestExecutor |
withIds(java.util.List<java.util.UUID> ids)
Specifies receivers identifiers.
|
ReceiversRequestExecutor |
withIds(java.util.UUID... ids)
Specifies receivers identifiers.
|
public ReceiversRequestExecutor(ReceiversService receiversService)
receiversService
- the receivers API service.public ReceiversRequestExecutor withIds(java.util.UUID... ids)
ids
- receivers identifiers.public ReceiversRequestExecutor withIds(java.util.List<java.util.UUID> ids)
ids
- receivers identifiers.public ReceiversRequestExecutor fromPlaces(java.util.UUID... placeIds)
placeIds
- places identifiers.public ReceiversRequestExecutor fromPlaces(java.util.List<java.util.UUID> placeIds)
placeIds
- places identifiers.public ReceiversRequestExecutor startIndex(int startIndex)
startIndex
in class PaginatedRequestExecutor<Receivers>
startIndex
- the start index.public ReceiversRequestExecutor maxResult(int maxResult)
maxResult
in class PaginatedRequestExecutor<Receivers>
maxResult
- the maximum response size value.public ReceiversRequestExecutor filter(java.lang.String query)
filter
in class PaginatedRequestExecutor<Receivers>
query
- the query filter.public ReceiversRequestExecutor orderBy(OrderBy orderBy, Order order)
orderBy
in class PaginatedRequestExecutor<Receivers>
orderBy
- the field type that specifies the order by column.order
- ascending or descending.public ReceiversRequestExecutor eTag(java.lang.String eTag)
eTag
in class PaginatedRequestExecutor<Receivers>
eTag
- the entity tag value.public Receivers execute() throws java.io.IOException, KontaktCloudException
execute
in class RequestExecutor<Receivers>
java.io.IOException
- exceptionKontaktCloudException
- exceptionpublic void execute(CloudCallback<Receivers> callback)
execute
in class RequestExecutor<Receivers>
callback
- the callback object.