RegisterInstance

pydantic model ansys.hps.client.rcs.RegisterInstance

Register a new instance route.

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": "RegisterInstance",
   "description": "Register a new instance route.",
   "type": "object",
   "properties": {
      "url": {
         "description": "(UI) URL of the instance/solution (e.g. http://ip.address:port)",
         "title": "Url",
         "type": "string"
      },
      "api_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "API URL of the instance/solution if any (optional) (e.g. http://ip.address:port)",
         "title": "Api Url"
      },
      "service_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Service name to be used in the URL (optional)",
         "title": "Service Name"
      },
      "project_url_sub_path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "URL subpath path of the project if any (optional) (e.g. /projects/1234)",
         "title": "Project Url Sub Path"
      },
      "jms_project_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "JMS project ID (optional). Passing this will create a URL with the project ID as a subpath rather than a random UID query parameter",
         "title": "Jms Project Id"
      },
      "jms_job_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "JMS job ID (optional) (e.g. 5678)",
         "title": "Jms Job Id"
      },
      "jms_task_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "JMS task ID (optional) (e.g. 91011)",
         "title": "Jms Task Id"
      },
      "routing": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Routing used when using skip_oauth2_proxy. `query`: The instance is added as a query parameter (?ans_instance_id=xxx). `path_prefix`: The instance is added in the path (/ans_instance_id/xxx).",
         "title": "Routing"
      }
   },
   "required": [
      "url"
   ]
}

Fields:

• api_url (str | None)

• jms_job_id (str | None)

• jms_project_id (str | None)

• jms_task_id (str | None)

• project_url_sub_path (str | None)

• routing (str | None)

• service_name (str | None)

• url (str)

field api_url: str | None = None

API URL of the instance/solution if any (optional) (e.g. http://ip.address:port)

field jms_job_id: str | None = None

JMS job ID (optional) (e.g. 5678)

field jms_project_id: str | None = None

JMS project ID (optional). Passing this will create a URL with the project ID as a subpath rather than a random UID query parameter

field jms_task_id: str | None = None

JMS task ID (optional) (e.g. 91011)

field project_url_sub_path: str | None = None

URL subpath path of the project if any (optional) (e.g. /projects/1234)

field routing: str | None = None

Routing used when using skip_oauth2_proxy. query: The instance is added as a query parameter (?ans_instance_id=xxx). path_prefix: The instance is added in the path (/ans_instance_id/xxx).

field service_name: str | None = None

Service name to be used in the URL (optional)

field url: str [Required]

(UI) URL of the instance/solution (e.g. http://ip.address:port)