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 final long	DEFAULT_DELIVERY_TIMEOUT_MILLIS	Default timeout for delivery calls.
static final int	DEFAULT_MAX_REQUEST_INSERTIONS	Default number of maximum request insertion passed to Delivery API.
static final int	DEFAULT_METRICS_THREAD_POOL_SIZE	Executor to run metrics logging in the background.
static final 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
DeliveryResponse	deliver(DeliveryRequest deliveryRequest)	Used to call Delivery API.
boolean	isPerformChecks()
void	setPerformChecks(boolean performChecks)

Methods inherited from class java.lang.Object

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

Field Details

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 Details

deliver

public DeliveryResponse deliver(DeliveryRequest deliveryRequest)
                         throws DeliveryException

Used to call Delivery API. Takes the given list of Content and ranks it.

Parameters:

deliveryRequest - the delivery request

Throws:

DeliveryException - when any exception occurs

isPerformChecks

public boolean isPerformChecks()

setPerformChecks

public void setPerformChecks(boolean performChecks)

builder

public static PromotedDeliveryClient.Builder builder()

Builder access for PromotedDeliveryClient

Returns:

the builder