Metadata-Version: 2.1
Name: rockset-v2-alpha
Version: 0.0.3
Summary: The python client for the Rockset API.
Home-page: https://github.com/rockset/rockset-python-client
Author: Rockset
Author-email: support@rockset.com
Requires-Python: >=3.6,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: geojson (>=2.5.0,<3.0.0)
Requires-Dist: python_dateutil (>=2.5.3,<3.0.0)
Requires-Dist: urllib3 (>=1.25.3,<2.0.0)
Project-URL: Repository, https://github.com/rockset/rockset-python-client
Description-Content-Type: text/markdown

## In progress
- README postprocessing
- polishing
- QA
- complete last part of async support

# rockset
Rockset's REST API allows for creating and managing all resources in Rockset. Each supported endpoint is documented below.

All requests must be authorized with a Rockset API key, which can be created in the [Rockset console](https://console.rockset.com). The API key must be provided as `ApiKey <api_key>` in the `Authorization` request header. For example:
```
Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT
```

All endpoints are only accessible via https.

Build something awesome!

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >=3.6

## Installation & Usage
### pip install

```sh
pip install rockset-v2-alpha
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import rockset
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import rockset
from pprint import pprint
from rockset.api import api_keys_api
from rockset.model.create_api_key_request import CreateApiKeyRequest
from rockset.model.create_api_key_response import CreateApiKeyResponse
from rockset.model.delete_api_key_response import DeleteApiKeyResponse
from rockset.model.error_model import ErrorModel
from rockset.model.get_api_key_response import GetApiKeyResponse
from rockset.model.list_api_keys_response import ListApiKeysResponse
from rockset.model.update_api_key_request import UpdateApiKeyRequest
from rockset.model.update_api_key_response import UpdateApiKeyResponse

# Enter a context with an instance of the API client
# Defining the host is optional and defaults to https://api.rs2.usw2.rockset.com
with rockset.RocksetClient(host="https://api.rs2.usw2.rockset.com", apikey="APIKEY") as rs:
    try:
        rs.APIKeysApi.create_api_key(name="api-key-name", role="member")
    except rockset.ApiException as e:
        print("Exception when calling ApiKey->create_api_key: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://api.rs2.usw2.rockset.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**create_api_key**](docs/APIKeysApi.md#create_api_key) | **POST** /v1/orgs/self/users/self/apikeys | Create API Key
*APIKeysApi* | [**delete_api_key**](docs/APIKeysApi.md#delete_api_key) | **DELETE** /v1/orgs/self/users/{user}/apikeys/{name} | Delete API Key
*APIKeysApi* | [**get_api_key**](docs/APIKeysApi.md#get_api_key) | **GET** /v1/orgs/self/users/{user}/apikeys/{name} | Retrieve API Key
*APIKeysApi* | [**list_api_keys**](docs/APIKeysApi.md#list_api_keys) | **GET** /v1/orgs/self/users/{user}/apikeys | List API Keys
*APIKeysApi* | [**update_api_key**](docs/APIKeysApi.md#update_api_key) | **POST** /v1/orgs/self/users/{user}/apikeys/{name} | Update API Key State
*AliasesApi* | [**create_alias**](docs/AliasesApi.md#create_alias) | **POST** /v1/orgs/self/ws/{workspace}/aliases | Create Alias
*AliasesApi* | [**delete_alias**](docs/AliasesApi.md#delete_alias) | **DELETE** /v1/orgs/self/ws/{workspace}/aliases/{alias} | Delete Alias
*AliasesApi* | [**get_alias**](docs/AliasesApi.md#get_alias) | **GET** /v1/orgs/self/ws/{workspace}/aliases/{alias} | Retrieve Alias
*AliasesApi* | [**list_aliases**](docs/AliasesApi.md#list_aliases) | **GET** /v1/orgs/self/aliases | List Aliases
*AliasesApi* | [**update_alias**](docs/AliasesApi.md#update_alias) | **POST** /v1/orgs/self/ws/{workspace}/aliases/{alias} | Update Alias
*AliasesApi* | [**workspace_aliases**](docs/AliasesApi.md#workspace_aliases) | **GET** /v1/orgs/self/ws/{workspace}/aliases | List Aliases in Workspace
*CollectionsApi* | [**create_azure_blob_storage_collection**](docs/CollectionsApi.md#create_azure_blob_storage_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#AzureBlobStorage | Create azure blob storage collection
*CollectionsApi* | [**create_azure_event_hubs_collection**](docs/CollectionsApi.md#create_azure_event_hubs_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#AzureEventHubs | Create azure event hubs collection
*CollectionsApi* | [**create_azure_service_bus_collection**](docs/CollectionsApi.md#create_azure_service_bus_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#AzureServiceBus | Create azure service bus collection
*CollectionsApi* | [**create_dynamodb_collection**](docs/CollectionsApi.md#create_dynamodb_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#Dynamodb | Create dynamodb collection
*CollectionsApi* | [**create_file_upload_collection**](docs/CollectionsApi.md#create_file_upload_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#FileUpload | Create file upload collection
*CollectionsApi* | [**create_gcs_collection**](docs/CollectionsApi.md#create_gcs_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#Gcs | Create gcs collection
*CollectionsApi* | [**create_kafka_collection**](docs/CollectionsApi.md#create_kafka_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#Kafka | Create kafka collection
*CollectionsApi* | [**create_kinesis_collection**](docs/CollectionsApi.md#create_kinesis_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#Kinesis | Create kinesis collection
*CollectionsApi* | [**create_mongodb_collection**](docs/CollectionsApi.md#create_mongodb_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#Mongodb | Create mongodb collection
*CollectionsApi* | [**create_s3_collection**](docs/CollectionsApi.md#create_s3_collection) | **POST** /v1/orgs/self/ws/{workspace}/collections#S3 | Create s3 collection
*CollectionsApi* | [**delete_collection**](docs/CollectionsApi.md#delete_collection) | **DELETE** /v1/orgs/self/ws/{workspace}/collections/{collection} | Delete Collection
*CollectionsApi* | [**get_collection**](docs/CollectionsApi.md#get_collection) | **GET** /v1/orgs/self/ws/{workspace}/collections/{collection} | Retrieve Collection
*CollectionsApi* | [**list_collections**](docs/CollectionsApi.md#list_collections) | **GET** /v1/orgs/self/collections | List Collections
*CollectionsApi* | [**workspace_collections**](docs/CollectionsApi.md#workspace_collections) | **GET** /v1/orgs/self/ws/{workspace}/collections | List Collections in Workspace
*CustomRolesBetaApi* | [**create_role**](docs/CustomRolesBetaApi.md#create_role) | **POST** /v1/orgs/self/roles | Create a Role
*CustomRolesBetaApi* | [**delete_role**](docs/CustomRolesBetaApi.md#delete_role) | **DELETE** /v1/orgs/self/roles/{roleName} | Delete a Role
*CustomRolesBetaApi* | [**list_roles**](docs/CustomRolesBetaApi.md#list_roles) | **GET** /v1/orgs/self/roles | List Roles
*CustomRolesBetaApi* | [**update_role**](docs/CustomRolesBetaApi.md#update_role) | **POST** /v1/orgs/self/roles/{roleName} | Update a Role
*DocumentsApi* | [**add_documents**](docs/DocumentsApi.md#add_documents) | **POST** /v1/orgs/self/ws/{workspace}/collections/{collection}/docs | Add Documents
*DocumentsApi* | [**delete_documents**](docs/DocumentsApi.md#delete_documents) | **DELETE** /v1/orgs/self/ws/{workspace}/collections/{collection}/docs | Delete Documents
*DocumentsApi* | [**patch_documents**](docs/DocumentsApi.md#patch_documents) | **PATCH** /v1/orgs/self/ws/{workspace}/collections/{collection}/docs | Patch Documents
*IntegrationsApi* | [**create_azure_blob_storage_integration**](docs/IntegrationsApi.md#create_azure_blob_storage_integration) | **POST** /v1/orgs/self/integrations#AzureBlobStorage | Create azure blob storage integration
*IntegrationsApi* | [**create_azure_event_hubs_integration**](docs/IntegrationsApi.md#create_azure_event_hubs_integration) | **POST** /v1/orgs/self/integrations#AzureEventHubs | Create azure event hubs integration
*IntegrationsApi* | [**create_dynamodb_integration**](docs/IntegrationsApi.md#create_dynamodb_integration) | **POST** /v1/orgs/self/integrations#Dynamodb | Create dynamodb integration
*IntegrationsApi* | [**create_gcs_integration**](docs/IntegrationsApi.md#create_gcs_integration) | **POST** /v1/orgs/self/integrations#Gcs | Create gcs integration
*IntegrationsApi* | [**create_kafka_integration**](docs/IntegrationsApi.md#create_kafka_integration) | **POST** /v1/orgs/self/integrations#Kafka | Create kafka integration
*IntegrationsApi* | [**create_kinesis_integration**](docs/IntegrationsApi.md#create_kinesis_integration) | **POST** /v1/orgs/self/integrations#Kinesis | Create kinesis integration
*IntegrationsApi* | [**create_mongodb_integration**](docs/IntegrationsApi.md#create_mongodb_integration) | **POST** /v1/orgs/self/integrations#Mongodb | Create mongodb integration
*IntegrationsApi* | [**create_s3_integration**](docs/IntegrationsApi.md#create_s3_integration) | **POST** /v1/orgs/self/integrations#S3 | Create s3 integration
*IntegrationsApi* | [**create_segment_integration**](docs/IntegrationsApi.md#create_segment_integration) | **POST** /v1/orgs/self/integrations#Segment | Create segment integration
*IntegrationsApi* | [**delete_integration**](docs/IntegrationsApi.md#delete_integration) | **DELETE** /v1/orgs/self/integrations/{integration} | Delete Integration
*IntegrationsApi* | [**get_integration**](docs/IntegrationsApi.md#get_integration) | **GET** /v1/orgs/self/integrations/{integration} | Retrieve Integration
*IntegrationsApi* | [**list_integrations**](docs/IntegrationsApi.md#list_integrations) | **GET** /v1/orgs/self/integrations | List Integrations
*OrganizationsApi* | [**get_organization**](docs/OrganizationsApi.md#get_organization) | **GET** /v1/orgs/self | Get Organization
*QueriesApi* | [**query**](docs/QueriesApi.md#query) | **POST** /v1/orgs/self/queries | Query
*QueriesApi* | [**validate**](docs/QueriesApi.md#validate) | **POST** /v1/orgs/self/queries/validations | Validate Query
*QueryLambdasApi* | [**create_query_lambda**](docs/QueryLambdasApi.md#create_query_lambda) | **POST** /v1/orgs/self/ws/{workspace}/lambdas | Create Query Lambda
*QueryLambdasApi* | [**create_query_lambda_tag**](docs/QueryLambdasApi.md#create_query_lambda_tag) | **POST** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags | Create Query Lambda Tag
*QueryLambdasApi* | [**delete_query_lambda**](docs/QueryLambdasApi.md#delete_query_lambda) | **DELETE** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda} | Delete Query Lambda
*QueryLambdasApi* | [**delete_query_lambda_tag**](docs/QueryLambdasApi.md#delete_query_lambda_tag) | **DELETE** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag} | Delete Query Lambda Tag Version
*QueryLambdasApi* | [**delete_query_lambda_version**](docs/QueryLambdasApi.md#delete_query_lambda_version) | **DELETE** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/version/{version} | Delete Query Lambda Version
*QueryLambdasApi* | [**execute_query_lambda**](docs/QueryLambdasApi.md#execute_query_lambda) | **POST** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version} | Execute Query Lambda By Version
*QueryLambdasApi* | [**execute_query_lambda_by_tag**](docs/QueryLambdasApi.md#execute_query_lambda_by_tag) | **POST** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag} | Execute Query Lambda By Tag
*QueryLambdasApi* | [**get_query_lambda_tag_version**](docs/QueryLambdasApi.md#get_query_lambda_tag_version) | **GET** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags/{tag} | Retrieve Query Lambda Tag
*QueryLambdasApi* | [**get_query_lambda_version**](docs/QueryLambdasApi.md#get_query_lambda_version) | **GET** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version} | Retrieve Query Lambda Version
*QueryLambdasApi* | [**list_all_query_lambdas**](docs/QueryLambdasApi.md#list_all_query_lambdas) | **GET** /v1/orgs/self/lambdas | List Query Lambdas
*QueryLambdasApi* | [**list_query_lambda_tags**](docs/QueryLambdasApi.md#list_query_lambda_tags) | **GET** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/tags | List Query Lambda Tags
*QueryLambdasApi* | [**list_query_lambda_versions**](docs/QueryLambdasApi.md#list_query_lambda_versions) | **GET** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions | List Query Lambda Versions
*QueryLambdasApi* | [**list_query_lambdas_in_workspace**](docs/QueryLambdasApi.md#list_query_lambdas_in_workspace) | **GET** /v1/orgs/self/ws/{workspace}/lambdas | List Query Lambdas in Workspace
*QueryLambdasApi* | [**update_query_lambda**](docs/QueryLambdasApi.md#update_query_lambda) | **POST** /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions | Update Query Lambda
*UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /v1/orgs/self/users | Create User
*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /v1/orgs/self/users/{user} | Delete User
*UsersApi* | [**get_current_user**](docs/UsersApi.md#get_current_user) | **GET** /v1/orgs/self/users/self | Retrieve Current User
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /v1/orgs/self/users/{user} | Retrieve User
*UsersApi* | [**list_unsubscribe_preferences**](docs/UsersApi.md#list_unsubscribe_preferences) | **GET** /v1/orgs/self/users/self/preferences | Retrieve Notification Preferences
*UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /v1/orgs/self/users | List Users
*UsersApi* | [**update_unsubscribe_preferences**](docs/UsersApi.md#update_unsubscribe_preferences) | **POST** /v1/orgs/self/users/self/preferences | Update Notification Preferences
*ViewsApi* | [**create_view**](docs/ViewsApi.md#create_view) | **POST** /v1/orgs/self/ws/{workspace}/views | Create View
*ViewsApi* | [**delete_view**](docs/ViewsApi.md#delete_view) | **DELETE** /v1/orgs/self/ws/{workspace}/views/{view} | Delete View
*ViewsApi* | [**get_view**](docs/ViewsApi.md#get_view) | **GET** /v1/orgs/self/ws/{workspace}/views/{view} | Retrieve View
*ViewsApi* | [**list_views**](docs/ViewsApi.md#list_views) | **GET** /v1/orgs/self/views | List Views
*ViewsApi* | [**update_view**](docs/ViewsApi.md#update_view) | **POST** /v1/orgs/self/ws/{workspace}/views/{view} | Update View
*ViewsApi* | [**workspace_views**](docs/ViewsApi.md#workspace_views) | **GET** /v1/orgs/self/ws/{workspace}/views | List Views in Workspace
*VirtualInstancesApi* | [**get_virtual_instance**](docs/VirtualInstancesApi.md#get_virtual_instance) | **GET** /v1/orgs/self/virtualinstances/{virtualInstanceId} | Retrieve Virtual Instance
*VirtualInstancesApi* | [**list_virtual_instances**](docs/VirtualInstancesApi.md#list_virtual_instances) | **GET** /v1/orgs/self/virtualinstances | List Virtual Instances
*VirtualInstancesApi* | [**set_virtual_instance**](docs/VirtualInstancesApi.md#set_virtual_instance) | **POST** /v1/orgs/self/virtualinstances/{virtualInstanceId} | Update Virtual Instance
*WorkspacesApi* | [**child_workspaces**](docs/WorkspacesApi.md#child_workspaces) | **GET** /v1/orgs/self/ws/{workspace}/ws | List Workspaces in Workspace
*WorkspacesApi* | [**create_workspace**](docs/WorkspacesApi.md#create_workspace) | **POST** /v1/orgs/self/ws | Create Workspace
*WorkspacesApi* | [**delete_workspace**](docs/WorkspacesApi.md#delete_workspace) | **DELETE** /v1/orgs/self/ws/{workspace} | Delete Workspace
*WorkspacesApi* | [**get_workspace**](docs/WorkspacesApi.md#get_workspace) | **GET** /v1/orgs/self/ws/{workspace} | Retrieve Workspace
*WorkspacesApi* | [**list_workspaces**](docs/WorkspacesApi.md#list_workspaces) | **GET** /v1/orgs/self/ws | List Workspaces


## Documentation For Models

 - [AddDocumentsRequest](docs/AddDocumentsRequest.md)
 - [AddDocumentsResponse](docs/AddDocumentsResponse.md)
 - [Alias](docs/Alias.md)
 - [ApiKey](docs/ApiKey.md)
 - [AwsAccessKey](docs/AwsAccessKey.md)
 - [AwsRole](docs/AwsRole.md)
 - [AzureBlobStorageCollectionCreationRequest](docs/AzureBlobStorageCollectionCreationRequest.md)
 - [AzureBlobStorageIntegration](docs/AzureBlobStorageIntegration.md)
 - [AzureBlobStorageIntegrationCreationRequest](docs/AzureBlobStorageIntegrationCreationRequest.md)
 - [AzureBlobStorageSourceWrapper](docs/AzureBlobStorageSourceWrapper.md)
 - [AzureEventHubsCollectionCreationRequest](docs/AzureEventHubsCollectionCreationRequest.md)
 - [AzureEventHubsIntegration](docs/AzureEventHubsIntegration.md)
 - [AzureEventHubsIntegrationCreationRequest](docs/AzureEventHubsIntegrationCreationRequest.md)
 - [AzureEventHubsSourceWrapper](docs/AzureEventHubsSourceWrapper.md)
 - [AzureServiceBusCollectionCreationRequest](docs/AzureServiceBusCollectionCreationRequest.md)
 - [AzureServiceBusIntegration](docs/AzureServiceBusIntegration.md)
 - [AzureServiceBusSourceWrapper](docs/AzureServiceBusSourceWrapper.md)
 - [Cluster](docs/Cluster.md)
 - [Collection](docs/Collection.md)
 - [CollectionStats](docs/CollectionStats.md)
 - [CreateAliasRequest](docs/CreateAliasRequest.md)
 - [CreateAliasResponse](docs/CreateAliasResponse.md)
 - [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
 - [CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
 - [CreateCollectionRequest](docs/CreateCollectionRequest.md)
 - [CreateCollectionResponse](docs/CreateCollectionResponse.md)
 - [CreateIntegrationRequest](docs/CreateIntegrationRequest.md)
 - [CreateIntegrationResponse](docs/CreateIntegrationResponse.md)
 - [CreateQueryLambdaRequest](docs/CreateQueryLambdaRequest.md)
 - [CreateQueryLambdaTagRequest](docs/CreateQueryLambdaTagRequest.md)
 - [CreateRoleRequest](docs/CreateRoleRequest.md)
 - [CreateUserRequest](docs/CreateUserRequest.md)
 - [CreateUserResponse](docs/CreateUserResponse.md)
 - [CreateViewRequest](docs/CreateViewRequest.md)
 - [CreateViewResponse](docs/CreateViewResponse.md)
 - [CreateWorkspaceRequest](docs/CreateWorkspaceRequest.md)
 - [CreateWorkspaceResponse](docs/CreateWorkspaceResponse.md)
 - [CsvParams](docs/CsvParams.md)
 - [DeleteAliasResponse](docs/DeleteAliasResponse.md)
 - [DeleteApiKeyResponse](docs/DeleteApiKeyResponse.md)
 - [DeleteCollectionResponse](docs/DeleteCollectionResponse.md)
 - [DeleteDocumentsRequest](docs/DeleteDocumentsRequest.md)
 - [DeleteDocumentsRequestData](docs/DeleteDocumentsRequestData.md)
 - [DeleteDocumentsResponse](docs/DeleteDocumentsResponse.md)
 - [DeleteIntegrationResponse](docs/DeleteIntegrationResponse.md)
 - [DeleteQueryLambdaResponse](docs/DeleteQueryLambdaResponse.md)
 - [DeleteUserResponse](docs/DeleteUserResponse.md)
 - [DeleteViewResponse](docs/DeleteViewResponse.md)
 - [DeleteWorkspaceResponse](docs/DeleteWorkspaceResponse.md)
 - [DocumentStatus](docs/DocumentStatus.md)
 - [DynamodbCollectionCreationRequest](docs/DynamodbCollectionCreationRequest.md)
 - [DynamodbIntegration](docs/DynamodbIntegration.md)
 - [DynamodbIntegrationCreationRequest](docs/DynamodbIntegrationCreationRequest.md)
 - [DynamodbSourceWrapper](docs/DynamodbSourceWrapper.md)
 - [ErrorModel](docs/ErrorModel.md)
 - [EventTimeInfo](docs/EventTimeInfo.md)
 - [ExecuteQueryLambdaRequest](docs/ExecuteQueryLambdaRequest.md)
 - [FieldMappingQuery](docs/FieldMappingQuery.md)
 - [FieldMappingV2](docs/FieldMappingV2.md)
 - [FieldMask](docs/FieldMask.md)
 - [FieldMaskMask](docs/FieldMaskMask.md)
 - [FieldOptions](docs/FieldOptions.md)
 - [FieldPartition](docs/FieldPartition.md)
 - [FieldSchema](docs/FieldSchema.md)
 - [FileUploadCollectionCreationRequest](docs/FileUploadCollectionCreationRequest.md)
 - [FileUploadSourceWrapper](docs/FileUploadSourceWrapper.md)
 - [FormatParams](docs/FormatParams.md)
 - [GcpServiceAccount](docs/GcpServiceAccount.md)
 - [GcsCollectionCreationRequest](docs/GcsCollectionCreationRequest.md)
 - [GcsIntegration](docs/GcsIntegration.md)
 - [GcsIntegrationCreationRequest](docs/GcsIntegrationCreationRequest.md)
 - [GcsSourceWrapper](docs/GcsSourceWrapper.md)
 - [GetAliasResponse](docs/GetAliasResponse.md)
 - [GetApiKeyResponse](docs/GetApiKeyResponse.md)
 - [GetCollectionResponse](docs/GetCollectionResponse.md)
 - [GetIntegrationResponse](docs/GetIntegrationResponse.md)
 - [GetViewResponse](docs/GetViewResponse.md)
 - [GetVirtualInstanceResponse](docs/GetVirtualInstanceResponse.md)
 - [GetWorkspaceResponse](docs/GetWorkspaceResponse.md)
 - [InputField](docs/InputField.md)
 - [Integration](docs/Integration.md)
 - [InvertedIndexGroupEncodingOptions](docs/InvertedIndexGroupEncodingOptions.md)
 - [KafkaCollectionCreationRequest](docs/KafkaCollectionCreationRequest.md)
 - [KafkaIntegration](docs/KafkaIntegration.md)
 - [KafkaIntegrationCreationRequest](docs/KafkaIntegrationCreationRequest.md)
 - [KafkaSourceWrapper](docs/KafkaSourceWrapper.md)
 - [KafkaV3SecurityConfig](docs/KafkaV3SecurityConfig.md)
 - [KinesisCollectionCreationRequest](docs/KinesisCollectionCreationRequest.md)
 - [KinesisIntegration](docs/KinesisIntegration.md)
 - [KinesisIntegrationCreationRequest](docs/KinesisIntegrationCreationRequest.md)
 - [KinesisStorageSourceWrapper](docs/KinesisStorageSourceWrapper.md)
 - [ListAliasesResponse](docs/ListAliasesResponse.md)
 - [ListApiKeysResponse](docs/ListApiKeysResponse.md)
 - [ListCollectionsResponse](docs/ListCollectionsResponse.md)
 - [ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
 - [ListQueryLambdaTagsResponse](docs/ListQueryLambdaTagsResponse.md)
 - [ListQueryLambdaVersionsResponse](docs/ListQueryLambdaVersionsResponse.md)
 - [ListQueryLambdasResponse](docs/ListQueryLambdasResponse.md)
 - [ListRolesResponse](docs/ListRolesResponse.md)
 - [ListUnsubscribePreferencesResponse](docs/ListUnsubscribePreferencesResponse.md)
 - [ListUsersResponse](docs/ListUsersResponse.md)
 - [ListViewsResponse](docs/ListViewsResponse.md)
 - [ListVirtualInstancesResponse](docs/ListVirtualInstancesResponse.md)
 - [ListWorkspacesResponse](docs/ListWorkspacesResponse.md)
 - [MongoDbIntegration](docs/MongoDbIntegration.md)
 - [MongodbCollectionCreationRequest](docs/MongodbCollectionCreationRequest.md)
 - [MongodbIntegrationCreationRequest](docs/MongodbIntegrationCreationRequest.md)
 - [MongodbSourceWrapper](docs/MongodbSourceWrapper.md)
 - [Organization](docs/Organization.md)
 - [OrganizationResponse](docs/OrganizationResponse.md)
 - [OutputField](docs/OutputField.md)
 - [PaginationInfo](docs/PaginationInfo.md)
 - [PatchDocument](docs/PatchDocument.md)
 - [PatchDocumentsRequest](docs/PatchDocumentsRequest.md)
 - [PatchDocumentsResponse](docs/PatchDocumentsResponse.md)
 - [PatchOperation](docs/PatchOperation.md)
 - [Privilege](docs/Privilege.md)
 - [QueryError](docs/QueryError.md)
 - [QueryFieldType](docs/QueryFieldType.md)
 - [QueryLambda](docs/QueryLambda.md)
 - [QueryLambdaSql](docs/QueryLambdaSql.md)
 - [QueryLambdaStats](docs/QueryLambdaStats.md)
 - [QueryLambdaTag](docs/QueryLambdaTag.md)
 - [QueryLambdaTagResponse](docs/QueryLambdaTagResponse.md)
 - [QueryLambdaVersion](docs/QueryLambdaVersion.md)
 - [QueryLambdaVersionResponse](docs/QueryLambdaVersionResponse.md)
 - [QueryParameter](docs/QueryParameter.md)
 - [QueryRequest](docs/QueryRequest.md)
 - [QueryRequestSql](docs/QueryRequestSql.md)
 - [QueryResponse](docs/QueryResponse.md)
 - [QueryResponseStats](docs/QueryResponseStats.md)
 - [Role](docs/Role.md)
 - [RoleResponse](docs/RoleResponse.md)
 - [S3CollectionCreationRequest](docs/S3CollectionCreationRequest.md)
 - [S3Integration](docs/S3Integration.md)
 - [S3IntegrationCreationRequest](docs/S3IntegrationCreationRequest.md)
 - [S3SourceWrapper](docs/S3SourceWrapper.md)
 - [SegmentIntegration](docs/SegmentIntegration.md)
 - [SegmentIntegrationCreationRequest](docs/SegmentIntegrationCreationRequest.md)
 - [Source](docs/Source.md)
 - [SourceAzureBlobStorage](docs/SourceAzureBlobStorage.md)
 - [SourceAzureEventHubs](docs/SourceAzureEventHubs.md)
 - [SourceAzureServiceBus](docs/SourceAzureServiceBus.md)
 - [SourceDynamoDb](docs/SourceDynamoDb.md)
 - [SourceFileUpload](docs/SourceFileUpload.md)
 - [SourceGcs](docs/SourceGcs.md)
 - [SourceKafka](docs/SourceKafka.md)
 - [SourceKinesis](docs/SourceKinesis.md)
 - [SourceMongoDb](docs/SourceMongoDb.md)
 - [SourceS3](docs/SourceS3.md)
 - [SqlExpression](docs/SqlExpression.md)
 - [Status](docs/Status.md)
 - [StatusAzureEventHubs](docs/StatusAzureEventHubs.md)
 - [StatusAzureEventHubsPartition](docs/StatusAzureEventHubsPartition.md)
 - [StatusAzureServiceBus](docs/StatusAzureServiceBus.md)
 - [StatusAzureServiceBusSession](docs/StatusAzureServiceBusSession.md)
 - [StatusDynamoDb](docs/StatusDynamoDb.md)
 - [StatusDynamoDbV2](docs/StatusDynamoDbV2.md)
 - [StatusKafka](docs/StatusKafka.md)
 - [StatusKafkaPartition](docs/StatusKafkaPartition.md)
 - [StatusMongoDb](docs/StatusMongoDb.md)
 - [UnsubscribePreference](docs/UnsubscribePreference.md)
 - [UpdateAliasRequest](docs/UpdateAliasRequest.md)
 - [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
 - [UpdateApiKeyResponse](docs/UpdateApiKeyResponse.md)
 - [UpdateQueryLambdaRequest](docs/UpdateQueryLambdaRequest.md)
 - [UpdateRoleRequest](docs/UpdateRoleRequest.md)
 - [UpdateUnsubscribePreferencesRequest](docs/UpdateUnsubscribePreferencesRequest.md)
 - [UpdateUnsubscribePreferencesResponse](docs/UpdateUnsubscribePreferencesResponse.md)
 - [UpdateViewRequest](docs/UpdateViewRequest.md)
 - [UpdateViewResponse](docs/UpdateViewResponse.md)
 - [UpdateVirtualInstanceRequest](docs/UpdateVirtualInstanceRequest.md)
 - [UpdateVirtualInstanceResponse](docs/UpdateVirtualInstanceResponse.md)
 - [User](docs/User.md)
 - [ValidateQueryResponse](docs/ValidateQueryResponse.md)
 - [View](docs/View.md)
 - [VirtualInstance](docs/VirtualInstance.md)
 - [Workspace](docs/Workspace.md)
 - [XmlParams](docs/XmlParams.md)


## Documentation For Authorization

The RocksetClient object must be instantiated with an apikey. You can create your first apikey in the [Rockset console](https://console.rockset.com/apikeys). The provided apikey will be used for all requests that are made using the instance of the client.

## Author

Rockset

## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in rockset.apis and rockset.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1:
Use specific imports for apis and models like:
- `from rockset.api.default_api import DefaultApi`
- `from rockset.model.pet import Pet`

Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import rockset
from rockset.apis import *
from rockset.models import *
```


