Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the partition object which is unique within a layer.

Hierarchy

  • Partition

Index

Properties

checksum?: string

The checksum field is optional. The response includes the checksum only if you specify checksum in the additionalFields query parameter, and if a checksum was specified in the partition metadata when it was published. You need to use the SHA-1 checksum of the data content if you want data comparison to work for this catalog. The maximum length of the checksum field is 128 characters.

compressedDataSize?: number

Optional value for the size of the compressed partition data in bytes. The response only includes the compressed data size if you specify compressedDataSize in the additionalFields query parameter, and if compression is enabled, and if compressedDataSize was specified in the partition metadata when it was published.

crc?: string

Optional value for the CRC of the partition data in bytes. The response only includes the data size if crc was specified in the additionalFields query parameter, and if crc was specified in the partition metadata when it was published.

dataHandle: string

You use the data handle when retrieving the data that relates to this partition. The data handle identifies a specific blob so that you can request the blob's contents with the Blob API. When requesting data from the Blob API, you must specify the catalog ID, layer ID and the dataHandle.

dataSize?: number

Optional value for the size of the partition data in bytes. The response only includes the data size if you specify dataSize in the additionalFields query parameter, and if dataSize was specified in the partition metadata when it was published.

partition: string

The partition key. This is a unique key for a partition within a layer. If the layer's partitioning scheme is set to heretile, the partition key is equivalent to the tile key. The partition key cannot be empty. The maximum length of the partition key is 500 characters.

version: number

For active versioned partitions, the version of the catalog when this partition was last changed. For volatile partitions this will always be -1

Generated using TypeDoc