final case class NewPartition(partition: String, layer: String, data: Blob, fields: Option[IndexFields] = None, metadata: Option[IndexMetadata] = None, checksum: Option[String] = None, crc: Option[String] = None, dataSize: Option[Long] = None, compressedDataSize: Option[Long] = None, additionalMetadata: Option[String] = None, timestamp: Option[Long] = None) extends javadsl.NewPartition with Product with Serializable

Represents a new (or changed) partition pending for publication.

Use the com.here.platform.data.client.scaladsl.NewPartition or com.here.platform.data.client.scaladsl.DeletedPartition to construct instances of this class.

additionalMetadata is now deprecated because it is no longer required by OLP services to route messages.

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.

layer

Id 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.

data

Data of new partition.

fields

Optional value for index fields. It's collection of name-value pairs used to index partition in Index layer.

metadata

optional user-defined fields that can store extra metadata about this index record. A typical example of extra metadata is the ingestion time of a record, Map("ingestionTime" -> "1532018660873")

checksum

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 publish 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.

crc

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 publish of the partition.

dataSize

Optional value for the uncompressed 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 publish of the partition.

compressedDataSize

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 publish of the partition.

additionalMetadata

Optional value for additional metadata

timestamp

Optional value for the stream record timestamp. Setting the timestamp is only effective when publishing to a stream layer using the kafka-connector. Please check https://developer.here.com/documentation/data-client-library/dev_guide/client/publish-data.html chapter "Publish to a Stream Layer" for the detailed meaning of the timestamp.

Linear Supertypes
Serializable, Serializable, Product, Equals, javadsl.NewPartition, PendingPartition, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NewPartition
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. NewPartition
  7. PendingPartition
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NewPartition(partition: String, layer: String, data: Blob, fields: Option[IndexFields] = None, metadata: Option[IndexMetadata] = None, checksum: Option[String] = None, crc: Option[String] = None, dataSize: Option[Long] = None, compressedDataSize: Option[Long] = None, additionalMetadata: Option[String] = None, timestamp: Option[Long] = None)

    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.

    layer

    Id 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.

    data

    Data of new partition.

    fields

    Optional value for index fields. It's collection of name-value pairs used to index partition in Index layer.

    metadata

    optional user-defined fields that can store extra metadata about this index record. A typical example of extra metadata is the ingestion time of a record, Map("ingestionTime" -> "1532018660873")

    checksum

    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 publish 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.

    crc

    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 publish of the partition.

    dataSize

    Optional value for the uncompressed 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 publish of the partition.

    compressedDataSize

    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 publish of the partition.

    additionalMetadata

    Optional value for additional metadata

    timestamp

    Optional value for the stream record timestamp. Setting the timestamp is only effective when publishing to a stream layer using the kafka-connector. Please check https://developer.here.com/documentation/data-client-library/dev_guide/client/publish-data.html chapter "Publish to a Stream Layer" for the detailed meaning of the timestamp.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val additionalMetadata: Option[String]

    Optional value for additional metadata

    Optional value for additional metadata

    Definition Classes
    NewPartition → NewPartition
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val checksum: Option[String]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. val compressedDataSize: Option[Long]
  9. val crc: Option[String]
  10. val data: Blob
  11. val dataSize: Option[Long]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val fields: Option[IndexFields]
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def getChecksum: Optional[String]

    The checksum field is optional.

    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 publish 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.

    Definition Classes
    NewPartition → NewPartition
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getCompressedDataSize: OptionalLong

    Optional value for the size of the compressed partition data in bytes.

    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 publish of the partition.

    Definition Classes
    NewPartition → NewPartition
  18. def getCrc: Optional[String]

    The crc field is optional.

    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 publish of the partition.

    Definition Classes
    NewPartition → NewPartition
  19. def getData: Blob

    Data of partition.

    Data of partition.

    Definition Classes
    NewPartition → NewPartition
  20. def getDataSize: OptionalLong

    Optional value for the uncompressed size of the partition data in bytes.

    Optional value for the uncompressed 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 publish of the partition.

    Definition Classes
    NewPartition → NewPartition
  21. def getFields: Optional[JIndexFields]

    Optional value for index fields.

    Optional value for index fields. It's collection of name-value pairs used to index partition in Index layer.

    Definition Classes
    NewPartition → NewPartition
  22. def getLayer: String

    The layer name of this pending partition.

    The layer name of this pending partition.

    returns

    layer name

    Definition Classes
    NewPartition → PendingPartition
  23. def getMetadata: Optional[JIndexMetadata]

    Optional user-defined fields that can store extra metadata about this index record.

    Optional user-defined fields that can store extra metadata about this index record. A typical example of extra metadata is the ingestion time of a record, Map("ingestionTime" -> "1532018660873")

    Definition Classes
    NewPartition → NewPartition
  24. def getPartition: String

    The partition id of this pending partition.

    The partition id of this pending partition.

    returns

    partition id

    Definition Classes
    NewPartition → PendingPartition
  25. def getTimestamp: OptionalLong

    Optional value for the stream record timestamp

    Optional value for the stream record timestamp

    Definition Classes
    NewPartition → NewPartition
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. val layer: String

    The layer name of this pending partition.

    The layer name of this pending partition.

    returns

    layer name

    Definition Classes
    NewPartition → PendingPartition
  28. val metadata: Option[IndexMetadata]
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. val partition: String

    The partition id of this pending partition.

    The partition id of this pending partition.

    returns

    partition id

    Definition Classes
    NewPartition → PendingPartition
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. val timestamp: Option[Long]
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from javadsl.NewPartition

Inherited from PendingPartition

Inherited from AnyRef

Inherited from Any

Ungrouped