EvaluatorRegistration

pydantic model ansys.hps.client.rms.EvaluatorRegistration

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Show JSON schema

{
   "title": "EvaluatorRegistration",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Unique ID for the worker.",
         "title": "Id"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User-defined name for the worker.",
         "title": "Name"
      },
      "last_modified": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Date and time when the registration was last modified.",
         "title": "Last Modified"
      },
      "host_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Static hardware and configuration-based UUID.",
         "title": "Host Id"
      },
      "host_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the host that the worker is running on.",
         "title": "Host Name"
      },
      "username": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Username that the worker authenticated with.",
         "title": "Username"
      },
      "user_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "User ID that the worker authenticated with.",
         "title": "User Id"
      },
      "platform": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "OS that the worker is running on.",
         "title": "Platform"
      },
      "build_info": {
         "anyOf": [
            {
               "additionalProperties": true,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": {},
         "description": "Dictionary with build information.",
         "title": "Build Info"
      },
      "organization_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Organization (e.g. customer, account) identifier.",
         "title": "Organization Id"
      },
      "is_admin": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Worker has admin privileges",
         "title": "Is Admin"
      },
      "compute_resource_set_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "ID of the compute resource set that the evaluator belongs to.",
         "title": "Compute Resource Set Id"
      },
      "change_requested": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Date and time of the configuration's last modification request.",
         "title": "Change Requested"
      },
      "shutdown_status": {
         "anyOf": [
            {
               "$ref": "#/$defs/ShutdownStatus"
            },
            {
               "type": "null"
            }
         ],
         "default": "unset",
         "description": "Status of Evaluator shutdown (default='unset').  Only Evaluator should set 'normal' status. Other statuses inferred by monitoring service.",
         "title": "Shutdown Status"
      },
      "house_cleaned": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Flag indicating housekeeper has processed abnormal shutdown_status.",
         "title": "House Cleaned"
      }
   },
   "$defs": {
      "ShutdownStatus": {
         "enum": [
            "unset",
            "normal",
            "aborted",
            "crash"
         ],
         "title": "ShutdownStatus",
         "type": "string"
      }
   }
}

Fields:

• build_info (dict[str, Any] | None)

• change_requested (datetime.datetime | None)

• compute_resource_set_id (str | None)

• host_id (str | None)

• host_name (str | None)

• house_cleaned (bool | None)

• id (str | None)

• is_admin (bool | None)

• last_modified (datetime.datetime | None)

• name (str | None)

• organization_id (str | None)

• platform (str | None)

• shutdown_status (ansys.hps.client.rms.models.ShutdownStatus | None)

• user_id (str | None)

• username (str | None)

field build_info: dict[str, Any] | None = {}

Dictionary with build information.

field change_requested: datetime | None = None

Date and time of the configuration’s last modification request.

field compute_resource_set_id: str | None = None

ID of the compute resource set that the evaluator belongs to.

field host_id: str | None = None

Static hardware and configuration-based UUID.

field host_name: str | None = None

Name of the host that the worker is running on.

field house_cleaned: bool | None = False

Flag indicating housekeeper has processed abnormal shutdown_status.

field id: str | None = None

Unique ID for the worker.

field is_admin: bool | None = False

Worker has admin privileges

field last_modified: datetime | None = None

Date and time when the registration was last modified.

field name: str | None = None

User-defined name for the worker.

field organization_id: str | None = None

Organization (e.g. customer, account) identifier.

field platform: str | None = None

OS that the worker is running on.

field shutdown_status: ShutdownStatus | None = 'unset'

Status of Evaluator shutdown (default=’unset’). Only Evaluator should set ‘normal’ status. Other statuses inferred by monitoring service.

field user_id: str | None = None

User ID that the worker authenticated with.

field username: str | None = None

Username that the worker authenticated with.