Web services objects

Objects and models for external connections. See supported Web services APIs.

vianops_client.models.webservices.external_connection

pydantic model V1ColumnMetadata

Bases: BaseModel

Show JSON schema

{
   "title": "V1ColumnMetadata",
   "type": "object",
   "properties": {
      "column_name": {
         "title": "Column Name",
         "type": "string"
      },
      "data_type": {
         "title": "Data Type",
         "type": "string"
      }
   },
   "required": [
      "column_name",
      "data_type"
   ]
}

Fields:

column_name (str)
data_type (str)

field column_name: str [Required]

field data_type: str [Required]

pydantic model V1ExternalConnectionModel

Bases: BaseModel

Show JSON schema

{
   "title": "V1ExternalConnectionModel",
   "type": "object",
   "properties": {
      "index": {
         "title": "Index",
         "type": "integer"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "display": {
         "title": "Display",
         "type": "boolean"
      },
      "url": {
         "title": "Url",
         "type": "string"
      },
      "type": {
         "title": "Type",
         "type": "string"
      },
      "hide_tables": {
         "title": "Hide Tables",
         "type": "array",
         "items": {}
      },
      "createdby": {
         "title": "Createdby",
         "type": "string"
      },
      "createddate": {
         "title": "Createddate",
         "type": "number"
      }
   },
   "required": [
      "name",
      "description",
      "display",
      "url",
      "type"
   ]
}

Config:

orm_mode: bool = True

Fields:

createdby (str | None)
createddate (float | None)
description (str)
display (bool)
hide_tables (list | None)
index (int | None)
name (str)
type (str)
url (str)

field createdby: str | None = None

field createddate: float | None = None

field description: str [Required]

field display: bool [Required]

field hide_tables: list | None = None

field index: int | None = None

field name: str [Required]

field type: str [Required]

field url: str [Required]

pydantic model V1ExternalConnectionModelList

Bases: BaseModel

Show JSON schema

{
   "title": "V1ExternalConnectionModelList",
   "type": "array",
   "items": {
      "$ref": "#/definitions/V1ExternalConnectionModel"
   },
   "definitions": {
      "V1ExternalConnectionModel": {
         "title": "V1ExternalConnectionModel",
         "type": "object",
         "properties": {
            "index": {
               "title": "Index",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            },
            "display": {
               "title": "Display",
               "type": "boolean"
            },
            "url": {
               "title": "Url",
               "type": "string"
            },
            "type": {
               "title": "Type",
               "type": "string"
            },
            "hide_tables": {
               "title": "Hide Tables",
               "type": "array",
               "items": {}
            },
            "createdby": {
               "title": "Createdby",
               "type": "string"
            },
            "createddate": {
               "title": "Createddate",
               "type": "number"
            }
         },
         "required": [
            "name",
            "description",
            "display",
            "url",
            "type"
         ]
      }
   }
}

Fields:

__root__ (List[vianops_client.models.webservices.external_connection.V1ExternalConnectionModel])

pydantic model V1ExternalConnectionSlimModel

Bases: BaseModel

Show JSON schema

{
   "title": "V1ExternalConnectionSlimModel",
   "type": "object",
   "properties": {
      "index": {
         "title": "Index",
         "type": "integer"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "description": {
         "title": "Description",
         "type": "string"
      },
      "type": {
         "title": "Type",
         "type": "string"
      },
      "createdby": {
         "title": "Createdby",
         "type": "string"
      },
      "createddate": {
         "title": "Createddate",
         "type": "number"
      }
   },
   "required": [
      "name",
      "description",
      "type"
   ]
}

Fields:

createdby (str | None)
createddate (float | None)
description (str)
index (int | None)
name (str)
type (str)

field createdby: str | None = None

field createddate: float | None = None

field description: str [Required]

field index: int | None = None

field name: str [Required]

field type: str [Required]

pydantic model V1ExternalConnectionSlimModelList

Bases: BaseModel

Show JSON schema

{
   "title": "V1ExternalConnectionSlimModelList",
   "type": "array",
   "items": {
      "$ref": "#/definitions/V1ExternalConnectionSlimModel"
   },
   "definitions": {
      "V1ExternalConnectionSlimModel": {
         "title": "V1ExternalConnectionSlimModel",
         "type": "object",
         "properties": {
            "index": {
               "title": "Index",
               "type": "integer"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "description": {
               "title": "Description",
               "type": "string"
            },
            "type": {
               "title": "Type",
               "type": "string"
            },
            "createdby": {
               "title": "Createdby",
               "type": "string"
            },
            "createddate": {
               "title": "Createddate",
               "type": "number"
            }
         },
         "required": [
            "name",
            "description",
            "type"
         ]
      }
   }
}

Fields:

__root__ (List[vianops_client.models.webservices.external_connection.V1ExternalConnectionSlimModel])

pydantic model V1TableMetadata

Bases: BaseModel

Show JSON schema

{
   "title": "V1TableMetadata",
   "type": "object",
   "properties": {
      "tablename": {
         "title": "Tablename",
         "type": "string"
      },
      "columns": {
         "title": "Columns",
         "type": "array",
         "items": {
            "$ref": "#/definitions/V1ColumnMetadata"
         }
      }
   },
   "required": [
      "tablename",
      "columns"
   ],
   "definitions": {
      "V1ColumnMetadata": {
         "title": "V1ColumnMetadata",
         "type": "object",
         "properties": {
            "column_name": {
               "title": "Column Name",
               "type": "string"
            },
            "data_type": {
               "title": "Data Type",
               "type": "string"
            }
         },
         "required": [
            "column_name",
            "data_type"
         ]
      }
   }
}

Fields:

columns (List[vianops_client.models.webservices.external_connection.V1ColumnMetadata])
tablename (str)

field columns: List[V1ColumnMetadata] [Required]

field tablename: str [Required]