com.kontakt.sdk.android.cloud.api.executor.configs

Class ReadAllRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<T>

com.kontakt.sdk.android.cloud.api.executor.PaginatedRequestExecutor<Configs>

com.kontakt.sdk.android.cloud.api.executor.configs.ReadAllRequestExecutor

public class ReadAllRequestExecutor
extends PaginatedRequestExecutor<Configs>

Request executor provided by ConfigsApi. Use this class if you want to obtain READ_ALL encrypted commands through fluent API in chained fashion. Here is an example of how to use this executor:

   
   KontaktCloud kontaktCloud = KontaktCloudFactory.create();
   Configs configs = kontaktCloud.configs().readAll()
      .withIds("7HuT", "2Fge", "dFGh")
      .maxResult(10)
      .execute();
   
 

Constructor Summary

Constructors

Constructor and Description
ReadAllRequestExecutor(ConfigsService configsService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ReadAllRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
ReadAllRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
ReadAllRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
ReadAllRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
ReadAllRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
ReadAllRequestExecutor	withIds(java.util.List<java.lang.String> uniqueIds) Specifies config unique IDs.
ReadAllRequestExecutor	withIds(java.lang.String... uniqueIds) Specifies config unique IDs.

Methods inherited from class com.kontakt.sdk.android.cloud.api.executor.RequestExecutor

execute, execute

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadAllRequestExecutor

public ReadAllRequestExecutor(ConfigsService configsService)

Constructs request executor initialized with corresponding service class.

Parameters:

configsService - the configs API service.

Method Detail

withIds

public ReadAllRequestExecutor withIds(java.lang.String... uniqueIds)

Specifies config unique IDs. Use that method if you want to fetch particular configs by ID.

Parameters:

uniqueIds - config unique identifiers.

Returns:

this request executor.

withIds

public ReadAllRequestExecutor withIds(java.util.List<java.lang.String> uniqueIds)

Specifies config unique IDs. Use that method if you want to fetch particular configs by ID.

Parameters:

uniqueIds - config unique identifiers.

Returns:

this request executor.

startIndex

public ReadAllRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Configs>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ReadAllRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Configs>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ReadAllRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Configs>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ReadAllRequestExecutor orderBy(OrderBy orderBy,
                                      Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Configs>

Parameters:

orderBy - the field type that specifies the order by column.

order - ascending or descending.

Returns:

this request executor.

eTag

public ReadAllRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Configs>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.