nisystemlink.clients.testmonitor

class nisystemlink.clients.testmonitor.TestMonitorClient(configuration=None)

__init__(configuration=None)

Initialize an instance.

Parameters

configuration (Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, the HttpConfigurationManager is used to obtain the configuration.

Raises

ApiException – if unable to communicate with the Spec Service.

pydantic model nisystemlink.clients.testmonitor.models.ApiInfo

Information about the available API operations.

Show JSON schema

{
   "title": "ApiInfo",
   "description": "Information about the available API operations.",
   "type": "object",
   "properties": {
      "operations": {
         "$ref": "#/definitions/V2Operations"
      }
   },
   "required": [
      "operations"
   ],
   "definitions": {
      "Operation": {
         "title": "Operation",
         "description": "Represents an operation that can be performed on a data frame.",
         "type": "object",
         "properties": {
            "available": {
               "title": "Available",
               "type": "boolean"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            }
         },
         "required": [
            "available",
            "version"
         ]
      },
      "V2Operations": {
         "title": "V2Operations",
         "description": "The operations available in the routes provided by the v2 HTTP API.",
         "type": "object",
         "properties": {
            "getProducts": {
               "$ref": "#/definitions/Operation"
            },
            "queryProducts": {
               "$ref": "#/definitions/Operation"
            },
            "createProducts": {
               "$ref": "#/definitions/Operation"
            },
            "updateProducts": {
               "$ref": "#/definitions/Operation"
            },
            "deleteProducts": {
               "$ref": "#/definitions/Operation"
            },
            "deleteManyProducts": {
               "$ref": "#/definitions/Operation"
            },
            "getResults": {
               "$ref": "#/definitions/Operation"
            },
            "getResultsPropertyKeys": {
               "$ref": "#/definitions/Operation"
            },
            "queryResults": {
               "$ref": "#/definitions/Operation"
            },
            "createResults": {
               "$ref": "#/definitions/Operation"
            },
            "updateResults": {
               "$ref": "#/definitions/Operation"
            },
            "deleteResult": {
               "$ref": "#/definitions/Operation"
            },
            "deleteManyResults": {
               "$ref": "#/definitions/Operation"
            },
            "getSteps": {
               "$ref": "#/definitions/Operation"
            },
            "querySteps": {
               "$ref": "#/definitions/Operation"
            },
            "createSteps": {
               "$ref": "#/definitions/Operation"
            },
            "updateSteps": {
               "$ref": "#/definitions/Operation"
            },
            "deleteStep": {
               "$ref": "#/definitions/Operation"
            },
            "deleteManySteps": {
               "$ref": "#/definitions/Operation"
            },
            "queryPaths": {
               "$ref": "#/definitions/Operation"
            }
         },
         "required": [
            "getProducts",
            "queryProducts",
            "createProducts",
            "updateProducts",
            "deleteProducts",
            "deleteManyProducts",
            "getResults",
            "getResultsPropertyKeys",
            "queryResults",
            "createResults",
            "updateResults",
            "deleteResult",
            "deleteManyResults",
            "getSteps",
            "querySteps",
            "createSteps",
            "updateSteps",
            "deleteStep",
            "deleteManySteps",
            "queryPaths"
         ]
      }
   }
}

Fields

• operations

field operations: V2Operations [Required]

pydantic model nisystemlink.clients.testmonitor.models.Operation

Represents an operation that can be performed on a data frame.

Show JSON schema

{
   "title": "Operation",
   "description": "Represents an operation that can be performed on a data frame.",
   "type": "object",
   "properties": {
      "available": {
         "title": "Available",
         "type": "boolean"
      },
      "version": {
         "title": "Version",
         "type": "integer"
      }
   },
   "required": [
      "available",
      "version"
   ]
}

Fields

• available

• version

field available: bool [Required]

Whether or not the operation is available to the caller (e.g. due to permissions).

field version: int [Required]

The version of the available operation.

pydantic model nisystemlink.clients.testmonitor.models.V2Operations

The operations available in the routes provided by the v2 HTTP API.

Show JSON schema

{
   "title": "V2Operations",
   "description": "The operations available in the routes provided by the v2 HTTP API.",
   "type": "object",
   "properties": {
      "getProducts": {
         "$ref": "#/definitions/Operation"
      },
      "queryProducts": {
         "$ref": "#/definitions/Operation"
      },
      "createProducts": {
         "$ref": "#/definitions/Operation"
      },
      "updateProducts": {
         "$ref": "#/definitions/Operation"
      },
      "deleteProducts": {
         "$ref": "#/definitions/Operation"
      },
      "deleteManyProducts": {
         "$ref": "#/definitions/Operation"
      },
      "getResults": {
         "$ref": "#/definitions/Operation"
      },
      "getResultsPropertyKeys": {
         "$ref": "#/definitions/Operation"
      },
      "queryResults": {
         "$ref": "#/definitions/Operation"
      },
      "createResults": {
         "$ref": "#/definitions/Operation"
      },
      "updateResults": {
         "$ref": "#/definitions/Operation"
      },
      "deleteResult": {
         "$ref": "#/definitions/Operation"
      },
      "deleteManyResults": {
         "$ref": "#/definitions/Operation"
      },
      "getSteps": {
         "$ref": "#/definitions/Operation"
      },
      "querySteps": {
         "$ref": "#/definitions/Operation"
      },
      "createSteps": {
         "$ref": "#/definitions/Operation"
      },
      "updateSteps": {
         "$ref": "#/definitions/Operation"
      },
      "deleteStep": {
         "$ref": "#/definitions/Operation"
      },
      "deleteManySteps": {
         "$ref": "#/definitions/Operation"
      },
      "queryPaths": {
         "$ref": "#/definitions/Operation"
      }
   },
   "required": [
      "getProducts",
      "queryProducts",
      "createProducts",
      "updateProducts",
      "deleteProducts",
      "deleteManyProducts",
      "getResults",
      "getResultsPropertyKeys",
      "queryResults",
      "createResults",
      "updateResults",
      "deleteResult",
      "deleteManyResults",
      "getSteps",
      "querySteps",
      "createSteps",
      "updateSteps",
      "deleteStep",
      "deleteManySteps",
      "queryPaths"
   ],
   "definitions": {
      "Operation": {
         "title": "Operation",
         "description": "Represents an operation that can be performed on a data frame.",
         "type": "object",
         "properties": {
            "available": {
               "title": "Available",
               "type": "boolean"
            },
            "version": {
               "title": "Version",
               "type": "integer"
            }
         },
         "required": [
            "available",
            "version"
         ]
      }
   }
}

Fields

• create_products

• create_results

• create_steps

• delete_many_products

• delete_many_results

• delete_many_steps

• delete_products

• delete_result

• delete_step

• get_products

• get_results

• get_results_property_keys

• get_steps

• query_paths

• query_products

• query_results

• query_steps

• update_products

• update_results

• update_steps

field create_products: Operation [Required]

The ability to create one or more products.

field create_results: Operation [Required]

The ability to create results.

field create_steps: Operation [Required]

The ability to create steps.

field delete_many_products: Operation [Required]

The ability to delete a list of products.

field delete_many_results: Operation [Required]

The ability to delete multiple results.

field delete_many_steps: Operation [Required]

The ability to delete multiple steps.

field delete_products: Operation [Required]

The ability to delete a single products.

field delete_result: Operation [Required]

The ability to delete a single results.

field delete_step: Operation [Required]

The ability to delete a single step.

field get_products: Operation [Required]

The ability to get a list of products.

field get_results: Operation [Required]

The ability to get a list of results.

field get_results_property_keys: Operation [Required]

The ability to get custom property keys.

field get_steps: Operation [Required]

The ability to get a list of steps.

field query_paths: Operation [Required]

The ability to query step paths.

field query_products: Operation [Required]

The ability to query products based on their properties.

field query_results: Operation [Required]

“The ability to to query results based on their properties.

field query_steps: Operation [Required]

The ability to query steps based on their properties.

field update_products: Operation [Required]

The ability to update the properties of one or more products.

field update_results: Operation [Required]

The ability to update results.

field update_steps: Operation [Required]

The ability to update steps.