Package org.apache.flink.fnexecution.v1

Class FlinkFnApi.StateDescriptor.StateTTLConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.flink.fnexecution.v1.FlinkFnApi.StateDescriptor.StateTTLConfig

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Enclosing class:

FlinkFnApi.StateDescriptor

public static final class FlinkFnApi.StateDescriptor.StateTTLConfig
extends com.google.protobuf.GeneratedMessageV3
implements FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Protobuf type org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FlinkFnApi.StateDescriptor.StateTTLConfig.Builder	Protobuf type org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig
static final class	FlinkFnApi.StateDescriptor.StateTTLConfig.CleanupStrategies	TTL cleanup strategies.
static interface	FlinkFnApi.StateDescriptor.StateTTLConfig.CleanupStrategiesOrBuilder
static enum	FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility	This option configures whether expired user value can be returned or not.
static enum	FlinkFnApi.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic	This option configures time scale to use for ttl.
static enum	FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType	This option value configures when to update last access timestamp which prolongs state TTL.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLEANUP_STRATEGIES_FIELD_NUMBER
static final int	STATE_VISIBILITY_FIELD_NUMBER
static final int	TTL_FIELD_NUMBER
static final int	TTL_TIME_CHARACTERISTIC_FIELD_NUMBER
static final int	UPDATE_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
FlinkFnApi.StateDescriptor.StateTTLConfig.CleanupStrategies	getCleanupStrategies()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.CleanupStrategies cleanup_strategies = 5;
FlinkFnApi.StateDescriptor.StateTTLConfig.CleanupStrategiesOrBuilder	getCleanupStrategiesOrBuilder()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.CleanupStrategies cleanup_strategies = 5;
static FlinkFnApi.StateDescriptor.StateTTLConfig	getDefaultInstance()
FlinkFnApi.StateDescriptor.StateTTLConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<FlinkFnApi.StateDescriptor.StateTTLConfig>	getParserForType()
int	getSerializedSize()
FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility	getStateVisibility()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.StateVisibility state_visibility = 2;
int	getStateVisibilityValue()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.StateVisibility state_visibility = 2;
long	getTtl()	int64 ttl = 4;
FlinkFnApi.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic	getTtlTimeCharacteristic()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic ttl_time_characteristic = 3;
int	getTtlTimeCharacteristicValue()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic ttl_time_characteristic = 3;
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType	getUpdateType()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.UpdateType update_type = 1;
int	getUpdateTypeValue()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.UpdateType update_type = 1;
boolean	hasCleanupStrategies()	.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.CleanupStrategies cleanup_strategies = 5;
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static FlinkFnApi.StateDescriptor.StateTTLConfig.Builder	newBuilder()
static FlinkFnApi.StateDescriptor.StateTTLConfig.Builder	newBuilder(FlinkFnApi.StateDescriptor.StateTTLConfig prototype)
FlinkFnApi.StateDescriptor.StateTTLConfig.Builder	newBuilderForType()
protected FlinkFnApi.StateDescriptor.StateTTLConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseDelimitedFrom(InputStream input)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(byte[] data)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(com.google.protobuf.ByteString data)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(InputStream input)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(ByteBuffer data)
static FlinkFnApi.StateDescriptor.StateTTLConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FlinkFnApi.StateDescriptor.StateTTLConfig>	parser()
FlinkFnApi.StateDescriptor.StateTTLConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

UPDATE_TYPE_FIELD_NUMBER

public static final int UPDATE_TYPE_FIELD_NUMBER

See Also:

• Constant Field Values

STATE_VISIBILITY_FIELD_NUMBER

public static final int STATE_VISIBILITY_FIELD_NUMBER

See Also:

• Constant Field Values

TTL_TIME_CHARACTERISTIC_FIELD_NUMBER

public static final int TTL_TIME_CHARACTERISTIC_FIELD_NUMBER

See Also:

• Constant Field Values

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER

See Also:

• Constant Field Values

CLEANUP_STRATEGIES_FIELD_NUMBER

public static final int CLEANUP_STRATEGIES_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getUpdateTypeValue

public int getUpdateTypeValue()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.UpdateType update_type = 1;

Specified by:

getUpdateTypeValue in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The enum numeric value on the wire for updateType.

getUpdateType

public FlinkFnApi.StateDescriptor.StateTTLConfig.UpdateType getUpdateType()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.UpdateType update_type = 1;

Specified by:

getUpdateType in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The updateType.

getStateVisibilityValue

public int getStateVisibilityValue()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.StateVisibility state_visibility = 2;

Specified by:

getStateVisibilityValue in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The enum numeric value on the wire for stateVisibility.

getStateVisibility

public FlinkFnApi.StateDescriptor.StateTTLConfig.StateVisibility getStateVisibility()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.StateVisibility state_visibility = 2;

Specified by:

getStateVisibility in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The stateVisibility.

getTtlTimeCharacteristicValue

public int getTtlTimeCharacteristicValue()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic ttl_time_characteristic = 3;

Specified by:

getTtlTimeCharacteristicValue in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The enum numeric value on the wire for ttlTimeCharacteristic.

getTtlTimeCharacteristic

public FlinkFnApi.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic getTtlTimeCharacteristic()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.TtlTimeCharacteristic ttl_time_characteristic = 3;

Specified by:

getTtlTimeCharacteristic in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The ttlTimeCharacteristic.

getTtl

public long getTtl()

int64 ttl = 4;

Specified by:

getTtl in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The ttl.

hasCleanupStrategies

public boolean hasCleanupStrategies()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.CleanupStrategies cleanup_strategies = 5;

Specified by:

hasCleanupStrategies in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

Whether the cleanupStrategies field is set.

getCleanupStrategies

public FlinkFnApi.StateDescriptor.StateTTLConfig.CleanupStrategies getCleanupStrategies()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.CleanupStrategies cleanup_strategies = 5;

Specified by:

getCleanupStrategies in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

Returns:

The cleanupStrategies.

getCleanupStrategiesOrBuilder

public FlinkFnApi.StateDescriptor.StateTTLConfig.CleanupStrategiesOrBuilder getCleanupStrategiesOrBuilder()

.org.apache.flink.fn_execution.v1.StateDescriptor.StateTTLConfig.CleanupStrategies cleanup_strategies = 5;

Specified by:

getCleanupStrategiesOrBuilder in interface FlinkFnApi.StateDescriptor.StateTTLConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(ByteBuffer data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(com.google.protobuf.ByteString data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(byte[] data)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseDelimitedFrom(InputStream input)
                                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                    throws IOException

Throws:

IOException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                                           throws IOException

Throws:

IOException

parseFrom

public static FlinkFnApi.StateDescriptor.StateTTLConfig parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

newBuilderForType

public FlinkFnApi.StateDescriptor.StateTTLConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FlinkFnApi.StateDescriptor.StateTTLConfig.Builder newBuilder()

newBuilder

public static FlinkFnApi.StateDescriptor.StateTTLConfig.Builder newBuilder(FlinkFnApi.StateDescriptor.StateTTLConfig prototype)

toBuilder

public FlinkFnApi.StateDescriptor.StateTTLConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FlinkFnApi.StateDescriptor.StateTTLConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FlinkFnApi.StateDescriptor.StateTTLConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<FlinkFnApi.StateDescriptor.StateTTLConfig> parser()

getParserForType

public com.google.protobuf.Parser<FlinkFnApi.StateDescriptor.StateTTLConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FlinkFnApi.StateDescriptor.StateTTLConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder