PipelineStep (GBIF Common :: API 1.16.18 API)

java.lang.Object
- org.gbif.api.model.pipelines.PipelineStep

All Implemented Interfaces:

Serializable, LenientEquals<PipelineStep>
```
public class PipelineStep
extends Object
implements LenientEquals<PipelineStep>, Serializable
```
Models a step in pipelines.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PipelineStep.MetricInfo` Inner class to store metrics.
`static class`	`PipelineStep.Status` Enum to represent the status of a step.

Field Summary

Fields
Modifier and Type	Field and Description
`static Comparator<PipelineStep>`	`STEPS_BY_FINISHED_ASC` Comparator that sorts pipeline steps by start date and then by finished date in ascending order.
`static Comparator<PipelineStep>`	`STEPS_BY_TYPE_ASC`

Constructor Summary

Constructors
Constructor and Description

PipelineStep()

Constructors
Constructor and Description
`PipelineStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipelineStep`	`addMetricInfo(PipelineStep.MetricInfo metricInfo)`
`boolean`	`equals(Object o)`
`String`	`getCreatedBy()`
`LocalDateTime`	`getFinished()`
`long`	`getKey()`
`String`	`getMessage()`
`Set<PipelineStep.MetricInfo>`	`getMetrics()`
`LocalDateTime`	`getModified()`
`String`	`getModifiedBy()`
`Long`	`getNumberRecords()`
`String`	`getPipelinesVersion()`
`StepRunner`	`getRunner()`
`LocalDateTime`	`getStarted()`
`PipelineStep.Status`	`getState()`
`StepType`	`getType()`
`int`	`hashCode()`
`boolean`	`lenientEquals(PipelineStep other)` Leniently tests if the objects are the same.
`PipelineStep`	`setCreatedBy(String createdBy)`
`PipelineStep`	`setFinished(LocalDateTime finished)`
`void`	`setKey(long key)`
`PipelineStep`	`setMessage(String message)`
`PipelineStep`	`setMetrics(Set<PipelineStep.MetricInfo> metrics)`
`PipelineStep`	`setModified(LocalDateTime modified)`
`PipelineStep`	`setModifiedBy(String modifiedBy)`
`PipelineStep`	`setNumberRecords(Long numberRecords)`
`PipelineStep`	`setPipelinesVersion(String pipelinesVersion)`
`PipelineStep`	`setRunner(StepRunner runner)`
`PipelineStep`	`setStarted(LocalDateTime started)`
`PipelineStep`	`setState(PipelineStep.Status state)`
`PipelineStep`	`setType(StepType type)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail
- STEPS_BY_TYPE_ASC
```
public static final Comparator<PipelineStep> STEPS_BY_TYPE_ASC
```
- STEPS_BY_FINISHED_ASC
```
public static final Comparator<PipelineStep> STEPS_BY_FINISHED_ASC
```
  Comparator that sorts pipeline steps by start date and then by finished date in ascending order.

Constructor Detail
- PipelineStep
```
public PipelineStep()
```

Method Detail

getKey
```
public long getKey()
```

getType
```
public StepType getType()
```

setType

public PipelineStep setType(StepType type)

getRunner
```
public StepRunner getRunner()
```

setRunner

public PipelineStep setRunner(StepRunner runner)

getStarted
```
public LocalDateTime getStarted()
```

setStarted

public PipelineStep setStarted(LocalDateTime started)

getFinished
```
public LocalDateTime getFinished()
```

setFinished

public PipelineStep setFinished(LocalDateTime finished)

getState
```
public PipelineStep.Status getState()
```

setState

public PipelineStep setState(PipelineStep.Status state)

getMessage
```
public String getMessage()
```

setMessage

public PipelineStep setMessage(String message)

setKey
```
public void setKey(long key)
```

getNumberRecords
```
public Long getNumberRecords()
```

setNumberRecords

public PipelineStep setNumberRecords(Long numberRecords)

getPipelinesVersion
```
public String getPipelinesVersion()
```

setPipelinesVersion

public PipelineStep setPipelinesVersion(String pipelinesVersion)

getCreatedBy
```
public String getCreatedBy()
```

setCreatedBy

public PipelineStep setCreatedBy(String createdBy)

getModified
```
public LocalDateTime getModified()
```

setModified

public PipelineStep setModified(LocalDateTime modified)

getModifiedBy
```
public String getModifiedBy()
```

setModifiedBy

public PipelineStep setModifiedBy(String modifiedBy)

getMetrics

public Set<PipelineStep.MetricInfo> getMetrics()

setMetrics

public PipelineStep setMetrics(Set<PipelineStep.MetricInfo> metrics)

addMetricInfo

public PipelineStep addMetricInfo(PipelineStep.MetricInfo metricInfo)

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

lenientEquals
```
public boolean lenientEquals(PipelineStep other)
```
Description copied from interface: LenientEquals

Leniently tests if the objects are the same. Implementors should declare what this means in practice.

Specified by:

lenientEquals in interface LenientEquals<PipelineStep>

Parameters:

other - To compare against

Returns:

true if...

Class PipelineStep

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STEPS_BY_TYPE_ASC

STEPS_BY_FINISHED_ASC

Constructor Detail

PipelineStep

Method Detail

getKey

getType

setType

getRunner

setRunner

getStarted

setStarted

getFinished

setFinished

getState

setState

getMessage

setMessage

setKey

getNumberRecords

setNumberRecords

getPipelinesVersion

setPipelinesVersion

getCreatedBy

setCreatedBy

getModified

setModified

getModifiedBy

setModifiedBy

getMetrics

setMetrics

addMetricInfo

equals

hashCode

toString

lenientEquals