Package ai.promoted.delivery.client

Class PromotedDeliveryClient

java.lang.Object

ai.promoted.delivery.client.PromotedDeliveryClient

public class PromotedDeliveryClient
extends Object

PromotedDeliveryClient is the main class for interacting with the Promoted.ai Delivery API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromotedDeliveryClient.Builder	Builds a PromotedDeliveryClient.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_DELIVERY_TIMEOUT_MILLIS	Default timeout for delivery calls.
static int	DEFAULT_MAX_REQUEST_INSERTIONS	Default number of maximum request insertion passed to Delivery API.
static int	DEFAULT_METRICS_THREAD_POOL_SIZE	Executor to run metrics logging in the background.
static long	DEFAULT_METRICS_TIMEOUT_MILLIS	Default timeout for metrics calls.

Method Summary

Modifier and Type	Method	Description
static PromotedDeliveryClient.Builder	builder()	Builder access for PromotedDeliveryClient
Response	callDeliveryAPI(DeliveryRequest deliveryRequest)	Runs a blocking call to Delivery API.
DeliveryResponse	deliver(DeliveryRequest deliveryRequest)	Used to call Delivery API.
DeliveryResponse	handleSdkAndLog(DeliveryRequest deliveryRequest, ai.promoted.delivery.client.DeliveryPlan plan, Response apiResponse)	Optionally handles SDK Delivery, logs and does shadow traffic.
boolean	isPerformChecks()
ai.promoted.delivery.client.DeliveryPlan	plan(boolean onlyLog, CohortMembership experiment)	Returns a DeliveryPlan that determines SDK execution for deliver(DeliveryRequest).
void	prepareRequest(DeliveryRequest deliveryRequest, ai.promoted.delivery.client.DeliveryPlan plan)	Prepares the deliveryRequest using the plan.
void	setPerformChecks(boolean performChecks)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELIVERY_TIMEOUT_MILLIS

public static final long DEFAULT_DELIVERY_TIMEOUT_MILLIS

Default timeout for delivery calls.

See Also:

Constant Field Values

DEFAULT_METRICS_TIMEOUT_MILLIS

public static final long DEFAULT_METRICS_TIMEOUT_MILLIS

Default timeout for metrics calls.

See Also:

Constant Field Values

DEFAULT_METRICS_THREAD_POOL_SIZE

public static final int DEFAULT_METRICS_THREAD_POOL_SIZE

Executor to run metrics logging in the background.

See Also:

Constant Field Values

DEFAULT_MAX_REQUEST_INSERTIONS

public static final int DEFAULT_MAX_REQUEST_INSERTIONS

Default number of maximum request insertion passed to Delivery API.

See Also:

Constant Field Values

Method Detail

deliver

public DeliveryResponse deliver(DeliveryRequest deliveryRequest)
                         throws DeliveryException

Used to call Delivery API. Ranks the given list of Content.

Parameters:

deliveryRequest - the delivery request

Throws:

DeliveryException - when any exception occurs

plan

public ai.promoted.delivery.client.DeliveryPlan plan(boolean onlyLog,
                                                     @Nullable
                                                     CohortMembership experiment)

Returns a DeliveryPlan that determines SDK execution for deliver(DeliveryRequest).

This method provides support for reusing/overriding parts of deliver(DeliveryRequest). Most users should use the deliver method instead.

Parameters:

onlyLog - if true, the SDK Response will use the SDK-side paged response

See Also:

deliver(ai.promoted.delivery.client.DeliveryRequest)

prepareRequest

public void prepareRequest(DeliveryRequest deliveryRequest,
                           ai.promoted.delivery.client.DeliveryPlan plan)

Prepares the deliveryRequest using the plan.

This method provides support for reusing/overriding parts of deliver(DeliveryRequest). Most users should use the deliver method instead.

See Also:

deliver(ai.promoted.delivery.client.DeliveryRequest)

callDeliveryAPI

public Response callDeliveryAPI(DeliveryRequest deliveryRequest)
                         throws DeliveryException

Runs a blocking call to Delivery API.

This method provides support for reusing/overriding parts of deliver(DeliveryRequest). Most users should use the deliver method instead.

Throws:

DeliveryException

See Also:

deliver(ai.promoted.delivery.client.DeliveryRequest)

handleSdkAndLog

public DeliveryResponse handleSdkAndLog(DeliveryRequest deliveryRequest,
                                        ai.promoted.delivery.client.DeliveryPlan plan,
                                        @Nullable
                                        Response apiResponse)
                                 throws DeliveryException

Optionally handles SDK Delivery, logs and does shadow traffic.

This method provides support for reusing/overriding parts of deliver(DeliveryRequest). Most users should use the deliver method instead.

Throws:

DeliveryException

See Also:

deliver(ai.promoted.delivery.client.DeliveryRequest)

isPerformChecks

public boolean isPerformChecks()

setPerformChecks

public void setPerformChecks(boolean performChecks)

builder

public static PromotedDeliveryClient.Builder builder()

Builder access for PromotedDeliveryClient

Returns:

the builder