Package io.pravega.client.stream

Enum ReaderGroupConfig.StreamDataRetention

java.lang.Object

java.lang.Enum<ReaderGroupConfig.StreamDataRetention>

io.pravega.client.stream.ReaderGroupConfig.StreamDataRetention

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReaderGroupConfig.StreamDataRetention>

Enclosing class:

ReaderGroupConfig

public static enum ReaderGroupConfig.StreamDataRetention
extends java.lang.Enum<ReaderGroupConfig.StreamDataRetention>

If a Reader Group wants unconsumed data to be retained in a Stream, the retentionType in ReaderGroupConfig should be set to to 'MANUAL_RELEASE_AT_USER_STREAMCUT' or 'AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT'. Setting these options implies the Reader Group will supply its consumption StreamCut, so only un-consumed data can be retained. This notification can be manual ('MANUAL_RELEASE_AT_USER_STREAMCUT') or automatic ('AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT') To ensure Reader Groups' read positions do not impact data retention in the Stream, set retentionType='NONE', so consumption position notifications are not sent to Controller. NONE - Set when the reader's positions of this Reader Group should not impact Stream retention. MANUAL_RELEASE_AT_USER_STREAMCUT - User provides StreamCut to mark position in the Stream till which data is consumed using ReaderGroup.updateRetentionStreamCut(java.util.Map) API. AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT - StreamCut of the last completed checkpoint is used as the retention Stream-Cut.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT
MANUAL_RELEASE_AT_USER_STREAMCUT
NONE

Method Summary

Modifier and Type	Method	Description
static ReaderGroupConfig.StreamDataRetention	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ReaderGroupConfig.StreamDataRetention[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final ReaderGroupConfig.StreamDataRetention NONE

MANUAL_RELEASE_AT_USER_STREAMCUT

public static final ReaderGroupConfig.StreamDataRetention MANUAL_RELEASE_AT_USER_STREAMCUT

AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT

public static final ReaderGroupConfig.StreamDataRetention AUTOMATIC_RELEASE_AT_LAST_CHECKPOINT

Method Detail

values

public static ReaderGroupConfig.StreamDataRetention[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReaderGroupConfig.StreamDataRetention c : ReaderGroupConfig.StreamDataRetention.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReaderGroupConfig.StreamDataRetention valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null