Package net.webpdf.wsclient.openapi

Class ApplicationConfigToolboxWebservice

java.lang.Object

net.webpdf.wsclient.openapi.ApplicationConfigToolboxWebservice

public class ApplicationConfigToolboxWebservice
extends Object

Defines a set of options specific for the \"Toolbox\" web service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplicationConfigToolboxWebservice.QueueModeEnum	Defines how the size of the queue is determined.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ENABLED
static String	JSON_PROPERTY_INSTANCES
static String	JSON_PROPERTY_MAX_LATENCY
static String	JSON_PROPERTY_QUEUE_MODE
static String	JSON_PROPERTY_QUEUE_SIZE

Constructor Summary

Constructors

Constructor	Description
ApplicationConfigToolboxWebservice()

Method Summary

Modifier and Type	Method	Description
ApplicationConfigToolboxWebservice	enabled(Boolean enabled)
boolean	equals(Object o)
@Nullable Boolean	getEnabled()	If enabled, then the web service is activated.
@Nullable Integer	getInstances()	Number of parallel instances (threads) for the web service.
@Nullable Integer	getMaxLatency()	Maximum allowed time in seconds for the execution of a web service request (job) before the request is canceled.
@Nullable ApplicationConfigToolboxWebservice.QueueModeEnum	getQueueMode()	Defines how the size of the queue is determined.
@Nullable Integer	getQueueSize()	Maximum number of waiting requests, before new requests are rejected.
int	hashCode()
ApplicationConfigToolboxWebservice	instances(Integer instances)
ApplicationConfigToolboxWebservice	maxLatency(Integer maxLatency)
ApplicationConfigToolboxWebservice	queueMode(ApplicationConfigToolboxWebservice.QueueModeEnum queueMode)
ApplicationConfigToolboxWebservice	queueSize(Integer queueSize)
void	setEnabled(Boolean enabled)
void	setInstances(Integer instances)
void	setMaxLatency(Integer maxLatency)
void	setQueueMode(ApplicationConfigToolboxWebservice.QueueModeEnum queueMode)
void	setQueueSize(Integer queueSize)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_ENABLED

public static final String JSON_PROPERTY_ENABLED

See Also:

Constant Field Values

JSON_PROPERTY_INSTANCES

public static final String JSON_PROPERTY_INSTANCES

See Also:

Constant Field Values

JSON_PROPERTY_MAX_LATENCY

public static final String JSON_PROPERTY_MAX_LATENCY

See Also:

Constant Field Values

JSON_PROPERTY_QUEUE_MODE

public static final String JSON_PROPERTY_QUEUE_MODE

See Also:

Constant Field Values

JSON_PROPERTY_QUEUE_SIZE

public static final String JSON_PROPERTY_QUEUE_SIZE

See Also:

Constant Field Values

Constructor Detail

ApplicationConfigToolboxWebservice

public ApplicationConfigToolboxWebservice()

Method Detail

enabled

public ApplicationConfigToolboxWebservice enabled(Boolean enabled)

getEnabled

@Nullable
public @Nullable Boolean getEnabled()

If enabled, then the web service is activated.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

instances

public ApplicationConfigToolboxWebservice instances(Integer instances)

getInstances

@Nullable
public @Nullable Integer getInstances()

Number of parallel instances (threads) for the web service. Defines the number of requests that can be executed in parallel before requests are queued. minimum: 1

Returns:

instances

setInstances

public void setInstances(Integer instances)

maxLatency

public ApplicationConfigToolboxWebservice maxLatency(Integer maxLatency)

getMaxLatency

@Nullable
public @Nullable Integer getMaxLatency()

Maximum allowed time in seconds for the execution of a web service request (job) before the request is canceled. If the time has expired, the execution is aborted and an error code is returned. minimum: 0

Returns:

maxLatency

setMaxLatency

public void setMaxLatency(Integer maxLatency)

queueMode

public ApplicationConfigToolboxWebservice queueMode(ApplicationConfigToolboxWebservice.QueueModeEnum queueMode)

getQueueMode

@Nullable
public @Nullable ApplicationConfigToolboxWebservice.QueueModeEnum getQueueMode()

Defines how the size of the queue is determined. With `AUTO`, it is calculated automatically by the server based on the number of configured instances.

Returns:

queueMode

setQueueMode

public void setQueueMode(ApplicationConfigToolboxWebservice.QueueModeEnum queueMode)

queueSize

public ApplicationConfigToolboxWebservice queueSize(Integer queueSize)

getQueueSize

@Nullable
public @Nullable Integer getQueueSize()

Maximum number of waiting requests, before new requests are rejected. If there are more requests than free instances, they are placed in the queue. If this maximum value is reached, further requests are rejected directly. This setting only applies if `queueMode` is set to `MANUAL`.

Returns:

queueSize

setQueueSize

public void setQueueSize(Integer queueSize)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object