depot_service.models package

Submodules

depot_service.models.abfss module

class depot_service.models.abfss.Abfss(*, wasbsUrl: str | None = None, container: str | None = None, account: str | None = None, metastoreUrl: str | None = None, relativePath: str | None = None, icebergCatalogType: IcebergCatalogType | None = None, abfssUrl: str | None = None)

Bases: BaseModel

abfssUrl: str | None

account: str | None

container: str | None

icebergCatalogType: IcebergCatalogType | None

metastoreUrl: str | None

relativePath: str | None

wasbsUrl: str | None

class depot_service.models.abfss.IcebergCatalogType(value)

Bases: str, Enum

An enumeration.

HADOOP = 'HADOOP'

HIVE = 'HIVE'

depot_service.models.abfss_depot module

class depot_service.models.abfss_depot.AbfssDepot(*, account: str | None = None, container: str | None = None, relativePath: str | None = None, format: str | None = None, metastoreUrl: str | None = None, endpointSuffix: str | None = None, icebergCatalogType: IcebergCatalogType | None = None)

Bases: BaseModel

account: str | None

container: str | None

endpointSuffix: str | None

format: str | None

icebergCatalogType: IcebergCatalogType | None

metastoreUrl: str | None

relativePath: str | None

class depot_service.models.abfss_depot.IcebergCatalogType(value)

Bases: str, Enum

An enumeration.

HADOOP = 'HADOOP'

HIVE = 'HIVE'

depot_service.models.address_info module

class depot_service.models.address_info.AddressInfo(*, depot: str | None = None, type: str | None = None, collection: str | None = None, dataset: str | None = None, format: str | None = None, external: bool | None = None, is_archived: bool | None = None, source: str | None = None, connection: Dict | None = None)

Bases: BaseModel

collection: str | None

connection: Dict | None

dataset: str | None

depot: str | None

external: bool | None

format: str | None

is_archived: bool | None

source: str | None

type: str | None

depot_service.models.big_query module

class depot_service.models.big_query.Bigquery(*, projectID: str | None = None, project: str | None = None, dataset: str | None = None, table: str | None = None)

Bases: BaseModel

dataset: str | None

project: str | None

projectID: str | None

table: str | None

depot_service.models.big_query_depot module

class depot_service.models.big_query_depot.BigQueryDepot(*, project: str | None = None, params: Dict[str, Any] | None = None, temporaryBucket: str | None = None, persistentBucket: str | None = None)

Bases: BaseModel

params: Dict[str, Any] | None

persistentBucket: str | None

project: str | None

temporaryBucket: str | None

depot_service.models.connection_details module

class depot_service.models.connection_details.ConnectionDetails

Bases: BaseModel

depot_service.models.dataset_request module

class depot_service.models.dataset_request.DatasetRequest(schema_: depot_service.models.dataset_request.SchemaRequest | NoneType = FieldInfo(default=PydanticUndefined, alias='schema', alias_priority=2, extra={}), iceberg: depot_service.models.dataset_request.IcebergRequest | NoneType = None, pulsar: depot_service.models.dataset_request.PulsarRequest | NoneType = None)

Bases: object

iceberg: IcebergRequest | None = None

pulsar: PulsarRequest | None = None

schema_: SchemaRequest | None = FieldInfo(default=PydanticUndefined, alias='schema', alias_priority=2, extra={})

class depot_service.models.dataset_request.IcebergPartitionSpecRequest(index: int = None, type: str = None, column: str = None, name: str = None)

Bases: object

column: str = None

index: int = None

name: str = None

type: str = None

class depot_service.models.dataset_request.IcebergRequest(specs: List[depot_service.models.dataset_request.IcebergPartitionSpecRequest] | NoneType = None, properties: Dict[str, str] | NoneType = None)

Bases: object

properties: Dict[str, str] | None = None

specs: List[IcebergPartitionSpecRequest] | None = None

class depot_service.models.dataset_request.PulsarRequest(partitions: int = None, type: str = None)

Bases: object

partitions: int = None

type: str = None

class depot_service.models.dataset_request.SchemaRequest(type: str = None, avro: str = None, mapping: str | NoneType = None)

Bases: object

avro: str = None

mapping: str | None = None

type: str = None

depot_service.models.dataset_response module

class depot_service.models.dataset_response.DatasetResponse(*, schema: SchemaResponse | None, iceberg: IcebergResponse | None = None, pulsar: PulsarResponse | None = None)

Bases: BaseModel

iceberg: IcebergResponse | None

pulsar: PulsarResponse | None

schema_: SchemaResponse | None

class depot_service.models.dataset_response.IcebergPartitionSpecResponse(*, index: int, type: str, column: str, name: str)

Bases: BaseModel

column: str

index: int

name: str

type: str

class depot_service.models.dataset_response.IcebergResponse(*, specs: List[IcebergPartitionSpecResponse] | None = None, properties: Dict[str, str], snapshotId: str, version: str)

Bases: BaseModel

properties: Dict[str, str]

snapshotId: str

specs: List[IcebergPartitionSpecResponse] | None

version: str

class depot_service.models.dataset_response.PulsarResponse(*, partitions: int, type: str)

Bases: BaseModel

partitions: int

type: str

class depot_service.models.dataset_response.SchemaResponse(*, type: str, avro: str, mapping: str | None = None)

Bases: BaseModel

avro: str

mapping: str | None

type: str

depot_service.models.depot_flag_request module

class depot_service.models.depot_flag_request.DepotFlagRequest(*, isArchived: bool, archivalMessage: str | None = None)

Bases: BaseModel

archivalMessage: str | None

isArchived: bool

depot_service.models.depot_request module

class depot_service.models.depot_request.DepotRequest(*, type: str, external: bool | None = None, owners: List[str], description: str | None = None, meta: Dict[str, Any] | None = None, source: str | None = None, abfss: AbfssDepot | None = None, bigquery: BigQueryDepot | None = None, elasticsearch: ElasticSearchDepot | None = None, eventhub: EventhubDepot | None = None, file: FileDepot | None = None, gcs: GCSDepot | None = None, http: HttpDepot | None = None, jdbc: JdbcDepot | None = None, kafka: KafkaDepot | None = None, mongodb: MongoDBDepot | None = None, mysql: MysqlDepot | None = None, opensearch: OpenSearchDepot | None = None, oracle: OracleDepot | None = None, postgresql: PostgresDepot | None = None, presto: PrestoDepot | None = None, pulsar: PulsarDepot | None = None, redis: RedisDepot | None = None, redshift: RedshiftDepot | None = None, s3: S3Depot | None = None, snowflake: SnowflakeDepot | None = None, wasbs: WasbsDepot | None = None)

Bases: BaseModel

abfss: AbfssDepot | None

bigquery: BigQueryDepot | None

description: str | None

elasticsearch: ElasticSearchDepot | None

eventhub: EventhubDepot | None

external: bool | None

file: FileDepot | None

gcs: GCSDepot | None

http: HttpDepot | None

jdbc: JdbcDepot | None

kafka: KafkaDepot | None

meta: Dict[str, Any] | None

mongodb: MongoDBDepot | None

mysql: MysqlDepot | None

opensearch: OpenSearchDepot | None

oracle: OracleDepot | None

owners: List[str]

postgresql: PostgresDepot | None

presto: PrestoDepot | None

pulsar: PulsarDepot | None

redis: RedisDepot | None

redshift: RedshiftDepot | None

s3: S3Depot | None

snowflake: SnowflakeDepot | None

source: str | None

type: str

wasbs: WasbsDepot | None

depot_service.models.depot_response module

class depot_service.models.depot_response.DepotResponse(*, name: str | None = None, type: str | None = None, external: bool | None = None, description: str | None = None, owners: List[str] | None = None, meta: Dict[str, Any] | None = None, source: str | None = None, isArchived: bool | None = None, archivalMessage: str | None = None, createdAt: str | None = None, updatedAt: str | None = None, abfss: AbfssDepot | None = None, bigquery: BigQueryDepot | None = None, elasticsearch: ElasticSearchDepot | None = None, eventhub: EventhubDepot | None = None, file: FileDepot | None = None, gcs: GCSDepot | None = None, http: HttpDepot | None = None, jdbc: JdbcDepot | None = None, kafka: KafkaDepot | None = None, mongodb: MongoDBDepot | None = None, mysql: MysqlDepot | None = None, opensearch: OpenSearchDepot | None = None, oracle: OracleDepot | None = None, postgresql: PostgresDepot | None = None, presto: PrestoDepot | None = None, pulsar: PulsarDepot | None = None, redis: RedisDepot | None = None, redshift: RedshiftDepot | None = None, s3: S3Depot | None = None, snowflake: SnowflakeDepot | None = None, wasbs: WasbsDepot | None = None)

Bases: BaseModel

abfss: AbfssDepot | None

archivalMessage: str | None

bigquery: BigQueryDepot | None

createdAt: str | None

description: str | None

elasticsearch: ElasticSearchDepot | None

eventhub: EventhubDepot | None

external: bool | None

file: FileDepot | None

gcs: GCSDepot | None

http: HttpDepot | None

isArchived: bool | None

jdbc: JdbcDepot | None

kafka: KafkaDepot | None

meta: Dict[str, Any] | None

mongodb: MongoDBDepot | None

mysql: MysqlDepot | None

name: str | None

opensearch: OpenSearchDepot | None

oracle: OracleDepot | None

owners: List[str] | None

postgresql: PostgresDepot | None

presto: PrestoDepot | None

pulsar: PulsarDepot | None

redis: RedisDepot | None

redshift: RedshiftDepot | None

s3: S3Depot | None

snowflake: SnowflakeDepot | None

source: str | None

type: str | None

updatedAt: str | None

wasbs: WasbsDepot | None

depot_service.models.elastic_search module

class depot_service.models.elastic_search.ElasticSearch(*, nodes: List[str] | None = None, index: str | None = None, type: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

index: str | None

nodes: List[str] | None

params: Dict[str, Any] | None

type: str | None

depot_service.models.elastic_search_depot module

class depot_service.models.elastic_search_depot.ElasticSearchDepot(*, nodes: List[str] | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

nodes: List[str] | None

params: Dict[str, Any] | None

depot_service.models.eventhub module

class depot_service.models.eventhub.Eventhub(*, endpoint: str | None = None, eventhubName: str | None = None)

Bases: BaseModel

endpoint: str | None

eventhubName: str | None

depot_service.models.eventhub_depot module

class depot_service.models.eventhub_depot.EventhubDepot(*, endpoint: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

endpoint: str | None

params: Dict[str, Any] | None

depot_service.models.field_rename_request module

class depot_service.models.field_rename_request.FieldRenameRequest(*, name: str)

Bases: BaseModel

name: str

depot_service.models.field_request module

class depot_service.models.field_request.FieldRequest(*, name: str, type: str, precision: int | None = None, scale: int | None = None, keyType: str | None = None, valueType: str | None = None)

Bases: BaseModel

keyType: str | None

name: str

precision: int | None

scale: int | None

type: str

valueType: str | None

depot_service.models.field_update_request module

class depot_service.models.field_update_request.FieldUpdateRequest(*, type: str, precision: int | None = None, scale: int | None = None)

Bases: BaseModel

precision: int | None

scale: int | None

type: str

depot_service.models.file_depot module

class depot_service.models.file_depot.FileDepot(*, path: str | None = None, format: str | None = None, metastoreUrl: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

class IcebergCatalogType(value)

Bases: str, Enum

An enumeration.

HADOOP = 'HADOOP'

HIVE = 'HIVE'

format: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

path: str | None

depot_service.models.gcs module

class depot_service.models.gcs.Gcs(*, gcsUrl: str | None = None, bucket: str | None = None, path: str | None = None, metastoreUrl: str | None = None, relativePath: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

class IcebergCatalogType(value)

Bases: str, Enum

An enumeration.

HADOOP = 'HADOOP'

HIVE = 'HIVE'

bucket: str | None

gcsUrl: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

path: str | None

relativePath: str | None

depot_service.models.gcs_depot module

class depot_service.models.gcs_depot.GCSDepot(*, bucket: str | None = None, relativePath: str | None = None, format: str | None = None, metastoreUrl: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

class IcebergCatalogType(value)

Bases: str, Enum

An enumeration.

HADOOP = 'HADOOP'

HIVE = 'HIVE'

bucket: str | None

format: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

relativePath: str | None

depot_service.models.http module

class depot_service.models.http.Http(*, url: str | None = None, headers: Dict[str, str] | None = None, queryParams: Dict[str, str] | None = None)

Bases: BaseModel

headers: Dict[str, str] | None

queryParams: Dict[str, str] | None

url: str | None

depot_service.models.htttp_depot module

class depot_service.models.htttp_depot.HttpDepot(*, baseUrl: str | None = None, headers: Dict[str, str] | None = None, queryParams: Dict[str, str] | None = None)

Bases: BaseModel

baseUrl: str | None

headers: Dict[str, str] | None

queryParams: Dict[str, str] | None

depot_service.models.iceberg_partition_spec_request module

class depot_service.models.iceberg_partition_spec_request.IcebergPartitionSpecRequest(*, index: int, type: str, column: str, name: str | None = None, num_buckets: int | None = None)

Bases: BaseModel

column: str

index: int

name: str | None

num_buckets: int | None

type: str

depot_service.models.iceberg_stats module

class depot_service.models.iceberg_stats.IcebergStats(*, stats: Dict[str, str], timeline: Dict[str, Dict[str, str]], properties: Dict[str, str])

Bases: BaseModel

properties: Dict[str, str]

stats: Dict[str, str]

timeline: Dict[str, Dict[str, str]]

depot_service.models.jdbc module

class depot_service.models.jdbc.Jdbc(*, url: str | None = None, table: str | None = None, database: str | None = None, host: str | None = None, port: int | None = None, subprotocol: str | None = None, schema: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

database: str | None

host: str | None

params: Dict[str, Any] | None

port: int | None

schema_: str | None

subprotocol: str | None

table: str | None

url: str | None

depot_service.models.jdbc_depot module

class depot_service.models.jdbc_depot.JdbcDepot(*, subprotocol: str | None = None, host: str | None = None, port: int | None = None, database: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

database: str | None

host: str | None

params: Dict[str, Any] | None

port: int | None

subprotocol: str | None

depot_service.models.kafka module

class depot_service.models.kafka.Kafka(*, brokers: List[str] | None = None, topic: str | None = None, schemaRegistryUrl: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

brokers: List[str] | None

params: Dict[str, Any] | None

schemaRegistryUrl: str | None

topic: str | None

depot_service.models.kafka_depot module

class depot_service.models.kafka_depot.KafkaDepot(*, brokers: List[str] | None = None, schemaRegistryUrl: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

brokers: List[str] | None

params: Dict[str, Any] | None

schemaRegistryUrl: str | None

depot_service.models.metadata_version_response module

class depot_service.models.metadata_version_response.MetadataVersionResponse(*, version: str, timestamp: int)

Bases: BaseModel

timestamp: int

version: str

depot_service.models.mongo_db module

class depot_service.models.mongo_db.MongoDb(*, connectionUrl: str | None = None, subprotocol: str | None = None, nodes: List[str] | None = None, database: str | None = None, table: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

connectionUrl: str | None

database: str | None

nodes: List[str] | None

params: Dict[str, Any] | None

subprotocol: str | None

table: str | None

depot_service.models.mongo_db_depot module

class depot_service.models.mongo_db_depot.MongoDBDepot(*, subprotocol: str | None = None, nodes: List[str] | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

nodes: List[str] | None

params: Dict[str, Any] | None

subprotocol: str | None

depot_service.models.mysql_depot module

class depot_service.models.mysql_depot.MysqlDepot(*, subprotocol: str | None = None, host: str | None = None, port: int | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

host: str | None

params: Dict[str, Any] | None

port: int | None

subprotocol: str | None

depot_service.models.open_search_depot module

class depot_service.models.open_search_depot.OpenSearchDepot(*, nodes: List[str] | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

nodes: List[str] | None

params: Dict[str, Any] | None

depot_service.models.oracle module

class depot_service.models.oracle.Oracle(*, url: str | None = None, host: str | None = None, port: int | None = None, table: str | None = None, service: str | None = None, schema: str | None = None, subprotocol: str | None = None)

Bases: BaseModel

host: str | None

port: int | None

schema_: str | None

service: str | None

subprotocol: str | None

table: str | None

url: str | None

depot_service.models.oracle_depot module

class depot_service.models.oracle_depot.OracleDepot(*, subprotocol: str | None = None, host: str | None = None, port: int | None = None, service: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

host: str | None

params: Dict[str, Any] | None

port: int | None

service: str | None

subprotocol: str | None

depot_service.models.postgres_depot module

class depot_service.models.postgres_depot.PostgresDepot(*, subprotocol: str | None = None, host: str | None = None, port: int | None = None, database: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

database: str | None

host: str | None

params: Dict[str, Any] | None

port: int | None

subprotocol: str | None

depot_service.models.presto module

class depot_service.models.presto.Presto(*, url: str | None = None, host: str | None = None, port: int | None = None, catalog: str | None = None, schema: str | None = None)

Bases: BaseModel

catalog: str | None

host: str | None

port: int | None

schema_: str | None

url: str | None

depot_service.models.presto_depot module

class depot_service.models.presto_depot.PrestoDepot(*, host: str | None = None, port: int | None = None, catalog: str | None = None, schema: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

catalog: str | None

host: str | None

params: Dict[str, Any] | None

port: int | None

schema_: str | None

depot_service.models.properties_response module

class depot_service.models.properties_response.PropertiesResponse(*, properties: Dict[str, str])

Bases: BaseModel

properties: Dict[str, str]

depot_service.models.pulsar module

class depot_service.models.pulsar.Pulsar(*, serviceUrl: str | None = None, adminUrl: str | None = None, tenant: str | None = None, topic: str | None = None, isPersistent: bool | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

adminUrl: str | None

isPersistent: bool | None

params: Dict[str, Any] | None

serviceUrl: str | None

tenant: str | None

topic: str | None

depot_service.models.pulsar_depot module

class depot_service.models.pulsar_depot.PulsarDepot(*, adminUrl: str | None = None, serviceUrl: str | None = None, tenant: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

adminUrl: str | None

params: Dict[str, Any] | None

serviceUrl: str | None

tenant: str | None

depot_service.models.pulsar_request module

class depot_service.models.pulsar_request.PulsarRequest(*, partitions: int | None = None, type: str | None = None)

Bases: BaseModel

partitions: int | None

type: str | None

depot_service.models.pulsar_response module

class depot_service.models.pulsar_response.PulsarResponse(*, partitions: int | None = None, type: str | None = None)

Bases: BaseModel

partitions: int | None

type: str | None

depot_service.models.redis module

class depot_service.models.redis.Redis(*, host: str | None = None, port: int | None = None, table: str | None = None, db: int | None = None)

Bases: BaseModel

db: int | None

host: str | None

port: int | None

table: str | None

depot_service.models.redis_depot module

class depot_service.models.redis_depot.RedisDepot(*, host: str | None = None, port: int | None = None, db: int | None = None)

Bases: BaseModel

db: int | None

host: str | None

port: int | None

depot_service.models.redshift_depot module

class depot_service.models.redshift_depot.RedshiftDepot(*, subprotocol: str | None = None, host: str | None = None, port: int | None = None, database: str | None = None, params: Dict[str, Any] | None = None, scheme: str | None = None, bucket: str | None = None, relativePath: str | None = None)

Bases: BaseModel

bucket: str | None

database: str | None

host: str | None

params: Dict[str, Any] | None

port: int | None

relativePath: str | None

scheme: str | None

subprotocol: str | None

depot_service.models.s3 module

class depot_service.models.s3.S3(*, s3Url: str | None = None, bucket: str | None = None, path: str | None = None, metastoreUrl: str | None = None, relativePath: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

bucket: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

path: str | None

relativePath: str | None

s3Url: str | None

depot_service.models.s3_depot module

class depot_service.models.s3_depot.S3Depot(*, scheme: str | None = None, bucket: str | None = None, relativePath: str | None = None, format: str | None = None, metastoreUrl: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

bucket: str | None

format: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

relativePath: str | None

scheme: str | None

depot_service.models.snapshot_response module

class depot_service.models.snapshot_response.SnapshotResponse(*, snapshotId: int, timestamp: int)

Bases: BaseModel

snapshotId: int

timestamp: int

depot_service.models.snowflake_depot module

class depot_service.models.snowflake_depot.SnowflakeDepot(*, url: str | None = None, database: str | None = None, warehouse: str | None = None, params: Dict[str, Any] | None = None)

Bases: BaseModel

database: str | None

params: Dict[str, Any] | None

url: str | None

warehouse: str | None

depot_service.models.wasbs module

class depot_service.models.wasbs.Wasbs(*, wasbsUrl: str | None = None, container: str | None = None, account: str | None = None, metastoreUrl: str | None = None, relativePath: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

account: str | None

container: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

relativePath: str | None

wasbsUrl: str | None

depot_service.models.wasbs_depot module

class depot_service.models.wasbs_depot.WasbsDepot(*, account: str | None = None, container: str | None = None, relativePath: str | None = None, format: str | None = None, metastoreUrl: str | None = None, endpointSuffix: str | None = None, icebergCatalogType: str | None = None)

Bases: BaseModel

account: str | None

container: str | None

endpointSuffix: str | None

format: str | None

icebergCatalogType: str | None

metastoreUrl: str | None

relativePath: str | None

Module contents