PartitionState (Couchbase Java DCP Client 0.36.0 API)

java.lang.Object
- com.couchbase.client.dcp.state.PartitionState

```
public class PartitionState
extends Object
```
Represents the individual current session state for a given partition.

Constructor Summary

Constructors
Constructor and Description

PartitionState()

Constructors
Constructor and Description
`PartitionState()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addToFailoverLog(long seqno, long vbuuid)` Deprecated. in favor of `setFailoverLog(List)`
`static PartitionState`	`fromOffset(StreamOffset offset)`
`CollectionsManifest`	`getCollectionsManifest()`
`long`	`getCollectionsManifestUid()`
`long`	`getEndSeqno()` Returns the current end sequence number.
`List<FailoverLogEntry>`	`getFailoverLog()` Returns the full failover log stored, in sorted order.
`KeyExtractor`	`getKeyExtractor()`
`long`	`getLastUuid()` Convenience method to get the last UUID returned on the failover log.
`StreamOffset`	`getOffset()`
`SnapshotMarker`	`getSnapshot()`
`long`	`getSnapshotEndSeqno()` Returns the current snapshot end sequence number.
`long`	`getSnapshotStartSeqno()` Returns the current snapshot start sequence number.
`long`	`getStartSeqno()` Returns the current start sequence number.
`boolean`	`isAtEnd()` Check if the current partition is at the end (start >= end seqno).
`void`	`setCollectionsManifest(CollectionsManifest collectionsManifest)`
`void`	`setCollectionsManifestUid(long collectionsManifestUid)`
`void`	`setEndSeqno(long endSeqno)` Allows to set the current end sequence number.
`void`	`setFailoverLog(List<FailoverLogEntry> log)` Sets the failover log.
`void`	`setKeyExtractor(KeyExtractor keyExtractor)`
`void`	`setSnapshot(SnapshotMarker snapshot)`
`void`	`setSnapshotEndSeqno(long snapshotEndSeqno)` Deprecated. in favor of `setSnapshot(SnapshotMarker)`
`void`	`setSnapshotStartSeqno(long snapshotStartSeqno)` Deprecated. in favor of `setSnapshot(SnapshotMarker)`
`void`	`setStartSeqno(long startSeqno)` Allows to set the current start sequence number.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PartitionState
```
public PartitionState()
```
- Method Detail
  - fromOffset
```
public static PartitionState fromOffset(StreamOffset offset)
```
  - getCollectionsManifestUid
```
public long getCollectionsManifestUid()
```
  - setCollectionsManifestUid
```
public void setCollectionsManifestUid(long collectionsManifestUid)
```
  - getCollectionsManifest
```
public CollectionsManifest getCollectionsManifest()
```
  - setCollectionsManifest
```
public void setCollectionsManifest(CollectionsManifest collectionsManifest)
```
  - getKeyExtractor
```
public KeyExtractor getKeyExtractor()
```
  - setKeyExtractor
```
public void setKeyExtractor(KeyExtractor keyExtractor)
```
  - getEndSeqno
```
public long getEndSeqno()
```
    Returns the current end sequence number.
  - getStartSeqno
```
public long getStartSeqno()
```
    Returns the current start sequence number.
  - setStartSeqno
```
public void setStartSeqno(long startSeqno)
```
    Allows to set the current start sequence number.
  - setEndSeqno
```
public void setEndSeqno(long endSeqno)
```
    Allows to set the current end sequence number.
  - getFailoverLog
```
public List<FailoverLogEntry> getFailoverLog()
```
    Returns the full failover log stored, in sorted order.
  - setFailoverLog
```
public void setFailoverLog(List<FailoverLogEntry> log)
```
    Sets the failover log.
  - addToFailoverLog
```
@Deprecated
public void addToFailoverLog(long seqno,
                                         long vbuuid)
```
    Deprecated. in favor of setFailoverLog(List)
    
    Add a new seqno/uuid combination to the failover log.
    
    Parameters:
    
    seqno - the sequence number.
    
    vbuuid - the uuid for the sequence.
  - getSnapshotStartSeqno
```
public long getSnapshotStartSeqno()
```
    Returns the current snapshot start sequence number.
  - setSnapshotStartSeqno
```
@Deprecated
public void setSnapshotStartSeqno(long snapshotStartSeqno)
```
    Deprecated. in favor of setSnapshot(SnapshotMarker)
    
    Allows to set the current snapshot start sequence number.
  - setSnapshot
```
public void setSnapshot(SnapshotMarker snapshot)
```
  - getSnapshot
```
public SnapshotMarker getSnapshot()
```
  - getSnapshotEndSeqno
```
public long getSnapshotEndSeqno()
```
    Returns the current snapshot end sequence number.
  - setSnapshotEndSeqno
```
@Deprecated
public void setSnapshotEndSeqno(long snapshotEndSeqno)
```
    Deprecated. in favor of setSnapshot(SnapshotMarker)
    
    Allows to set the current snapshot end sequence number.
  - isAtEnd
```
public boolean isAtEnd()
```
    Check if the current partition is at the end (start >= end seqno).
  - getLastUuid
```
public long getLastUuid()
```
    Convenience method to get the last UUID returned on the failover log.
    Note that if the failover log is empty, 0 is sent out to indicate the start.
    The server inserts failover records into the head of the list, so the first one is the most recent.
  - getOffset
```
public StreamOffset getOffset()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PartitionState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartitionState

Method Detail

fromOffset

getCollectionsManifestUid

setCollectionsManifestUid

getCollectionsManifest

setCollectionsManifest

getKeyExtractor

setKeyExtractor

getEndSeqno

getStartSeqno

setStartSeqno

setEndSeqno

getFailoverLog

setFailoverLog

addToFailoverLog

getSnapshotStartSeqno

setSnapshotStartSeqno

setSnapshot

getSnapshot

getSnapshotEndSeqno

setSnapshotEndSeqno

isAtEnd

getLastUuid

getOffset

toString