perceptic-core-client 0.6.0__py3-none-any.whl → 0.6.2__py3-none-any.whl

perceptic_core_client/perceptic_core_client/docs/ConnectionApiDto.md

@@ -0,0 +1,33 @@
+# ConnectionApiDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rid** | **str** |  | [optional] 
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**user_id** | **str** |  | [optional] 
+**settings** | [**ConnectionSettingsApiDto**](ConnectionSettingsApiDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.connection_api_dto import ConnectionApiDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectionApiDto from a JSON string
+connection_api_dto_instance = ConnectionApiDto.from_json(json)
+# print the JSON string representation of the object
+print(ConnectionApiDto.to_json())
+
+# convert the object into a dict
+connection_api_dto_dict = connection_api_dto_instance.to_dict()
+# create an instance of ConnectionApiDto from a dict
+connection_api_dto_from_dict = ConnectionApiDto.from_dict(connection_api_dto_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/ConnectionResourceApi.md

@@ -0,0 +1,144 @@
+# perceptic_core_client.ConnectionResourceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**api_v1_connections_connection_rid_get**](ConnectionResourceApi.md#api_v1_connections_connection_rid_get) | **GET** /api/v1/connections/{connectionRid} | Get Connection
+[**api_v1_connections_post**](ConnectionResourceApi.md#api_v1_connections_post) | **POST** /api/v1/connections | Create Connection
+
+
+# **api_v1_connections_connection_rid_get**
+> GetConnectionResponse api_v1_connections_connection_rid_get(connection_rid)
+
+Get Connection
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.get_connection_response import GetConnectionResponse
+from perceptic_core_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.ConnectionResourceApi(api_client)
+    connection_rid = 'connection_rid_example' # str | 
+
+    try:
+        # Get Connection
+        api_response = api_instance.api_v1_connections_connection_rid_get(connection_rid)
+        print("The response of ConnectionResourceApi->api_v1_connections_connection_rid_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ConnectionResourceApi->api_v1_connections_connection_rid_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **connection_rid** | **str**|  | 
+
+### Return type
+
+[**GetConnectionResponse**](GetConnectionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **api_v1_connections_post**
+> CreateConnectionResponse api_v1_connections_post(create_connection_request)
+
+Create Connection
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.create_connection_request import CreateConnectionRequest
+from perceptic_core_client.models.create_connection_response import CreateConnectionResponse
+from perceptic_core_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.ConnectionResourceApi(api_client)
+    create_connection_request = perceptic_core_client.CreateConnectionRequest() # CreateConnectionRequest | 
+
+    try:
+        # Create Connection
+        api_response = api_instance.api_v1_connections_post(create_connection_request)
+        print("The response of ConnectionResourceApi->api_v1_connections_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ConnectionResourceApi->api_v1_connections_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_connection_request** | [**CreateConnectionRequest**](CreateConnectionRequest.md)|  | 
+
+### Return type
+
+[**CreateConnectionResponse**](CreateConnectionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**400** | Bad Request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

perceptic_core_client/perceptic_core_client/docs/ConnectionSettingsApiDto.md

@@ -0,0 +1,36 @@
+# ConnectionSettingsApiDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **str** |  | [optional] 
+**region** | **str** |  | 
+**access_key** | **str** |  | 
+**secret_key** | **str** |  | 
+**url** | **str** |  | 
+**container** | **str** |  | 
+**credential_name** | **str** |  | 
+**credential_key** | **str** |  | 
+
+## Example
+
+```python
+from perceptic_core_client.models.connection_settings_api_dto import ConnectionSettingsApiDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectionSettingsApiDto from a JSON string
+connection_settings_api_dto_instance = ConnectionSettingsApiDto.from_json(json)
+# print the JSON string representation of the object
+print(ConnectionSettingsApiDto.to_json())
+
+# convert the object into a dict
+connection_settings_api_dto_dict = connection_settings_api_dto_instance.to_dict()
+# create an instance of ConnectionSettingsApiDto from a dict
+connection_settings_api_dto_from_dict = ConnectionSettingsApiDto.from_dict(connection_settings_api_dto_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateConnectionRequest.md

@@ -0,0 +1,31 @@
+# CreateConnectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**settings** | [**ConnectionSettingsApiDto**](ConnectionSettingsApiDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_connection_request import CreateConnectionRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateConnectionRequest from a JSON string
+create_connection_request_instance = CreateConnectionRequest.from_json(json)
+# print the JSON string representation of the object
+print(CreateConnectionRequest.to_json())
+
+# convert the object into a dict
+create_connection_request_dict = create_connection_request_instance.to_dict()
+# create an instance of CreateConnectionRequest from a dict
+create_connection_request_from_dict = CreateConnectionRequest.from_dict(create_connection_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateConnectionResponse.md

@@ -0,0 +1,29 @@
+# CreateConnectionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connection_rid** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_connection_response import CreateConnectionResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateConnectionResponse from a JSON string
+create_connection_response_instance = CreateConnectionResponse.from_json(json)
+# print the JSON string representation of the object
+print(CreateConnectionResponse.to_json())
+
+# convert the object into a dict
+create_connection_response_dict = create_connection_response_instance.to_dict()
+# create an instance of CreateConnectionResponse from a dict
+create_connection_response_from_dict = CreateConnectionResponse.from_dict(create_connection_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateFileSystemResponse.md

@@ -0,0 +1,29 @@
+# CreateFileSystemResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_system_rid** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_file_system_response import CreateFileSystemResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateFileSystemResponse from a JSON string
+create_file_system_response_instance = CreateFileSystemResponse.from_json(json)
+# print the JSON string representation of the object
+print(CreateFileSystemResponse.to_json())
+
+# convert the object into a dict
+create_file_system_response_dict = create_file_system_response_instance.to_dict()
+# create an instance of CreateFileSystemResponse from a dict
+create_file_system_response_from_dict = CreateFileSystemResponse.from_dict(create_file_system_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateFolderRequest.md

@@ -0,0 +1,29 @@
+# CreateFolderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folder_name** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_folder_request import CreateFolderRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateFolderRequest from a JSON string
+create_folder_request_instance = CreateFolderRequest.from_json(json)
+# print the JSON string representation of the object
+print(CreateFolderRequest.to_json())
+
+# convert the object into a dict
+create_folder_request_dict = create_folder_request_instance.to_dict()
+# create an instance of CreateFolderRequest from a dict
+create_folder_request_from_dict = CreateFolderRequest.from_dict(create_folder_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateFolderResponse.md

@@ -0,0 +1,29 @@
+# CreateFolderResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource_id** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_folder_response import CreateFolderResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateFolderResponse from a JSON string
+create_folder_response_instance = CreateFolderResponse.from_json(json)
+# print the JSON string representation of the object
+print(CreateFolderResponse.to_json())
+
+# convert the object into a dict
+create_folder_response_dict = create_folder_response_instance.to_dict()
+# create an instance of CreateFolderResponse from a dict
+create_folder_response_from_dict = CreateFolderResponse.from_dict(create_folder_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateIndexingTaskRequest.md

@@ -0,0 +1,33 @@
+# CreateIndexingTaskRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indexer_rid** | **str** |  | [optional] 
+**folder_uri** | **str** |  | [optional] 
+**namespace** | **str** |  | [optional] 
+**target_minimum_version** | **int** |  | [optional] 
+**settings** | **Dict[str, object]** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_indexing_task_request import CreateIndexingTaskRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateIndexingTaskRequest from a JSON string
+create_indexing_task_request_instance = CreateIndexingTaskRequest.from_json(json)
+# print the JSON string representation of the object
+print(CreateIndexingTaskRequest.to_json())
+
+# convert the object into a dict
+create_indexing_task_request_dict = create_indexing_task_request_instance.to_dict()
+# create an instance of CreateIndexingTaskRequest from a dict
+create_indexing_task_request_from_dict = CreateIndexingTaskRequest.from_dict(create_indexing_task_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateIndexingTaskResponse.md

@@ -0,0 +1,31 @@
+# CreateIndexingTaskResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_rid** | **str** |  | [optional] 
+**task** | [**IndexingTaskDto**](IndexingTaskDto.md) |  | [optional] 
+**created** | **bool** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_indexing_task_response import CreateIndexingTaskResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateIndexingTaskResponse from a JSON string
+create_indexing_task_response_instance = CreateIndexingTaskResponse.from_json(json)
+# print the JSON string representation of the object
+print(CreateIndexingTaskResponse.to_json())
+
+# convert the object into a dict
+create_indexing_task_response_dict = create_indexing_task_response_instance.to_dict()
+# create an instance of CreateIndexingTaskResponse from a dict
+create_indexing_task_response_from_dict = CreateIndexingTaskResponse.from_dict(create_indexing_task_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateManagedFileSystemRequest.md

@@ -0,0 +1,30 @@
+# CreateManagedFileSystemRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_managed_file_system_request import CreateManagedFileSystemRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateManagedFileSystemRequest from a JSON string
+create_managed_file_system_request_instance = CreateManagedFileSystemRequest.from_json(json)
+# print the JSON string representation of the object
+print(CreateManagedFileSystemRequest.to_json())
+
+# convert the object into a dict
+create_managed_file_system_request_dict = create_managed_file_system_request_instance.to_dict()
+# create an instance of CreateManagedFileSystemRequest from a dict
+create_managed_file_system_request_from_dict = CreateManagedFileSystemRequest.from_dict(create_managed_file_system_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/CreateRemoteFileSystemRequest.md

@@ -0,0 +1,32 @@
+# CreateRemoteFileSystemRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connection_rid** | **str** |  | [optional] 
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**metadata** | [**FileSystemRootMetadataApiDto**](FileSystemRootMetadataApiDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.create_remote_file_system_request import CreateRemoteFileSystemRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateRemoteFileSystemRequest from a JSON string
+create_remote_file_system_request_instance = CreateRemoteFileSystemRequest.from_json(json)
+# print the JSON string representation of the object
+print(CreateRemoteFileSystemRequest.to_json())
+
+# convert the object into a dict
+create_remote_file_system_request_dict = create_remote_file_system_request_instance.to_dict()
+# create an instance of CreateRemoteFileSystemRequest from a dict
+create_remote_file_system_request_from_dict = CreateRemoteFileSystemRequest.from_dict(create_remote_file_system_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

perceptic_core_client/perceptic_core_client/docs/FileSystemApiDto.md

@@ -0,0 +1,34 @@
+# FileSystemApiDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **str** |  | [optional] 
+**rid** | **str** |  | [optional] 
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**metadata** | [**FileSystemRootMetadataApiDto**](FileSystemRootMetadataApiDto.md) |  | [optional] 
+**connection_rid** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.file_system_api_dto import FileSystemApiDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FileSystemApiDto from a JSON string
+file_system_api_dto_instance = FileSystemApiDto.from_json(json)
+# print the JSON string representation of the object
+print(FileSystemApiDto.to_json())
+
+# convert the object into a dict
+file_system_api_dto_dict = file_system_api_dto_instance.to_dict()
+# create an instance of FileSystemApiDto from a dict
+file_system_api_dto_from_dict = FileSystemApiDto.from_dict(file_system_api_dto_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+