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

Class SecureConfigsRequestExecutor

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.SecureConfigsRequestExecutor

public class SecureConfigsRequestExecutor
extends PaginatedRequestExecutor<Configs>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Configs configs = kontaktCloud.configs().secure()
      .withIds("7HuT", "2Fge", "dFGh")
      .maxResult(10)
      .execute();
   
 

Field Summary

Fields inherited from class com.kontakt.sdk.android.cloud.api.executor.PaginatedRequestExecutor

eTag, maxResult, order, orderBy, query, startIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SecureConfigsRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
SecureConfigsRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
SecureConfigsRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
SecureConfigsRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's query parameters in map.
protected retrofit2.Call<Configs>	prepareCall() Prepares a request to execute.
SecureConfigsRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
SecureConfigsRequestExecutor	withIds(java.util.List<java.lang.String> uniqueIds) Specifies config unique IDs.
SecureConfigsRequestExecutor	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

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

Constructor Detail

SecureConfigsRequestExecutor

public SecureConfigsRequestExecutor(ConfigsService configsService)

Constructs request executor initialized with corresponding service class.

Parameters:

configsService - the configs API service.

Method Detail

withIds

public SecureConfigsRequestExecutor 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 SecureConfigsRequestExecutor 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 SecureConfigsRequestExecutor 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 SecureConfigsRequestExecutor 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 SecureConfigsRequestExecutor 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 SecureConfigsRequestExecutor 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 SecureConfigsRequestExecutor 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.

prepareCall

protected retrofit2.Call<Configs> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Configs>

Returns:

the request.

params

protected java.util.Map<java.lang.String,java.lang.String> params()

Composes the request's query parameters in map.

Overrides:

params in class PaginatedRequestExecutor<Configs>

Returns:

the map of request parameters that are being used to get desired data from API.