Package com.commercetools.api.client
Class ByProjectKeySubscriptionsGet
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeySubscriptionsGet,SubscriptionPagedQueryResponse>
com.commercetools.api.client.ByProjectKeySubscriptionsGet
- All Implemented Interfaces:
ByProjectKeySubscriptionsGetMixin
,Deprecatable200Trait<ByProjectKeySubscriptionsGet>
,ErrorableTrait<ByProjectKeySubscriptionsGet>
,PagingTrait<ByProjectKeySubscriptionsGet>
,QueryTrait<ByProjectKeySubscriptionsGet>
,SimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
,SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> SortableTrait<ByProjectKeySubscriptionsGet>
,ClientRequestCommand<SubscriptionPagedQueryResponse>
,CreateHttpRequestCommand
,HttpRequestCommand<SubscriptionPagedQueryResponse>
,RequestCommand<SubscriptionPagedQueryResponse>
public class ByProjectKeySubscriptionsGet
extends TypeApiMethod<ByProjectKeySubscriptionsGet,SubscriptionPagedQueryResponse>
implements ByProjectKeySubscriptionsGetMixin, SortableTrait<ByProjectKeySubscriptionsGet>, PagingTrait<ByProjectKeySubscriptionsGet>, QueryTrait<ByProjectKeySubscriptionsGet>, ErrorableTrait<ByProjectKeySubscriptionsGet>, Deprecatable200Trait<ByProjectKeySubscriptionsGet>
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.subscription.SubscriptionPagedQueryResponse>> result = apiRoot
.withProjectKey("{projectKey}")
.subscriptions()
.get()
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeySubscriptionsGet
(ApiHttpClient apiHttpClient, String projectKey) -
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeySubscriptionsGet
addLimit
(Collection<TValue> limit) add additional limit query parametersadd additional limit query parameteradd additional limit query parameter<TValue> ByProjectKeySubscriptionsGet
addLimit
(TValue limit) add additional limit query parameter<TValue> ByProjectKeySubscriptionsGet
addOffset
(Collection<TValue> offset) add additional offset query parametersadd additional offset query parameteradd additional offset query parameter<TValue> ByProjectKeySubscriptionsGet
addOffset
(TValue offset) add additional offset query parameter<TValue> ByProjectKeySubscriptionsGet
addPredicateVar
(String varName, Collection<TValue> predicateVar) add additional predicateVar query parameters<TValue> ByProjectKeySubscriptionsGet
addPredicateVar
(String varName, TValue predicateVar) add additional predicateVar query parameter<TValue> ByProjectKeySubscriptionsGet
addSort
(Collection<TValue> sort) add additional sort query parametersadd additional sort query parameteradd additional sort query parameter<TValue> ByProjectKeySubscriptionsGet
addSort
(TValue sort) add additional sort query parameter<TValue> ByProjectKeySubscriptionsGet
addWhere
(Collection<TValue> where) add additional where query parametersadd additional where query parameteradd additional where query parameter<TValue> ByProjectKeySubscriptionsGet
addWhere
(TValue where) add additional where query parameter<TValue> ByProjectKeySubscriptionsGet
addWithTotal
(Collection<TValue> withTotal) add additional withTotal query parametersadd additional withTotal query parameteraddWithTotal
(Supplier<Boolean> supplier) add additional withTotal query parameter<TValue> ByProjectKeySubscriptionsGet
addWithTotal
(TValue withTotal) add additional withTotal query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getLimit()
getSort()
getWhere()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<SubscriptionPagedQueryResponse>
void
setProjectKey
(String projectKey) toString()
<TValue> ByProjectKeySubscriptionsGet
withLimit
(Collection<TValue> limit) set limit with the specified valuesset limit with the specified valueset limit with the specified value<TValue> ByProjectKeySubscriptionsGet
withLimit
(TValue limit) set limit with the specified value<TValue> ByProjectKeySubscriptionsGet
withOffset
(Collection<TValue> offset) set offset with the specified valuesset offset with the specified valuewithOffset
(Supplier<Integer> supplier) set offset with the specified value<TValue> ByProjectKeySubscriptionsGet
withOffset
(TValue offset) set offset with the specified value<TValue> ByProjectKeySubscriptionsGet
withPredicateVar
(String varName, Collection<TValue> predicateVar) set predicateVar with the specificied values<TValue> ByProjectKeySubscriptionsGet
withPredicateVar
(String varName, TValue predicateVar) set predicateVar with the specificied value<TValue> ByProjectKeySubscriptionsGet
withSort
(Collection<TValue> sort) set sort with the specified valuesset sort with the specified valueset sort with the specified value<TValue> ByProjectKeySubscriptionsGet
withSort
(TValue sort) set sort with the specified value<TValue> ByProjectKeySubscriptionsGet
withWhere
(Collection<TValue> where) set where with the specified valuesset where with the specified valueset where with the specified value<TValue> ByProjectKeySubscriptionsGet
withWhere
(TValue where) set where with the specified value<TValue> ByProjectKeySubscriptionsGet
withWithTotal
(Collection<TValue> withTotal) set withTotal with the specified valuesset withTotal with the specified valuewithWithTotal
(Supplier<Boolean> supplier) set withTotal with the specified value<TValue> ByProjectKeySubscriptionsGet
withWithTotal
(TValue withTotal) set withTotal with the specified valueMethods inherited from class io.vrap.rmf.base.client.ApiMethod
addHeader, addQueryParam, addQueryParams, contentType, createHttpRequest, execute, execute, execute, execute, execute, execute, execute, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriString, getQueryParamUriStrings, send, sendBlocking, sendBlocking, with, with, withHeader, withHeaders, withHttpRequest, withoutHeader, withoutQueryParam, withQueryParam, withQueryParams
Methods inherited from interface com.commercetools.api.client.ByProjectKeySubscriptionsGetMixin
queryDsl
Methods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand
executeBlocking
Methods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequest
Methods inherited from interface com.commercetools.api.client.Deprecatable200Trait
asDeprecatable200Trait, asDeprecatable200TraitToBaseType
Methods inherited from interface com.commercetools.api.client.ErrorableTrait
asErrorableTrait, asErrorableTraitToBaseType
Methods inherited from interface com.commercetools.api.client.PagingTrait
asPagingTrait, asPagingTraitToBaseType
Methods inherited from interface com.commercetools.api.client.QueryTrait
asQueryTrait, asQueryTraitToBaseType
Methods inherited from interface io.vrap.rmf.base.client.RequestCommand
execute, executeBlocking, executeBlocking
Methods inherited from interface com.commercetools.api.client.SimplePagedQueryResourceRequest
addQuery, addQuery, addQuery, addQuery, addWhere, addWhere, addWhere, asPagedQueryResourceRequest, asPagedQueryResourceRequestToBaseType, getFirstQueryParam, getQueryParam, getQueryParams, withQuery, withQuery, withQuery, withQuery, withWhere, withWhere, withWhere
Methods inherited from interface com.commercetools.api.client.SortableTrait
asSortableTrait, asSortableTraitToBaseType
-
Constructor Details
-
ByProjectKeySubscriptionsGet
-
ByProjectKeySubscriptionsGet
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<SubscriptionPagedQueryResponse>
-
executeBlocking
public ApiHttpResponse<SubscriptionPagedQueryResponse> executeBlocking(ApiHttpClient client, Duration timeout) - Specified by:
executeBlocking
in interfaceClientRequestCommand<SubscriptionPagedQueryResponse>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse>
-
execute
public CompletableFuture<ApiHttpResponse<SubscriptionPagedQueryResponse>> execute(ApiHttpClient client) - Specified by:
execute
in interfaceClientRequestCommand<SubscriptionPagedQueryResponse>
- Specified by:
execute
in classApiMethod<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse>
-
getProjectKey
-
getSort
- Specified by:
getSort
in interfaceSortableTrait<ByProjectKeySubscriptionsGet>
-
getLimit
- Specified by:
getLimit
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
-
getOffset
- Specified by:
getOffset
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
-
getWithTotal
- Specified by:
getWithTotal
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
-
getWhere
- Specified by:
getWhere
in interfaceQueryTrait<ByProjectKeySubscriptionsGet>
-
setProjectKey
-
withSort
set sort with the specified value- Specified by:
withSort
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Specified by:
withSort
in interfaceSortableTrait<ByProjectKeySubscriptionsGet>
- Type Parameters:
TValue
- value type- Parameters:
sort
- value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addSort
add additional sort query parameter- Specified by:
addSort
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Specified by:
addSort
in interfaceSortableTrait<ByProjectKeySubscriptionsGet>
- Type Parameters:
TValue
- value type- Parameters:
sort
- value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withSort
set sort with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addSort
add additional sort query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withSort
set sort with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addSort
add additional sort query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withSort
set sort with the specified values- Type Parameters:
TValue
- value type- Parameters:
sort
- values to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addSort
add additional sort query parameters- Type Parameters:
TValue
- value type- Parameters:
sort
- values to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withLimit
set limit with the specified value- Specified by:
withLimit
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
- Specified by:
withLimit
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
limit
- value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addLimit
add additional limit query parameter- Specified by:
addLimit
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
- Specified by:
addLimit
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
limit
- value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withLimit
set limit with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addLimit
add additional limit query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withLimit
set limit with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addLimit
add additional limit query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withLimit
set limit with the specified values- Type Parameters:
TValue
- value type- Parameters:
limit
- values to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addLimit
add additional limit query parameters- Type Parameters:
TValue
- value type- Parameters:
limit
- values to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withOffset
set offset with the specified value- Specified by:
withOffset
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
- Specified by:
withOffset
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
offset
- value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addOffset
add additional offset query parameter- Specified by:
addOffset
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
- Specified by:
addOffset
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
offset
- value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withOffset
set offset with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addOffset
add additional offset query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withOffset
set offset with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addOffset
add additional offset query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withOffset
set offset with the specified values- Type Parameters:
TValue
- value type- Parameters:
offset
- values to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addOffset
add additional offset query parameters- Type Parameters:
TValue
- value type- Parameters:
offset
- values to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWithTotal
set withTotal with the specified value- Specified by:
withWithTotal
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
- Specified by:
withWithTotal
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
withTotal
- value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWithTotal
add additional withTotal query parameter- Specified by:
addWithTotal
in interfacePagingTrait<ByProjectKeySubscriptionsGet>
- Specified by:
addWithTotal
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
withTotal
- value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWithTotal
set withTotal with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWithTotal
add additional withTotal query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWithTotal
set withTotal with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWithTotal
add additional withTotal query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWithTotal
set withTotal with the specified values- Type Parameters:
TValue
- value type- Parameters:
withTotal
- values to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWithTotal
add additional withTotal query parameters- Type Parameters:
TValue
- value type- Parameters:
withTotal
- values to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWhere
set where with the specified value- Specified by:
withWhere
in interfaceQueryTrait<ByProjectKeySubscriptionsGet>
- Specified by:
withWhere
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
where
- value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWhere
add additional where query parameter- Specified by:
addWhere
in interfaceQueryTrait<ByProjectKeySubscriptionsGet>
- Specified by:
addWhere
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
where
- value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWhere
set where with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWhere
add additional where query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWhere
set where with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWhere
add additional where query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withWhere
set where with the specified values- Type Parameters:
TValue
- value type- Parameters:
where
- values to be set- Returns:
- ByProjectKeySubscriptionsGet
-
addWhere
add additional where query parameters- Type Parameters:
TValue
- value type- Parameters:
where
- values to be added- Returns:
- ByProjectKeySubscriptionsGet
-
withPredicateVar
set predicateVar with the specificied value- Specified by:
withPredicateVar
in interfaceQueryTrait<ByProjectKeySubscriptionsGet>
- Specified by:
withPredicateVar
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter value- Returns:
- ByProjectKeySubscriptionsGet
-
addPredicateVar
add additional predicateVar query parameter- Specified by:
addPredicateVar
in interfaceQueryTrait<ByProjectKeySubscriptionsGet>
- Specified by:
addPredicateVar
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter value- Returns:
- ByProjectKeySubscriptionsGet
-
withPredicateVar
public <TValue> ByProjectKeySubscriptionsGet withPredicateVar(String varName, Collection<TValue> predicateVar) set predicateVar with the specificied values- Specified by:
withPredicateVar
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter values- Returns:
- ByProjectKeySubscriptionsGet
-
addPredicateVar
public <TValue> ByProjectKeySubscriptionsGet addPredicateVar(String varName, Collection<TValue> predicateVar) add additional predicateVar query parameters- Specified by:
addPredicateVar
in interfaceSimplePagedQueryResourceRequest<ByProjectKeySubscriptionsGet,
SubscriptionPagedQueryResponse, com.commercetools.api.predicates.query.subscription.SubscriptionQueryBuilderDsl> - Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter values- Returns:
- ByProjectKeySubscriptionsGet
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-