Domains

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

class databricks.sdk.service.domains.Domain(tag_key: 'str', business_owner_ids: 'Optional[List[int]]' = None, create_time: 'Optional[Timestamp]' = None, description: 'Optional[str]' = None, domain_id: 'Optional[str]' = None, draft: 'Optional[bool]' = None, effective_draft: 'Optional[bool]' = None, icon: 'Optional[DomainIcon]' = None, name: 'Optional[str]' = None, parent_domain_id: 'Optional[str]' = None, subtitle: 'Optional[str]' = None, technical_owner_ids: 'Optional[List[int]]' = None, update_time: 'Optional[Timestamp]' = None)

tag_key: str

Governed tag key associated with this domain.

business_owner_ids: List[int] | None = None

Principal IDs of the business owners (users, groups, or service principals).

create_time: Timestamp | None = None

Timestamp when the domain was created.

description: str | None = None

Full description (max 4096 chars)

domain_id: str | None = None

Unique identifier for the domain. If omitted at Create, the server generates one.

draft: bool | None = None

Whether to mark the domain as a draft. If omitted on Create, the server applies a default; the resolved value is returned in effective_draft.

effective_draft: bool | None = None

Resolved draft state of the domain.

icon: DomainIcon | None = None

Icon to display for the domain.

name: str | None = None

Full resource name of the domain. The primary identifier for this resource. Format: domains/{domain_id} Identifies the domain on get, update, and delete. Not an input on create — to choose the id, set CreateDomainRequest.domain_id.

parent_domain_id: str | None = None

Domain ID of the parent. If absent, this is a top-level domain. If present, this domain is a subdomain of the specified parent.

subtitle: str | None = None

Short description (max 280 chars)

technical_owner_ids: List[int] | None = None

Principal IDs of the technical owners (users, groups, or service principals).

update_time: Timestamp | None = None

Timestamp when the domain was last updated.

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the Domain into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Domain

Deserializes the Domain from a dictionary.

class databricks.sdk.service.domains.DomainIcon(color: str | None = None, name: DomainIconName | None = None)

Icon configuration for a domain.

color: str | None = None

Hex color code with # prefix (e.g., “#FF5733”).

name: DomainIconName | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the DomainIcon into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DomainIcon

Deserializes the DomainIcon from a dictionary.

class databricks.sdk.service.domains.DomainIconName

Available icon names for a domain.

ADDRESS_BOOK = "ADDRESS_BOOK"

ALARM = "ALARM"

ARROWS_IN = "ARROWS_IN"

ATOM = "ATOM"

BALLOON = "BALLOON"

BANK = "BANK"

BARRICADE = "BARRICADE"

BASKET = "BASKET"

BRIDGE = "BRIDGE"

CACTUS = "CACTUS"

CALL_BELL = "CALL_BELL"

CARROT = "CARROT"

CHART_PIE_SLICE = "CHART_PIE_SLICE"

CITY = "CITY"

CLOUD = "CLOUD"

COINS = "COINS"

COMPASS_ROSE = "COMPASS_ROSE"

CRANE_TOWER = "CRANE_TOWER"

CROWN = "CROWN"

CUBE_TRANSPARENT = "CUBE_TRANSPARENT"

FADERS = "FADERS"

FLAG_BANNER_FOLD = "FLAG_BANNER_FOLD"

FLAG_CHECKERED = "FLAG_CHECKERED"

GAVEL = "GAVEL"

HAMBURGER = "HAMBURGER"

HEAD_CIRCUIT = "HEAD_CIRCUIT"

HOURGLASS_HIGH = "HOURGLASS_HIGH"

INTERSECT_THREE = "INTERSECT_THREE"

MICROSCOPE = "MICROSCOPE"

MOON_STARS = "MOON_STARS"

PACKAGE = "PACKAGE"

PARACHUTE = "PARACHUTE"

PEPPER = "PEPPER"

PIGGY_BANK = "PIGGY_BANK"

PILL = "PILL"

PLANET = "PLANET"

PLANT = "PLANT"

PLUGS_CONNECTED = "PLUGS_CONNECTED"

POPCORN = "POPCORN"

PRESENTATION_CHART = "PRESENTATION_CHART"

PUZZLE_PIECE = "PUZZLE_PIECE"

RAINBOW = "RAINBOW"

RANKING = "RANKING"

RECEIPT = "RECEIPT"

ROCKET = "ROCKET"

RULER = "RULER"

SAILBOAT = "SAILBOAT"

SCALES = "SCALES"

SCAN_SMILEY = "SCAN_SMILEY"

SCROLL = "SCROLL"

SHIELD_CHECKERED = "SHIELD_CHECKERED"

SNEAKER = "SNEAKER"

SNOWFLAKE = "SNOWFLAKE"

SOLAR_ROOF = "SOLAR_ROOF"

SPEEDOMETER = "SPEEDOMETER"

STAMP = "STAMP"

STEPS = "STEPS"

STRATEGY = "STRATEGY"

SWORD = "SWORD"

TELEVISION_SIMPLE = "TELEVISION_SIMPLE"

TENT = "TENT"

TICKET = "TICKET"

TRACTOR = "TRACTOR"

TRAFFIC_CONE = "TRAFFIC_CONE"

TRAIN = "TRAIN"

TREE_EVERGREEN = "TREE_EVERGREEN"

TREE_STRUCTURE = "TREE_STRUCTURE"

TROLLEY_SUITCASE = "TROLLEY_SUITCASE"

TROPHY = "TROPHY"

TRUCK_TRAILER = "TRUCK_TRAILER"

USERS_THREE = "USERS_THREE"

VECTOR_THREE = "VECTOR_THREE"

class databricks.sdk.service.domains.ListDomainsResponse(domains: 'Optional[List[Domain]]' = None, next_page_token: 'Optional[str]' = None)

domains: List[Domain] | None = None

next_page_token: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

Serializes the ListDomainsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListDomainsResponse

Deserializes the ListDomainsResponse from a dictionary.