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": {
         "description": "Name of the column.",
         "title": "Column Name",
         "type": "string"
      },
      "data_type": {
         "description": "Data type of the column.",
         "title": "Data Type",
         "type": "string"
      }
   },
   "required": [
      "column_name",
      "data_type"
   ]
}

Fields:

• column_name (str)

• data_type (str)

field column_name: str [Required]

Name of the column.

field data_type: str [Required]

Data type of the column.

pydantic model V1ExternalConnectionModel

Bases: BaseModel

Show JSON schema

{
   "title": "V1ExternalConnectionModel",
   "type": "object",
   "properties": {
      "index": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "An optional index for the external connection.",
         "title": "Index"
      },
      "name": {
         "description": "Name of the external connection.",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "description": "Description of the external connection.",
         "title": "Description",
         "type": "string"
      },
      "display": {
         "description": "Boolean flag indicating whether the external connection is to be displayed.",
         "title": "Display",
         "type": "boolean"
      },
      "url": {
         "description": "URL for the external connection.",
         "title": "Url",
         "type": "string"
      },
      "type": {
         "description": "Type of the external connection.",
         "title": "Type",
         "type": "string"
      },
      "is_rdbms": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Boolean flag indicating whether the connection is an RDBMS.",
         "title": "Is Rdbms"
      },
      "hide_tables": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "List of tables to hide.",
         "title": "Hide Tables"
      },
      "hide_schemas": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "List of schemas to hide.",
         "title": "Hide Schemas"
      },
      "hide_views": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "List of views to hide.",
         "title": "Hide Views"
      },
      "createdby": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the creator.",
         "title": "Createdby"
      },
      "createddate": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Timestamp when the external connection was created.",
         "title": "Createddate"
      }
   },
   "required": [
      "name",
      "description",
      "display",
      "url",
      "type"
   ]
}

Config:

• from_attributes: bool = True

Fields:

• createdby (str | None)

• createddate (float | None)

• description (str)

• display (bool)

• hide_schemas (list | None)

• hide_tables (list | None)

• hide_views (list | None)

• index (int | None)

• is_rdbms (bool | None)

• name (str)

• type (str)

• url (str)

field createdby: str | None = None

Name of the creator.

field createddate: float | None = None

Timestamp when the external connection was created.

field description: str [Required]

Description of the external connection.

field display: bool [Required]

Boolean flag indicating whether the external connection is to be displayed.

field hide_schemas: list | None = []

List of schemas to hide.

field hide_tables: list | None = []

List of tables to hide.

field hide_views: list | None = []

List of views to hide.

field index: int | None = None

An optional index for the external connection.

field is_rdbms: bool | None = True

Boolean flag indicating whether the connection is an RDBMS.

field name: str [Required]

Name of the external connection.

field type: str [Required]

Type of the external connection.

field url: str [Required]

URL for the external connection.

pydantic model V1ExternalConnectionModelList

Bases: RootModel

Show JSON schema

{
   "title": "V1ExternalConnectionModelList",
   "type": "array",
   "$defs": {
      "V1ExternalConnectionModel": {
         "properties": {
            "index": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An optional index for the external connection.",
               "title": "Index"
            },
            "name": {
               "description": "Name of the external connection.",
               "title": "Name",
               "type": "string"
            },
            "description": {
               "description": "Description of the external connection.",
               "title": "Description",
               "type": "string"
            },
            "display": {
               "description": "Boolean flag indicating whether the external connection is to be displayed.",
               "title": "Display",
               "type": "boolean"
            },
            "url": {
               "description": "URL for the external connection.",
               "title": "Url",
               "type": "string"
            },
            "type": {
               "description": "Type of the external connection.",
               "title": "Type",
               "type": "string"
            },
            "is_rdbms": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "description": "Boolean flag indicating whether the connection is an RDBMS.",
               "title": "Is Rdbms"
            },
            "hide_tables": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "description": "List of tables to hide.",
               "title": "Hide Tables"
            },
            "hide_schemas": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "description": "List of schemas to hide.",
               "title": "Hide Schemas"
            },
            "hide_views": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [],
               "description": "List of views to hide.",
               "title": "Hide Views"
            },
            "createdby": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the creator.",
               "title": "Createdby"
            },
            "createddate": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Timestamp when the external connection was created.",
               "title": "Createddate"
            }
         },
         "required": [
            "name",
            "description",
            "display",
            "url",
            "type"
         ],
         "title": "V1ExternalConnectionModel",
         "type": "object"
      }
   },
   "items": {
      "$ref": "#/$defs/V1ExternalConnectionModel"
   }
}

Fields:

• root (List[vianops_client.models.webservices.external_connection.V1ExternalConnectionModel])

field root: List[V1ExternalConnectionModel] [Required]

pydantic model V1ExternalConnectionSlimModel

Bases: BaseModel

Show JSON schema

{
   "title": "V1ExternalConnectionSlimModel",
   "type": "object",
   "properties": {
      "index": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "An optional index for the external connection.",
         "title": "Index"
      },
      "name": {
         "description": "Name of the external connection.",
         "title": "Name",
         "type": "string"
      },
      "description": {
         "description": "Description of the external connection.",
         "title": "Description",
         "type": "string"
      },
      "type": {
         "description": "Type of the external connection.",
         "title": "Type",
         "type": "string"
      },
      "is_rdbms": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Boolean flag indicating whether the connection is an RDBMS.",
         "title": "Is Rdbms"
      },
      "createdby": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the creator.",
         "title": "Createdby"
      },
      "createddate": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Timestamp when the external connection was created.",
         "title": "Createddate"
      }
   },
   "required": [
      "name",
      "description",
      "type"
   ]
}

Fields:

• createdby (str | None)

• createddate (float | None)

• description (str)

• index (int | None)

• is_rdbms (bool | None)

• name (str)

• type (str)

field createdby: str | None = None

Name of the creator.

field createddate: float | None = None

Timestamp when the external connection was created.

field description: str [Required]

Description of the external connection.

field index: int | None = None

An optional index for the external connection.

field is_rdbms: bool | None = True

Boolean flag indicating whether the connection is an RDBMS.

field name: str [Required]

Name of the external connection.

field type: str [Required]

Type of the external connection.

pydantic model V1ExternalConnectionSlimModelList

Bases: RootModel

Show JSON schema

{
   "title": "V1ExternalConnectionSlimModelList",
   "type": "array",
   "$defs": {
      "V1ExternalConnectionSlimModel": {
         "properties": {
            "index": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "An optional index for the external connection.",
               "title": "Index"
            },
            "name": {
               "description": "Name of the external connection.",
               "title": "Name",
               "type": "string"
            },
            "description": {
               "description": "Description of the external connection.",
               "title": "Description",
               "type": "string"
            },
            "type": {
               "description": "Type of the external connection.",
               "title": "Type",
               "type": "string"
            },
            "is_rdbms": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "description": "Boolean flag indicating whether the connection is an RDBMS.",
               "title": "Is Rdbms"
            },
            "createdby": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Name of the creator.",
               "title": "Createdby"
            },
            "createddate": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Timestamp when the external connection was created.",
               "title": "Createddate"
            }
         },
         "required": [
            "name",
            "description",
            "type"
         ],
         "title": "V1ExternalConnectionSlimModel",
         "type": "object"
      }
   },
   "items": {
      "$ref": "#/$defs/V1ExternalConnectionSlimModel"
   }
}

Fields:

• root (List[vianops_client.models.webservices.external_connection.V1ExternalConnectionSlimModel])

field root: List[V1ExternalConnectionSlimModel] [Required]

pydantic model V1TableMetadata

Bases: BaseModel

Show JSON schema

{
   "title": "V1TableMetadata",
   "type": "object",
   "properties": {
      "tablename": {
         "description": "Name of the table.",
         "title": "Tablename",
         "type": "string"
      },
      "columns": {
         "description": "List of column metadata for the table.",
         "items": {
            "$ref": "#/$defs/V1ColumnMetadata"
         },
         "title": "Columns",
         "type": "array"
      }
   },
   "$defs": {
      "V1ColumnMetadata": {
         "properties": {
            "column_name": {
               "description": "Name of the column.",
               "title": "Column Name",
               "type": "string"
            },
            "data_type": {
               "description": "Data type of the column.",
               "title": "Data Type",
               "type": "string"
            }
         },
         "required": [
            "column_name",
            "data_type"
         ],
         "title": "V1ColumnMetadata",
         "type": "object"
      }
   },
   "required": [
      "tablename",
      "columns"
   ]
}

Fields:

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

• tablename (str)

field columns: List[V1ColumnMetadata] [Required]

List of column metadata for the table.

field tablename: str [Required]

Name of the table.