Web services APIs

Operations for managing and accessing VIANOPS webservices. Provides APIs support creating, deleting, searching for, and updating external connections.

vianops_client.api.webservices.external_connection

class ExternalConnectionV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

create(data: V1ExternalConnectionModel, output_type: str = 'object') → V1ExternalConnectionModel

Add external connection

Parameters:: data (V1ExternalConnectionModel) – Instance containing the data to add new external connection.
Returns:: Instance containing information about the created external connection.
Return type:: V1ExternalConnectionModel

delete(index: int) → dict | list

Delete external connection by its index.

Parameters:: index (int) – The index of the external connection to delete.
Returns:: A dictionary or a list containing information about the response from deleting external connection.
Return type:: Union[dict, list]

get_data(output_type: str = 'object') → V1ExternalConnectionModelList

Retrieve all external connections

Returns:: Instance containing information about all external connections.
Return type:: V1ExternalConnectionModelList

get_data_safe(output_type: str = 'object') → V1ExternalConnectionSlimModelList

Retrieve all external connections (secure)

Returns:: Instance containing information about all external connections.
Return type:: V1ExternalConnectionSlimModelList

search_by_name(name: str, output_type: str = 'object') → V1ExternalConnectionModel

Search external connections by name.

Parameters:: name (str) – The name to use to search for connection.
Returns:: Instance containing information about the external connections with the specified name.
Return type:: V1ExternalConnectionModel

search_columns(name: str, table: str) → dict | list

Retrieve columns of specified table within specified connection name.

Parameters:

name (str) – The name of connection containing the specified table.
table (str) – The name of the table containing the columns to retrieve.

Returns:

A dictionary or a list containing information about the columns of the specified table within the specified connection.

Return type:

Union[dict, list]

search_tables(name: str) → dict | list

Retrieve tables within external connections by name.

Parameters:: name (str) – The name of connection containing tables to retrieve.
Returns:: A dictionary or a list containing information about the tables within the connection with the specified name.
Return type:: Union[dict, list]

test_by_index(index: int) → dict | list

Test external connection by its index.

Parameters:: index (int) – The index of the external connection to test.
Returns:: A dictionary or a list containing information about results from connection test.
Return type:: Union[dict, list]

update(data: V1ExternalConnectionModel, output_type: str = 'object') → V1ExternalConnectionModel

Update an existing external connection

Parameters:: data (V1ExternalConnectionModel) – Instance containing the data to update external connection.
Returns:: Instance containing information about the updated external connection.
Return type:: V1ExternalConnectionModel

update_display(index: int, display: bool | None = None) → dict | list

Update the display value of external connection.

Parameters:

index (int) – The index of the external connection to update.
display (bool, optional) – The display value to set for the external connection.

Returns:

A dictionary or a list containing information about the updated external connection.

Return type:

Union[dict, list]

url_columns = '/v1/external-connections/{name}/tables/{table}/columns'

url_index = '/v1/external-connections/{index}'

url_name = '/v1/external-connections/name/{name}'

url_safe = '/v1/external-connections/safe'

url_suffix = '/v1/external-connections'

url_tables = '/v1/external-connections/{name}/tables'

url_test = '/v1/external-connections/{index}/test'