java.lang.Object
- org.apache.flink.cdc.connectors.base.options.StartupOptions

All Implemented Interfaces:

Serializable
```
public final class StartupOptions
extends Object
implements Serializable
```
Flink CDC Connector startup options.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`Map<String,String>`	`offset`
`String`	`specificOffsetFile`
`Integer`	`specificOffsetPos`
`StartupMode`	`startupMode`
`Long`	`startupTimestampMillis`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartupOptions`	`committed()`	Never to perform snapshot on the monitored database tables upon first startup, just read from the previous committed posistion of the change log which means only have the changes since the connector last stopped.
`static StartupOptions`	`earliest()`	Never to perform snapshot on the monitored database tables upon first startup, just read from the beginning of the change log.
`boolean`	`equals(Object o)`
`Map<String,String>`	`getOffset()`
`int`	`hashCode()`
`static StartupOptions`	`initial()`	Performs an initial snapshot on the monitored database tables upon first startup, and continue to read the latest change log.
`boolean`	`isSnapshotOnly()`
`boolean`	`isStreamOnly()`
`static StartupOptions`	`latest()`	Never to perform snapshot on the monitored database tables upon first startup, just read from the end of the change log which means only have the changes since the connector was started.
`static StartupOptions`	`snapshot()`	Performs an initial snapshot on the monitored database tables upon first startup, and not read the change log anymore .
`static StartupOptions`	`specificOffset(String specificOffsetFile, int specificOffsetPos)`	Never to perform snapshot on the monitored database tables upon first startup, and directly read change log from the specified offset.
`static StartupOptions`	`specificOffset(Map<String,String> offset)`
`static StartupOptions`	`timestamp(long startupTimestampMillis)`	Never to perform snapshot on the monitored database tables upon first startup, and directly read change log from the specified timestamp.

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

- Field Detail
  - startupMode
```
public final StartupMode startupMode
```
  - specificOffsetFile
```
public final String specificOffsetFile
```
  - specificOffsetPos
```
public final Integer specificOffsetPos
```
  - startupTimestampMillis
```
public final Long startupTimestampMillis
```
  - offset
```
public final Map<String,String> offset
```
- Method Detail
  - initial
```
public static StartupOptions initial()
```
    Performs an initial snapshot on the monitored database tables upon first startup, and continue to read the latest change log.
  - snapshot
```
public static StartupOptions snapshot()
```
    Performs an initial snapshot on the monitored database tables upon first startup, and not read the change log anymore .
  - earliest
```
public static StartupOptions earliest()
```
    Never to perform snapshot on the monitored database tables upon first startup, just read from the beginning of the change log. This should be used with care, as it is only valid when the change log is guaranteed to contain the entire history of the database.
  - latest
```
public static StartupOptions latest()
```
    Never to perform snapshot on the monitored database tables upon first startup, just read from the end of the change log which means only have the changes since the connector was started.
  - committed
```
public static StartupOptions committed()
```
    Never to perform snapshot on the monitored database tables upon first startup, just read from the previous committed posistion of the change log which means only have the changes since the connector last stopped.
  - specificOffset
```
public static StartupOptions specificOffset(String specificOffsetFile,
                                            int specificOffsetPos)
```
    Never to perform snapshot on the monitored database tables upon first startup, and directly read change log from the specified offset.
  - specificOffset
```
public static StartupOptions specificOffset(Map<String,String> offset)
```
  - timestamp
```
public static StartupOptions timestamp(long startupTimestampMillis)
```
    Never to perform snapshot on the monitored database tables upon first startup, and directly read change log from the specified timestamp.
    The consumer will traverse the change log from the beginning and ignore change events whose timestamp is smaller than the specified timestamp.
    
    Parameters:
    
    startupTimestampMillis - timestamp for the startup offsets, as milliseconds from epoch.
  - getOffset
```
public Map<String,String> getOffset()
```
  - isStreamOnly
```
public boolean isStreamOnly()
```
  - isSnapshotOnly
```
public boolean isSnapshotOnly()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class StartupOptions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startupMode

specificOffsetFile

specificOffsetPos

startupTimestampMillis

offset

Method Detail

initial

snapshot

earliest

latest

committed

specificOffset

specificOffset

timestamp

getOffset

isStreamOnly

isSnapshotOnly

equals

hashCode