SettingsV2

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

class databricks.sdk.service.settingsv2.AibiDashboardEmbeddingAccessPolicy(access_policy_type: 'AibiDashboardEmbeddingAccessPolicyAccessPolicyType')

access_policy_type: AibiDashboardEmbeddingAccessPolicyAccessPolicyType

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AibiDashboardEmbeddingAccessPolicy from a dictionary.

class databricks.sdk.service.settingsv2.AibiDashboardEmbeddingAccessPolicyAccessPolicyType

ALLOW_ALL_DOMAINS = "ALLOW_ALL_DOMAINS"

ALLOW_APPROVED_DOMAINS = "ALLOW_APPROVED_DOMAINS"

DENY_ALL_DOMAINS = "DENY_ALL_DOMAINS"

class databricks.sdk.service.settingsv2.AibiDashboardEmbeddingApprovedDomains(approved_domains: 'Optional[List[str]]' = None)

approved_domains: List[str] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AibiDashboardEmbeddingApprovedDomains from a dictionary.

class databricks.sdk.service.settingsv2.AllowedAppsUserApiScopesMessage(allowed_scopes: 'Optional[List[str]]' = None)

allowed_scopes: List[str] | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the AllowedAppsUserApiScopesMessage from a dictionary.

class databricks.sdk.service.settingsv2.BooleanMessage(value: 'Optional[bool]' = None)

value: bool | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the BooleanMessage from a dictionary.

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessage(can_toggle: 'Optional[bool]' = None, enabled: 'Optional[bool]' = None, enablement_details: 'Optional[ClusterAutoRestartMessageEnablementDetails]' = None, maintenance_window: 'Optional[ClusterAutoRestartMessageMaintenanceWindow]' = None, restart_even_if_no_updates_available: 'Optional[bool]' = None)

can_toggle: bool | None = None

enabled: bool | None = None

enablement_details: ClusterAutoRestartMessageEnablementDetails | None = None

maintenance_window: ClusterAutoRestartMessageMaintenanceWindow | None = None

restart_even_if_no_updates_available: bool | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ClusterAutoRestartMessage from a dictionary.

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessageEnablementDetails(forced_for_compliance_mode: bool | None = None, unavailable_for_disabled_entitlement: bool | None = None, unavailable_for_non_enterprise_tier: bool | None = None)

Contains an information about the enablement status judging (e.g. whether the enterprise tier is enabled) This is only additional information that MUST NOT be used to decide whether the setting is enabled or not. This is intended to use only for purposes like showing an error message to the customer with the additional details. For example, using these details we can check why exactly the feature is disabled for this customer.

forced_for_compliance_mode: bool | None = None

The feature is force enabled if compliance mode is active

unavailable_for_disabled_entitlement: bool | None = None

The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)

unavailable_for_non_enterprise_tier: bool | None = None

The feature is unavailable if the customer doesn’t have enterprise tier

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ClusterAutoRestartMessageEnablementDetails from a dictionary.

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessageMaintenanceWindow(week_day_based_schedule: 'Optional[ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule]' = None)

week_day_based_schedule: ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ClusterAutoRestartMessageMaintenanceWindow from a dictionary.

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessageMaintenanceWindowDayOfWeek

FRIDAY = "FRIDAY"

MONDAY = "MONDAY"

SATURDAY = "SATURDAY"

SUNDAY = "SUNDAY"

THURSDAY = "THURSDAY"

TUESDAY = "TUESDAY"

WEDNESDAY = "WEDNESDAY"

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule(day_of_week: 'Optional[ClusterAutoRestartMessageMaintenanceWindowDayOfWeek]' = None, frequency: 'Optional[ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency]' = None, window_start_time: 'Optional[ClusterAutoRestartMessageMaintenanceWindowWindowStartTime]' = None)

day_of_week: ClusterAutoRestartMessageMaintenanceWindowDayOfWeek | None = None

frequency: ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency | None = None

window_start_time: ClusterAutoRestartMessageMaintenanceWindowWindowStartTime | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule from a dictionary.

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency

EVERY_WEEK = "EVERY_WEEK"

FIRST_AND_THIRD_OF_MONTH = "FIRST_AND_THIRD_OF_MONTH"

FIRST_OF_MONTH = "FIRST_OF_MONTH"

FOURTH_OF_MONTH = "FOURTH_OF_MONTH"

SECOND_AND_FOURTH_OF_MONTH = "SECOND_AND_FOURTH_OF_MONTH"

SECOND_OF_MONTH = "SECOND_OF_MONTH"

THIRD_OF_MONTH = "THIRD_OF_MONTH"

class databricks.sdk.service.settingsv2.ClusterAutoRestartMessageMaintenanceWindowWindowStartTime(hours: 'Optional[int]' = None, minutes: 'Optional[int]' = None)

hours: int | None = None

minutes: int | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ClusterAutoRestartMessageMaintenanceWindowWindowStartTime from a dictionary.

class databricks.sdk.service.settingsv2.CollaborationPlatformConnectivityMessage(connectivity: CollaborationPlatformConnectivityMessageConnectivity)

Controls which external collaboration platforms (Slack, Microsoft Teams) can connect to a workspace. Defaults to ALLOW_ALL.

connectivity: CollaborationPlatformConnectivityMessageConnectivity

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the CollaborationPlatformConnectivityMessage from a dictionary.

class databricks.sdk.service.settingsv2.CollaborationPlatformConnectivityMessageConnectivity

ALLOW_ALL = "ALLOW_ALL"

ALLOW_SLACK = "ALLOW_SLACK"

ALLOW_TEAMS = "ALLOW_TEAMS"

DENY_ALL = "DENY_ALL"

class databricks.sdk.service.settingsv2.IntegerMessage(value: 'Optional[int]' = None)

value: int | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the IntegerMessage from a dictionary.

class databricks.sdk.service.settingsv2.ListAccountSettingsMetadataResponse(next_page_token: 'Optional[str]' = None, settings_metadata: 'Optional[List[SettingsMetadata]]' = None)

next_page_token: str | None = None

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

settings_metadata: List[SettingsMetadata] | None = None

List of all settings available via public APIs and their metadata

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListAccountSettingsMetadataResponse from a dictionary.

class databricks.sdk.service.settingsv2.ListAccountUserPreferencesMetadataResponse(next_page_token: 'Optional[str]' = None, settings_metadata: 'Optional[List[SettingsMetadata]]' = None)

next_page_token: str | None = None

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

settings_metadata: List[SettingsMetadata] | None = None

List of all settings available via public APIs and their metadata

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListAccountUserPreferencesMetadataResponse from a dictionary.

class databricks.sdk.service.settingsv2.ListWorkspaceSettingsMetadataResponse(next_page_token: 'Optional[str]' = None, settings_metadata: 'Optional[List[SettingsMetadata]]' = None)

next_page_token: str | None = None

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

settings_metadata: List[SettingsMetadata] | None = None

List of all settings available via public APIs and their metadata

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the ListWorkspaceSettingsMetadataResponse from a dictionary.

class databricks.sdk.service.settingsv2.OperationalEmailCustomRecipientMessage(email: 'Optional[str]' = None)

email: str | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the OperationalEmailCustomRecipientMessage from a dictionary.

class databricks.sdk.service.settingsv2.PersonalComputeMessage(value: 'Optional[PersonalComputeMessagePersonalComputeMessageEnum]' = None)

value: PersonalComputeMessagePersonalComputeMessageEnum | None = None

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the PersonalComputeMessage from a dictionary.

class databricks.sdk.service.settingsv2.PersonalComputeMessagePersonalComputeMessageEnum

ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing all users to create single-machine compute resources. DELEGATE: Moves access control for the Personal Compute default policy to individual workspaces and requires a workspace’s users or groups to be added to the ACLs of that workspace’s Personal Compute default policy before they will be able to create compute resources through that policy.

DELEGATE = "DELEGATE"

ON = "ON"

class databricks.sdk.service.settingsv2.PreviewPhase

Preview phase for settings that are feature previews. For settings that are not feature previews, the preview_phase field is left unset. Mirrors only the customer-facing phases surfaced in the UI; internal-only phases (DISABLED, DEV, UNDER_MIGRATION, LAUNCHED, etc.) are not exposed here.

BETA = "BETA"

GA = "GA"

GA_SOON = "GA_SOON"

PRIVATE_PREVIEW = "PRIVATE_PREVIEW"

PUBLIC_PREVIEW = "PUBLIC_PREVIEW"

class databricks.sdk.service.settingsv2.RestrictWorkspaceAdminsMessage(status: 'RestrictWorkspaceAdminsMessageStatus', disable_gov_tag_creation: 'Optional[bool]' = None)

status: RestrictWorkspaceAdminsMessageStatus

disable_gov_tag_creation: bool | None = None

When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the RestrictWorkspaceAdminsMessage from a dictionary.

class databricks.sdk.service.settingsv2.RestrictWorkspaceAdminsMessageStatus

ALLOW_ALL = "ALLOW_ALL"

RESTRICT_TOKENS_AND_JOB_RUN_AS = "RESTRICT_TOKENS_AND_JOB_RUN_AS"

class databricks.sdk.service.settingsv2.Setting(aibi_dashboard_embedding_access_policy: 'Optional[AibiDashboardEmbeddingAccessPolicy]' = None, aibi_dashboard_embedding_approved_domains: 'Optional[AibiDashboardEmbeddingApprovedDomains]' = None, allowed_apps_user_api_scopes: 'Optional[AllowedAppsUserApiScopesMessage]' = None, automatic_cluster_update_workspace: 'Optional[ClusterAutoRestartMessage]' = None, boolean_val: 'Optional[BooleanMessage]' = None, collaboration_platform_connectivity: 'Optional[CollaborationPlatformConnectivityMessage]' = None, effective_aibi_dashboard_embedding_access_policy: 'Optional[AibiDashboardEmbeddingAccessPolicy]' = None, effective_aibi_dashboard_embedding_approved_domains: 'Optional[AibiDashboardEmbeddingApprovedDomains]' = None, effective_allowed_apps_user_api_scopes: 'Optional[AllowedAppsUserApiScopesMessage]' = None, effective_automatic_cluster_update_workspace: 'Optional[ClusterAutoRestartMessage]' = None, effective_boolean_val: 'Optional[BooleanMessage]' = None, effective_collaboration_platform_connectivity: 'Optional[CollaborationPlatformConnectivityMessage]' = None, effective_integer_val: 'Optional[IntegerMessage]' = None, effective_operational_email_custom_recipient: 'Optional[OperationalEmailCustomRecipientMessage]' = None, effective_personal_compute: 'Optional[PersonalComputeMessage]' = None, effective_restrict_workspace_admins: 'Optional[RestrictWorkspaceAdminsMessage]' = None, effective_string_val: 'Optional[StringMessage]' = None, integer_val: 'Optional[IntegerMessage]' = None, name: 'Optional[str]' = None, operational_email_custom_recipient: 'Optional[OperationalEmailCustomRecipientMessage]' = None, personal_compute: 'Optional[PersonalComputeMessage]' = None, restrict_workspace_admins: 'Optional[RestrictWorkspaceAdminsMessage]' = None, string_val: 'Optional[StringMessage]' = None)

aibi_dashboard_embedding_access_policy: AibiDashboardEmbeddingAccessPolicy | None = None

Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.

aibi_dashboard_embedding_approved_domains: AibiDashboardEmbeddingApprovedDomains | None = None

Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.

allowed_apps_user_api_scopes: AllowedAppsUserApiScopesMessage | None = None

Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.

automatic_cluster_update_workspace: ClusterAutoRestartMessage | None = None

Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.

boolean_val: BooleanMessage | None = None

Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.

collaboration_platform_connectivity: CollaborationPlatformConnectivityMessage | None = None

Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value.

effective_aibi_dashboard_embedding_access_policy: AibiDashboardEmbeddingAccessPolicy | None = None

Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.

effective_aibi_dashboard_embedding_approved_domains: AibiDashboardEmbeddingApprovedDomains | None = None

Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.

effective_allowed_apps_user_api_scopes: AllowedAppsUserApiScopesMessage | None = None

Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.

effective_automatic_cluster_update_workspace: ClusterAutoRestartMessage | None = None

Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.

effective_boolean_val: BooleanMessage | None = None

Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.

effective_collaboration_platform_connectivity: CollaborationPlatformConnectivityMessage | None = None

Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.

effective_integer_val: IntegerMessage | None = None

Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.

effective_operational_email_custom_recipient: OperationalEmailCustomRecipientMessage | None = None

Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.

effective_personal_compute: PersonalComputeMessage | None = None

Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.

effective_restrict_workspace_admins: RestrictWorkspaceAdminsMessage | None = None

Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.

effective_string_val: StringMessage | None = None

Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.

integer_val: IntegerMessage | None = None

Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.

name: str | None = None

Name of the setting.

operational_email_custom_recipient: OperationalEmailCustomRecipientMessage | None = None

Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.

personal_compute: PersonalComputeMessage | None = None

Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.

restrict_workspace_admins: RestrictWorkspaceAdminsMessage | None = None

Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.

string_val: StringMessage | None = None

Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the Setting from a dictionary.

class databricks.sdk.service.settingsv2.SettingsMetadata(description: 'Optional[str]' = None, display_name: 'Optional[str]' = None, docs_link: 'Optional[str]' = None, name: 'Optional[str]' = None, preview_phase: 'Optional[PreviewPhase]' = None, type: 'Optional[str]' = None)

description: str | None = None

Setting description for what this setting controls

display_name: str | None = None

Human-readable display name for the setting or feature preview. This field may be unset if no display name is available.

docs_link: str | None = None

Link to databricks documentation for the setting

name: str | None = None

Name of the setting.

preview_phase: PreviewPhase | None = None

Preview phase for feature preview settings. This field is not set for non-preview settings.

type: str | None = None

Sample message depicting the type of the setting. To set this setting, the value sent must match this type.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the SettingsMetadata from a dictionary.

class databricks.sdk.service.settingsv2.StringMessage(value: 'Optional[str]' = None)

value: str | None = None

Represents a generic string value.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the StringMessage from a dictionary.

class databricks.sdk.service.settingsv2.UserPreference(boolean_val: BooleanMessage | None = None, effective_boolean_val: BooleanMessage | None = None, effective_string_val: StringMessage | None = None, name: str | None = None, string_val: StringMessage | None = None, user_id: str | None = None)

User Preference represents a user-specific setting scoped to an individual user within an account. Unlike workspace or account settings that apply to all users, user preferences allow personal customization (e.g., UI theme, editor preferences) without affecting other users.

boolean_val: BooleanMessage | None = None

effective_boolean_val: BooleanMessage | None = None

effective_string_val: StringMessage | None = None

name: str | None = None

Name of the setting.

string_val: StringMessage | None = None

user_id: str | None = None

User ID of the user.

as_dict() → dict

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

as_shallow_dict() → dict

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

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

Deserializes the UserPreference from a dictionary.