2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

MemoryStoreSortedMapItem — cloud.docs

Represents an item within a sorted map structure.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the memory store sorted map item. Format: cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{memory_store_sorted_map_id}/items/{memory_store_sorted_map_item_id}
value#/components/schemas/GoogleProtobufValuefalseThe value of the item.
etagstringfalseThe server generated tag of an item.
ttlstringfalseThe TTL for the item.
expireTimestringfalseThe expiration time of the item.
idstringfalseThe name of the item.
stringSortKeystringfalseThe item will be sorted lexicographically according to this string.
numericSortKeynumberfalseThe item will be sorted according to this number.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "cloud/v2/universes/123/memory-store/sorted-maps/some-memory-store-sorted-map-id/items/some-memory-store-sorted-map-item-id",
      "type": "string",
      "description": "The resource path of the memory store sorted map item.\n\nFormat:\n`cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{memory_store_sorted_map_id}/items/{memory_store_sorted_map_item_id}`"
    },
    "value": {
      "$ref": "#/components/schemas/GoogleProtobufValue",
      "description": "The value of the item."
    },
    "etag": {
      "readOnly": true,
      "type": "string",
      "description": "The server generated tag of an item."
    },
    "ttl": {
      "writeOnly": true,
      "example": "3s",
      "type": "string",
      "description": "The TTL for the item.",
      "format": "duration"
    },
    "expireTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The expiration time of the item.",
      "format": "date-time"
    },
    "id": {
      "type": "string",
      "description": "The name of the item."
    },
    "stringSortKey": {
      "type": "string",
      "description": "The item will be sorted lexicographically according to this string."
    },
    "numericSortKey": {
      "type": "number",
      "description": "The item will be sorted according to this number.",
      "format": "double"
    }
  },
  "description": "Represents an item within a sorted map structure.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}/memory-store/sorted-maps/{memory_store_sorted_map_id}/items/{memory_store_sorted_map_item_id}"
    ],
    "plural": "memory-store-sorted-map-items",
    "singular": "memory-store-sorted-map-item"
  },
  "x-resource": true,
  "x-oneOf": {
    "expiration": [
      "ttl",
      "expireTime"
    ],
    "sortKey": [
      "stringSortKey",
      "numericSortKey"
    ]
  }
}