Package com.here.platform.data.client.service.stream

Class StreamPartitionMessage

java.lang.Object
com.here.platform.data.client.service.stream.StreamPartitionMessage
All Implemented Interfaces:
Partition, com.here.platform.data.client.scaladsl.Partition, HasCheckpointing, Serializable
Direct Known Subclasses:
StreamEmbeddedPartitionMessage, StreamReferencedPartitionMessage
public abstract class StreamPartitionMessage extends Object implements com.here.platform.data.client.scaladsl.Partition, HasCheckpointing
See Also:

  • Constructor Details

    • StreamPartitionMessage

      public StreamPartitionMessage(StreamMessage raw)

  • Method Details

    • apply

      public static StreamPartitionMessage apply(String layer, StreamMessage msg, boolean isCompressed)

    • streamPartition

      public int streamPartition()

    • offset

      public long offset()

    • partition

      public String partition()
      Specified by:
      partition in interface com.here.platform.data.client.scaladsl.Partition

    • checksum

      public scala.Option<String> checksum()
      Specified by:
      checksum in interface com.here.platform.data.client.scaladsl.Partition

    • crc

      public scala.Option<String> crc()
      Specified by:
      crc in interface com.here.platform.data.client.scaladsl.Partition

    • dataSize

      public scala.Option<Object> dataSize()
      Specified by:
      dataSize in interface com.here.platform.data.client.scaladsl.Partition

    • compressedDataSize

      public scala.Option<Object> compressedDataSize()
      Specified by:
      compressedDataSize in interface com.here.platform.data.client.scaladsl.Partition

    • additionalMetadata

      public scala.Option<String> additionalMetadata()
      Specified by:
      additionalMetadata in interface com.here.platform.data.client.scaladsl.Partition

    • isDeleted

      public boolean isDeleted()
      Description copied from interface: Partition
      Return true if partition represent a delete modification
      Specified by:
      isDeleted in interface Partition
      Specified by:
      isDeleted in interface com.here.platform.data.client.scaladsl.Partition

    • timestamp

      public scala.Option<Object> timestamp()
      Specified by:
      timestamp in interface com.here.platform.data.client.scaladsl.Partition

    • getPartition

      public String getPartition()
      Description copied from interface: Partition
      Name of the partition. If the partition is using a tiling partitioning scheme, this is the id of the tile. The name cannot be empty. Maximum length of this field is 500 characters.
      Specified by:
      getPartition in interface Partition

    • getLayer

      public String getLayer()
      Description copied from interface: Partition
      Name of the layer. Content of this field must refer to a valid layer already configured in the catalog configuration. Allowed are only: a-z, A-Z, 0-9, '_' and '-' characters. The partition layer cannot be empty. Maximum length is 50 characters.
      Specified by:
      getLayer in interface Partition

    • getAdditionalMetadata

      public Optional<String> getAdditionalMetadata()
      Description copied from interface: Partition
      Optional value for additional metadata
      Specified by:
      getAdditionalMetadata in interface Partition

    • getTimestamp

      public OptionalLong getTimestamp()
      Description copied from interface: Partition
      Optional value for the stream or index record timestamp
      Specified by:
      getTimestamp in interface Partition

    • getChecksum

      public Optional<String> getChecksum()
      Description copied from interface: Partition
      The checksum field is optional. It is only included if checksum was requested in the API call (using 'additionalFields' query parameter) and if a checksum was provided during commit of the partition. It should be set to the sha1 checksum of the data content if data comparison needs to work for this catalog. The maximum length of checksum field is 128 characters.
      Specified by:
      getChecksum in interface Partition

    • getCrc

      public Optional<String> getCrc()
      Description copied from interface: Partition
      The crc field is optional. It is only included if crc was requested in the API call (using 'additionalFields' query parameter) and if a crc was provided during commit of the partition.
      Specified by:
      getCrc in interface Partition

    • getDataSize

      public OptionalLong getDataSize()
      Description copied from interface: Partition
      Optional value for the size of the partition data in bytes. It is only included if the dataSize field was requested in the API call, and if a dataSize was provided during commit of the partition.
      Specified by:
      getDataSize in interface Partition

    • getCompressedDataSize

      public OptionalLong getCompressedDataSize()
      Description copied from interface: Partition
      Optional value for the size of the compressed partition data in bytes. It is only included if the compressedDataSize field was requested in the API call, and if a compressedDataSize was provided during commit of the partition.
      Specified by:
      getCompressedDataSize in interface Partition

    • checkpoint

      public scala.Option<CheckpointMark> checkpoint()
      Specified by:
      checkpoint in interface HasCheckpointing
      Specified by:
      checkpoint in interface com.here.platform.data.client.scaladsl.Partition

    • withCheckpoint

      public HasCheckpointing withCheckpoint(CheckpointMark checkpoint)
      Specified by:
      withCheckpoint in interface HasCheckpointing