Package org.gbif.api.model.crawler

Class DatasetProcessStatus

java.lang.Object

org.gbif.api.model.crawler.DatasetProcessStatus

public class DatasetProcessStatus
extends Object

Information about a dataset that is currently being processed. That usually means that we are crawling it at the moment or are in the process of persisting and interpreting its occurrences.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatasetProcessStatus.Builder

Constructor Summary

Constructors

Constructor	Description
DatasetProcessStatus()
DatasetProcessStatus(DatasetProcessStatus.Builder builder)	Builds a new object from the builder validating it in the process.

Method Summary

Modifier and Type	Method	Description
static DatasetProcessStatus.Builder	builder()
boolean	equals(Object o)
String	getCrawlContext()	Last successful crawl context, this is a JSON string.
CrawlJob	getCrawlJob()
UUID	getDatasetKey()	Key that identifies the Dataset.
Long	getDeclaredCount()
Date	getFinishedCrawling()	Timestamp of when the crawl was finished.
FinishReason	getFinishReason()	The reason a crawl is finished.
@javax.validation.constraints.Min(0L) long	getFragmentsEmitted()
@javax.validation.constraints.Min(0L) long	getFragmentsProcessed()	Number of fragments that have been processed.
@javax.validation.constraints.Min(0L) long	getFragmentsReceived()
@javax.validation.constraints.Min(0L) long	getInterpretedOccurrencesPersistedError()
@javax.validation.constraints.Min(0L) long	getInterpretedOccurrencesPersistedSuccessful()
@javax.validation.constraints.Min(0L) long	getPagesCrawled()	Number of pages crawled in total.
@javax.validation.constraints.Min(0L) long	getPagesFragmentedError()
@javax.validation.constraints.Min(0L) long	getPagesFragmentedSuccessful()	Number of pages that have been fragmented.
ProcessState	getProcessStateChecklist()
ProcessState	getProcessStateOccurrence()
ProcessState	getProcessStateSample()
@javax.validation.constraints.Min(0L) long	getRawOccurrencesPersistedError()
@javax.validation.constraints.Min(0L) long	getRawOccurrencesPersistedNew()
@javax.validation.constraints.Min(0L) long	getRawOccurrencesPersistedUnchanged()
@javax.validation.constraints.Min(0L) long	getRawOccurrencesPersistedUpdated()
Date	getStartedCrawling()	Timestamp of when the crawl was actually started by a crawler.
@javax.validation.constraints.Min(0L) long	getVerbatimOccurrencesPersistedError()
@javax.validation.constraints.Min(0L) long	getVerbatimOccurrencesPersistedSuccessful()
int	hashCode()
void	setCrawlContext(String crawlContext)
void	setCrawlJob(CrawlJob crawlJob)
void	setDatasetKey(UUID datasetKey)
void	setDeclaredCount(Long declaredCount)
void	setFinishedCrawling(Date finishedCrawling)
void	setFinishReason(FinishReason finishReason)
void	setFragmentsEmitted(long fragmentsEmitted)
void	setFragmentsProcessed(long fragmentsProcessed)
void	setFragmentsReceived(long fragmentsReceived)
void	setInterpretedOccurrencesPersistedError(long interpretedOccurrencesPersistedError)
void	setInterpretedOccurrencesPersistedSuccessful(long interpretedOccurrencesPersistedSuccessful)
void	setPagesCrawled(long pagesCrawled)
void	setPagesFragmentedError(long pagesFragmentedError)
void	setPagesFragmentedSuccessful(long pagesFragmentedSuccessful)
void	setProcessStateChecklist(ProcessState processStateChecklist)
void	setProcessStateOccurrence(ProcessState processStateOccurrence)
void	setProcessStateSample(ProcessState processStateSample)
void	setRawOccurrencesPersistedError(long rawOccurrencesPersistedError)
void	setRawOccurrencesPersistedNew(long rawOccurrencesPersistedNew)
void	setRawOccurrencesPersistedUnchanged(long rawOccurrencesPersistedUnchanged)
void	setRawOccurrencesPersistedUpdated(long rawOccurrencesPersistedUpdated)
void	setStartedCrawling(Date startedCrawling)
void	setVerbatimOccurrencesPersistedError(long verbatimOccurrencesPersistedError)
void	setVerbatimOccurrencesPersistedSuccessful(long verbatimOccurrencesPersistedSuccessful)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DatasetProcessStatus

public DatasetProcessStatus()

DatasetProcessStatus

public DatasetProcessStatus(DatasetProcessStatus.Builder builder)

Builds a new object from the builder validating it in the process.

We only validate very little (all counts have to be greater than or equal to zero, a few null checks etc.) but not

Method Detail

builder

public static DatasetProcessStatus.Builder builder()

getCrawlContext

@Nullable
public String getCrawlContext()

Last successful crawl context, this is a JSON string.

Returns:

the last successful crawl context, this is a JSON string

getCrawlJob

public CrawlJob getCrawlJob()

getDatasetKey

public UUID getDatasetKey()

Key that identifies the Dataset.

Returns:

the UUID key that identifies the dataset

getDeclaredCount

@Nullable
public Long getDeclaredCount()

getFinishedCrawling

@Nullable
public Date getFinishedCrawling()

Timestamp of when the crawl was finished.

Returns:

the timestamp when the crawl finished

getFinishReason

@Nullable
public FinishReason getFinishReason()

The reason a crawl is finished. Will be null if getFinishedCrawling() returns null.

Returns:

the reason the crawl finished

getProcessStateOccurrence

@Nullable
public ProcessState getProcessStateOccurrence()

getProcessStateChecklist

@Nullable
public ProcessState getProcessStateChecklist()

getProcessStateSample

@Nullable
public ProcessState getProcessStateSample()

getFragmentsEmitted

@Min(0L)
public @javax.validation.constraints.Min(0L) long getFragmentsEmitted()

getFragmentsProcessed

@Min(0L)
public @javax.validation.constraints.Min(0L) long getFragmentsProcessed()

Number of fragments that have been processed.

Returns:

the number of fragments that have been processed

getFragmentsReceived

@Min(0L)
public @javax.validation.constraints.Min(0L) long getFragmentsReceived()

getInterpretedOccurrencesPersistedError

@Min(0L)
public @javax.validation.constraints.Min(0L) long getInterpretedOccurrencesPersistedError()

getInterpretedOccurrencesPersistedSuccessful

@Min(0L)
public @javax.validation.constraints.Min(0L) long getInterpretedOccurrencesPersistedSuccessful()

getPagesCrawled

@Min(0L)
public @javax.validation.constraints.Min(0L) long getPagesCrawled()

Number of pages crawled in total.

Returns:

number of pages crawled

getPagesFragmentedError

@Min(0L)
public @javax.validation.constraints.Min(0L) long getPagesFragmentedError()

getPagesFragmentedSuccessful

@Min(0L)
public @javax.validation.constraints.Min(0L) long getPagesFragmentedSuccessful()

Number of pages that have been fragmented.

Returns:

the number of pages that have been fragmented

getRawOccurrencesPersistedError

@Min(0L)
public @javax.validation.constraints.Min(0L) long getRawOccurrencesPersistedError()

getRawOccurrencesPersistedNew

@Min(0L)
public @javax.validation.constraints.Min(0L) long getRawOccurrencesPersistedNew()

getRawOccurrencesPersistedUnchanged

@Min(0L)
public @javax.validation.constraints.Min(0L) long getRawOccurrencesPersistedUnchanged()

getRawOccurrencesPersistedUpdated

@Min(0L)
public @javax.validation.constraints.Min(0L) long getRawOccurrencesPersistedUpdated()

getStartedCrawling

@Nullable
public Date getStartedCrawling()

Timestamp of when the crawl was actually started by a crawler.

Returns:

the timestamp when the crawl started

getVerbatimOccurrencesPersistedError

@Min(0L)
public @javax.validation.constraints.Min(0L) long getVerbatimOccurrencesPersistedError()

getVerbatimOccurrencesPersistedSuccessful

@Min(0L)
public @javax.validation.constraints.Min(0L) long getVerbatimOccurrencesPersistedSuccessful()

setDatasetKey

public void setDatasetKey(UUID datasetKey)

setCrawlJob

public void setCrawlJob(CrawlJob crawlJob)

setStartedCrawling

public void setStartedCrawling(Date startedCrawling)

setFinishedCrawling

public void setFinishedCrawling(Date finishedCrawling)

setCrawlContext

public void setCrawlContext(String crawlContext)

setFinishReason

public void setFinishReason(FinishReason finishReason)

setProcessStateOccurrence

public void setProcessStateOccurrence(ProcessState processStateOccurrence)

setProcessStateChecklist

public void setProcessStateChecklist(ProcessState processStateChecklist)

setProcessStateSample

public void setProcessStateSample(ProcessState processStateSample)

setDeclaredCount

public void setDeclaredCount(Long declaredCount)

setPagesCrawled

public void setPagesCrawled(long pagesCrawled)

setPagesFragmentedSuccessful

public void setPagesFragmentedSuccessful(long pagesFragmentedSuccessful)

setPagesFragmentedError

public void setPagesFragmentedError(long pagesFragmentedError)

setFragmentsEmitted

public void setFragmentsEmitted(long fragmentsEmitted)

setFragmentsReceived

public void setFragmentsReceived(long fragmentsReceived)

setRawOccurrencesPersistedNew

public void setRawOccurrencesPersistedNew(long rawOccurrencesPersistedNew)

setRawOccurrencesPersistedUpdated

public void setRawOccurrencesPersistedUpdated(long rawOccurrencesPersistedUpdated)

setRawOccurrencesPersistedUnchanged

public void setRawOccurrencesPersistedUnchanged(long rawOccurrencesPersistedUnchanged)

setRawOccurrencesPersistedError

public void setRawOccurrencesPersistedError(long rawOccurrencesPersistedError)

setFragmentsProcessed

public void setFragmentsProcessed(long fragmentsProcessed)

setVerbatimOccurrencesPersistedSuccessful

public void setVerbatimOccurrencesPersistedSuccessful(long verbatimOccurrencesPersistedSuccessful)

setVerbatimOccurrencesPersistedError

public void setVerbatimOccurrencesPersistedError(long verbatimOccurrencesPersistedError)

setInterpretedOccurrencesPersistedSuccessful

public void setInterpretedOccurrencesPersistedSuccessful(long interpretedOccurrencesPersistedSuccessful)

setInterpretedOccurrencesPersistedError

public void setInterpretedOccurrencesPersistedError(long interpretedOccurrencesPersistedError)

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