InternalTimer.TimerSerializer (flink 1.5-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.typeutils.TypeSerializer<InternalTimer<K,N>>
- - org.apache.flink.streaming.api.operators.InternalTimer.TimerSerializer<K,N>

All Implemented Interfaces:

Serializable

Enclosing class:

InternalTimer<K,N>
```
public static class InternalTimer.TimerSerializer<K,N>
extends TypeSerializer<InternalTimer<K,N>>
```
A TypeSerializer used to serialize/deserialize a InternalTimer.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canEqual(Object obj)` Returns true if the given object can be equaled with this object.
`void`	`copy(DataInputView source, DataOutputView target)` Copies exactly one record from the source input view to the target output view.
`InternalTimer<K,N>`	`copy(InternalTimer<K,N> from)` Creates a deep copy of the given element in a new element.
`InternalTimer<K,N>`	`copy(InternalTimer<K,N> from, InternalTimer<K,N> reuse)` Creates a copy from the given element.
`InternalTimer<K,N>`	`createInstance()` Creates a new instance of the data type.
`InternalTimer<K,N>`	`deserialize(DataInputView source)` De-serializes a record from the given source input view.
`InternalTimer<K,N>`	`deserialize(InternalTimer<K,N> reuse, DataInputView source)` De-serializes a record from the given source input view into the given reuse record instance if mutable.
`TypeSerializer<InternalTimer<K,N>>`	`duplicate()` Creates a deep copy of this serializer if it is necessary, i.e.
`CompatibilityResult<InternalTimer<K,N>>`	`ensureCompatibility(TypeSerializerConfigSnapshot configSnapshot)` Ensure compatibility of this serializer with a preceding serializer that was registered for serialization of the same managed state (if any - this method is only relevant if this serializer is registered for serialization of managed state).
`boolean`	`equals(Object obj)`
`int`	`getLength()` Gets the length of the data type, if it is a fix length data type.
`int`	`hashCode()`
`boolean`	`isImmutableType()` Gets whether the type is an immutable type.
`void`	`serialize(InternalTimer<K,N> record, DataOutputView target)` Serializes the given record to the given target output view.
`TypeSerializerConfigSnapshot`	`snapshotConfiguration()` Create a snapshot of the serializer's current configuration to be stored along with the managed state it is registered to (if any - this method is only relevant if this serializer is registered for serialization of managed state).

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

- Method Detail
  - isImmutableType
```
public boolean isImmutableType()
```
    Description copied from class: TypeSerializer
    
    Gets whether the type is an immutable type.
    
    Specified by:
    
    isImmutableType in class TypeSerializer<InternalTimer<K,N>>
    
    Returns:
    
    True, if the type is immutable.
  - duplicate
```
public TypeSerializer<InternalTimer<K,N>> duplicate()
```
    Description copied from class: TypeSerializer
    
    Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful. We need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.
    
    Specified by:
    
    duplicate in class TypeSerializer<InternalTimer<K,N>>
  - createInstance
```
public InternalTimer<K,N> createInstance()
```
    Description copied from class: TypeSerializer
    
    Creates a new instance of the data type.
    
    Specified by:
    
    createInstance in class TypeSerializer<InternalTimer<K,N>>
    
    Returns:
    
    A new instance of the data type.
  - copy
```
public InternalTimer<K,N> copy(InternalTimer<K,N> from)
```
    Description copied from class: TypeSerializer
    
    Creates a deep copy of the given element in a new element.
    
    Specified by:
    
    copy in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    from - The element reuse be copied.
    
    Returns:
    
    A deep copy of the element.
  - copy
```
public InternalTimer<K,N> copy(InternalTimer<K,N> from,
                               InternalTimer<K,N> reuse)
```
    Description copied from class: TypeSerializer
    
    Creates a copy from the given element. The method makes an attempt to store the copy in the given reuse element, if the type is mutable. This is, however, not guaranteed.
    
    Specified by:
    
    copy in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    from - The element to be copied.
    
    reuse - The element to be reused. May or may not be used.
    
    Returns:
    
    A deep copy of the element.
  - getLength
```
public int getLength()
```
    Description copied from class: TypeSerializer
    
    Gets the length of the data type, if it is a fix length data type.
    
    Specified by:
    
    getLength in class TypeSerializer<InternalTimer<K,N>>
    
    Returns:
    
    The length of the data type, or -1 for variable length data types.
  - serialize
```
public void serialize(InternalTimer<K,N> record,
                      DataOutputView target)
               throws IOException
```
    Description copied from class: TypeSerializer
    
    Serializes the given record to the given target output view.
    
    Specified by:
    
    serialize in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    record - The record to serialize.
    
    target - The output view to write the serialized data to.
    
    Throws:
    
    IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.
  - deserialize
```
public InternalTimer<K,N> deserialize(DataInputView source)
                               throws IOException
```
    Description copied from class: TypeSerializer
    
    De-serializes a record from the given source input view.
    
    Specified by:
    
    deserialize in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    source - The input view from which to read the data.
    
    Returns:
    
    The deserialized element.
    
    Throws:
    
    IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.
  - deserialize
```
public InternalTimer<K,N> deserialize(InternalTimer<K,N> reuse,
                                      DataInputView source)
                               throws IOException
```
    Description copied from class: TypeSerializer
    
    De-serializes a record from the given source input view into the given reuse record instance if mutable.
    
    Specified by:
    
    deserialize in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    reuse - The record instance into which to de-serialize the data.
    
    source - The input view from which to read the data.
    
    Returns:
    
    The deserialized element.
    
    Throws:
    
    IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.
  - copy
```
public void copy(DataInputView source,
                 DataOutputView target)
          throws IOException
```
    Description copied from class: TypeSerializer
    
    Copies exactly one record from the source input view to the target output view. Whether this operation works on binary data or partially de-serializes the record to determine its length (such as for records of variable length) is up to the implementer. Binary copies are typically faster. A copy of a record containing two integer numbers (8 bytes total) is most efficiently implemented as target.write(source, 8);.
    
    Specified by:
    
    copy in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    source - The input view from which to read the record.
    
    target - The target output view to which to write the record.
    
    Throws:
    
    IOException - Thrown if any of the two views raises an exception.
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class TypeSerializer<InternalTimer<K,N>>
  - canEqual
```
public boolean canEqual(Object obj)
```
    Description copied from class: TypeSerializer
    
    Returns true if the given object can be equaled with this object. If not, it returns false.
    
    Specified by:
    
    canEqual in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    obj - Object which wants to take part in the equality relation
    
    Returns:
    
    true if obj can be equaled with this, otherwise false
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class TypeSerializer<InternalTimer<K,N>>
  - snapshotConfiguration
```
public TypeSerializerConfigSnapshot snapshotConfiguration()
```
    Description copied from class: TypeSerializer
    
    Create a snapshot of the serializer's current configuration to be stored along with the managed state it is registered to (if any - this method is only relevant if this serializer is registered for serialization of managed state).
    The configuration snapshot should contain information about the serializer's parameter settings and its serialization format. When a new serializer is registered to serialize the same managed state that this serializer was registered to, the returned configuration snapshot can be used to ensure compatibility of the new serializer and determine if state migration is required.
    
    Specified by:
    
    snapshotConfiguration in class TypeSerializer<InternalTimer<K,N>>
    
    Returns:
    
    snapshot of the serializer's current configuration (cannot be null).
    
    See Also:
    
    TypeSerializerConfigSnapshot
  - ensureCompatibility
```
public CompatibilityResult<InternalTimer<K,N>> ensureCompatibility(TypeSerializerConfigSnapshot configSnapshot)
```
    Description copied from class: TypeSerializer
    Ensure compatibility of this serializer with a preceding serializer that was registered for serialization of the same managed state (if any - this method is only relevant if this serializer is registered for serialization of managed state). The compatibility check in this method should be performed by inspecting the preceding serializer's configuration snapshot. The method may reconfigure the serializer (if required and possible) so that it may be compatible, or provide a signaling result that informs Flink that state migration is necessary before continuing to use this serializer.
    The result can be one of the following:
    - CompatibilityResult.compatible(): this signals Flink that this serializer is compatible, or has been reconfigured to be compatible, to continue reading previous data, and that the serialization schema remains the same. No migration needs to be performed.
    - CompatibilityResult.requiresMigration(TypeDeserializer): this signals Flink that migration needs to be performed, because this serializer is not compatible, or cannot be reconfigured to be compatible, for previous data. Furthermore, in the case that the preceding serializer cannot be found or restored to read the previous data to perform the migration, the provided convert deserializer can be used as a fallback resort.
    - CompatibilityResult.requiresMigration(): this signals Flink that migration needs to be performed, because this serializer is not compatible, or cannot be reconfigured to be compatible, for previous data. If the preceding serializer cannot be found (either its implementation changed or it was removed from the classpath) then the migration will fail due to incapability to read previous data.
    Specified by:
    
    ensureCompatibility in class TypeSerializer<InternalTimer<K,N>>
    
    Parameters:
    
    configSnapshot - configuration snapshot of a preceding serializer for the same managed state
    
    Returns:
    
    the determined compatibility result (cannot be null).
    
    See Also:
    
    CompatibilityResult

Back to Flink Website

Class InternalTimer.TimerSerializer<K,N>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isImmutableType

duplicate

createInstance

copy

copy

getLength

serialize

deserialize

deserialize

copy

equals

canEqual

hashCode

snapshotConfiguration

ensureCompatibility

Back to Flink Website