com.databricks.sdk.service.settingsv2

Class AccountSettingsV2API

java.lang.Object

com.databricks.sdk.service.settingsv2.AccountSettingsV2API

@Generated
public class AccountSettingsV2API
extends Object

APIs to manage account level settings

Constructor Summary

Constructors

Constructor and Description
AccountSettingsV2API(AccountSettingsV2Service mock) Constructor for mocks
AccountSettingsV2API(ApiClient apiClient) Regular-use constructor

Method Summary

Modifier and Type	Method and Description
Setting	getPublicAccountSetting(GetPublicAccountSettingRequest request) Get a setting value at account level.
Setting	getPublicAccountSetting(String name)
UserPreference	getPublicAccountUserPreference(GetPublicAccountUserPreferenceRequest request) Get a user preference for a specific user.
UserPreference	getPublicAccountUserPreference(String userId, String name)
AccountSettingsV2Service	impl()
Iterable<SettingsMetadata>	listAccountSettingsMetadata(ListAccountSettingsMetadataRequest request) List valid setting keys and metadata.
Iterable<SettingsMetadata>	listAccountUserPreferencesMetadata(ListAccountUserPreferencesMetadataRequest request) List valid user preferences and their metadata for a specific user.
Iterable<SettingsMetadata>	listAccountUserPreferencesMetadata(String userId)
Setting	patchPublicAccountSetting(PatchPublicAccountSettingRequest request) Patch a setting value at account level.
UserPreference	patchPublicAccountUserPreference(PatchPublicAccountUserPreferenceRequest request) Update a user preference for a specific user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountSettingsV2API

public AccountSettingsV2API(ApiClient apiClient)

Regular-use constructor

AccountSettingsV2API

public AccountSettingsV2API(AccountSettingsV2Service mock)

Constructor for mocks

Method Detail

getPublicAccountSetting

public Setting getPublicAccountSetting(String name)

getPublicAccountSetting

public Setting getPublicAccountSetting(GetPublicAccountSettingRequest request)

Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.

getPublicAccountUserPreference

public UserPreference getPublicAccountUserPreference(String userId,
                                                     String name)

getPublicAccountUserPreference

public UserPreference getPublicAccountUserPreference(GetPublicAccountUserPreferenceRequest request)

Get a user preference for a specific user. User preferences are personal settings that allow individual customization without affecting other users. See :method:settingsv2/listaccountuserpreferencesmetadata for list of user preferences available via public APIs.

listAccountSettingsMetadata

public Iterable<SettingsMetadata> listAccountSettingsMetadata(ListAccountSettingsMetadataRequest request)

List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountsetting and PATCH :method:settingsv2/patchpublicaccountsetting APIs

listAccountUserPreferencesMetadata

public Iterable<SettingsMetadata> listAccountUserPreferencesMetadata(String userId)

listAccountUserPreferencesMetadata

public Iterable<SettingsMetadata> listAccountUserPreferencesMetadata(ListAccountUserPreferencesMetadataRequest request)

List valid user preferences and their metadata for a specific user. User preferences are personal settings that allow individual customization without affecting other users. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountuserpreference and PATCH :method:settingsv2/patchpublicaccountuserpreference APIs

patchPublicAccountSetting

public Setting patchPublicAccountSetting(PatchPublicAccountSettingRequest request)

Patch a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level. To determine the correct field to include in a patch request, refer to the type field of the setting returned in the :method:settingsv2/listaccountsettingsmetadata response.

Note: Page refresh is required for changes to take effect in UI.

patchPublicAccountUserPreference

public UserPreference patchPublicAccountUserPreference(PatchPublicAccountUserPreferenceRequest request)

Update a user preference for a specific user. User preferences are personal settings that allow individual customization without affecting other users. See :method:settingsv2/listaccountuserpreferencesmetadata for list of user preferences available via public APIs.

Note: Page refresh is required for changes to take effect in UI.

impl

public AccountSettingsV2Service impl()