settings

package
v0.0.1-dev.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AibiDashboardEmbeddingAccessPolicy

type AibiDashboardEmbeddingAccessPolicy struct {
	AccessPolicyType AibiDashboardEmbeddingAccessPolicy_AccessPolicyType
}

type AibiDashboardEmbeddingAccessPolicy_AccessPolicyType

type AibiDashboardEmbeddingAccessPolicy_AccessPolicyType string
const (
	AibiDashboardEmbeddingAccessPolicy_AccessPolicyType_Unspecified          AibiDashboardEmbeddingAccessPolicy_AccessPolicyType = ""
	AibiDashboardEmbeddingAccessPolicy_AccessPolicyType_AllowAllDomains      AibiDashboardEmbeddingAccessPolicy_AccessPolicyType = "ALLOW_ALL_DOMAINS"
	AibiDashboardEmbeddingAccessPolicy_AccessPolicyType_AllowApprovedDomains AibiDashboardEmbeddingAccessPolicy_AccessPolicyType = "ALLOW_APPROVED_DOMAINS"
	AibiDashboardEmbeddingAccessPolicy_AccessPolicyType_DenyAllDomains       AibiDashboardEmbeddingAccessPolicy_AccessPolicyType = "DENY_ALL_DOMAINS"
)

type AibiDashboardEmbeddingApprovedDomains

type AibiDashboardEmbeddingApprovedDomains struct {
	ApprovedDomains []string
}

type AllowedAppsUserApiScopesMessage

type AllowedAppsUserApiScopesMessage struct {
	AllowedScopes []string
}

type BooleanMessage

type BooleanMessage struct {
	Value *bool
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, opts ...client.Option) (*Client, error)

func (*Client) GetPublicAccountSetting

func (c *Client) GetPublicAccountSetting(ctx context.Context, req GetPublicAccountSettingRequest, opts ...call.Option) (*Setting, error)

Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.

func (*Client) GetPublicAccountUserPreference

func (c *Client) GetPublicAccountUserPreference(ctx context.Context, req GetPublicAccountUserPreferenceRequest, opts ...call.Option) (*UserPreference, error)

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. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.

func (*Client) GetPublicWorkspaceSetting

func (c *Client) GetPublicWorkspaceSetting(ctx context.Context, req GetPublicWorkspaceSettingRequest, opts ...call.Option) (*Setting, error)

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

func (*Client) ListAccountSettingsMetadata

func (c *Client) ListAccountSettingsMetadata(ctx context.Context, req ListAccountSettingsMetadataRequest, opts ...call.Option) (*ListAccountSettingsMetadataResponse, error)

List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountsetting and PATCH :method:settingsv2/patchpublicaccountsetting APIs Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.

func (*Client) ListAccountSettingsMetadataIter

func (c *Client) ListAccountSettingsMetadataIter(ctx context.Context, req ListAccountSettingsMetadataRequest, opts ...call.Option) iter.Seq2[*SettingsMetadata, error]

ListAccountSettingsMetadataIter returns an iterator that iterates over the results of ListAccountSettingsMetadata.

For example:

for item, err := range c.ListAccountSettingsMetadataIter(ctx, ListAccountSettingsMetadataRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListAccountSettingsMetadata call made by the iterator under the hood.

Callers who need custom pagination logic should use ListAccountSettingsMetadata directly.

func (*Client) ListAccountUserPreferencesMetadata

func (c *Client) ListAccountUserPreferencesMetadata(ctx context.Context, req ListAccountUserPreferencesMetadataRequest, opts ...call.Option) (*ListAccountUserPreferencesMetadataResponse, error)

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 Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.

func (*Client) ListAccountUserPreferencesMetadataIter

func (c *Client) ListAccountUserPreferencesMetadataIter(ctx context.Context, req ListAccountUserPreferencesMetadataRequest, opts ...call.Option) iter.Seq2[*SettingsMetadata, error]

ListAccountUserPreferencesMetadataIter returns an iterator that iterates over the results of ListAccountUserPreferencesMetadata.

For example:

for item, err := range c.ListAccountUserPreferencesMetadataIter(ctx, ListAccountUserPreferencesMetadataRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListAccountUserPreferencesMetadata call made by the iterator under the hood.

Callers who need custom pagination logic should use ListAccountUserPreferencesMetadata directly.

func (*Client) ListWorkspaceSettingsMetadata

func (c *Client) ListWorkspaceSettingsMetadata(ctx context.Context, req ListWorkspaceSettingsMetadataRequest, opts ...call.Option) (*ListWorkspaceSettingsMetadataResponse, error)

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

func (*Client) ListWorkspaceSettingsMetadataIter

func (c *Client) ListWorkspaceSettingsMetadataIter(ctx context.Context, req ListWorkspaceSettingsMetadataRequest, opts ...call.Option) iter.Seq2[*SettingsMetadata, error]

ListWorkspaceSettingsMetadataIter returns an iterator that iterates over the results of ListWorkspaceSettingsMetadata.

For example:

for item, err := range c.ListWorkspaceSettingsMetadataIter(ctx, ListWorkspaceSettingsMetadataRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListWorkspaceSettingsMetadata call made by the iterator under the hood.

Callers who need custom pagination logic should use ListWorkspaceSettingsMetadata directly.

func (*Client) PatchPublicAccountSetting

func (c *Client) PatchPublicAccountSetting(ctx context.Context, req PatchPublicAccountSettingRequest, opts ...call.Option) (*Setting, error)

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. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.

func (*Client) PatchPublicAccountUserPreference

func (c *Client) PatchPublicAccountUserPreference(ctx context.Context, req PatchPublicAccountUserPreferenceRequest, opts ...call.Option) (*UserPreference, error)

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. Account-level method. Uses the Client's accountID, overridable per call via req.AccountId.

func (*Client) PatchPublicWorkspaceSetting

func (c *Client) PatchPublicWorkspaceSetting(ctx context.Context, req PatchPublicWorkspaceSettingRequest, opts ...call.Option) (*Setting, error)

Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs at workspace 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/listworkspacesettingsmetadata response.

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

type ClusterAutoRestartMessage

type ClusterAutoRestartMessage struct {
	Enabled                         *bool
	CanToggle                       *bool
	MaintenanceWindow               *ClusterAutoRestartMessage_MaintenanceWindow
	EnablementDetails               *ClusterAutoRestartMessage_EnablementDetails
	RestartEvenIfNoUpdatesAvailable *bool
}

type ClusterAutoRestartMessage_EnablementDetails

type ClusterAutoRestartMessage_EnablementDetails struct {
	// The feature is unavailable if the customer doesn't have enterprise tier
	UnavailableForNonEnterpriseTier *bool
	// The feature is unavailable if the corresponding entitlement disabled (see
	// getShieldEntitlementEnable)
	UnavailableForDisabledEntitlement *bool
	// The feature is force enabled if compliance mode is active
	ForcedForComplianceMode *bool
}

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..

type ClusterAutoRestartMessage_MaintenanceWindow

type ClusterAutoRestartMessage_MaintenanceWindow struct {
	WeekDayBasedSchedule *ClusterAutoRestartMessage_MaintenanceWindow_WeekDayBasedSchedule
}

type ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek

type ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek string
const (
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Unspecified ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = ""
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Monday      ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "MONDAY"
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Tuesday     ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "TUESDAY"
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Wednesday   ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "WEDNESDAY"
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Thursday    ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "THURSDAY"
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Friday      ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "FRIDAY"
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Saturday    ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "SATURDAY"
	ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek_Sunday      ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek = "SUNDAY"
)

type ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency

type ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency string
const (
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_Unspecified            ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = ""
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_FirstOfMonth           ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "FIRST_OF_MONTH"
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_SecondOfMonth          ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "SECOND_OF_MONTH"
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_ThirdOfMonth           ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "THIRD_OF_MONTH"
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_FourthOfMonth          ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "FOURTH_OF_MONTH"
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_FirstAndThirdOfMonth   ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "FIRST_AND_THIRD_OF_MONTH"
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_SecondAndFourthOfMonth ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "SECOND_AND_FOURTH_OF_MONTH"
	ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency_EveryWeek              ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency = "EVERY_WEEK"
)

type ClusterAutoRestartMessage_MaintenanceWindow_WindowStartTime

type ClusterAutoRestartMessage_MaintenanceWindow_WindowStartTime struct {
	Hours   *int
	Minutes *int
}

type CollaborationPlatformConnectivityMessage

type CollaborationPlatformConnectivityMessage struct {
	Connectivity CollaborationPlatformConnectivityMessage_Connectivity
}

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

type CollaborationPlatformConnectivityMessage_Connectivity

type CollaborationPlatformConnectivityMessage_Connectivity string
const (
	CollaborationPlatformConnectivityMessage_Connectivity_Unspecified CollaborationPlatformConnectivityMessage_Connectivity = ""
	CollaborationPlatformConnectivityMessage_Connectivity_AllowAll    CollaborationPlatformConnectivityMessage_Connectivity = "ALLOW_ALL"
	CollaborationPlatformConnectivityMessage_Connectivity_AllowTeams  CollaborationPlatformConnectivityMessage_Connectivity = "ALLOW_TEAMS"
	CollaborationPlatformConnectivityMessage_Connectivity_AllowSlack  CollaborationPlatformConnectivityMessage_Connectivity = "ALLOW_SLACK"
	CollaborationPlatformConnectivityMessage_Connectivity_DenyAll     CollaborationPlatformConnectivityMessage_Connectivity = "DENY_ALL"
)

type GetPublicAccountSettingRequest

type GetPublicAccountSettingRequest struct {
	AccountId *string
	Name      *string
}

type GetPublicAccountUserPreferenceRequest

type GetPublicAccountUserPreferenceRequest struct {
	// <Databricks> account ID of the account being managed.
	AccountId *string
	// User ID of the user whose setting is being retrieved.
	UserId *string
	// User Setting name.
	Name *string
}

type GetPublicWorkspaceSettingRequest

type GetPublicWorkspaceSettingRequest struct {
	// Name of the setting
	Name *string
}

type IntegerMessage

type IntegerMessage struct {
	Value *int
}

type ListAccountSettingsMetadataRequest

type ListAccountSettingsMetadataRequest struct {
	// <Databricks> account ID of the account being managed.
	AccountId *string
	// The maximum number of settings to return. The service may return fewer than
	// this value. If unspecified, at most 200 settings will be returned. The
	// maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize *int
	// A page token, received from a previous `ListAccountSettingsMetadataRequest`
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `ListAccountSettingsMetadataRequest` must match the call that provided the
	// page token.
	PageToken *string
}

type ListAccountSettingsMetadataResponse

type ListAccountSettingsMetadataResponse struct {
	// List of all settings available via public APIs and their metadata
	SettingsMetadata []SettingsMetadata
	// A token that can be sent as `page_token` to retrieve the next page. If this
	// field is omitted, there are no subsequent pages.
	NextPageToken *string
}

type ListAccountUserPreferencesMetadataRequest

type ListAccountUserPreferencesMetadataRequest struct {
	// <Databricks> account ID of the account being managed.
	AccountId *string
	// User ID of the user whose settings metadata is being retrieved.
	UserId *string
	// The maximum number of settings to return. The service may return fewer than
	// this value. If unspecified, at most 200 settings will be returned. The
	// maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize *int
	// A page token, received from a previous
	// `ListAccountUserPreferencesMetadataRequest` call. Provide this to retrieve
	// the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `ListAccountUserPreferencesMetadataRequest` must match the call that provided
	// the page token.
	PageToken *string
}

type ListAccountUserPreferencesMetadataResponse

type ListAccountUserPreferencesMetadataResponse struct {
	// List of all settings available via public APIs and their metadata
	SettingsMetadata []SettingsMetadata
	// A token that can be sent as `page_token` to retrieve the next page. If this
	// field is omitted, there are no subsequent pages.
	NextPageToken *string
}

type ListWorkspaceSettingsMetadataRequest

type ListWorkspaceSettingsMetadataRequest struct {
	// The maximum number of settings to return. The service may return fewer than
	// this value. If unspecified, at most 200 settings will be returned. The
	// maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize *int
	// A page token, received from a previous `ListWorkspaceSettingsMetadataRequest`
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `ListWorkspaceSettingsMetadataRequest` must match the call that provided the
	// page token.
	PageToken *string
}

type ListWorkspaceSettingsMetadataResponse

type ListWorkspaceSettingsMetadataResponse struct {
	// List of all settings available via public APIs and their metadata
	SettingsMetadata []SettingsMetadata
	// A token that can be sent as `page_token` to retrieve the next page. If this
	// field is omitted, there are no subsequent pages.
	NextPageToken *string
}

type OperationalEmailCustomRecipientMessage

type OperationalEmailCustomRecipientMessage struct {
	Email *string
}

type PatchPublicAccountSettingRequest

type PatchPublicAccountSettingRequest struct {
	// <Databricks> account ID of the account being managed.
	AccountId *string
	Name      *string
	Setting   *Setting
}

type PatchPublicAccountUserPreferenceRequest

type PatchPublicAccountUserPreferenceRequest struct {
	// <Databricks> account ID of the account being managed.
	AccountId *string
	// User ID of the user whose setting is being updated.
	UserId  *string
	Name    *string
	Setting *UserPreference
}

type PatchPublicWorkspaceSettingRequest

type PatchPublicWorkspaceSettingRequest struct {
	// Name of the setting
	Name    *string
	Setting *Setting
}

type PersonalComputeMessage

type PersonalComputeMessage struct {
	Value PersonalComputeMessage_PersonalComputeMessageEnum
}

type PersonalComputeMessage_PersonalComputeMessageEnum

type PersonalComputeMessage_PersonalComputeMessageEnum string

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.

const (
	PersonalComputeMessage_PersonalComputeMessageEnum_Unspecified PersonalComputeMessage_PersonalComputeMessageEnum = ""
	PersonalComputeMessage_PersonalComputeMessageEnum_On          PersonalComputeMessage_PersonalComputeMessageEnum = "ON"
	PersonalComputeMessage_PersonalComputeMessageEnum_Delegate    PersonalComputeMessage_PersonalComputeMessageEnum = "DELEGATE"
)

type PreviewPhase

type PreviewPhase string

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.

const (
	PreviewPhase_Unspecified PreviewPhase = ""
	// The feature is in private preview, available only to specifically enrolled
	// customers.
	PreviewPhase_PrivatePreview PreviewPhase = "PRIVATE_PREVIEW"
	// The feature is in public preview, available to all customers. Also used for
	// gated public preview (available to customers who request access) since the
	// distinction is internal.
	PreviewPhase_PublicPreview PreviewPhase = "PUBLIC_PREVIEW"
	// The feature is in beta.
	PreviewPhase_Beta PreviewPhase = "BETA"
	// The feature is approaching general availability.
	PreviewPhase_GaSoon PreviewPhase = "GA_SOON"
	// The feature has reached general availability.
	PreviewPhase_Ga PreviewPhase = "GA"
)

type RestrictWorkspaceAdminsMessage

type RestrictWorkspaceAdminsMessage struct {
	Status RestrictWorkspaceAdminsMessage_Status
	// When true, workspace admins cannot create governance tags. ALLOW_ALL status
	// does not override this; they are independent.
	DisableGovTagCreation *bool
}

type RestrictWorkspaceAdminsMessage_Status

type RestrictWorkspaceAdminsMessage_Status string
const (
	RestrictWorkspaceAdminsMessage_Status_Unspecified RestrictWorkspaceAdminsMessage_Status = ""
	// Default value for existing workspaces Allows WS admins to create OBO tokens
	// for all SPs in the workspace without explicit permissions.
	RestrictWorkspaceAdminsMessage_Status_AllowAll RestrictWorkspaceAdminsMessage_Status = "ALLOW_ALL"
	// Default value for new workspaces Restrict WS admins to create OBO tokens for
	// SPs in the workspace unless corresponding permissions are provided
	RestrictWorkspaceAdminsMessage_Status_RestrictTokensAndJobRunAs RestrictWorkspaceAdminsMessage_Status = "RESTRICT_TOKENS_AND_JOB_RUN_AS"
)

type Setting

type Setting struct {
	// Name of the setting.
	Name *string
	// New fields should be added before the oneof below - unless it's a new Setting
	// value message, in that case it needs to be defined in the oneof below. The
	// user-set value that goes into storage
	Value isSetting_Value
	// New fields should be added before the oneof below - unless it's a new Setting
	// value message, in that case it needs to be defined in the oneof below. The
	// final effective value from server as per the policy evaluation.
	EffectiveValue isSetting_EffectiveValue
}

type Setting_EffectiveValue_EffectiveAibiDashboardEmbeddingAccessPolicy

type Setting_EffectiveValue_EffectiveAibiDashboardEmbeddingAccessPolicy struct {
	EffectiveAibiDashboardEmbeddingAccessPolicy AibiDashboardEmbeddingAccessPolicy
}

Setting_EffectiveValue_EffectiveAibiDashboardEmbeddingAccessPolicy selects EffectiveAibiDashboardEmbeddingAccessPolicy for Setting.EffectiveValue. 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.

type Setting_EffectiveValue_EffectiveAibiDashboardEmbeddingApprovedDomains

type Setting_EffectiveValue_EffectiveAibiDashboardEmbeddingApprovedDomains struct {
	EffectiveAibiDashboardEmbeddingApprovedDomains AibiDashboardEmbeddingApprovedDomains
}

Setting_EffectiveValue_EffectiveAibiDashboardEmbeddingApprovedDomains selects EffectiveAibiDashboardEmbeddingApprovedDomains for Setting.EffectiveValue. 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.

type Setting_EffectiveValue_EffectiveAllowedAppsUserApiScopes

type Setting_EffectiveValue_EffectiveAllowedAppsUserApiScopes struct {
	EffectiveAllowedAppsUserApiScopes AllowedAppsUserApiScopesMessage
}

Setting_EffectiveValue_EffectiveAllowedAppsUserApiScopes selects EffectiveAllowedAppsUserApiScopes for Setting.EffectiveValue. 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.

type Setting_EffectiveValue_EffectiveAutomaticClusterUpdateWorkspace

type Setting_EffectiveValue_EffectiveAutomaticClusterUpdateWorkspace struct {
	EffectiveAutomaticClusterUpdateWorkspace ClusterAutoRestartMessage
}

Setting_EffectiveValue_EffectiveAutomaticClusterUpdateWorkspace selects EffectiveAutomaticClusterUpdateWorkspace for Setting.EffectiveValue. 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.

type Setting_EffectiveValue_EffectiveBooleanVal

type Setting_EffectiveValue_EffectiveBooleanVal struct {
	EffectiveBooleanVal BooleanMessage
}

Setting_EffectiveValue_EffectiveBooleanVal selects EffectiveBooleanVal for Setting.EffectiveValue. Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.

type Setting_EffectiveValue_EffectiveCollaborationPlatformConnectivity

type Setting_EffectiveValue_EffectiveCollaborationPlatformConnectivity struct {
	EffectiveCollaborationPlatformConnectivity CollaborationPlatformConnectivityMessage
}

Setting_EffectiveValue_EffectiveCollaborationPlatformConnectivity selects EffectiveCollaborationPlatformConnectivity for Setting.EffectiveValue. Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity.

type Setting_EffectiveValue_EffectiveIntegerVal

type Setting_EffectiveValue_EffectiveIntegerVal struct {
	EffectiveIntegerVal IntegerMessage
}

Setting_EffectiveValue_EffectiveIntegerVal selects EffectiveIntegerVal for Setting.EffectiveValue. Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.

type Setting_EffectiveValue_EffectiveOperationalEmailCustomRecipient

type Setting_EffectiveValue_EffectiveOperationalEmailCustomRecipient struct {
	EffectiveOperationalEmailCustomRecipient OperationalEmailCustomRecipientMessage
}

Setting_EffectiveValue_EffectiveOperationalEmailCustomRecipient selects EffectiveOperationalEmailCustomRecipient for Setting.EffectiveValue. 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.

type Setting_EffectiveValue_EffectivePersonalCompute

type Setting_EffectiveValue_EffectivePersonalCompute struct {
	EffectivePersonalCompute PersonalComputeMessage
}

Setting_EffectiveValue_EffectivePersonalCompute selects EffectivePersonalCompute for Setting.EffectiveValue. Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.

type Setting_EffectiveValue_EffectiveRestrictWorkspaceAdmins

type Setting_EffectiveValue_EffectiveRestrictWorkspaceAdmins struct {
	EffectiveRestrictWorkspaceAdmins RestrictWorkspaceAdminsMessage
}

Setting_EffectiveValue_EffectiveRestrictWorkspaceAdmins selects EffectiveRestrictWorkspaceAdmins for Setting.EffectiveValue. Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.

type Setting_EffectiveValue_EffectiveStringVal

type Setting_EffectiveValue_EffectiveStringVal struct {
	EffectiveStringVal StringMessage
}

Setting_EffectiveValue_EffectiveStringVal selects EffectiveStringVal for Setting.EffectiveValue. Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.

type Setting_Value_AibiDashboardEmbeddingAccessPolicy

type Setting_Value_AibiDashboardEmbeddingAccessPolicy struct {
	AibiDashboardEmbeddingAccessPolicy AibiDashboardEmbeddingAccessPolicy
}

Setting_Value_AibiDashboardEmbeddingAccessPolicy selects AibiDashboardEmbeddingAccessPolicy for Setting.Value. 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.

type Setting_Value_AibiDashboardEmbeddingApprovedDomains

type Setting_Value_AibiDashboardEmbeddingApprovedDomains struct {
	AibiDashboardEmbeddingApprovedDomains AibiDashboardEmbeddingApprovedDomains
}

Setting_Value_AibiDashboardEmbeddingApprovedDomains selects AibiDashboardEmbeddingApprovedDomains for Setting.Value. 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.

type Setting_Value_AllowedAppsUserApiScopes

type Setting_Value_AllowedAppsUserApiScopes struct {
	AllowedAppsUserApiScopes AllowedAppsUserApiScopesMessage
}

Setting_Value_AllowedAppsUserApiScopes selects AllowedAppsUserApiScopes for Setting.Value. 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.

type Setting_Value_AutomaticClusterUpdateWorkspace

type Setting_Value_AutomaticClusterUpdateWorkspace struct {
	AutomaticClusterUpdateWorkspace ClusterAutoRestartMessage
}

Setting_Value_AutomaticClusterUpdateWorkspace selects AutomaticClusterUpdateWorkspace for Setting.Value. 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.

type Setting_Value_BooleanVal

type Setting_Value_BooleanVal struct {
	BooleanVal BooleanMessage
}

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

type Setting_Value_CollaborationPlatformConnectivity

type Setting_Value_CollaborationPlatformConnectivity struct {
	CollaborationPlatformConnectivity CollaborationPlatformConnectivityMessage
}

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

type Setting_Value_IntegerVal

type Setting_Value_IntegerVal struct {
	IntegerVal IntegerMessage
}

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

type Setting_Value_OperationalEmailCustomRecipient

type Setting_Value_OperationalEmailCustomRecipient struct {
	OperationalEmailCustomRecipient OperationalEmailCustomRecipientMessage
}

Setting_Value_OperationalEmailCustomRecipient selects OperationalEmailCustomRecipient for Setting.Value. 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.

type Setting_Value_PersonalCompute

type Setting_Value_PersonalCompute struct {
	PersonalCompute PersonalComputeMessage
}

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

type Setting_Value_RestrictWorkspaceAdmins

type Setting_Value_RestrictWorkspaceAdmins struct {
	RestrictWorkspaceAdmins RestrictWorkspaceAdminsMessage
}

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

type Setting_Value_StringVal

type Setting_Value_StringVal struct {
	StringVal StringMessage
}

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

type SettingsMetadata

type SettingsMetadata struct {
	// Name of the setting.
	Name *string
	// Setting description for what this setting controls
	Description *string
	// Sample message depicting the type of the setting. To set this setting, the
	// value sent must match this type.
	Type *string
	// Link to databricks documentation for the setting
	DocsLink *string
	// Preview phase for feature preview settings. This field is not set for
	// non-preview settings.
	PreviewPhase PreviewPhase
	// Human-readable display name for the setting or feature preview. This field
	// may be unset if no display name is available.
	DisplayName *string
}

type StringMessage

type StringMessage struct {
	// Represents a generic string value.
	Value *string
}

type UserPreference

type UserPreference struct {
	// Name of the setting.
	Name *string
	// User ID of the user.
	UserId *string
	// New fields should be added before the oneof below - unless it's a new Setting
	// value message, in that case it needs to be defined in the oneof below. The
	// user-set value that goes into storage.
	Value isUserPreference_Value
	// New fields should be added before the oneof below - unless it's a new User
	// Preference value message, in that case it needs to be defined in the oneof
	// below. The final effective value from server as per the policy evaluation.
	EffectiveValue isUserPreference_EffectiveValue
}

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..

type UserPreference_EffectiveValue_EffectiveBooleanVal

type UserPreference_EffectiveValue_EffectiveBooleanVal struct {
	EffectiveBooleanVal BooleanMessage
}

UserPreference_EffectiveValue_EffectiveBooleanVal selects EffectiveBooleanVal for UserPreference.EffectiveValue.

type UserPreference_EffectiveValue_EffectiveStringVal

type UserPreference_EffectiveValue_EffectiveStringVal struct {
	EffectiveStringVal StringMessage
}

UserPreference_EffectiveValue_EffectiveStringVal selects EffectiveStringVal for UserPreference.EffectiveValue.

type UserPreference_Value_BooleanVal

type UserPreference_Value_BooleanVal struct {
	BooleanVal BooleanMessage
}

UserPreference_Value_BooleanVal selects BooleanVal for UserPreference.Value.

type UserPreference_Value_StringVal

type UserPreference_Value_StringVal struct {
	StringVal StringMessage
}

UserPreference_Value_StringVal selects StringVal for UserPreference.Value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL