Marketplace

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.marketplace module.

class databricks.sdk.service.marketplace.AddExchangeForListingRequest
listing_id: str
exchange_id: str
as_dict() → dict

Serializes the AddExchangeForListingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AddExchangeForListingRequest

Deserializes the AddExchangeForListingRequest from a dictionary.

class databricks.sdk.service.marketplace.AddExchangeForListingResponse
exchange_for_listing: ExchangeListing | None = None
as_dict() → dict

Serializes the AddExchangeForListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AddExchangeForListingResponse

Deserializes the AddExchangeForListingResponse from a dictionary.

class databricks.sdk.service.marketplace.AssetType
ASSET_TYPE_DATA_TABLE = "ASSET_TYPE_DATA_TABLE"
ASSET_TYPE_GIT_REPO = "ASSET_TYPE_GIT_REPO"
ASSET_TYPE_MEDIA = "ASSET_TYPE_MEDIA"
ASSET_TYPE_MODEL = "ASSET_TYPE_MODEL"
ASSET_TYPE_NOTEBOOK = "ASSET_TYPE_NOTEBOOK"
ASSET_TYPE_UNSPECIFIED = "ASSET_TYPE_UNSPECIFIED"
class databricks.sdk.service.marketplace.Category
ADVERTISING_AND_MARKETING = "ADVERTISING_AND_MARKETING"
CLIMATE_AND_ENVIRONMENT = "CLIMATE_AND_ENVIRONMENT"
COMMERCE = "COMMERCE"
DEMOGRAPHICS = "DEMOGRAPHICS"
ECONOMICS = "ECONOMICS"
EDUCATION = "EDUCATION"
ENERGY = "ENERGY"
FINANCIAL = "FINANCIAL"
GAMING = "GAMING"
GEOSPATIAL = "GEOSPATIAL"
HEALTH = "HEALTH"
LOOKUP_TABLES = "LOOKUP_TABLES"
MANUFACTURING = "MANUFACTURING"
MEDIA = "MEDIA"
OTHER = "OTHER"
PUBLIC_SECTOR = "PUBLIC_SECTOR"
RETAIL = "RETAIL"
SCIENCE_AND_RESEARCH = "SCIENCE_AND_RESEARCH"
SECURITY = "SECURITY"
SPORTS = "SPORTS"
TRANSPORTATION_AND_LOGISTICS = "TRANSPORTATION_AND_LOGISTICS"
TRAVEL_AND_TOURISM = "TRAVEL_AND_TOURISM"
class databricks.sdk.service.marketplace.ConsumerTerms
version: str
as_dict() → dict

Serializes the ConsumerTerms into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ConsumerTerms

Deserializes the ConsumerTerms from a dictionary.

class databricks.sdk.service.marketplace.ContactInfo

contact info for the consumer requesting data or performing a listing installation

company: str | None = None
email: str | None = None
first_name: str | None = None
last_name: str | None = None
as_dict() → dict

Serializes the ContactInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ContactInfo

Deserializes the ContactInfo from a dictionary.

class databricks.sdk.service.marketplace.Cost
FREE = "FREE"
PAID = "PAID"
class databricks.sdk.service.marketplace.CreateExchangeFilterRequest
filter: ExchangeFilter
as_dict() → dict

Serializes the CreateExchangeFilterRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExchangeFilterRequest

Deserializes the CreateExchangeFilterRequest from a dictionary.

class databricks.sdk.service.marketplace.CreateExchangeFilterResponse
filter_id: str | None = None
as_dict() → dict

Serializes the CreateExchangeFilterResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExchangeFilterResponse

Deserializes the CreateExchangeFilterResponse from a dictionary.

class databricks.sdk.service.marketplace.CreateExchangeRequest
exchange: Exchange
as_dict() → dict

Serializes the CreateExchangeRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExchangeRequest

Deserializes the CreateExchangeRequest from a dictionary.

class databricks.sdk.service.marketplace.CreateExchangeResponse
exchange_id: str | None = None
as_dict() → dict

Serializes the CreateExchangeResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExchangeResponse

Deserializes the CreateExchangeResponse from a dictionary.

class databricks.sdk.service.marketplace.CreateFileRequest
file_parent: FileParent
marketplace_file_type: MarketplaceFileType
mime_type: str
display_name: str | None = None
as_dict() → dict

Serializes the CreateFileRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateFileRequest

Deserializes the CreateFileRequest from a dictionary.

class databricks.sdk.service.marketplace.CreateFileResponse
file_info: FileInfo | None = None
upload_url: str | None = None

Pre-signed POST URL to blob storage

as_dict() → dict

Serializes the CreateFileResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateFileResponse

Deserializes the CreateFileResponse from a dictionary.

class databricks.sdk.service.marketplace.CreateInstallationRequest
accepted_consumer_terms: ConsumerTerms | None = None
catalog_name: str | None = None
listing_id: str | None = None
recipient_type: DeltaSharingRecipientType | None = None
repo_detail: RepoInstallation | None = None

for git repo installations

share_name: str | None = None
as_dict() → dict

Serializes the CreateInstallationRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateInstallationRequest

Deserializes the CreateInstallationRequest from a dictionary.

class databricks.sdk.service.marketplace.CreateListingRequest
listing: Listing
as_dict() → dict

Serializes the CreateListingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateListingRequest

Deserializes the CreateListingRequest from a dictionary.

class databricks.sdk.service.marketplace.CreateListingResponse
listing_id: str | None = None
as_dict() → dict

Serializes the CreateListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateListingResponse

Deserializes the CreateListingResponse from a dictionary.

class databricks.sdk.service.marketplace.CreatePersonalizationRequest

Data request messages also creates a lead (maybe)

intended_use: str
accepted_consumer_terms: ConsumerTerms
comment: str | None = None
company: str | None = None
first_name: str | None = None
is_from_lighthouse: bool | None = None
last_name: str | None = None
listing_id: str | None = None
recipient_type: DeltaSharingRecipientType | None = None
as_dict() → dict

Serializes the CreatePersonalizationRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreatePersonalizationRequest

Deserializes the CreatePersonalizationRequest from a dictionary.

class databricks.sdk.service.marketplace.CreatePersonalizationRequestResponse
id: str | None = None
as_dict() → dict

Serializes the CreatePersonalizationRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreatePersonalizationRequestResponse

Deserializes the CreatePersonalizationRequestResponse from a dictionary.

class databricks.sdk.service.marketplace.CreateProviderRequest
provider: ProviderInfo
as_dict() → dict

Serializes the CreateProviderRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateProviderRequest

Deserializes the CreateProviderRequest from a dictionary.

class databricks.sdk.service.marketplace.CreateProviderResponse
id: str | None = None
as_dict() → dict

Serializes the CreateProviderResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateProviderResponse

Deserializes the CreateProviderResponse from a dictionary.

class databricks.sdk.service.marketplace.DataRefresh
DAILY = "DAILY"
HOURLY = "HOURLY"
MINUTE = "MINUTE"
MONTHLY = "MONTHLY"
NONE = "NONE"
QUARTERLY = "QUARTERLY"
SECOND = "SECOND"
WEEKLY = "WEEKLY"
YEARLY = "YEARLY"
class databricks.sdk.service.marketplace.DataRefreshInfo
interval: int
unit: DataRefresh
as_dict() → dict

Serializes the DataRefreshInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DataRefreshInfo

Deserializes the DataRefreshInfo from a dictionary.

class databricks.sdk.service.marketplace.DeleteExchangeFilterResponse
as_dict() → dict

Serializes the DeleteExchangeFilterResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteExchangeFilterResponse

Deserializes the DeleteExchangeFilterResponse from a dictionary.

class databricks.sdk.service.marketplace.DeleteExchangeResponse
as_dict() → dict

Serializes the DeleteExchangeResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteExchangeResponse

Deserializes the DeleteExchangeResponse from a dictionary.

class databricks.sdk.service.marketplace.DeleteFileResponse
as_dict() → dict

Serializes the DeleteFileResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteFileResponse

Deserializes the DeleteFileResponse from a dictionary.

class databricks.sdk.service.marketplace.DeleteInstallationResponse
as_dict() → dict

Serializes the DeleteInstallationResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteInstallationResponse

Deserializes the DeleteInstallationResponse from a dictionary.

class databricks.sdk.service.marketplace.DeleteListingResponse
as_dict() → dict

Serializes the DeleteListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteListingResponse

Deserializes the DeleteListingResponse from a dictionary.

class databricks.sdk.service.marketplace.DeleteProviderResponse
as_dict() → dict

Serializes the DeleteProviderResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteProviderResponse

Deserializes the DeleteProviderResponse from a dictionary.

class databricks.sdk.service.marketplace.DeltaSharingRecipientType
DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS = "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
DELTA_SHARING_RECIPIENT_TYPE_OPEN = "DELTA_SHARING_RECIPIENT_TYPE_OPEN"
class databricks.sdk.service.marketplace.Exchange
name: str
comment: str | None = None
created_at: int | None = None
created_by: str | None = None
filters: List[ExchangeFilter] | None = None
id: str | None = None
linked_listings: List[ExchangeListing] | None = None
updated_at: int | None = None
updated_by: str | None = None
as_dict() → dict

Serializes the Exchange into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Exchange

Deserializes the Exchange from a dictionary.

class databricks.sdk.service.marketplace.ExchangeFilter
exchange_id: str
filter_value: str
filter_type: ExchangeFilterType
created_at: int | None = None
created_by: str | None = None
id: str | None = None
name: str | None = None
updated_at: int | None = None
updated_by: str | None = None
as_dict() → dict

Serializes the ExchangeFilter into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExchangeFilter

Deserializes the ExchangeFilter from a dictionary.

class databricks.sdk.service.marketplace.ExchangeFilterType
GLOBAL_METASTORE_ID = "GLOBAL_METASTORE_ID"
class databricks.sdk.service.marketplace.ExchangeListing
created_at: int | None = None
created_by: str | None = None
exchange_id: str | None = None
exchange_name: str | None = None
id: str | None = None
listing_id: str | None = None
listing_name: str | None = None
as_dict() → dict

Serializes the ExchangeListing into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExchangeListing

Deserializes the ExchangeListing from a dictionary.

class databricks.sdk.service.marketplace.FileInfo
created_at: int | None = None
display_name: str | None = None

Name displayed to users for applicable files, e.g. embedded notebooks

file_parent: FileParent | None = None
id: str | None = None
marketplace_file_type: MarketplaceFileType | None = None
mime_type: str | None = None
status: FileStatus | None = None
status_message: str | None = None

Populated if status is in a failed state with more information on reason for the failure.

updated_at: int | None = None
as_dict() → dict

Serializes the FileInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FileInfo

Deserializes the FileInfo from a dictionary.

class databricks.sdk.service.marketplace.FileParent
file_parent_type: FileParentType | None = None
parent_id: str | None = None

TODO make the following fields required

as_dict() → dict

Serializes the FileParent into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FileParent

Deserializes the FileParent from a dictionary.

class databricks.sdk.service.marketplace.FileParentType
LISTING = "LISTING"
PROVIDER = "PROVIDER"
class databricks.sdk.service.marketplace.FileStatus
FILE_STATUS_PUBLISHED = "FILE_STATUS_PUBLISHED"
FILE_STATUS_SANITIZATION_FAILED = "FILE_STATUS_SANITIZATION_FAILED"
FILE_STATUS_SANITIZING = "FILE_STATUS_SANITIZING"
FILE_STATUS_STAGING = "FILE_STATUS_STAGING"
class databricks.sdk.service.marketplace.FilterType
METASTORE = "METASTORE"
class databricks.sdk.service.marketplace.FulfillmentType
INSTALL = "INSTALL"
REQUEST_ACCESS = "REQUEST_ACCESS"
class databricks.sdk.service.marketplace.GetExchangeResponse
exchange: Exchange | None = None
as_dict() → dict

Serializes the GetExchangeResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetExchangeResponse

Deserializes the GetExchangeResponse from a dictionary.

class databricks.sdk.service.marketplace.GetFileResponse
file_info: FileInfo | None = None
as_dict() → dict

Serializes the GetFileResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetFileResponse

Deserializes the GetFileResponse from a dictionary.

class databricks.sdk.service.marketplace.GetLatestVersionProviderAnalyticsDashboardResponse
version: int | None = None

version here is latest logical version of the dashboard template

as_dict() → dict

Serializes the GetLatestVersionProviderAnalyticsDashboardResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetLatestVersionProviderAnalyticsDashboardResponse

Deserializes the GetLatestVersionProviderAnalyticsDashboardResponse from a dictionary.

class databricks.sdk.service.marketplace.GetListingContentMetadataResponse
next_page_token: str | None = None
shared_data_objects: List[SharedDataObject] | None = None
as_dict() → dict

Serializes the GetListingContentMetadataResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetListingContentMetadataResponse

Deserializes the GetListingContentMetadataResponse from a dictionary.

class databricks.sdk.service.marketplace.GetListingResponse
listing: Listing | None = None
as_dict() → dict

Serializes the GetListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetListingResponse

Deserializes the GetListingResponse from a dictionary.

class databricks.sdk.service.marketplace.GetListingsResponse
listings: List[Listing] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the GetListingsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetListingsResponse

Deserializes the GetListingsResponse from a dictionary.

class databricks.sdk.service.marketplace.GetPersonalizationRequestResponse
personalization_requests: List[PersonalizationRequest] | None = None
as_dict() → dict

Serializes the GetPersonalizationRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetPersonalizationRequestResponse

Deserializes the GetPersonalizationRequestResponse from a dictionary.

class databricks.sdk.service.marketplace.GetProviderResponse
provider: ProviderInfo | None = None
as_dict() → dict

Serializes the GetProviderResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetProviderResponse

Deserializes the GetProviderResponse from a dictionary.

class databricks.sdk.service.marketplace.Installation
installation: InstallationDetail | None = None
as_dict() → dict

Serializes the Installation into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Installation

Deserializes the Installation from a dictionary.

class databricks.sdk.service.marketplace.InstallationDetail
catalog_name: str | None = None
error_message: str | None = None
id: str | None = None
installed_on: int | None = None
listing_id: str | None = None
listing_name: str | None = None
recipient_type: DeltaSharingRecipientType | None = None
repo_name: str | None = None
repo_path: str | None = None
share_name: str | None = None
status: InstallationStatus | None = None
token_detail: TokenDetail | None = None
tokens: List[TokenInfo] | None = None
as_dict() → dict

Serializes the InstallationDetail into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → InstallationDetail

Deserializes the InstallationDetail from a dictionary.

class databricks.sdk.service.marketplace.InstallationStatus
FAILED = "FAILED"
INSTALLED = "INSTALLED"
class databricks.sdk.service.marketplace.ListAllInstallationsResponse
installations: List[InstallationDetail] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListAllInstallationsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListAllInstallationsResponse

Deserializes the ListAllInstallationsResponse from a dictionary.

class databricks.sdk.service.marketplace.ListAllPersonalizationRequestsResponse
next_page_token: str | None = None
personalization_requests: List[PersonalizationRequest] | None = None
as_dict() → dict

Serializes the ListAllPersonalizationRequestsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListAllPersonalizationRequestsResponse

Deserializes the ListAllPersonalizationRequestsResponse from a dictionary.

class databricks.sdk.service.marketplace.ListExchangeFiltersResponse
filters: List[ExchangeFilter] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListExchangeFiltersResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListExchangeFiltersResponse

Deserializes the ListExchangeFiltersResponse from a dictionary.

class databricks.sdk.service.marketplace.ListExchangesForListingResponse
exchange_listing: List[ExchangeListing] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListExchangesForListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListExchangesForListingResponse

Deserializes the ListExchangesForListingResponse from a dictionary.

class databricks.sdk.service.marketplace.ListExchangesResponse
exchanges: List[Exchange] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListExchangesResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListExchangesResponse

Deserializes the ListExchangesResponse from a dictionary.

class databricks.sdk.service.marketplace.ListFilesResponse
file_infos: List[FileInfo] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListFilesResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListFilesResponse

Deserializes the ListFilesResponse from a dictionary.

class databricks.sdk.service.marketplace.ListFulfillmentsResponse
fulfillments: List[ListingFulfillment] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListFulfillmentsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListFulfillmentsResponse

Deserializes the ListFulfillmentsResponse from a dictionary.

class databricks.sdk.service.marketplace.ListInstallationsResponse
installations: List[InstallationDetail] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListInstallationsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListInstallationsResponse

Deserializes the ListInstallationsResponse from a dictionary.

class databricks.sdk.service.marketplace.ListListingsForExchangeResponse
exchange_listings: List[ExchangeListing] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListListingsForExchangeResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListListingsForExchangeResponse

Deserializes the ListListingsForExchangeResponse from a dictionary.

class databricks.sdk.service.marketplace.ListListingsResponse
listings: List[Listing] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListListingsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListListingsResponse

Deserializes the ListListingsResponse from a dictionary.

class databricks.sdk.service.marketplace.ListProviderAnalyticsDashboardResponse
id: str
dashboard_id: str

dashboard_id will be used to open Lakeview dashboard.

version: int | None = None
as_dict() → dict

Serializes the ListProviderAnalyticsDashboardResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListProviderAnalyticsDashboardResponse

Deserializes the ListProviderAnalyticsDashboardResponse from a dictionary.

class databricks.sdk.service.marketplace.ListProvidersResponse
next_page_token: str | None = None
providers: List[ProviderInfo] | None = None
as_dict() → dict

Serializes the ListProvidersResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListProvidersResponse

Deserializes the ListProvidersResponse from a dictionary.

class databricks.sdk.service.marketplace.Listing
summary: ListingSummary

Next Number: 26

detail: ListingDetail | None = None
id: str | None = None
as_dict() → dict

Serializes the Listing into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Listing

Deserializes the Listing from a dictionary.

class databricks.sdk.service.marketplace.ListingDetail
assets: List[AssetType] | None = None

Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK

collection_date_end: int | None = None

The ending date timestamp for when the data spans

collection_date_start: int | None = None

The starting date timestamp for when the data spans

collection_granularity: DataRefreshInfo | None = None

Smallest unit of time in the dataset

cost: Cost | None = None

Whether the dataset is free or paid

data_source: str | None = None

Where/how the data is sourced

description: str | None = None
embedded_notebook_file_infos: List[FileInfo] | None = None
file_ids: List[str] | None = None
geographical_coverage: str | None = None

Which geo region the listing data is collected from

license: str | None = None

ID 20, 21 removed don’t use License of the data asset - Required for listings with model based assets

pricing_model: str | None = None

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid TODO: Not used yet, should deprecate if we will never use it

size: float | None = None

size of the dataset in GB

tags: List[ListingTag] | None = None

Listing tags - Simple key value pair to annotate listings. When should I use tags vs dedicated fields? Using tags avoids the need to add new columns in the database for new annotations. However, this should be used sparingly since tags are stored as key value pair. Use tags only: 1. If the field is optional and won’t need to have NOT NULL integrity check 2. The value is fairly fixed, static and low cardinality (eg. enums). 3. The value won’t be used in filters or joins with other tables.

terms_of_service: str | None = None
update_frequency: DataRefreshInfo | None = None

How often data is updated

as_dict() → dict

Serializes the ListingDetail into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListingDetail

Deserializes the ListingDetail from a dictionary.

class databricks.sdk.service.marketplace.ListingFulfillment
listing_id: str
fulfillment_type: FulfillmentType | None = None
recipient_type: DeltaSharingRecipientType | None = None
repo_info: RepoInfo | None = None
share_info: ShareInfo | None = None
as_dict() → dict

Serializes the ListingFulfillment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListingFulfillment

Deserializes the ListingFulfillment from a dictionary.

class databricks.sdk.service.marketplace.ListingSetting
filters: List[VisibilityFilter] | None = None

filters are joined with or conjunction.

visibility: Visibility | None = None
as_dict() → dict

Serializes the ListingSetting into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListingSetting

Deserializes the ListingSetting from a dictionary.

class databricks.sdk.service.marketplace.ListingShareType
FULL = "FULL"
SAMPLE = "SAMPLE"
class databricks.sdk.service.marketplace.ListingStatus

Enums

DRAFT = "DRAFT"
PENDING = "PENDING"
PUBLISHED = "PUBLISHED"
SUSPENDED = "SUSPENDED"
class databricks.sdk.service.marketplace.ListingSummary

Next Number: 26

name: str
listing_type: ListingType
categories: List[Category] | None = None
created_at: int | None = None
created_by: str | None = None
created_by_id: int | None = None
exchange_ids: List[str] | None = None
git_repo: RepoInfo | None = None

if a git repo is being created, a listing will be initialized with this field as opposed to a share

metastore_id: str | None = None
provider_id: str | None = None
provider_region: RegionInfo | None = None
published_at: int | None = None
published_by: str | None = None
setting: ListingSetting | None = None
share: ShareInfo | None = None
status: ListingStatus | None = None

Enums

subtitle: str | None = None
updated_at: int | None = None
updated_by: str | None = None
updated_by_id: int | None = None
as_dict() → dict

Serializes the ListingSummary into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListingSummary

Deserializes the ListingSummary from a dictionary.

class databricks.sdk.service.marketplace.ListingTag
tag_name: ListingTagType | None = None

Tag name (enum)

tag_values: List[str] | None = None

String representation of the tag value. Values should be string literals (no complex types)

as_dict() → dict

Serializes the ListingTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListingTag

Deserializes the ListingTag from a dictionary.

class databricks.sdk.service.marketplace.ListingTagType
LISTING_TAG_TYPE_LANGUAGE = "LISTING_TAG_TYPE_LANGUAGE"
LISTING_TAG_TYPE_TASK = "LISTING_TAG_TYPE_TASK"
LISTING_TAG_TYPE_UNSPECIFIED = "LISTING_TAG_TYPE_UNSPECIFIED"
class databricks.sdk.service.marketplace.ListingType
PERSONALIZED = "PERSONALIZED"
STANDARD = "STANDARD"
class databricks.sdk.service.marketplace.MarketplaceFileType
EMBEDDED_NOTEBOOK = "EMBEDDED_NOTEBOOK"
PROVIDER_ICON = "PROVIDER_ICON"
class databricks.sdk.service.marketplace.PersonalizationRequest
consumer_region: RegionInfo
comment: str | None = None
contact_info: ContactInfo | None = None

contact info for the consumer requesting data or performing a listing installation

created_at: int | None = None
id: str | None = None
intended_use: str | None = None
is_from_lighthouse: bool | None = None
listing_id: str | None = None
listing_name: str | None = None
metastore_id: str | None = None
provider_id: str | None = None
recipient_type: DeltaSharingRecipientType | None = None
share: ShareInfo | None = None
status: PersonalizationRequestStatus | None = None
status_message: str | None = None
updated_at: int | None = None
as_dict() → dict

Serializes the PersonalizationRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PersonalizationRequest

Deserializes the PersonalizationRequest from a dictionary.

class databricks.sdk.service.marketplace.PersonalizationRequestStatus
DENIED = "DENIED"
FULFILLED = "FULFILLED"
NEW = "NEW"
REQUEST_PENDING = "REQUEST_PENDING"
class databricks.sdk.service.marketplace.ProviderAnalyticsDashboard
id: str
as_dict() → dict

Serializes the ProviderAnalyticsDashboard into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ProviderAnalyticsDashboard

Deserializes the ProviderAnalyticsDashboard from a dictionary.

class databricks.sdk.service.marketplace.ProviderInfo
name: str
business_contact_email: str
dark_mode_icon_file_id: str | None = None
dark_mode_icon_file_path: str | None = None
description: str | None = None
icon_file_id: str | None = None
icon_file_path: str | None = None
id: str | None = None

is_featured is accessible by consumers only

published_by: str | None = None

published_by is only applicable to data aggregators (e.g. Crux)

support_contact_email: str | None = None
as_dict() → dict

Serializes the ProviderInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ProviderInfo

Deserializes the ProviderInfo from a dictionary.

class databricks.sdk.service.marketplace.RegionInfo
cloud: str | None = None
region: str | None = None
as_dict() → dict

Serializes the RegionInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegionInfo

Deserializes the RegionInfo from a dictionary.

class databricks.sdk.service.marketplace.RemoveExchangeForListingResponse
as_dict() → dict

Serializes the RemoveExchangeForListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RemoveExchangeForListingResponse

Deserializes the RemoveExchangeForListingResponse from a dictionary.

class databricks.sdk.service.marketplace.RepoInfo
git_repo_url: str

the git repo url e.g. https://github.com/databrickslabs/dolly.git

as_dict() → dict

Serializes the RepoInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RepoInfo

Deserializes the RepoInfo from a dictionary.

class databricks.sdk.service.marketplace.RepoInstallation
repo_name: str

the user-specified repo name for their installed git repo listing

repo_path: str

refers to the full url file path that navigates the user to the repo’s entrypoint (e.g. a README.md file, or the repo file view in the unified UI) should just be a relative path

as_dict() → dict

Serializes the RepoInstallation into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RepoInstallation

Deserializes the RepoInstallation from a dictionary.

class databricks.sdk.service.marketplace.SearchListingsResponse
listings: List[Listing] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the SearchListingsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchListingsResponse

Deserializes the SearchListingsResponse from a dictionary.

class databricks.sdk.service.marketplace.ShareInfo
name: str
type: ListingShareType
as_dict() → dict

Serializes the ShareInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ShareInfo

Deserializes the ShareInfo from a dictionary.

class databricks.sdk.service.marketplace.SharedDataObject
data_object_type: str | None = None

The type of the data object. Could be one of: TABLE, SCHEMA, NOTEBOOK_FILE, MODEL, VOLUME

name: str | None = None

Name of the shared object

as_dict() → dict

Serializes the SharedDataObject into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SharedDataObject

Deserializes the SharedDataObject from a dictionary.

class databricks.sdk.service.marketplace.SortBy
SORT_BY_DATE = "SORT_BY_DATE"
SORT_BY_RELEVANCE = "SORT_BY_RELEVANCE"
SORT_BY_TITLE = "SORT_BY_TITLE"
SORT_BY_UNSPECIFIED = "SORT_BY_UNSPECIFIED"
class databricks.sdk.service.marketplace.SortBySpec
sort_by: SortBy

The field on which to sort the listing.

sort_order: SortOrder

The order in which to sort the listing.

as_dict() → dict

Serializes the SortBySpec into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SortBySpec

Deserializes the SortBySpec from a dictionary.

class databricks.sdk.service.marketplace.SortOrder
SORT_ORDER_ASCENDING = "SORT_ORDER_ASCENDING"
SORT_ORDER_DESCENDING = "SORT_ORDER_DESCENDING"
SORT_ORDER_UNSPECIFIED = "SORT_ORDER_UNSPECIFIED"
class databricks.sdk.service.marketplace.TokenDetail
bearer_token: str | None = None
endpoint: str | None = None
expiration_time: str | None = None
share_credentials_version: int | None = None

These field names must follow the delta sharing protocol. Original message: RetrieveToken.Response in managed-catalog/api/messages/recipient.proto

as_dict() → dict

Serializes the TokenDetail into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenDetail

Deserializes the TokenDetail from a dictionary.

class databricks.sdk.service.marketplace.TokenInfo
activation_url: str | None = None

Full activation url to retrieve the access token. It will be empty if the token is already retrieved.

created_at: int | None = None

Time at which this Recipient Token was created, in epoch milliseconds.

created_by: str | None = None

Username of Recipient Token creator.

expiration_time: int | None = None

Expiration timestamp of the token in epoch milliseconds.

id: str | None = None

Unique id of the Recipient Token.

updated_at: int | None = None

Time at which this Recipient Token was updated, in epoch milliseconds.

updated_by: str | None = None

Username of Recipient Token updater.

as_dict() → dict

Serializes the TokenInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TokenInfo

Deserializes the TokenInfo from a dictionary.

class databricks.sdk.service.marketplace.UpdateExchangeFilterRequest
filter: ExchangeFilter
id: str | None = None
as_dict() → dict

Serializes the UpdateExchangeFilterRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExchangeFilterRequest

Deserializes the UpdateExchangeFilterRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdateExchangeFilterResponse
filter: ExchangeFilter | None = None
as_dict() → dict

Serializes the UpdateExchangeFilterResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExchangeFilterResponse

Deserializes the UpdateExchangeFilterResponse from a dictionary.

class databricks.sdk.service.marketplace.UpdateExchangeRequest
exchange: Exchange
id: str | None = None
as_dict() → dict

Serializes the UpdateExchangeRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExchangeRequest

Deserializes the UpdateExchangeRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdateExchangeResponse
exchange: Exchange | None = None
as_dict() → dict

Serializes the UpdateExchangeResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExchangeResponse

Deserializes the UpdateExchangeResponse from a dictionary.

class databricks.sdk.service.marketplace.UpdateInstallationRequest
installation: InstallationDetail
installation_id: str | None = None
listing_id: str | None = None
rotate_token: bool | None = None
as_dict() → dict

Serializes the UpdateInstallationRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateInstallationRequest

Deserializes the UpdateInstallationRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdateInstallationResponse
installation: InstallationDetail | None = None
as_dict() → dict

Serializes the UpdateInstallationResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateInstallationResponse

Deserializes the UpdateInstallationResponse from a dictionary.

class databricks.sdk.service.marketplace.UpdateListingRequest
listing: Listing
id: str | None = None
as_dict() → dict

Serializes the UpdateListingRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateListingRequest

Deserializes the UpdateListingRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdateListingResponse
listing: Listing | None = None
as_dict() → dict

Serializes the UpdateListingResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateListingResponse

Deserializes the UpdateListingResponse from a dictionary.

class databricks.sdk.service.marketplace.UpdatePersonalizationRequestRequest
status: PersonalizationRequestStatus
listing_id: str | None = None
reason: str | None = None
request_id: str | None = None
share: ShareInfo | None = None
as_dict() → dict

Serializes the UpdatePersonalizationRequestRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdatePersonalizationRequestRequest

Deserializes the UpdatePersonalizationRequestRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdatePersonalizationRequestResponse
request: PersonalizationRequest | None = None
as_dict() → dict

Serializes the UpdatePersonalizationRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdatePersonalizationRequestResponse

Deserializes the UpdatePersonalizationRequestResponse from a dictionary.

class databricks.sdk.service.marketplace.UpdateProviderAnalyticsDashboardRequest
id: str | None = None

id is immutable property and can’t be updated.

version: int | None = None

this is the version of the dashboard template we want to update our user to current expectation is that it should be equal to latest version of the dashboard template

as_dict() → dict

Serializes the UpdateProviderAnalyticsDashboardRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateProviderAnalyticsDashboardRequest

Deserializes the UpdateProviderAnalyticsDashboardRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdateProviderAnalyticsDashboardResponse
id: str

id & version should be the same as the request

dashboard_id: str

this is newly created Lakeview dashboard for the user

version: int | None = None
as_dict() → dict

Serializes the UpdateProviderAnalyticsDashboardResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateProviderAnalyticsDashboardResponse

Deserializes the UpdateProviderAnalyticsDashboardResponse from a dictionary.

class databricks.sdk.service.marketplace.UpdateProviderRequest
provider: ProviderInfo
id: str | None = None
as_dict() → dict

Serializes the UpdateProviderRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateProviderRequest

Deserializes the UpdateProviderRequest from a dictionary.

class databricks.sdk.service.marketplace.UpdateProviderResponse
provider: ProviderInfo | None = None
as_dict() → dict

Serializes the UpdateProviderResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateProviderResponse

Deserializes the UpdateProviderResponse from a dictionary.

class databricks.sdk.service.marketplace.Visibility
PRIVATE = "PRIVATE"
PUBLIC = "PUBLIC"
class databricks.sdk.service.marketplace.VisibilityFilter
filter_type: FilterType | None = None
filter_value: str | None = None
as_dict() → dict

Serializes the VisibilityFilter into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → VisibilityFilter

Deserializes the VisibilityFilter from a dictionary.