Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update from release_2024.01.31 #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ docs/DeleteUserResponse.md
docs/DeleteViewResponse.md
docs/DeleteVirtualInstanceResponse.md
docs/DeleteWorkspaceResponse.md
docs/DeploymentSettings.md
docs/DeploymentSettingsApi.md
docs/DeploymentSettingsResponse.md
docs/DocumentStatus.md
docs/DocumentsApi.md
docs/DynamodbCollectionCreationRequest.md
Expand Down Expand Up @@ -219,6 +222,7 @@ docs/UpdateAliasRequest.md
docs/UpdateApiKeyRequest.md
docs/UpdateApiKeyResponse.md
docs/UpdateCollectionRequest.md
docs/UpdateDeploymentSettingsRequest.md
docs/UpdateIntegrationRequest.md
docs/UpdateIntegrationResponse.md
docs/UpdateQueryLambdaRequest.md
Expand Down Expand Up @@ -249,6 +253,7 @@ rockset/api/aliases_api.py
rockset/api/api_keys_api.py
rockset/api/collections_api.py
rockset/api/custom_roles_api.py
rockset/api/deployment_settings_api.py
rockset/api/documents_api.py
rockset/api/integrations_api.py
rockset/api/organizations_api.py
Expand Down Expand Up @@ -327,6 +332,8 @@ rockset/model/delete_user_response.py
rockset/model/delete_view_response.py
rockset/model/delete_virtual_instance_response.py
rockset/model/delete_workspace_response.py
rockset/model/deployment_settings.py
rockset/model/deployment_settings_response.py
rockset/model/document_status.py
rockset/model/dynamodb_collection_creation_request.py
rockset/model/dynamodb_integration.py
Expand Down Expand Up @@ -472,6 +479,7 @@ rockset/model/update_alias_request.py
rockset/model/update_api_key_request.py
rockset/model/update_api_key_response.py
rockset/model/update_collection_request.py
rockset/model/update_deployment_settings_request.py
rockset/model/update_integration_request.py
rockset/model/update_integration_response.py
rockset/model/update_query_lambda_request.py
Expand Down Expand Up @@ -562,6 +570,9 @@ test/test_delete_user_response.py
test/test_delete_view_response.py
test/test_delete_virtual_instance_response.py
test/test_delete_workspace_response.py
test/test_deployment_settings.py
test/test_deployment_settings_api.py
test/test_deployment_settings_response.py
test/test_document_status.py
test/test_documents_api.py
test/test_dynamodb_collection_creation_request.py
Expand Down Expand Up @@ -717,6 +728,7 @@ test/test_update_alias_request.py
test/test_update_api_key_request.py
test/test_update_api_key_response.py
test/test_update_collection_request.py
test/test_update_deployment_settings_request.py
test/test_update_integration_request.py
test/test_update_integration_response.py
test/test_update_query_lambda_request.py
Expand Down
3 changes: 3 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
### v2.2.0
- TODO

### v2.1.0
- Get Collection Offset APIs

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,8 @@ Class | Method | HTTP request | Description
*CustomRoles* | [**get**](docs/CustomRolesApi.md#get) | **GET** /v1/orgs/self/roles/{roleName} | Retrieve role
*CustomRoles* | [**list**](docs/CustomRolesApi.md#list) | **GET** /v1/orgs/self/roles | List Roles
*CustomRoles* | [**update**](docs/CustomRolesApi.md#update) | **POST** /v1/orgs/self/roles/{roleName} | Update a Role
*DeploymentSettings* | [**get_deployment_settings**](docs/DeploymentSettingsApi.md#get_deployment_settings) | **GET** /v1/orgs/self/deploymentsettings | Retrieve Deployment Settings
*DeploymentSettings* | [**update_deployment_settings**](docs/DeploymentSettingsApi.md#update_deployment_settings) | **PUT** /v1/orgs/self/deploymentsettings | Update Deployment Settings
*Documents* | [**add_documents**](docs/DocumentsApi.md#add_documents) | **POST** /v1/orgs/self/ws/{workspace}/collections/{collection}/docs | Add Documents
*Documents* | [**delete_documents**](docs/DocumentsApi.md#delete_documents) | **DELETE** /v1/orgs/self/ws/{workspace}/collections/{collection}/docs | Delete Documents
*Documents* | [**patch_documents**](docs/DocumentsApi.md#patch_documents) | **PATCH** /v1/orgs/self/ws/{workspace}/collections/{collection}/docs | Patch Documents
Expand Down Expand Up @@ -311,6 +313,8 @@ Class | Method | HTTP request | Description
- [DeleteViewResponse](docs/DeleteViewResponse.md)
- [DeleteVirtualInstanceResponse](docs/DeleteVirtualInstanceResponse.md)
- [DeleteWorkspaceResponse](docs/DeleteWorkspaceResponse.md)
- [DeploymentSettings](docs/DeploymentSettings.md)
- [DeploymentSettingsResponse](docs/DeploymentSettingsResponse.md)
- [DocumentStatus](docs/DocumentStatus.md)
- [DynamodbCollectionCreationRequest](docs/DynamodbCollectionCreationRequest.md)
- [DynamodbIntegration](docs/DynamodbIntegration.md)
Expand Down Expand Up @@ -458,6 +462,7 @@ Class | Method | HTTP request | Description
- [UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
- [UpdateApiKeyResponse](docs/UpdateApiKeyResponse.md)
- [UpdateCollectionRequest](docs/UpdateCollectionRequest.md)
- [UpdateDeploymentSettingsRequest](docs/UpdateDeploymentSettingsRequest.md)
- [UpdateIntegrationRequest](docs/UpdateIntegrationRequest.md)
- [UpdateIntegrationResponse](docs/UpdateIntegrationResponse.md)
- [UpdateQueryLambdaRequest](docs/UpdateQueryLambdaRequest.md)
Expand Down
1 change: 1 addition & 0 deletions docs/CreateIntegrationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**description** | **str** | Longer explanation for the integration. | [optional]
**dynamodb** | [**DynamodbIntegration**](DynamodbIntegration.md) | | [optional]
**gcs** | [**GcsIntegration**](GcsIntegration.md) | | [optional]
**is_write_enabled** | **bool** | is write access enabled for this integration. | [optional]
**kafka** | [**KafkaIntegration**](KafkaIntegration.md) | | [optional]
**kinesis** | [**KinesisIntegration**](KinesisIntegration.md) | | [optional]
**mongodb** | [**MongoDbIntegration**](MongoDbIntegration.md) | | [optional]
Expand Down
3 changes: 2 additions & 1 deletion docs/CreateVirtualInstanceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ Name | Type | Description | Notes
**auto_suspend_seconds** | **int** | Number of seconds without queries after which the VI is suspended | [optional]
**description** | **str** | Description of requested virtual instance. | [optional]
**enable_remount_on_resume** | **bool** | When a Virtual Instance is resumed, it will remount all collections that were mounted when the Virtual Instance was suspended. | [optional]
**instance_class** | **str** | Virtual Instance Class. Use `MO_IL` for Memory Optimized and `GP_IL` for General Purpose instance class. | [optional]
**mount_refresh_interval_seconds** | **int** | DEPRECATED. Use `mount_type` instead. Number of seconds between data refreshes for mounts on this Virtual Instance. The only valid values are 0 and null. 0 means the data will be refreshed continuously and null means the data will never refresh. | [optional]
**mount_type** | **str** | The mount type of collections that this Virtual Instance will query. Live mounted collections stay up-to-date with the underlying collection in real-time. Static mounted collections do not stay up-to-date. See https://docs.rockset.com/documentation/docs/virtual-instances#virtual-instance-configuration | [optional]
**mount_type** | **str** | The mount type of collections that this Virtual Instance will query. Live mounted collections stay up-to-date with the underlying collection in real-time. Static mounted collections do not stay up-to-date. See https://docs.rockset.com/documentation/docs/using-virtual-instances#virtual-instance-configuration | [optional]
**type** | **str** | Requested virtual instance type. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

Expand Down
12 changes: 12 additions & 0 deletions docs/DeploymentSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DeploymentSettings


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**default_query_vi** | [**VirtualInstanceRrn**](VirtualInstanceRrn.md) | | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


178 changes: 178 additions & 0 deletions docs/DeploymentSettingsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
# rockset.DeploymentSettings

All URIs are relative to *https://api.use1a1.rockset.com* or the apiserver provided when initializing RocksetClient

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_deployment_settings**](DeploymentSettingsApi.md#get_deployment_settings) | **GET** /v1/orgs/self/deploymentsettings | Retrieve Deployment Settings
[**update_deployment_settings**](DeploymentSettingsApi.md#update_deployment_settings) | **PUT** /v1/orgs/self/deploymentsettings | Update Deployment Settings


# **get_deployment_settings**
> DeploymentSettingsResponse get_deployment_settings()

Retrieve Deployment Settings

Retrieve settings for the current deployment.

### Example

* Api Key Authentication (apikey):

```python
from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Retrieve Deployment Settings
api_response = rs.DeploymentSettings.get_deployment_settings(
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
# print("Exception when calling DeploymentSettings->get_deployment_settings: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Retrieve Deployment Settings
api_response = await rs.DeploymentSettings.get_deployment_settings(
async_req=True,
)
if isinstance(api_response, rockset.ApiException):
print("Exception when calling DeploymentSettings->get_deployment_settings: %s\n" % e)
return
pprint(api_response)

```


### Parameters
This endpoint does not need any parameter.

### Return type

[**DeploymentSettingsResponse**](DeploymentSettingsResponse.md)

### Authorization

All requests must use apikeys for [authorization](../README.md#Documentation-For-Authorization).


### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Deployment settings retrieved successfully | - |
**400** | bad request | - |
**401** | unauthorized | - |
**403** | forbidden | - |
**404** | not found | - |
**405** | not allowed | - |
**406** | not acceptable | - |
**408** | request timeout | - |
**409** | conflict | - |
**415** | not supported | - |
**429** | resource exceeded | - |
**500** | internal error | - |
**501** | not implemented | - |
**502** | bad gateway | - |
**503** | not ready | - |

[[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)

# **update_deployment_settings**
> DeploymentSettingsResponse update_deployment_settings(update_deployment_settings_request)

Update Deployment Settings

Update settings for the current deployment.

### Example

* Api Key Authentication (apikey):

```python
from rockset import *
from rockset.models import *
from pprint import pprint

# Create an instance of the Rockset client
rs = RocksetClient(api_key="abc123", host=Regions.use1a1)

# synchronous example passing only required values which don't have defaults set
# Update Deployment Settings
api_response = rs.DeploymentSettings.update_deployment_settings(
)
pprint(api_response)
# Error responses from the server will cause the client to throw an ApiException
# except ApiException as e:
# print("Exception when calling DeploymentSettings->update_deployment_settings: %s\n" % e)

# asynchronous example passing optional values and required values which don't have defaults set
# assumes that execution takes place within an asynchronous context
# Update Deployment Settings
api_response = await rs.DeploymentSettings.update_deployment_settings(
default_query_vi="rrn:vi:use1a1:123e4567-e89b-12d3-a456-556642440000",
async_req=True,
)
if isinstance(api_response, rockset.ApiException):
print("Exception when calling DeploymentSettings->update_deployment_settings: %s\n" % e)
return
pprint(api_response)

```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**default_query_vi** | **str** | RRN of the Virtual Instance that all queries will be routed to by default | [optional]

### Return type

[**DeploymentSettingsResponse**](DeploymentSettingsResponse.md)

### Authorization

All requests must use apikeys for [authorization](../README.md#Documentation-For-Authorization).


### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Deployment settings updated successfully. Settings may take up to 1 minute to take effect | - |
**400** | bad request | - |
**401** | unauthorized | - |
**403** | forbidden | - |
**404** | not found | - |
**405** | not allowed | - |
**406** | not acceptable | - |
**408** | request timeout | - |
**409** | conflict | - |
**415** | not supported | - |
**429** | resource exceeded | - |
**500** | internal error | - |
**501** | not implemented | - |
**502** | bad gateway | - |
**503** | not ready | - |

[[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)

12 changes: 12 additions & 0 deletions docs/DeploymentSettingsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DeploymentSettingsResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**DeploymentSettings**](DeploymentSettings.md) | | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Description | Notes
**description** | **str** | Longer explanation for the integration. | [optional]
**dynamodb** | [**DynamodbIntegration**](DynamodbIntegration.md) | | [optional]
**gcs** | [**GcsIntegration**](GcsIntegration.md) | | [optional]
**is_write_enabled** | **bool** | is write access enabled for this integration | [optional]
**kafka** | [**KafkaIntegration**](KafkaIntegration.md) | | [optional]
**kinesis** | [**KinesisIntegration**](KinesisIntegration.md) | | [optional]
**mongodb** | [**MongoDbIntegration**](MongoDbIntegration.md) | | [optional]
Expand Down
2 changes: 2 additions & 0 deletions docs/IntegrationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1241,6 +1241,7 @@ SharedAccessSignature=<KeyValue>''',
service_account_key_file_json="service_account_key_file_json_example",
),
),
is_write_enabled=True,
kafka=KafkaIntegration(
aws_role=AwsRole(
aws_external_id="external id of aws",
Expand Down Expand Up @@ -1334,6 +1335,7 @@ Name | Type | Description | Notes
**description** | **str** | Longer explanation for the integration. | [optional]
**dynamodb** | [**DynamodbIntegration**](DynamodbIntegration.md) | | [optional]
**gcs** | [**GcsIntegration**](GcsIntegration.md) | | [optional]
**is_write_enabled** | **bool** | is write access enabled for this integration. | [optional]
**kafka** | [**KafkaIntegration**](KafkaIntegration.md) | | [optional]
**kinesis** | [**KinesisIntegration**](KinesisIntegration.md) | | [optional]
**mongodb** | [**MongoDbIntegration**](MongoDbIntegration.md) | | [optional]
Expand Down
1 change: 0 additions & 1 deletion docs/ScheduledLambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Name | Type | Description | Notes
**tag** | **str** | The query lambda tag. | [optional]
**total_times_to_execute** | **int** | The number of times to execute this scheduled query lambda. Once this scheduled query lambda has been executed this many times, it will no longer be executed. | [optional]
**version** | **str** | The version of the associated query lambda. | [optional]
**vi_rrn** | [**VirtualInstanceRrn**](VirtualInstanceRrn.md) | | [optional]
**webhook_payload** | **str** | The payload that should be sent to the webhook. | [optional]
**webhook_url** | **str** | The URL of the webhook that should be triggered after this scheduled query lambda completes. | [optional]
**workspace** | **str** | Workspace of the associated query lambda. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/Source.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**status** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] [readonly]
**suspended_at** | **str** | ISO-8601 date when source was suspended, if suspended | [optional] [readonly]
**system** | [**SourceSystem**](SourceSystem.md) | | [optional]
**write_api** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/Stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**elapsed_time_ms** | **int** | Total execution time (including time queued) of the query, in milliseconds. | [optional]
**result_set_bytes_size** | **int** | Number of bytes in the query result set. Only populated if &#x60;status&#x60; is &#x60;COMPLETE&#x60;. Not populated for INSERT INTO queries. | [optional]
**result_set_document_count** | **int** | Number of documents returned by the query. Only populated if &#x60;status&#x60; is &#x60;COMPLETE&#x60;. | [optional]
**result_set_file_count** | **int** | Number of files written by by the query. Only populated if &#x60;status&#x60; is &#x60;COMPLETE&#x60; and the query is an export query. | [optional]
**throttled_time_ms** | **int** | Time query spent queued, in milliseconds. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

Expand Down
12 changes: 12 additions & 0 deletions docs/UpdateDeploymentSettingsRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# UpdateDeploymentSettingsRequest


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**default_query_vi** | **str** | RRN of the Virtual Instance that all queries will be routed to by default | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/UpdateIntegrationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**description** | **str** | Longer explanation for the integration. | [optional]
**dynamodb** | [**DynamodbIntegration**](DynamodbIntegration.md) | | [optional]
**gcs** | [**GcsIntegration**](GcsIntegration.md) | | [optional]
**is_write_enabled** | **bool** | is write access enabled for this integration. | [optional]
**kafka** | [**KafkaIntegration**](KafkaIntegration.md) | | [optional]
**kinesis** | [**KinesisIntegration**](KinesisIntegration.md) | | [optional]
**mongodb** | [**MongoDbIntegration**](MongoDbIntegration.md) | | [optional]
Expand Down
Loading