GET /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read — cloud.docs

Read Memory Store Queue Items

Returns the specified number of items at the front of the queue.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
queue_id	path	true	The queue ID.
count	query	false	The number of items to read from the queue If unspecified, 1 item will be returned. The maximum value is 200; values above 200 will be coerced to 200.
allOrNothing	query	false	If `all_or_nothing` is true and the requested number of objects is not available, will return a 404 Error. Otherwise, will return the path and read_id of the read operation and a list of the MemoryStoreQueue items.
invisibilityWindow	query	false	Invisibility window for items read, in seconds. Items read are invisible in subsequent reads during the invisibility window duration. It must be written in seconds greater than 0 and end with `s`. Defaults to `30s`.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "queue_id",
    "in": "path",
    "description": "The queue ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "count",
    "in": "query",
    "description": "The number of items to read from the queue\nIf unspecified, 1 item will be returned.\nThe maximum value is 200; values above 200 will be coerced to 200.",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "allOrNothing",
    "in": "query",
    "description": "If `all_or_nothing` is true and the requested number of objects is not\navailable, will return a 404 Error.\n\nOtherwise, will return the path and read_id of the read operation and a\nlist of the MemoryStoreQueue items.",
    "schema": {
      "example": true,
      "type": "boolean"
    }
  },
  {
    "name": "invisibilityWindow",
    "in": "query",
    "description": "Invisibility window for items read, in seconds.\n\nItems read are invisible in subsequent reads during the invisibility\nwindow duration.\n\nIt must be written in seconds greater than 0 and end with `s`.\n\nDefaults to `30s`.",
    "schema": {
      "example": "3s",
      "type": "string",
      "format": "duration"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ReadMemoryStoreQueueItemsResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Read Memory Store Queue Items",
  "description": "Returns the specified number of items at the front of the queue.\n\n",
  "operationId": "Cloud_ReadMemoryStoreQueueItems",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "queue_id",
      "in": "path",
      "description": "The queue ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "count",
      "in": "query",
      "description": "The number of items to read from the queue\nIf unspecified, 1 item will be returned.\nThe maximum value is 200; values above 200 will be coerced to 200.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "allOrNothing",
      "in": "query",
      "description": "If `all_or_nothing` is true and the requested number of objects is not\navailable, will return a 404 Error.\n\nOtherwise, will return the path and read_id of the read operation and a\nlist of the MemoryStoreQueue items.",
      "schema": {
        "example": true,
        "type": "boolean"
      }
    },
    {
      "name": "invisibilityWindow",
      "in": "query",
      "description": "Invisibility window for items read, in seconds.\n\nItems read are invisible in subsequent reads during the invisibility\nwindow duration.\n\nIt must be written in seconds greater than 0 and end with `s`.\n\nDefaults to `30s`.",
      "schema": {
        "example": "3s",
        "type": "string",
        "format": "duration"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ReadMemoryStoreQueueItemsResponse"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "memory-store.queue:dequeue"
    }
  ],
  "x-roblox-docs": {
    "category": "Data and memory stores",
    "methodProperties": {
      "scopes": [
        "memory-store.queue:dequeue"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/MemoryStoreQueueItem",
      "name": "MemoryStoreQueueItem"
    }
  }
}