org.lockss.laaws.poller.model

Class PollDesc

java.lang.Object

org.lockss.laaws.poller.model.PollDesc

@Validated
public class PollDesc
extends Object

The Poller Services poll spec used to define a poll.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PollDesc.VariantEnum The V3 poll variation.

Constructor Summary

Constructors

Constructor and Description
PollDesc()

Method Summary

Modifier and Type	Method and Description
PollDesc	auId(String auId)
PollDesc	cuSetSpec(CachedUriSetSpec cuSetSpec)
boolean	equals(Object o)
String	getAuId() The id which defines the poll
CachedUriSetSpec	getCuSetSpec() Get cuSetSpec
Integer	getModulus() Poll on every 'n'th url.
String	getPluginPollVersion() The version of the polling features needed by the plugin.
Integer	getPollType() The type of poll to run.
Integer	getProtocol() The version of polling protocol.
PollDesc.VariantEnum	getVariant() The V3 poll variation.
int	hashCode()
PollDesc	modulus(Integer modulus)
PollDesc	pluginPollVersion(String pluginPollVersion)
PollDesc	pollType(Integer pollType)
PollDesc	protocol(Integer protocol)
void	setAuId(String auId)
void	setCuSetSpec(CachedUriSetSpec cuSetSpec)
void	setModulus(Integer modulus)
void	setPluginPollVersion(String pluginPollVersion)
void	setPollType(Integer pollType)
void	setProtocol(Integer protocol)
void	setVariant(PollDesc.VariantEnum variant)
String	toString()
PollDesc	variant(PollDesc.VariantEnum variant)

Methods inherited from class java.lang.Object

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

Constructor Detail

PollDesc

public PollDesc()

Method Detail

auId

public PollDesc auId(String auId)

getAuId

@NotNull
public String getAuId()

The id which defines the poll

Returns:

auId

setAuId

public void setAuId(String auId)

cuSetSpec

public PollDesc cuSetSpec(CachedUriSetSpec cuSetSpec)

getCuSetSpec

public CachedUriSetSpec getCuSetSpec()

Get cuSetSpec

Returns:

cuSetSpec

setCuSetSpec

public void setCuSetSpec(CachedUriSetSpec cuSetSpec)

pollType

public PollDesc pollType(Integer pollType)

getPollType

@Min(value=3L)
public Integer getPollType()

The type of poll to run. Only V3 is supported. minimum: 3

Returns:

pollType

setPollType

public void setPollType(Integer pollType)

protocol

public PollDesc protocol(Integer protocol)

getProtocol

public Integer getProtocol()

The version of polling protocol.

Returns:

protocol

setProtocol

public void setProtocol(Integer protocol)

pluginPollVersion

public PollDesc pluginPollVersion(String pluginPollVersion)

getPluginPollVersion

public String getPluginPollVersion()

The version of the polling features needed by the plugin.

Returns:

pluginPollVersion

setPluginPollVersion

public void setPluginPollVersion(String pluginPollVersion)

variant

public PollDesc variant(PollDesc.VariantEnum variant)

getVariant

public PollDesc.VariantEnum getVariant()

The V3 poll variation.

Returns:

variant

setVariant

public void setVariant(PollDesc.VariantEnum variant)

modulus

public PollDesc modulus(Integer modulus)

getModulus

public Integer getModulus()

Poll on every 'n'th url.

Returns:

modulus

setModulus

public void setModulus(Integer modulus)

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