ClusterInfo

pydantic model ansys.hps.client.rms.ClusterInfo

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": "ClusterInfo",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Unique ID for the database.",
         "title": "Id"
      },
      "crs_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Compute resource set ID.",
         "title": "Crs Id"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Cluster name.",
         "title": "Name"
      },
      "queues": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Queue"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "title": "Queues"
      },
      "nodes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Node"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "title": "Nodes"
      },
      "additional_props": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "object"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": {},
         "title": "Additional Props"
      }
   },
   "$defs": {
      "Node": {
         "properties": {
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Node name.",
               "title": "Name"
            },
            "total_memory_mb": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "Total memory.",
               "title": "Total Memory Mb"
            },
            "total_cores": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "Number of cores.",
               "title": "Total Cores"
            },
            "additional_props": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {},
               "title": "Additional Props"
            }
         },
         "required": [
            "total_memory_mb",
            "total_cores"
         ],
         "title": "Node",
         "type": "object"
      },
      "NodeGroup": {
         "properties": {
            "node_names": {
               "items": {
                  "type": "string"
               },
               "title": "Node Names",
               "type": "array"
            },
            "memory_per_node_mb": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "Memory per node.",
               "title": "Memory Per Node Mb"
            },
            "cores_per_node": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "Cores per node.",
               "title": "Cores Per Node"
            }
         },
         "required": [
            "node_names",
            "memory_per_node_mb",
            "cores_per_node"
         ],
         "title": "NodeGroup",
         "type": "object"
      },
      "Queue": {
         "properties": {
            "name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Queue name.",
               "title": "Name"
            },
            "node_groups": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/NodeGroup"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of node groups associated with the queue (if available).",
               "title": "Node Groups"
            },
            "additional_props": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {},
               "title": "Additional Props"
            }
         },
         "title": "Queue",
         "type": "object"
      }
   }
}

Fields:

• additional_props (Dict[str, Dict[str, Any]] | None)

• crs_id (str | None)

• id (str | None)

• name (str | None)

• nodes (List[ansys.hps.client.rms.models.Node] | None)

• queues (List[ansys.hps.client.rms.models.Queue] | None)

field additional_props: Optional[Dict[str, Dict[str, Any]]] = {}

field crs_id: Optional[str] = None

Compute resource set ID.

field id: Optional[str] = None

Unique ID for the database.

field name: Optional[str] = None

Cluster name.

field nodes: Optional[List[Node]] = []

field queues: Optional[List[Queue]] = []