Package com.commercetools.api.client

Class ByProjectKeySubscriptionsPost

java.lang.Object

io.vrap.rmf.base.client.ApiMethod<T,TResult>

io.vrap.rmf.base.client.BodyApiMethod<T,TResult,TBody>

io.vrap.rmf.base.client.TypeBodyApiMethod<ByProjectKeySubscriptionsPost,Subscription,SubscriptionDraft>

com.commercetools.api.client.ByProjectKeySubscriptionsPost

All Implemented Interfaces:

Deprecatable201Trait<ByProjectKeySubscriptionsPost>, ErrorableTrait<ByProjectKeySubscriptionsPost>, ClientRequestCommand<Subscription>, CreateHttpRequestCommand, HttpRequestCommand<Subscription>, RequestCommand<Subscription>

public class ByProjectKeySubscriptionsPost
extends TypeBodyApiMethod<ByProjectKeySubscriptionsPost,Subscription,SubscriptionDraft>
implements Deprecatable201Trait<ByProjectKeySubscriptionsPost>, ErrorableTrait<ByProjectKeySubscriptionsPost>

A test notification is sent to ensure the correct configuration of the Destination. If the notification cannot be delivered, the Subscription will not be created. The payload of the test notification is of type ResourceCreated for the resourceTypeId subscription.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.subscription.Subscription>> result = apiRoot
            .withProjectKey("{projectKey}")
            .subscriptions()
            .post(null)
            .execute()
 

Nested Class Summary

Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod

ApiMethod.ParamEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
ByProjectKeySubscriptionsPost(ByProjectKeySubscriptionsPost t)
ByProjectKeySubscriptionsPost(ApiHttpClient apiHttpClient, String projectKey, SubscriptionDraft subscriptionDraft)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<Subscription>>	execute(ApiHttpClient client)
ApiHttpResponse<Subscription>	executeBlocking(ApiHttpClient client, Duration timeout)
SubscriptionDraft	getBody()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<Subscription>	resultType()
void	setProjectKey(String projectKey)
String	toString()
ByProjectKeySubscriptionsPost	withBody(SubscriptionDraft subscriptionDraft)

Methods 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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

asDeprecatable201Trait, asDeprecatable201TraitToBaseType

Methods inherited from interface com.commercetools.api.client.ErrorableTrait

asErrorableTrait, asErrorableTraitToBaseType

Methods inherited from interface io.vrap.rmf.base.client.RequestCommand

executeBlocking

Constructor Details

ByProjectKeySubscriptionsPost

public ByProjectKeySubscriptionsPost(ApiHttpClient apiHttpClient,
 String projectKey,
 SubscriptionDraft subscriptionDraft)

ByProjectKeySubscriptionsPost

public ByProjectKeySubscriptionsPost(ByProjectKeySubscriptionsPost t)

Method Details

resultType

public com.fasterxml.jackson.core.type.TypeReference<Subscription> resultType()

Specified by:

resultType in interface HttpRequestCommand<Subscription>

executeBlocking

public ApiHttpResponse<Subscription> executeBlocking(ApiHttpClient client,
 Duration timeout)

Specified by:

executeBlocking in interface ClientRequestCommand<Subscription>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeySubscriptionsPost,Subscription>

execute

public CompletableFuture<ApiHttpResponse<Subscription>> execute(ApiHttpClient client)

Specified by:

execute in interface ClientRequestCommand<Subscription>

Specified by:

execute in class ApiMethod<ByProjectKeySubscriptionsPost,Subscription>

getProjectKey

public String getProjectKey()

setProjectKey

public void setProjectKey(String projectKey)

getBody

public SubscriptionDraft getBody()

Overrides:

getBody in class TypeBodyApiMethod<ByProjectKeySubscriptionsPost,Subscription,SubscriptionDraft>

withBody

public ByProjectKeySubscriptionsPost withBody(SubscriptionDraft subscriptionDraft)

Overrides:

withBody in class TypeBodyApiMethod<ByProjectKeySubscriptionsPost,Subscription,SubscriptionDraft>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()