{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-worker-schema.json",
  "title": "Worker",
  "description": "The information about an On-premise VP worker.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-apmsynthetic-api-openapi.yml#/components/schemas/Worker",
  "properties": {
    "configurationDetails": {
      "description": "Configuration details of the On-premise VP worker.",
      "type": "object"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "Unique On-premise VP worker name that cannot be edited. The name should not contain any confidential information.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "geoInfo": {
      "description": "Geographical information of the On-premise VP worker.",
      "maxLength": 4096,
      "minLength": 1,
      "type": "string"
    },
    "id": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise VP worker.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "identityInfo": {
      "$ref": "#/$defs/IdentityInfoDetails"
    },
    "monitorList": {
      "description": "Monitors list assigned to the On-premise VP worker.",
      "items": {
        "$ref": "#/$defs/WorkerMonitorList"
      },
      "type": "array"
    },
    "name": {
      "description": "Unique permanent name of the On-premise VP worker. This is the same as the displayName.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "opvpId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise vantage point.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "opvpName": {
      "description": "On-premise vantage point name.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "priority": {
      "default": 10,
      "description": "Priority of the On-premise VP worker to schedule monitors.",
      "maximum": 10,
      "minimum": 1,
      "type": "integer"
    },
    "runtimeId": {
      "description": "The runtime assigned id of the On-premise VP worker.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "status": {
      "description": "Enables or disables the On-premise VP worker.",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/OnPremiseVantagePointWorkerStatus"
    },
    "timeCreated": {
      "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)\ntimestamp format.\nExample: `2020-02-12T22:47:12.613Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeLastSyncUp": {
      "description": "The time the resource was last synced, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)\ntimestamp format.\nExample: `2020-02-12T22:47:12.613Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)\ntimestamp format.\nExample: `2020-02-13T22:47:12.613Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "versionDetails": {
      "$ref": "#/$defs/OnPremiseVpWorkerVersionDetails"
    },
    "workerType": {
      "description": "Type of the On-premise VP worker.",
      "enum": [
        "DOCKER"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/OnPremiseVantagePointWorkerType"
    }
  },
  "required": [
    "id",
    "runtimeId",
    "displayName",
    "name",
    "opvpId",
    "opvpName",
    "versionDetails",
    "workerType",
    "status",
    "priority"
  ],
  "type": "object",
  "$defs": {
    "IdentityInfoDetails": {
      "description": "Domain details of the On-premise VP worker.",
      "properties": {
        "apmShortId": {
          "description": "Domain short id of the On-premise VP worker.",
          "type": "string"
        },
        "collectorEndPoint": {
          "description": "Collector endpoint of the On-premise VP worker.",
          "type": "string"
        },
        "regionName": {
          "description": "Domain region of the On-premise VP worker.",
          "type": "string"
        }
      },
      "required": [
        "regionName",
        "apmShortId",
        "collectorEndPoint"
      ],
      "type": "object"
    },
    "OnPremiseVpWorkerVersionDetails": {
      "description": "Image version details of the On-premise VP worker.",
      "properties": {
        "latestVersion": {
          "description": "Latest image version of the On-premise VP worker.",
          "maxLength": 120,
          "minLength": 1,
          "type": "string"
        },
        "minSupportedVersion": {
          "description": "Minimum supported image version of the On-premise VP worker.",
          "maxLength": 120,
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Current image version of the On-premise VP worker.",
          "maxLength": 120,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "version",
        "minSupportedVersion",
        "latestVersion"
      ],
      "type": "object"
    },
    "WorkerMonitorList": {
      "description": "Details of the monitor assigned to an On-premise vantage point worker.",
      "properties": {
        "displayName": {
          "description": "Unique name that can be edited. The name should not contain any confidential information.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "id": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the monitor.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "isRunNow": {
          "default": false,
          "description": "If isRunNow is enabled, then the monitor will run immediately.",
          "type": "boolean"
        },
        "monitorType": {
          "description": "Type of monitor.",
          "enum": [
            "SCRIPTED_BROWSER",
            "BROWSER",
            "SCRIPTED_REST",
            "REST",
            "NETWORK",
            "DNS",
            "FTP",
            "SQL"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/MonitorTypes"
        },
        "timeAssigned": {
          "description": "The time the resource was last assigned to an On-premise vantage point worker, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)\ntimestamp format.\nExample: `2020-02-12T22:47:12.613Z`\n",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "displayName",
        "monitorType"
      ],
      "type": "object"
    }
  }
}