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

Class NamespacesRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.namespaces.NamespacesRequestExecutor

public class NamespacesRequestExecutor
extends PaginatedRequestExecutor<Namespaces>

Request executor provided by NamespacesApi. Use this class if you want to fetch secure namespaces mapping through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.namespaces().fetch()
      .startIndex(4)
      .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
NamespacesRequestExecutor(NamespacesService namespacesService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
NamespacesRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
NamespacesRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
NamespacesRequestExecutor	mappedBy(java.lang.String namespace) Specifies namespace to mapping.
NamespacesRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
NamespacesRequestExecutor	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<Namespaces>	prepareCall() Prepares a request to execute.
NamespacesRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.

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

NamespacesRequestExecutor

public NamespacesRequestExecutor(NamespacesService namespacesService)

Constructs request executor initialized with corresponding service class.

Parameters:

namespacesService - the namespaces API service.

Method Detail

mappedBy

public NamespacesRequestExecutor mappedBy(java.lang.String namespace)

Specifies namespace to mapping.

Parameters:

namespace - the namespace.

Returns:

this request executor.

startIndex

public NamespacesRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Namespaces>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public NamespacesRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Namespaces>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public NamespacesRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Namespaces>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public NamespacesRequestExecutor orderBy(OrderBy orderBy,
                                         Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Namespaces>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public NamespacesRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Namespaces>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Namespaces> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Namespaces>

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<Namespaces>

Returns:

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