Objects and models

Reference to objects provided by the Python SDK.

Utility submodules

vianops_client.models.commons

class V1DeleteTypes(value)

Bases: Enum

An enumeration.

ARCHIVE = 'archive'

DELETE = 'delete'

FORCE_DELETE = 'force_delete'

pydantic model V1Filters

Bases: V1FiltersCommon

Show JSON schema

{
   "title": "V1Filters",
   "type": "object",
   "properties": {
      "created_by": {
         "title": "Created By",
         "description": "List of 'created by' users to search for.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "modified_by": {
         "title": "Modified By",
         "description": "List of 'modified by' users to search for.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "created_ts_start": {
         "title": "Created Ts Start",
         "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
         "type": "number"
      },
      "created_ts_end": {
         "title": "Created Ts End",
         "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
         "type": "number"
      },
      "modified_ts_start": {
         "title": "Modified Ts Start",
         "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
         "type": "number"
      },
      "modified_ts_end": {
         "title": "Modified Ts End",
         "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
         "type": "number"
      },
      "uuid": {
         "title": "Uuid",
         "description": "List of uuids for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "name": {
         "title": "Name",
         "description": "List of names for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "status": {
         "title": "Status",
         "description": "List of statuses for this operation.",
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields:

name (List[str] | None)
status (List[str] | None)
uuid (List[str] | None)

field name: List[str] | None = None: List of names for this operation.

field status: List[str] | None = None: List of statuses for this operation.

field uuid: List[str] | None = None: List of uuids for this operation.

pydantic model V1FiltersCommon

Bases: BaseModel

Show JSON schema

{
   "title": "V1FiltersCommon",
   "type": "object",
   "properties": {
      "created_by": {
         "title": "Created By",
         "description": "List of 'created by' users to search for.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "modified_by": {
         "title": "Modified By",
         "description": "List of 'modified by' users to search for.",
         "type": "array",
         "items": {
            "type": "string"
         }
      },
      "created_ts_start": {
         "title": "Created Ts Start",
         "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
         "type": "number"
      },
      "created_ts_end": {
         "title": "Created Ts End",
         "description": "Unix time in milliseconds for searching for all objects created during a specified time period.",
         "type": "number"
      },
      "modified_ts_start": {
         "title": "Modified Ts Start",
         "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
         "type": "number"
      },
      "modified_ts_end": {
         "title": "Modified Ts End",
         "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.",
         "type": "number"
      }
   }
}

Fields:

created_by (List[str] | None)
created_ts_end (float | None)
created_ts_start (float | None)
modified_by (List[str] | None)
modified_ts_end (float | None)
modified_ts_start (float | None)

field created_by: List[str] | None = None: List of ‘created by’ users to search for.

field created_ts_end: float | None = None: Unix time in milliseconds for searching for all objects created during a specified time period.

field created_ts_start: float | None = None: Unix time in milliseconds for searching for all objects created during a specified time period.

field modified_by: List[str] | None = None: List of ‘modified by’ users to search for.

field modified_ts_end: float | None = None: Unix time in milliseconds for searching for all objects modified during a specified time period.

field modified_ts_start: float | None = None: Unix time in milliseconds for searching for all objects modified during a specified time period.

vianops_client.models.pagination

pydantic model PageModel

Bases: BaseModel

Show JSON schema

{
   "title": "PageModel",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "default": [],
         "type": "array",
         "items": {}
      },
      "current_page": {
         "title": "Current Page",
         "default": 0,
         "type": "integer"
      },
      "page_size": {
         "title": "Page Size",
         "default": 0,
         "type": "integer"
      },
      "previous_page": {
         "title": "Previous Page",
         "type": "integer"
      },
      "next_page": {
         "title": "Next Page",
         "type": "integer"
      },
      "has_previous": {
         "title": "Has Previous",
         "default": false,
         "type": "boolean"
      },
      "previous_items": {
         "title": "Previous Items",
         "default": 0,
         "type": "integer"
      },
      "has_next": {
         "title": "Has Next",
         "default": false,
         "type": "boolean"
      },
      "total": {
         "title": "Total",
         "default": 0,
         "type": "integer"
      },
      "pages": {
         "title": "Pages",
         "default": 0,
         "type": "integer"
      }
   }
}

Fields:

current_page (int)
has_next (bool)
has_previous (bool)
items (List[Any])
next_page (int | None)
page_size (int)
pages (int)
previous_items (int)
previous_page (int | None)
total (int)

field current_page: int = 0

field has_next: bool = False

field has_previous: bool = False

field items: List[Any] = []

field next_page: int | None = None

field page_size: int = 0

field pages: int = 0

field previous_items: int = 0

field previous_page: int | None = None

field total: int = 0

pydantic model V1OrderBy

Bases: BaseModel

Show JSON schema

{
   "title": "V1OrderBy",
   "type": "object",
   "properties": {
      "field": {
         "title": "Field",
         "description": "Field to order by.",
         "type": "string"
      },
      "direction": {
         "title": "Direction",
         "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).",
         "default": "ASC",
         "type": "string"
      }
   },
   "required": [
      "field"
   ]
}

Fields:

direction (str | None)
field (str)

field direction: str | None = 'ASC': Direction to order the field by. Supported values: ASC (ascending) and DESC (descending) (case-insensitive).

field field: str [Required]: Field to order by.

pydantic model V1PageModel

Bases: BaseModel

Show JSON schema

{
   "title": "V1PageModel",
   "type": "object",
   "properties": {
      "items": {
         "title": "Items",
         "description": "Items of the page.",
         "default": [],
         "type": "array",
         "items": {}
      },
      "current_page": {
         "title": "Current Page",
         "description": "Current page of items.",
         "default": 0,
         "type": "integer"
      },
      "page_size": {
         "title": "Page Size",
         "description": "Number of items on a page.",
         "default": 0,
         "type": "integer"
      },
      "previous_page": {
         "title": "Previous Page",
         "description": "Number of the previous page.",
         "type": "integer"
      },
      "next_page": {
         "title": "Next Page",
         "description": "Number of the next page.",
         "type": "integer"
      },
      "has_previous": {
         "title": "Has Previous",
         "description": "Whether or not there is a previous page.",
         "default": false,
         "type": "boolean"
      },
      "previous_items": {
         "title": "Previous Items",
         "default": 0,
         "type": "integer"
      },
      "has_next": {
         "title": "Has Next",
         "description": "Whether or not there is a next page.",
         "default": false,
         "type": "boolean"
      },
      "total": {
         "title": "Total",
         "description": "Total number of items returned by search over all pages.",
         "default": 0,
         "type": "integer"
      },
      "pages": {
         "title": "Pages",
         "description": "Total number of pages returned by search.",
         "default": 0,
         "type": "integer"
      }
   }
}

Fields:

current_page (int)
has_next (bool)
has_previous (bool)
items (List[Any])
next_page (int | None)
page_size (int)
pages (int)
previous_items (int)
previous_page (int | None)
total (int)

field current_page: int = 0: Current page of items.

field has_next: bool = False: Whether or not there is a next page.

field has_previous: bool = False: Whether or not there is a previous page.

field items: List[Any] = []: Items of the page.

field next_page: int | None = None: Number of the next page.

field page_size: int = 0: Number of items on a page.

field pages: int = 0: Total number of pages returned by search.

field previous_items: int = 0

field previous_page: int | None = None: Number of the previous page.

field total: int = 0: Total number of items returned by search over all pages.

pydantic model V1PageSearch

Bases: BaseModel

Show JSON schema

{
   "title": "V1PageSearch",
   "type": "object",
   "properties": {
      "page": {
         "title": "Page",
         "description": "Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don't exceed the number of pages, set `page` to 1 and run this search operation to return the total number items (`total`). Then run it again to return the exact page (`page`) for the specified number of items per page (`page-size`).",
         "type": "integer"
      },
      "page_size": {
         "title": "Page Size",
         "description": "Number of items to return on a page. Default is 25 items per page.",
         "default": 25,
         "type": "integer"
      },
      "order": {
         "title": "Order",
         "description": "Fields to use for ordering returned pages and the sort direction.",
         "type": "array",
         "items": {
            "$ref": "#/definitions/V1OrderBy"
         }
      },
      "search": {
         "title": "Search",
         "description": "String to search for (case-insensitive) across all fields in previously created items.",
         "type": "string"
      }
   },
   "required": [
      "page"
   ],
   "definitions": {
      "V1OrderBy": {
         "title": "V1OrderBy",
         "type": "object",
         "properties": {
            "field": {
               "title": "Field",
               "description": "Field to order by.",
               "type": "string"
            },
            "direction": {
               "title": "Direction",
               "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).",
               "default": "ASC",
               "type": "string"
            }
         },
         "required": [
            "field"
         ]
      }
   }
}

Fields:

order (List[vianops_client.models.pagination.V1OrderBy] | None)
page (int)
page_size (int)
search (str | None)

field order: List[V1OrderBy] | None = None: Fields to use for ordering returned pages and the sort direction.

field page: int [Required]: Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don’t exceed the number of pages, set page to 1 and run this search operation to return the total number items (total). Then run it again to return the exact page (page) for the specified number of items per page (page-size).

field page_size: int = 25: Number of items to return on a page. Default is 25 items per page.

field search: str | None = None: String to search for (case-insensitive) across all fields in previously created items.