Package com.commercetools.api.client
Class ByProjectKeyMeGet
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyMeGet,Customer>
com.commercetools.api.client.ByProjectKeyMeGet
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyMeGet>
,ErrorableTrait<ByProjectKeyMeGet>
,ExpandableTrait<ByProjectKeyMeGet>
,PagingTrait<ByProjectKeyMeGet>
,QueryTrait<ByProjectKeyMeGet>
,SortableTrait<ByProjectKeyMeGet>
,ClientRequestCommand<Customer>
,CreateHttpRequestCommand
,HttpRequestCommand<Customer>
,RequestCommand<Customer>
public class ByProjectKeyMeGet
extends TypeApiMethod<ByProjectKeyMeGet,Customer>
implements SortableTrait<ByProjectKeyMeGet>, PagingTrait<ByProjectKeyMeGet>, ExpandableTrait<ByProjectKeyMeGet>, QueryTrait<ByProjectKeyMeGet>, ErrorableTrait<ByProjectKeyMeGet>, Deprecatable200Trait<ByProjectKeyMeGet>
Returns a Customer for a given Query Predicate. Returns a 200 OK
status if successful.
A ResourceNotFound error is returned in the following scenarios:
- If no Customer exists for the given Query Predicate.
- If a Customer exists for the given Query Predicate, but does not have an
id
value that matches the customer:{id} scope.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.customer.Customer>> result = apiRoot
.withProjectKey("{projectKey}")
.me()
.get()
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeyMeGet
addExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameter<TValue> ByProjectKeyMeGet
addExpand
(TValue expand) add additional expand query parameter<TValue> ByProjectKeyMeGet
addLimit
(Collection<TValue> limit) add additional limit query parametersadd additional limit query parameteradd additional limit query parameter<TValue> ByProjectKeyMeGet
addLimit
(TValue limit) add additional limit query parameter<TValue> ByProjectKeyMeGet
addOffset
(Collection<TValue> offset) add additional offset query parametersadd additional offset query parameteradd additional offset query parameter<TValue> ByProjectKeyMeGet
addOffset
(TValue offset) add additional offset query parameter<TValue> ByProjectKeyMeGet
addPredicateVar
(String varName, Collection<TValue> predicateVar) add additional predicateVar query parameters<TValue> ByProjectKeyMeGet
addPredicateVar
(String varName, TValue predicateVar) add additional predicateVar query parameter<TValue> ByProjectKeyMeGet
addSort
(Collection<TValue> sort) add additional sort query parametersadd additional sort query parameteradd additional sort query parameter<TValue> ByProjectKeyMeGet
addSort
(TValue sort) add additional sort query parameter<TValue> ByProjectKeyMeGet
addWhere
(Collection<TValue> where) add additional where query parametersadd additional where query parameteradd additional where query parameter<TValue> ByProjectKeyMeGet
addWhere
(TValue where) add additional where query parameter<TValue> ByProjectKeyMeGet
addWithTotal
(Collection<TValue> withTotal) add additional withTotal query parametersadd additional withTotal query parameteraddWithTotal
(Supplier<Boolean> supplier) add additional withTotal query parameter<TValue> ByProjectKeyMeGet
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<Customer>
void
setProjectKey
(String projectKey) toString()
<TValue> ByProjectKeyMeGet
withExpand
(Collection<TValue> expand) set expand with the specified valuesset expand with the specified valuewithExpand
(Supplier<String> supplier) set expand with the specified value<TValue> ByProjectKeyMeGet
withExpand
(TValue expand) set expand with the specified value<TValue> ByProjectKeyMeGet
withLimit
(Collection<TValue> limit) set limit with the specified valuesset limit with the specified valueset limit with the specified value<TValue> ByProjectKeyMeGet
withLimit
(TValue limit) set limit with the specified value<TValue> ByProjectKeyMeGet
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> ByProjectKeyMeGet
withOffset
(TValue offset) set offset with the specified value<TValue> ByProjectKeyMeGet
withPredicateVar
(String varName, Collection<TValue> predicateVar) set predicateVar with the specificied values<TValue> ByProjectKeyMeGet
withPredicateVar
(String varName, TValue predicateVar) set predicateVar with the specificied value<TValue> ByProjectKeyMeGet
withSort
(Collection<TValue> sort) set sort with the specified valuesset sort with the specified valueset sort with the specified value<TValue> ByProjectKeyMeGet
withSort
(TValue sort) set sort with the specified value<TValue> ByProjectKeyMeGet
withWhere
(Collection<TValue> where) set where with the specified valuesset where with the specified valueset where with the specified value<TValue> ByProjectKeyMeGet
withWhere
(TValue where) set where with the specified value<TValue> ByProjectKeyMeGet
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> ByProjectKeyMeGet
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 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.ExpandableTrait
asExpandableTrait, asExpandableTraitToBaseType
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
executeBlocking
Methods inherited from interface com.commercetools.api.client.SortableTrait
asSortableTrait, asSortableTraitToBaseType
-
Constructor Details
-
ByProjectKeyMeGet
-
ByProjectKeyMeGet
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<Customer>
-
executeBlocking
- Specified by:
executeBlocking
in interfaceClientRequestCommand<Customer>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyMeGet,
Customer>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<Customer>
- Specified by:
execute
in classApiMethod<ByProjectKeyMeGet,
Customer>
-
getProjectKey
-
getSort
- Specified by:
getSort
in interfaceSortableTrait<ByProjectKeyMeGet>
-
getLimit
- Specified by:
getLimit
in interfacePagingTrait<ByProjectKeyMeGet>
-
getOffset
- Specified by:
getOffset
in interfacePagingTrait<ByProjectKeyMeGet>
-
getWithTotal
- Specified by:
getWithTotal
in interfacePagingTrait<ByProjectKeyMeGet>
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyMeGet>
-
getWhere
- Specified by:
getWhere
in interfaceQueryTrait<ByProjectKeyMeGet>
-
setProjectKey
-
withSort
set sort with the specified value- Specified by:
withSort
in interfaceSortableTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
sort
- value to be set- Returns:
- ByProjectKeyMeGet
-
addSort
add additional sort query parameter- Specified by:
addSort
in interfaceSortableTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
sort
- value to be added- Returns:
- ByProjectKeyMeGet
-
withSort
set sort with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeGet
-
addSort
add additional sort query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeGet
-
withSort
set sort with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeGet
-
addSort
add additional sort query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeGet
-
withSort
set sort with the specified values- Type Parameters:
TValue
- value type- Parameters:
sort
- values to be set- Returns:
- ByProjectKeyMeGet
-
addSort
add additional sort query parameters- Type Parameters:
TValue
- value type- Parameters:
sort
- values to be added- Returns:
- ByProjectKeyMeGet
-
withLimit
set limit with the specified value- Specified by:
withLimit
in interfacePagingTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
limit
- value to be set- Returns:
- ByProjectKeyMeGet
-
addLimit
add additional limit query parameter- Specified by:
addLimit
in interfacePagingTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
limit
- value to be added- Returns:
- ByProjectKeyMeGet
-
withLimit
set limit with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeGet
-
addLimit
add additional limit query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeGet
-
withLimit
set limit with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeGet
-
addLimit
add additional limit query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeGet
-
withLimit
set limit with the specified values- Type Parameters:
TValue
- value type- Parameters:
limit
- values to be set- Returns:
- ByProjectKeyMeGet
-
addLimit
add additional limit query parameters- Type Parameters:
TValue
- value type- Parameters:
limit
- values to be added- Returns:
- ByProjectKeyMeGet
-
withOffset
set offset with the specified value- Specified by:
withOffset
in interfacePagingTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
offset
- value to be set- Returns:
- ByProjectKeyMeGet
-
addOffset
add additional offset query parameter- Specified by:
addOffset
in interfacePagingTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
offset
- value to be added- Returns:
- ByProjectKeyMeGet
-
withOffset
set offset with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeGet
-
addOffset
add additional offset query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeGet
-
withOffset
set offset with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeGet
-
addOffset
add additional offset query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeGet
-
withOffset
set offset with the specified values- Type Parameters:
TValue
- value type- Parameters:
offset
- values to be set- Returns:
- ByProjectKeyMeGet
-
addOffset
add additional offset query parameters- Type Parameters:
TValue
- value type- Parameters:
offset
- values to be added- Returns:
- ByProjectKeyMeGet
-
withWithTotal
set withTotal with the specified value- Specified by:
withWithTotal
in interfacePagingTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
withTotal
- value to be set- Returns:
- ByProjectKeyMeGet
-
addWithTotal
add additional withTotal query parameter- Specified by:
addWithTotal
in interfacePagingTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
withTotal
- value to be added- Returns:
- ByProjectKeyMeGet
-
withWithTotal
set withTotal with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeGet
-
addWithTotal
add additional withTotal query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeGet
-
withWithTotal
set withTotal with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeGet
-
addWithTotal
add additional withTotal query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeGet
-
withWithTotal
set withTotal with the specified values- Type Parameters:
TValue
- value type- Parameters:
withTotal
- values to be set- Returns:
- ByProjectKeyMeGet
-
addWithTotal
add additional withTotal query parameters- Type Parameters:
TValue
- value type- Parameters:
withTotal
- values to be added- Returns:
- ByProjectKeyMeGet
-
withExpand
set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyMeGet
-
addExpand
add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyMeGet
-
withExpand
set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeGet
-
addExpand
add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeGet
-
withExpand
set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeGet
-
addExpand
add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeGet
-
withExpand
set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyMeGet
-
addExpand
add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyMeGet
-
withWhere
set where with the specified value- Specified by:
withWhere
in interfaceQueryTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
where
- value to be set- Returns:
- ByProjectKeyMeGet
-
addWhere
add additional where query parameter- Specified by:
addWhere
in interfaceQueryTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
where
- value to be added- Returns:
- ByProjectKeyMeGet
-
withWhere
set where with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyMeGet
-
addWhere
add additional where query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyMeGet
-
withWhere
set where with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyMeGet
-
addWhere
add additional where query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyMeGet
-
withWhere
set where with the specified values- Type Parameters:
TValue
- value type- Parameters:
where
- values to be set- Returns:
- ByProjectKeyMeGet
-
addWhere
add additional where query parameters- Type Parameters:
TValue
- value type- Parameters:
where
- values to be added- Returns:
- ByProjectKeyMeGet
-
withPredicateVar
set predicateVar with the specificied value- Specified by:
withPredicateVar
in interfaceQueryTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter value- Returns:
- ByProjectKeyMeGet
-
addPredicateVar
add additional predicateVar query parameter- Specified by:
addPredicateVar
in interfaceQueryTrait<ByProjectKeyMeGet>
- Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter value- Returns:
- ByProjectKeyMeGet
-
withPredicateVar
set predicateVar with the specificied values- Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter values- Returns:
- ByProjectKeyMeGet
-
addPredicateVar
add additional predicateVar query parameters- Type Parameters:
TValue
- value type- Parameters:
varName
- parameter namepredicateVar
- parameter values- Returns:
- ByProjectKeyMeGet
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-