Skip to content
Merged
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
2 changes: 1 addition & 1 deletion client/python/docs/AuthenticationParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
-->
# AuthenticationParameters

Authentication-specific information for a REST connection
Authentication-specific information for a connection

## Properties

Expand Down
49 changes: 49 additions & 0 deletions client/python/docs/AwsIamServiceIdentityInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->
# AwsIamServiceIdentityInfo


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**iam_arn** | **str** | The ARN of the IAM user or IAM role Polaris uses to assume roles and then access external resources. |

## Example

```python
from polaris.management.models.aws_iam_service_identity_info import AwsIamServiceIdentityInfo

# TODO update the JSON string below
json = "{}"
# create an instance of AwsIamServiceIdentityInfo from a JSON string
aws_iam_service_identity_info_instance = AwsIamServiceIdentityInfo.from_json(json)
# print the JSON string representation of the object
print(AwsIamServiceIdentityInfo.to_json())

# convert the object into a dict
aws_iam_service_identity_info_dict = aws_iam_service_identity_info_instance.to_dict()
# create an instance of AwsIamServiceIdentityInfo from a dict
aws_iam_service_identity_info_from_dict = AwsIamServiceIdentityInfo.from_dict(aws_iam_service_identity_info_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)


16 changes: 16 additions & 0 deletions client/python/docs/CatalogPrivilege.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,22 @@

* `VIEW_FULL_METADATA` (value: `'VIEW_FULL_METADATA'`)

* `POLICY_CREATE` (value: `'POLICY_CREATE'`)

* `POLICY_WRITE` (value: `'POLICY_WRITE'`)

* `POLICY_READ` (value: `'POLICY_READ'`)

* `POLICY_DROP` (value: `'POLICY_DROP'`)

* `POLICY_LIST` (value: `'POLICY_LIST'`)

* `POLICY_FULL_METADATA` (value: `'POLICY_FULL_METADATA'`)

* `CATALOG_ATTACH_POLICY` (value: `'CATALOG_ATTACH_POLICY'`)

* `CATALOG_DETACH_POLICY` (value: `'CATALOG_DETACH_POLICY'`)

[[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 client/python/docs/ConnectionConfigInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Name | Type | Description | Notes
**connection_type** | **str** | The type of remote catalog service represented by this connection |
**uri** | **str** | URI to the remote catalog service | [optional]
**authentication_parameters** | [**AuthenticationParameters**](AuthenticationParameters.md) | | [optional]
**service_identity** | [**ServiceIdentityInfo**](ServiceIdentityInfo.md) | | [optional]

## Example

Expand Down
50 changes: 50 additions & 0 deletions client/python/docs/HadoopConnectionConfigInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->
# HadoopConnectionConfigInfo

Configuration necessary for connecting to a Hadoop Catalog

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**warehouse** | **str** | The file path to where this catalog should store tables | [optional]

## Example

```python
from polaris.management.models.hadoop_connection_config_info import HadoopConnectionConfigInfo

# TODO update the JSON string below
json = "{}"
# create an instance of HadoopConnectionConfigInfo from a JSON string
hadoop_connection_config_info_instance = HadoopConnectionConfigInfo.from_json(json)
# print the JSON string representation of the object
print(HadoopConnectionConfigInfo.to_json())

# convert the object into a dict
hadoop_connection_config_info_dict = hadoop_connection_config_info_instance.to_dict()
# create an instance of HadoopConnectionConfigInfo from a dict
hadoop_connection_config_info_from_dict = HadoopConnectionConfigInfo.from_dict(hadoop_connection_config_info_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)


10 changes: 8 additions & 2 deletions client/python/docs/IcebergCatalogAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -1432,7 +1432,7 @@ Name | Type | Description | Notes
[[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)

# **load_table**
> LoadTableResult load_table(x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
> LoadTableResult load_table(prefix, namespace, table, x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)

Load a table from the catalog

Expand Down Expand Up @@ -1471,13 +1471,16 @@ configuration = polaris.catalog.Configuration(
with polaris.catalog.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = polaris.catalog.IcebergCatalogAPI(api_client)
prefix = 'prefix_example' # str | An optional prefix in the path
namespace = 'accounting' # str | A namespace identifier as a single string. Multipart namespace parts should be separated by the unit separator (`0x1F`) byte.
table = 'sales' # str | A table name
x_iceberg_access_delegation = 'vended-credentials,remote-signing' # str | Optional signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. Specific properties and handling for `vended-credentials` is documented in the `LoadTableResult` schema section of this spec document. The protocol and specification for `remote-signing` is documented in the `s3-signer-open-api.yaml` OpenApi spec in the `aws` module. (optional)
if_none_match = 'if_none_match_example' # str | An optional header that allows the server to return 304 (Not Modified) if the metadata is current. The content is the value of the ETag received in a CreateTableResponse or LoadTableResponse. (optional)
snapshots = 'snapshots_example' # str | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. Default if no param is provided is `all`. (optional)

try:
# Load a table from the catalog
api_response = api_instance.load_table(x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
api_response = api_instance.load_table(prefix, namespace, table, x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
print("The response of IcebergCatalogAPI->load_table:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -1491,6 +1494,9 @@ with polaris.catalog.ApiClient(configuration) as api_client:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**prefix** | **str**| An optional prefix in the path |
**namespace** | **str**| A namespace identifier as a single string. Multipart namespace parts should be separated by the unit separator (&#x60;0x1F&#x60;) byte. |
**table** | **str**| A table name |
**x_iceberg_access_delegation** | **str**| Optional signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. Specific properties and handling for &#x60;vended-credentials&#x60; is documented in the &#x60;LoadTableResult&#x60; schema section of this spec document. The protocol and specification for &#x60;remote-signing&#x60; is documented in the &#x60;s3-signer-open-api.yaml&#x60; OpenApi spec in the &#x60;aws&#x60; module. | [optional]
**if_none_match** | **str**| An optional header that allows the server to return 304 (Not Modified) if the metadata is current. The content is the value of the ETag received in a CreateTableResponse or LoadTableResponse. | [optional]
**snapshots** | **str**| The snapshots to return in the body of the metadata. Setting the value to &#x60;all&#x60; would return the full set of snapshots currently valid for the table. Setting the value to &#x60;refs&#x60; would load all snapshots referenced by branches or tags. Default if no param is provided is &#x60;all&#x60;. | [optional]
Expand Down
16 changes: 16 additions & 0 deletions client/python/docs/NamespacePrivilege.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@

* `VIEW_FULL_METADATA` (value: `'VIEW_FULL_METADATA'`)

* `POLICY_CREATE` (value: `'POLICY_CREATE'`)

* `POLICY_WRITE` (value: `'POLICY_WRITE'`)

* `POLICY_READ` (value: `'POLICY_READ'`)

* `POLICY_DROP` (value: `'POLICY_DROP'`)

* `POLICY_LIST` (value: `'POLICY_LIST'`)

* `POLICY_FULL_METADATA` (value: `'POLICY_FULL_METADATA'`)

* `NAMESPACE_ATTACH_POLICY` (value: `'NAMESPACE_ATTACH_POLICY'`)

* `NAMESPACE_DETACH_POLICY` (value: `'NAMESPACE_DETACH_POLICY'`)

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


51 changes: 51 additions & 0 deletions client/python/docs/PolicyGrant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->
# PolicyGrant


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**namespace** | **List[str]** | |
**policy_name** | **str** | |
**privilege** | [**PolicyPrivilege**](PolicyPrivilege.md) | |

## Example

```python
from polaris.management.models.policy_grant import PolicyGrant

# TODO update the JSON string below
json = "{}"
# create an instance of PolicyGrant from a JSON string
policy_grant_instance = PolicyGrant.from_json(json)
# print the JSON string representation of the object
print(PolicyGrant.to_json())

# convert the object into a dict
policy_grant_dict = policy_grant_instance.to_dict()
# create an instance of PolicyGrant from a dict
policy_grant_from_dict = PolicyGrant.from_dict(policy_grant_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)


44 changes: 44 additions & 0 deletions client/python/docs/PolicyPrivilege.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->
# PolicyPrivilege


## Enum

* `CATALOG_MANAGE_ACCESS` (value: `'CATALOG_MANAGE_ACCESS'`)

* `POLICY_READ` (value: `'POLICY_READ'`)

* `POLICY_DROP` (value: `'POLICY_DROP'`)

* `POLICY_WRITE` (value: `'POLICY_WRITE'`)

* `POLICY_LIST` (value: `'POLICY_LIST'`)

* `POLICY_FULL_METADATA` (value: `'POLICY_FULL_METADATA'`)

* `POLICY_ATTACH` (value: `'POLICY_ATTACH'`)

* `POLICY_DETACH` (value: `'POLICY_DETACH'`)

[[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 client/python/docs/PrincipalRole.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the role |
**federated** | **bool** | Whether the principal role is a federated role (that is, managed by an external identity provider) | [optional] [default to False]
**properties** | **Dict[str, str]** | | [optional]
**create_timestamp** | **int** | | [optional]
**last_update_timestamp** | **int** | | [optional]
Expand Down
50 changes: 50 additions & 0 deletions client/python/docs/ServiceIdentityInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

-->
# ServiceIdentityInfo

Identity metadata for the Polaris service used to access external resources.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_type** | **str** | The type of identity used to access external resources |

## Example

```python
from polaris.management.models.service_identity_info import ServiceIdentityInfo

# TODO update the JSON string below
json = "{}"
# create an instance of ServiceIdentityInfo from a JSON string
service_identity_info_instance = ServiceIdentityInfo.from_json(json)
# print the JSON string representation of the object
print(ServiceIdentityInfo.to_json())

# convert the object into a dict
service_identity_info_dict = service_identity_info_instance.to_dict()
# create an instance of ServiceIdentityInfo from a dict
service_identity_info_from_dict = ServiceIdentityInfo.from_dict(service_identity_info_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)


Loading
Loading