`kaskada.view`

Module Contents

`get_view_name`(view)
`list_views`([search, client])	Lists all the views the user has access to
`get_view`(view[, client])	Gets a view by name
`create_view`(view_name, expression[, client])	Creates a view with a name and expression
`delete_view`(view[, client, force])	Deletes a view

get_view_name(view)[source]

Parameters:: view (Union[kaskada.kaskada.v1alpha.view_service_pb2.View, kaskada.kaskada.v1alpha.view_service_pb2.CreateViewResponse, kaskada.kaskada.v1alpha.view_service_pb2.GetViewResponse, str]) –
Return type:: str

list_views(search=None, client=None)[source]

Lists all the views the user has access to

Parameters:

search (str, optional) – The search parameter to filter list by. Defaults to None.
client (Client, optional) – The Kaskada Client. Defaults to kaskada.KASKADA_DEFAULT_CLIENT.

Returns:

Response from the API

Return type:

view_pb.ListViewsResponse

get_view(view, client=None)[source]

Gets a view by name

Parameters:

view (Union[view_pb.View, view_pb.CreateViewResponse, view_pb.GetViewResponse, str]) – The target view object
client (Client, optional) – The Kaskada Client. Defaults to kaskada.KASKADA_DEFAULT_CLIENT.

Returns:

Response from the API

Return type:

view_pb.GetViewResponse

create_view(view_name, expression, client=None)[source]

Creates a view with a name and expression

Parameters:

view_name (str) – The view name
expression (str) – The view fenl expression
client (Client, optional) – The Kaskada Client. Defaults to kaskada.KASKADA_DEFAULT_CLIENT.

Returns:

Response from the API

Return type:

view_pb.CreateViewResponse

delete_view(view, client=None, force=False)[source]

Deletes a view

Parameters:

view (Union[view_pb.View, view_pb.CreateViewResponse, view_pb.GetViewResponse, str]) – The target view object
client (Client, optional) – The Kaskada Client. Defaults to kaskada.KASKADA_DEFAULT_CLIENT.
force (bool) –

Returns:

Response from the API

Return type:

view_pb.DeleteViewResponse