depot_service package

Subpackages

• depot_service.apis package
  • Submodules
  • depot_service.apis.dataset_api module
    • DatasetApi
      • DatasetApi.add_field
      • DatasetApi.add_properties
      • DatasetApi.create_dataset
      • DatasetApi.create_namespace
      • DatasetApi.drop_dataset
      • DatasetApi.drop_field
      • DatasetApi.fetch_dataset
      • DatasetApi.fetch_schema
      • DatasetApi.fetch_schemas
      • DatasetApi.list_dataset
      • DatasetApi.list_metadata
      • DatasetApi.list_properties
      • DatasetApi.list_snapshots
      • DatasetApi.remove_properties
      • DatasetApi.rename_field
      • DatasetApi.set_metadata
      • DatasetApi.set_snapshot
      • DatasetApi.show_stats
      • DatasetApi.update_field
      • DatasetApi.update_nullability
      • DatasetApi.update_partition
  • depot_service.apis.depot_api module
    • DepotApi
      • DepotApi.add_owner
      • DepotApi.archive
      • DepotApi.create_or_update
      • DepotApi.delete_meta
      • DepotApi.delete_owner
      • DepotApi.get_collections
      • DepotApi.get_depot
      • DepotApi.get_depots
      • DepotApi.get_meta
      • DepotApi.get_owners
      • DepotApi.update_meta
  • depot_service.apis.resolver_api module
    • ResolveApi
      • ResolveApi.resolve
  • depot_service.apis.secret_api module
    • SecretApi
      • SecretApi.get_secrets
  • Module contents
• depot_service.models package
  • Submodules
  • depot_service.models.abfss module
    • Abfss
      • Abfss.abfssUrl
      • Abfss.account
      • Abfss.container
      • Abfss.icebergCatalogType
      • Abfss.metastoreUrl
      • Abfss.relativePath
      • Abfss.wasbsUrl
    • IcebergCatalogType
      • IcebergCatalogType.HADOOP
      • IcebergCatalogType.HIVE
  • depot_service.models.abfss_depot module
    • AbfssDepot
      • AbfssDepot.account
      • AbfssDepot.container
      • AbfssDepot.endpointSuffix
      • AbfssDepot.format
      • AbfssDepot.icebergCatalogType
      • AbfssDepot.metastoreUrl
      • AbfssDepot.relativePath
    • IcebergCatalogType
      • IcebergCatalogType.HADOOP
      • IcebergCatalogType.HIVE
  • depot_service.models.address_info module
    • AddressInfo
      • AddressInfo.collection
      • AddressInfo.connection
      • AddressInfo.dataset
      • AddressInfo.depot
      • AddressInfo.external
      • AddressInfo.format
      • AddressInfo.is_archived
      • AddressInfo.source
      • AddressInfo.type
  • depot_service.models.big_query module
    • Bigquery
      • Bigquery.dataset
      • Bigquery.project
      • Bigquery.projectID
      • Bigquery.table
  • depot_service.models.big_query_depot module
    • BigQueryDepot
      • BigQueryDepot.params
      • BigQueryDepot.persistentBucket
      • BigQueryDepot.project
      • BigQueryDepot.temporaryBucket
  • depot_service.models.connection_details module
    • ConnectionDetails
  • depot_service.models.dataset_request module
    • DatasetRequest
      • DatasetRequest.iceberg
      • DatasetRequest.pulsar
      • DatasetRequest.schema_
    • IcebergPartitionSpecRequest
      • IcebergPartitionSpecRequest.column
      • IcebergPartitionSpecRequest.index
      • IcebergPartitionSpecRequest.name
      • IcebergPartitionSpecRequest.type
    • IcebergRequest
      • IcebergRequest.properties
      • IcebergRequest.specs
    • PulsarRequest
      • PulsarRequest.partitions
      • PulsarRequest.type
    • SchemaRequest
      • SchemaRequest.avro
      • SchemaRequest.mapping
      • SchemaRequest.type
  • depot_service.models.dataset_response module
    • DatasetResponse
      • DatasetResponse.iceberg
      • DatasetResponse.pulsar
      • DatasetResponse.schema_
    • IcebergPartitionSpecResponse
      • IcebergPartitionSpecResponse.column
      • IcebergPartitionSpecResponse.index
      • IcebergPartitionSpecResponse.name
      • IcebergPartitionSpecResponse.type
    • IcebergResponse
      • IcebergResponse.properties
      • IcebergResponse.snapshotId
      • IcebergResponse.specs
      • IcebergResponse.version
    • PulsarResponse
      • PulsarResponse.partitions
      • PulsarResponse.type
    • SchemaResponse
      • SchemaResponse.avro
      • SchemaResponse.mapping
      • SchemaResponse.type
  • depot_service.models.depot_flag_request module
    • DepotFlagRequest
      • DepotFlagRequest.archivalMessage
      • DepotFlagRequest.isArchived
  • depot_service.models.depot_request module
    • DepotRequest
      • DepotRequest.abfss
      • DepotRequest.bigquery
      • DepotRequest.description
      • DepotRequest.elasticsearch
      • DepotRequest.eventhub
      • DepotRequest.external
      • DepotRequest.file
      • DepotRequest.gcs
      • DepotRequest.http
      • DepotRequest.jdbc
      • DepotRequest.kafka
      • DepotRequest.meta
      • DepotRequest.mongodb
      • DepotRequest.mysql
      • DepotRequest.opensearch
      • DepotRequest.oracle
      • DepotRequest.owners
      • DepotRequest.postgresql
      • DepotRequest.presto
      • DepotRequest.pulsar
      • DepotRequest.redis
      • DepotRequest.redshift
      • DepotRequest.s3
      • DepotRequest.snowflake
      • DepotRequest.source
      • DepotRequest.type
      • DepotRequest.wasbs
  • depot_service.models.depot_response module
    • DepotResponse
      • DepotResponse.abfss
      • DepotResponse.archivalMessage
      • DepotResponse.bigquery
      • DepotResponse.createdAt
      • DepotResponse.description
      • DepotResponse.elasticsearch
      • DepotResponse.eventhub
      • DepotResponse.external
      • DepotResponse.file
      • DepotResponse.gcs
      • DepotResponse.http
      • DepotResponse.isArchived
      • DepotResponse.jdbc
      • DepotResponse.kafka
      • DepotResponse.meta
      • DepotResponse.mongodb
      • DepotResponse.mysql
      • DepotResponse.name
      • DepotResponse.opensearch
      • DepotResponse.oracle
      • DepotResponse.owners
      • DepotResponse.postgresql
      • DepotResponse.presto
      • DepotResponse.pulsar
      • DepotResponse.redis
      • DepotResponse.redshift
      • DepotResponse.s3
      • DepotResponse.snowflake
      • DepotResponse.source
      • DepotResponse.type
      • DepotResponse.updatedAt
      • DepotResponse.wasbs
  • depot_service.models.elastic_search module
    • ElasticSearch
      • ElasticSearch.index
      • ElasticSearch.nodes
      • ElasticSearch.params
      • ElasticSearch.type
  • depot_service.models.elastic_search_depot module
    • ElasticSearchDepot
      • ElasticSearchDepot.nodes
      • ElasticSearchDepot.params
  • depot_service.models.eventhub module
    • Eventhub
      • Eventhub.endpoint
      • Eventhub.eventhubName
  • depot_service.models.eventhub_depot module
    • EventhubDepot
      • EventhubDepot.endpoint
      • EventhubDepot.params
  • depot_service.models.field_rename_request module
    • FieldRenameRequest
      • FieldRenameRequest.name
  • depot_service.models.field_request module
    • FieldRequest
      • FieldRequest.keyType
      • FieldRequest.name
      • FieldRequest.precision
      • FieldRequest.scale
      • FieldRequest.type
      • FieldRequest.valueType
  • depot_service.models.field_update_request module
    • FieldUpdateRequest
      • FieldUpdateRequest.precision
      • FieldUpdateRequest.scale
      • FieldUpdateRequest.type
  • depot_service.models.file_depot module
    • FileDepot
      • FileDepot.IcebergCatalogType
      • FileDepot.format
      • FileDepot.icebergCatalogType
      • FileDepot.metastoreUrl
      • FileDepot.path
  • depot_service.models.gcs module
    • Gcs
      • Gcs.IcebergCatalogType
      • Gcs.bucket
      • Gcs.gcsUrl
      • Gcs.icebergCatalogType
      • Gcs.metastoreUrl
      • Gcs.path
      • Gcs.relativePath
  • depot_service.models.gcs_depot module
    • GCSDepot
      • GCSDepot.IcebergCatalogType
      • GCSDepot.bucket
      • GCSDepot.format
      • GCSDepot.icebergCatalogType
      • GCSDepot.metastoreUrl
      • GCSDepot.relativePath
  • depot_service.models.http module
    • Http
      • Http.headers
      • Http.queryParams
      • Http.url
  • depot_service.models.htttp_depot module
    • HttpDepot
      • HttpDepot.baseUrl
      • HttpDepot.headers
      • HttpDepot.queryParams
  • depot_service.models.iceberg_partition_spec_request module
    • IcebergPartitionSpecRequest
      • IcebergPartitionSpecRequest.column
      • IcebergPartitionSpecRequest.index
      • IcebergPartitionSpecRequest.name
      • IcebergPartitionSpecRequest.num_buckets
      • IcebergPartitionSpecRequest.type
  • depot_service.models.iceberg_stats module
    • IcebergStats
      • IcebergStats.properties
      • IcebergStats.stats
      • IcebergStats.timeline
  • depot_service.models.jdbc module
    • Jdbc
      • Jdbc.database
      • Jdbc.host
      • Jdbc.params
      • Jdbc.port
      • Jdbc.schema_
      • Jdbc.subprotocol
      • Jdbc.table
      • Jdbc.url
  • depot_service.models.jdbc_depot module
    • JdbcDepot
      • JdbcDepot.database
      • JdbcDepot.host
      • JdbcDepot.params
      • JdbcDepot.port
      • JdbcDepot.subprotocol
  • depot_service.models.kafka module
    • Kafka
      • Kafka.brokers
      • Kafka.params
      • Kafka.schemaRegistryUrl
      • Kafka.topic
  • depot_service.models.kafka_depot module
    • KafkaDepot
      • KafkaDepot.brokers
      • KafkaDepot.params
      • KafkaDepot.schemaRegistryUrl
  • depot_service.models.metadata_version_response module
    • MetadataVersionResponse
      • MetadataVersionResponse.timestamp
      • MetadataVersionResponse.version
  • depot_service.models.mongo_db module
    • MongoDb
      • MongoDb.connectionUrl
      • MongoDb.database
      • MongoDb.nodes
      • MongoDb.params
      • MongoDb.subprotocol
      • MongoDb.table
  • depot_service.models.mongo_db_depot module
    • MongoDBDepot
      • MongoDBDepot.nodes
      • MongoDBDepot.params
      • MongoDBDepot.subprotocol
  • depot_service.models.mysql_depot module
    • MysqlDepot
      • MysqlDepot.host
      • MysqlDepot.params
      • MysqlDepot.port
      • MysqlDepot.subprotocol
  • depot_service.models.open_search_depot module
    • OpenSearchDepot
      • OpenSearchDepot.nodes
      • OpenSearchDepot.params
  • depot_service.models.oracle module
    • Oracle
      • Oracle.host
      • Oracle.port
      • Oracle.schema_
      • Oracle.service
      • Oracle.subprotocol
      • Oracle.table
      • Oracle.url
  • depot_service.models.oracle_depot module
    • OracleDepot
      • OracleDepot.host
      • OracleDepot.params
      • OracleDepot.port
      • OracleDepot.service
      • OracleDepot.subprotocol
  • depot_service.models.postgres_depot module
    • PostgresDepot
      • PostgresDepot.database
      • PostgresDepot.host
      • PostgresDepot.params
      • PostgresDepot.port
      • PostgresDepot.subprotocol
  • depot_service.models.presto module
    • Presto
      • Presto.catalog
      • Presto.host
      • Presto.port
      • Presto.schema_
      • Presto.url
  • depot_service.models.presto_depot module
    • PrestoDepot
      • PrestoDepot.catalog
      • PrestoDepot.host
      • PrestoDepot.params
      • PrestoDepot.port
      • PrestoDepot.schema_
  • depot_service.models.properties_response module
    • PropertiesResponse
      • PropertiesResponse.properties
  • depot_service.models.pulsar module
    • Pulsar
      • Pulsar.adminUrl
      • Pulsar.isPersistent
      • Pulsar.params
      • Pulsar.serviceUrl
      • Pulsar.tenant
      • Pulsar.topic
  • depot_service.models.pulsar_depot module
    • PulsarDepot
      • PulsarDepot.adminUrl
      • PulsarDepot.params
      • PulsarDepot.serviceUrl
      • PulsarDepot.tenant
  • depot_service.models.pulsar_request module
    • PulsarRequest
      • PulsarRequest.partitions
      • PulsarRequest.type
  • depot_service.models.pulsar_response module
    • PulsarResponse
      • PulsarResponse.partitions
      • PulsarResponse.type
  • depot_service.models.redis module
    • Redis
      • Redis.db
      • Redis.host
      • Redis.port
      • Redis.table
  • depot_service.models.redis_depot module
    • RedisDepot
      • RedisDepot.db
      • RedisDepot.host
      • RedisDepot.port
  • depot_service.models.redshift_depot module
    • RedshiftDepot
      • RedshiftDepot.bucket
      • RedshiftDepot.database
      • RedshiftDepot.host
      • RedshiftDepot.params
      • RedshiftDepot.port
      • RedshiftDepot.relativePath
      • RedshiftDepot.scheme
      • RedshiftDepot.subprotocol
  • depot_service.models.s3 module
    • S3
      • S3.bucket
      • S3.icebergCatalogType
      • S3.metastoreUrl
      • S3.path
      • S3.relativePath
      • S3.s3Url
  • depot_service.models.s3_depot module
    • S3Depot
      • S3Depot.bucket
      • S3Depot.format
      • S3Depot.icebergCatalogType
      • S3Depot.metastoreUrl
      • S3Depot.relativePath
      • S3Depot.scheme
  • depot_service.models.snapshot_response module
    • SnapshotResponse
      • SnapshotResponse.snapshotId
      • SnapshotResponse.timestamp
  • depot_service.models.snowflake_depot module
    • SnowflakeDepot
      • SnowflakeDepot.database
      • SnowflakeDepot.params
      • SnowflakeDepot.url
      • SnowflakeDepot.warehouse
  • depot_service.models.wasbs module
    • Wasbs
      • Wasbs.account
      • Wasbs.container
      • Wasbs.icebergCatalogType
      • Wasbs.metastoreUrl
      • Wasbs.relativePath
      • Wasbs.wasbsUrl
  • depot_service.models.wasbs_depot module
    • WasbsDepot
      • WasbsDepot.account
      • WasbsDepot.container
      • WasbsDepot.endpointSuffix
      • WasbsDepot.format
      • WasbsDepot.icebergCatalogType
      • WasbsDepot.metastoreUrl
      • WasbsDepot.relativePath
  • Module contents

Submodules

depot_service.depot_service_client module

class depot_service.depot_service_client.DepotServiceClient(base_url, apikey, client=None)

Bases: object

class depot_service.depot_service_client.DepotServiceClientBuilder

Bases: BaseHTTPClientBuilder

build()

Build the DepotServiceClient instance.

Returns:

An instance of DepotServiceClient with the configured settings.

Return type:

DepotServiceClient

get_default_user_agent_suffix()

Module contents