Away 9:27 PM

3 min read

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

OpenCloudUsers.Operation — openapi

This resource represents a long-running operation that is the result of a network API call.

Properties

NameTypeRequiredDescription
pathstringfalseThe server-assigned path, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the path should be a resource path ending with operations/{unique_id}.
metadatafalseService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
donebooleanfalseIf the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
errorfalseThe error result of the operation in case of failure or cancellation.
responsefalseThe normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The server-assigned path, which is only unique within the same service that\r\noriginally returns it. If you use the default HTTP mapping, the\r\n`path` should be a resource path ending with `operations/{unique_id}`.",
      "nullable": true
    },
    "metadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenerateUserThumbnailMetadata"
        }
      ],
      "description": "Service-specific metadata associated with the operation.  It typically\r\ncontains progress information and common metadata such as create time.\r\nSome services might not provide such metadata.  Any method that returns a\r\nlong-running operation should document the metadata type, if any.",
      "nullable": true
    },
    "done": {
      "type": "boolean",
      "description": "If the value is `false`, it means the operation is still in progress.\r\nIf `true`, the operation is completed, and either `error` or `response` is\r\navailable."
    },
    "error": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OpenCloudUsers.Status"
        }
      ],
      "description": "The error result of the operation in case of failure or cancellation.",
      "nullable": true
    },
    "response": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenerateUserThumbnailResponse"
        }
      ],
      "description": "The normal response of the operation in case of success.  If the original\r\nmethod returns no data on success, such as `Delete`, the response is\r\n`google.protobuf.Empty`.  If the original method is standard\r\n`Get`/`Create`/`Update`, the response should be the resource.  For other\r\nmethods, the response should have the type `XxxResponse`, where `Xxx`\r\nis the original method name.  For example, if the original method name\r\nis `TakeSnapshot()`, the inferred response type is\r\n`TakeSnapshotResponse`.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "This resource represents a long-running operation that is the result of a\r\nnetwork API call."
}