depot-service/io.dataos.ds.client.models

Package-level declarations

Types

data class Abfss(val wasbsUrl: String? = null, val container: String? = null, val account: String? = null, val metastoreUrl: String? = null, val relativePath: String? = null, val icebergCatalogType: Abfss.IcebergCatalogType? = null, val abfssUrl: String? = null)

Represents the ABFSS (Azure Blob File System Service) configuration.

AbfssDepot

data class AbfssDepot(val account: String? = null, val container: String? = null, val relativePath: String? = null, val format: String? = null, val metastoreUrl: String? = null, val endpointSuffix: String? = null, val icebergCatalogType: AbfssDepot.IcebergCatalogType? = null)

Represents the ABFSS (Azure Blob File System Service) depot configuration.

AddressInfo

data class AddressInfo(val depot: String? = null, val type: String? = null, val collection: String? = null, val dataset: String? = null, val format: String? = null, val external: Boolean? = null, val isArchived: Boolean? = null, val source: String? = null, val connection: Map<String, Any>? = null)

Represents address information.

Bigquery

data class Bigquery(val projectID: String? = null, val project: String? = null, val dataset: String? = null, val table: String? = null)

Represents BigQuery information.

BigQueryDepot

data class BigQueryDepot(val project: String? = null, val params: Map<String, Any>? = null, val temporaryBucket: String? = null, val persistentBucket: String? = null)

Represents BigQuery information for the Depot.

ConnectionDetails

class ConnectionDetails

Represents the connection details for a dataset.

DatasetRequest

data class DatasetRequest(val schema: SchemaRequest? = null, val iceberg: IcebergRequest? = null, val pulsar: PulsarRequest? = null)

Represents a request for creating a dataset.

DatasetResponse

data class DatasetResponse(val schema: SchemaResponse? = null, val iceberg: IcebergResponse? = null, val pulsar: PulsarResponse? = null)

Represents a response containing dataset information.

DepotFlagRequest

data class DepotFlagRequest(val isArchived: Boolean? = null, val archivalMessage: String? = null)

Represents a request for updating depot flags.

DepotRequest

data class DepotRequest(val type: String? = null, val external: Boolean? = null, val owners: Array<String>? = null, val description: String? = null, val meta: Map<String, Any>? = null, val source: String? = null, val abfss: AbfssDepot? = null, val bigquery: BigQueryDepot? = null, val elasticsearch: ElasticSearchDepot? = null, val eventhub: EventhubDepot? = null, val file: FileDepot? = null, val gcs: GCSDepot? = null, val http: HttpDepot? = null, val jdbc: JdbcDepot? = null, val kafka: KafkaDepot? = null, val mongodb: MongoDBDepot? = null, val mysql: MysqlDepot? = null, val opensearch: OpenSearchDepot? = null, val oracle: OracleDepot? = null, val postgresql: PostgresDepot? = null, val presto: PrestoDepot? = null, val pulsar: PulsarDepot? = null, val redis: RedisDepot? = null, val redshift: RedshiftDepot? = null, val s3: S3Depot? = null, val snowflake: SnowflakeDepot? = null, val wasbs: WasbsDepot? = null)

Represents a request for creating a depot.

DepotResponse

data class DepotResponse(val name: String? = null, val type: String? = null, val external: Boolean? = null, val description: String? = null, val owners: Array<String>? = null, val meta: Map<String, Any>? = null, val source: String? = null, val isArchived: Boolean? = null, val archivalMessage: String? = null, val createdAt: String? = null, val updatedAt: String? = null, val abfss: AbfssDepot? = null, val bigquery: BigQueryDepot? = null, val elasticsearch: ElasticSearchDepot? = null, val eventhub: EventhubDepot? = null, val file: FileDepot? = null, val gcs: GCSDepot? = null, val http: HttpDepot? = null, val jdbc: JdbcDepot? = null, val kafka: KafkaDepot? = null, val mongodb: MongoDBDepot? = null, val mysql: MysqlDepot? = null, val opensearch: OpenSearchDepot? = null, val oracle: OracleDepot? = null, val postgresql: PostgresDepot? = null, val presto: PrestoDepot? = null, val pulsar: PulsarDepot? = null, val redis: RedisDepot? = null, val redshift: RedshiftDepot? = null, val s3: S3Depot? = null, val snowflake: SnowflakeDepot? = null, val wasbs: WasbsDepot? = null)

Represents the response for a depot.

ElasticSearch

data class ElasticSearch(val nodes: Array<String>? = null, val index: String? = null, val type: String? = null, val params: Map<String, Any>? = null)

Represents ElasticSearch configuration details.

ElasticSearchDepot

data class ElasticSearchDepot(val nodes: Array<String>? = null, val params: Map<String, Any>? = null)

Represents the ElasticSearch depot configuration.

Eventhub

data class Eventhub(val endpoint: String? = null, val eventhubName: String? = null)

Represents the Eventhub configuration.

EventhubDepot

data class EventhubDepot(val endpoint: String? = null, val params: Map<String, Any>? = null)

Represents the Eventhub depot configuration.

FieldRenameRequest

data class FieldRenameRequest(val name: String? = null)

Represents a request for field renaming.

FieldRequest

data class FieldRequest(val name: String? = null, val type: String? = null)

Represents a request for a field.

FieldUpdateRequest

data class FieldUpdateRequest(val type: String? = null)

Represents a request to update a field.

FileDepot

data class FileDepot(val path: String? = null, val format: String? = null, val metastoreUrl: String? = null, val icebergCatalogType: FileDepot.IcebergCatalogType? = null)

Represents a File Depot.

Gcs

data class Gcs(val gcsUrl: String? = null, val bucket: String? = null, val path: String? = null, val metastoreUrl: String? = null, val relativePath: String? = null, val icebergCatalogType: Gcs.IcebergCatalogType? = null)

Represents a Google Cloud Storage (GCS) configuration.

GCSDepot

data class GCSDepot(val bucket: String? = null, val relativePath: String? = null, val format: String? = null, val metastoreUrl: String? = null, val icebergCatalogType: GCSDepot.IcebergCatalogType? = null)

Represents a Google Cloud Storage (GCS) depot configuration.

Http

data class Http(val url: String? = null, val headers: Map<String, String>? = null, val queryParams: Map<String, String>? = null)

Represents an HTTP configuration.

HttpDepot

data class HttpDepot(val baseUrl: String? = null, val headers: Map<String, String>? = null, val queryParams: Map<String, String>? = null)

Represents an HTTP depot configuration.

IcebergPartitionSpecRequest

data class IcebergPartitionSpecRequest(val index: Int? = null, val type: String? = null, val column: String? = null, val name: String? = null, val numBuckets: Int? = null)

Represents a request for configuring an Iceberg partition specification.

IcebergPartitionSpecResponse

data class IcebergPartitionSpecResponse(val index: Int? = null, val type: String? = null, val column: String? = null, val name: String? = null)

Represents a response containing information about an Iceberg partition specification.

IcebergRequest

data class IcebergRequest(val specs: Array<IcebergPartitionSpecRequest>? = null, val properties: Map<String, String>? = null)

Represents a request for Iceberg-related information.

IcebergResponse

data class IcebergResponse(val specs: Array<IcebergPartitionSpecResponse>? = null, val properties: Map<String, String>? = null, val snapshotId: String? = null, val version: String? = null)

Represents a response containing Iceberg-related information.

IcebergStats

data class IcebergStats(val stats: Map<String, String>? = null, val timeline: Map<String, Map<String, String>>? = null, val properties: Map<String, String>? = null)

Represents statistics and timeline information related to Iceberg.

Jdbc

data class Jdbc(val url: String? = null, val table: String? = null, val database: String? = null, val host: String? = null, val port: Int? = null, val subprotocol: String? = null, val schema: String? = null, val params: Map<String, Any>? = null)

Represents JDBC connection details.

JdbcDepot

data class JdbcDepot(val subprotocol: String? = null, val host: String? = null, val port: Int? = null, val database: String? = null, val params: Map<String, Any>? = null)

Represents a JDBC depot configuration.

Kafka

data class Kafka(val brokers: Array<String>? = null, val topic: String? = null, val schemaRegistryUrl: String? = null, val params: Map<String, Any>? = null)

Represents a Kafka configuration.

KafkaDepot

data class KafkaDepot(val brokers: Array<String>? = null, val schemaRegistryUrl: String? = null, val params: Map<String, Any>? = null)

Represents a Kafka depot configuration.

MetadataVersionResponse

data class MetadataVersionResponse(val version: String? = null, val timestamp: Long? = null)

Represents a response containing metadata version information.

MongoDb

data class MongoDb(val connectionUrl: String? = null, val subprotocol: String? = null, val nodes: Array<String>? = null, val database: String? = null, val table: String? = null, val params: Map<String, Any>? = null)

Represents a MongoDB configuration.

MongoDBDepot

data class MongoDBDepot(val subprotocol: String? = null, val nodes: Array<String>? = null, val params: Map<String, Any>? = null)

Represents a MongoDB depot configuration.

MysqlDepot

data class MysqlDepot(val subprotocol: String? = null, val host: String? = null, val port: Int? = null, val params: Map<String, Any>? = null)

Represents a MySQL depot configuration.

OpenSearchDepot

data class OpenSearchDepot(val nodes: Array<String>? = null, val params: Map<String, Any>? = null)

Represents an OpenSearch depot configuration.

Oracle

data class Oracle(val url: String? = null, val host: String? = null, val port: Int? = null, val table: String? = null, val service: String? = null, val schema: String? = null, val subprotocol: String? = null)

Represents an Oracle configuration.

OracleDepot

data class OracleDepot(val subprotocol: String? = null, val host: String? = null, val port: Int? = null, val service: String? = null, val params: Map<String, Any>? = null)

Represents an Oracle depot configuration.

PostgresDepot

data class PostgresDepot(val subprotocol: String? = null, val host: String? = null, val port: Int? = null, val database: String? = null, val params: Map<String, Any>? = null)

Represents a Postgres depot configuration.

Presto

data class Presto(val url: String? = null, val host: String? = null, val port: Int? = null, val catalog: String? = null, val schema: String? = null)

Represents a Presto configuration.

PrestoDepot

data class PrestoDepot(val host: String? = null, val port: Int? = null, val catalog: String? = null, val schema: String? = null, val params: Map<String, Any>? = null)

Represents a Presto depot configuration.

PropertiesResponse

data class PropertiesResponse(val key: String? = null, val value: String? = null)

Represents a response containing properties information.

Pulsar

data class Pulsar(val serviceUrl: String? = null, val adminUrl: String? = null, val tenant: String? = null, val topic: String? = null, val isPersistent: Boolean? = null, val params: Map<String, Any>? = null)

Represents a Pulsar configuration.

PulsarDepot

data class PulsarDepot(val adminUrl: String? = null, val serviceUrl: String? = null, val tenant: String? = null, val params: Map<String, Any>? = null)

Represents a Pulsar depot configuration.

PulsarRequest

data class PulsarRequest(val partitions: Int? = null, val type: String? = null)

Represents a Pulsar request configuration.

PulsarResponse

data class PulsarResponse(val partitions: Int? = null, val type: String? = null)

Represents a Pulsar response configuration.

Redis

data class Redis(val host: String? = null, val port: Int? = null, val table: String? = null, val db: Int? = null)

Represents a Redis configuration.

RedisDepot

data class RedisDepot(val host: String? = null, val port: Int? = null, val db: Int? = null)

Represents a Redis depot configuration.

RedshiftDepot

data class RedshiftDepot(val subprotocol: String? = null, val host: String? = null, val port: Int? = null, val database: String? = null, val params: Map<String, Any>? = null, val scheme: String? = null, val bucket: String? = null, val relativePath: String? = null)

Represents a Redshift depot configuration.

data class S3(val s3Url: String? = null, val bucket: String? = null, val path: String? = null, val metastoreUrl: String? = null, val relativePath: String? = null, val icebergCatalogType: S3.IcebergCatalogType? = null)

Represents an S3 configuration.

S3Depot

data class S3Depot(val scheme: String? = null, val bucket: String? = null, val relativePath: String? = null, val format: String? = null, val metastoreUrl: String? = null, val icebergCatalogType: S3Depot.IcebergCatalogType? = null)

Represents an S3 depot configuration.

SchemaRequest

data class SchemaRequest(val type: String? = null, val avro: String? = null, val mapping: String? = null)

Represents a schema request configuration.

SchemaResponse

data class SchemaResponse(val type: String? = null, val avro: String? = null, val mapping: String? = null)

Represents a schema response configuration.

SnapshotResponse

data class SnapshotResponse(val snapshotId: String? = null, val timestamp: Long? = null)

Represents a snapshot response configuration.

SnowflakeDepot

data class SnowflakeDepot(val url: String? = null, val database: String? = null, val warehouse: String? = null, val params: Map<String, Any>? = null)

Represents a Snowflake depot configuration.

Wasbs

data class Wasbs(val wasbsUrl: String? = null, val container: String? = null, val account: String? = null, val metastoreUrl: String? = null, val relativePath: String? = null, val icebergCatalogType: Wasbs.IcebergCatalogType? = null)

Represents a Wasbs configuration.

WasbsDepot

data class WasbsDepot(val account: String? = null, val container: String? = null, val relativePath: String? = null, val format: String? = null, val metastoreUrl: String? = null, val endpointSuffix: String? = null, val icebergCatalogType: WasbsDepot.IcebergCatalogType? = null)

Represents a Wasbs depot configuration.