Documentation
¶
Overview ¶
These APIs allow you to manage Account Settings V2, Workspace Settings V2, etc.
Index ¶
- type AccountSettingsV2API
- func (a *AccountSettingsV2API) GetPublicAccountSetting(ctx context.Context, request GetPublicAccountSettingRequest) (*Setting, error)
- func (a *AccountSettingsV2API) GetPublicAccountUserPreference(ctx context.Context, request GetPublicAccountUserPreferenceRequest) (*UserPreference, error)
- func (a *AccountSettingsV2API) ListAccountSettingsMetadata(ctx context.Context, request ListAccountSettingsMetadataRequest) listing.Iterator[SettingsMetadata]
- func (a *AccountSettingsV2API) ListAccountSettingsMetadataAll(ctx context.Context, request ListAccountSettingsMetadataRequest) ([]SettingsMetadata, error)
- func (a *AccountSettingsV2API) ListAccountUserPreferencesMetadata(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) listing.Iterator[SettingsMetadata]
- func (a *AccountSettingsV2API) ListAccountUserPreferencesMetadataAll(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) ([]SettingsMetadata, error)
- func (a *AccountSettingsV2API) PatchPublicAccountSetting(ctx context.Context, request PatchPublicAccountSettingRequest) (*Setting, error)
- func (a *AccountSettingsV2API) PatchPublicAccountUserPreference(ctx context.Context, request PatchPublicAccountUserPreferenceRequest) (*UserPreference, error)
- type AccountSettingsV2Interface
- type AccountSettingsV2Servicedeprecated
- type AibiDashboardEmbeddingAccessPolicy
- type AibiDashboardEmbeddingAccessPolicyAccessPolicyType
- func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Set(v string) error
- func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) String() string
- func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Type() string
- func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Values() []AibiDashboardEmbeddingAccessPolicyAccessPolicyType
- type AibiDashboardEmbeddingApprovedDomains
- type AllowedAppsUserApiScopesMessage
- type BooleanMessage
- type ClusterAutoRestartMessage
- type ClusterAutoRestartMessageEnablementDetails
- type ClusterAutoRestartMessageMaintenanceWindow
- type ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
- func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Set(v string) error
- func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) String() string
- func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Type() string
- func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Values() []ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
- type ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule
- type ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
- func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Set(v string) error
- func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) String() string
- func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Type() string
- func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Values() []ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
- type ClusterAutoRestartMessageMaintenanceWindowWindowStartTime
- type CollaborationPlatformConnectivityMessage
- type CollaborationPlatformConnectivityMessageConnectivity
- func (f *CollaborationPlatformConnectivityMessageConnectivity) Set(v string) error
- func (f *CollaborationPlatformConnectivityMessageConnectivity) String() string
- func (f *CollaborationPlatformConnectivityMessageConnectivity) Type() string
- func (f *CollaborationPlatformConnectivityMessageConnectivity) Values() []CollaborationPlatformConnectivityMessageConnectivity
- type DashboardTheme
- type DashboardThemeAlignment
- type DashboardThemeContinuousGradient
- type DashboardThemeContinuousGradientCustomDivergingRamp
- type DashboardThemeContinuousGradientCustomSequentialRamp
- type DashboardThemeContinuousGradientGradientValue
- type DashboardThemeDashboardThemeColor
- type DashboardThemeFontConfig
- type DashboardThemeFontSettings
- type DashboardThemeFontStyle
- type DashboardThemeSentimentColors
- type DashboardThemeTextCase
- type DashboardThemeTextDecoration
- type DashboardThemeVerticalAlign
- type GetPublicAccountSettingRequest
- type GetPublicAccountUserPreferenceRequest
- type GetPublicWorkspaceSettingRequest
- type IntegerMessage
- type ListAccountSettingsMetadataRequest
- type ListAccountSettingsMetadataResponse
- type ListAccountUserPreferencesMetadataRequest
- type ListAccountUserPreferencesMetadataResponse
- type ListWorkspaceSettingsMetadataRequest
- type ListWorkspaceSettingsMetadataResponse
- type OperationalEmailCustomRecipientMessage
- type PatchPublicAccountSettingRequest
- type PatchPublicAccountUserPreferenceRequest
- type PatchPublicWorkspaceSettingRequest
- type PersonalComputeMessage
- type PersonalComputeMessagePersonalComputeMessageEnum
- func (f *PersonalComputeMessagePersonalComputeMessageEnum) Set(v string) error
- func (f *PersonalComputeMessagePersonalComputeMessageEnum) String() string
- func (f *PersonalComputeMessagePersonalComputeMessageEnum) Type() string
- func (f *PersonalComputeMessagePersonalComputeMessageEnum) Values() []PersonalComputeMessagePersonalComputeMessageEnum
- type PreviewPhase
- type RestrictWorkspaceAdminsMessage
- type RestrictWorkspaceAdminsMessageStatus
- type Setting
- type SettingsMetadata
- type StringMessage
- type UserPreference
- type WorkspaceLabelMessage
- type WorkspaceSettingsV2API
- func (a *WorkspaceSettingsV2API) GetPublicWorkspaceSetting(ctx context.Context, request GetPublicWorkspaceSettingRequest) (*Setting, error)
- func (a *WorkspaceSettingsV2API) ListWorkspaceSettingsMetadata(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) listing.Iterator[SettingsMetadata]
- func (a *WorkspaceSettingsV2API) ListWorkspaceSettingsMetadataAll(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) ([]SettingsMetadata, error)
- func (a *WorkspaceSettingsV2API) PatchPublicWorkspaceSetting(ctx context.Context, request PatchPublicWorkspaceSettingRequest) (*Setting, error)
- type WorkspaceSettingsV2Interface
- type WorkspaceSettingsV2Servicedeprecated
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountSettingsV2API ¶
type AccountSettingsV2API struct {
// contains filtered or unexported fields
}
APIs to manage account level settings
func NewAccountSettingsV2 ¶
func NewAccountSettingsV2(client *client.DatabricksClient) *AccountSettingsV2API
func (*AccountSettingsV2API) GetPublicAccountSetting ¶
func (a *AccountSettingsV2API) GetPublicAccountSetting(ctx context.Context, request GetPublicAccountSettingRequest) (*Setting, error)
func (*AccountSettingsV2API) GetPublicAccountUserPreference ¶ added in v0.98.0
func (a *AccountSettingsV2API) GetPublicAccountUserPreference(ctx context.Context, request GetPublicAccountUserPreferenceRequest) (*UserPreference, error)
func (*AccountSettingsV2API) ListAccountSettingsMetadata ¶
func (a *AccountSettingsV2API) ListAccountSettingsMetadata(ctx context.Context, request ListAccountSettingsMetadataRequest) listing.Iterator[SettingsMetadata]
List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountsetting and PATCH :method:settingsv2/patchpublicaccountsetting APIs
func (*AccountSettingsV2API) ListAccountSettingsMetadataAll ¶
func (a *AccountSettingsV2API) ListAccountSettingsMetadataAll(ctx context.Context, request ListAccountSettingsMetadataRequest) ([]SettingsMetadata, 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
func (*AccountSettingsV2API) ListAccountUserPreferencesMetadata ¶ added in v0.98.0
func (a *AccountSettingsV2API) ListAccountUserPreferencesMetadata(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) listing.Iterator[SettingsMetadata]
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
func (*AccountSettingsV2API) ListAccountUserPreferencesMetadataAll ¶ added in v0.98.0
func (a *AccountSettingsV2API) ListAccountUserPreferencesMetadataAll(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) ([]SettingsMetadata, 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
func (*AccountSettingsV2API) PatchPublicAccountSetting ¶
func (a *AccountSettingsV2API) PatchPublicAccountSetting(ctx context.Context, request PatchPublicAccountSettingRequest) (*Setting, error)
func (*AccountSettingsV2API) PatchPublicAccountUserPreference ¶ added in v0.98.0
func (a *AccountSettingsV2API) PatchPublicAccountUserPreference(ctx context.Context, request PatchPublicAccountUserPreferenceRequest) (*UserPreference, error)
type AccountSettingsV2Interface ¶
type AccountSettingsV2Interface interface {
// Get a setting value at account level. See
// :method:settingsv2/listaccountsettingsmetadata for list of setting available
// via public APIs at account level.
GetPublicAccountSetting(ctx context.Context, request GetPublicAccountSettingRequest) (*Setting, 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.
GetPublicAccountUserPreference(ctx context.Context, request GetPublicAccountUserPreferenceRequest) (*UserPreference, 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
//
// This method is generated by Databricks SDK Code Generator.
ListAccountSettingsMetadata(ctx context.Context, request ListAccountSettingsMetadataRequest) listing.Iterator[SettingsMetadata]
// List valid setting keys and metadata. These settings are available to be
// referenced via GET :method:settingsv2/getpublicaccountsetting and PATCH
// :method:settingsv2/patchpublicaccountsetting APIs
//
// This method is generated by Databricks SDK Code Generator.
ListAccountSettingsMetadataAll(ctx context.Context, request ListAccountSettingsMetadataRequest) ([]SettingsMetadata, 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
//
// This method is generated by Databricks SDK Code Generator.
ListAccountUserPreferencesMetadata(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) listing.Iterator[SettingsMetadata]
// 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
//
// This method is generated by Databricks SDK Code Generator.
ListAccountUserPreferencesMetadataAll(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) ([]SettingsMetadata, 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.
PatchPublicAccountSetting(ctx context.Context, request PatchPublicAccountSettingRequest) (*Setting, 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.
PatchPublicAccountUserPreference(ctx context.Context, request PatchPublicAccountUserPreferenceRequest) (*UserPreference, error)
}
type AccountSettingsV2Service
deprecated
type AccountSettingsV2Service interface {
// Get a setting value at account level. See
// :method:settingsv2/listaccountsettingsmetadata for list of setting
// available via public APIs at account level.
GetPublicAccountSetting(ctx context.Context, request GetPublicAccountSettingRequest) (*Setting, 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.
GetPublicAccountUserPreference(ctx context.Context, request GetPublicAccountUserPreferenceRequest) (*UserPreference, 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
ListAccountSettingsMetadata(ctx context.Context, request ListAccountSettingsMetadataRequest) (*ListAccountSettingsMetadataResponse, 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
ListAccountUserPreferencesMetadata(ctx context.Context, request ListAccountUserPreferencesMetadataRequest) (*ListAccountUserPreferencesMetadataResponse, 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.
PatchPublicAccountSetting(ctx context.Context, request PatchPublicAccountSettingRequest) (*Setting, 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.
PatchPublicAccountUserPreference(ctx context.Context, request PatchPublicAccountUserPreferenceRequest) (*UserPreference, error)
}
APIs to manage account level settings
Deprecated: Do not use this interface, it will be removed in a future version of the SDK.
type AibiDashboardEmbeddingAccessPolicy ¶
type AibiDashboardEmbeddingAccessPolicy struct {
AccessPolicyType AibiDashboardEmbeddingAccessPolicyAccessPolicyType `json:"access_policy_type"`
}
func (*AibiDashboardEmbeddingAccessPolicy) UnmarshalJSON ¶ added in v0.174.0
func (s *AibiDashboardEmbeddingAccessPolicy) UnmarshalJSON(b []byte) error
type AibiDashboardEmbeddingAccessPolicyAccessPolicyType ¶
type AibiDashboardEmbeddingAccessPolicyAccessPolicyType string
const AibiDashboardEmbeddingAccessPolicyAccessPolicyTypeAllowAllDomains AibiDashboardEmbeddingAccessPolicyAccessPolicyType = `ALLOW_ALL_DOMAINS`
const AibiDashboardEmbeddingAccessPolicyAccessPolicyTypeAllowApprovedDomains AibiDashboardEmbeddingAccessPolicyAccessPolicyType = `ALLOW_APPROVED_DOMAINS`
const AibiDashboardEmbeddingAccessPolicyAccessPolicyTypeDenyAllDomains AibiDashboardEmbeddingAccessPolicyAccessPolicyType = `DENY_ALL_DOMAINS`
func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Set ¶
func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Set(v string) error
Set raw string value and validate it against allowed values
func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) String ¶
func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) String() string
String representation for fmt.Print
func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Type ¶
func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Type() string
Type always returns AibiDashboardEmbeddingAccessPolicyAccessPolicyType to satisfy [pflag.Value] interface
func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Values ¶
func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Values() []AibiDashboardEmbeddingAccessPolicyAccessPolicyType
Values returns all possible values for AibiDashboardEmbeddingAccessPolicyAccessPolicyType.
There is no guarantee on the order of the values in the slice.
type AibiDashboardEmbeddingApprovedDomains ¶
type AibiDashboardEmbeddingApprovedDomains struct {
ApprovedDomains []string `json:"approved_domains,omitempty"`
}
func (*AibiDashboardEmbeddingApprovedDomains) UnmarshalJSON ¶ added in v0.174.0
func (s *AibiDashboardEmbeddingApprovedDomains) UnmarshalJSON(b []byte) error
type AllowedAppsUserApiScopesMessage ¶ added in v0.133.0
type AllowedAppsUserApiScopesMessage struct {
AllowedScopes []string `json:"allowed_scopes,omitempty"`
}
func (*AllowedAppsUserApiScopesMessage) UnmarshalJSON ¶ added in v0.174.0
func (s *AllowedAppsUserApiScopesMessage) UnmarshalJSON(b []byte) error
type BooleanMessage ¶
type BooleanMessage struct {
Value bool `json:"value,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (BooleanMessage) MarshalJSON ¶
func (s BooleanMessage) MarshalJSON() ([]byte, error)
func (*BooleanMessage) UnmarshalJSON ¶
func (s *BooleanMessage) UnmarshalJSON(b []byte) error
type ClusterAutoRestartMessage ¶
type ClusterAutoRestartMessage struct {
CanToggle bool `json:"can_toggle,omitempty"`
Enabled bool `json:"enabled,omitempty"`
EnablementDetails *ClusterAutoRestartMessageEnablementDetails `json:"enablement_details,omitempty"`
MaintenanceWindow *ClusterAutoRestartMessageMaintenanceWindow `json:"maintenance_window,omitempty"`
RestartEvenIfNoUpdatesAvailable bool `json:"restart_even_if_no_updates_available,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ClusterAutoRestartMessage) MarshalJSON ¶
func (s ClusterAutoRestartMessage) MarshalJSON() ([]byte, error)
func (*ClusterAutoRestartMessage) UnmarshalJSON ¶
func (s *ClusterAutoRestartMessage) UnmarshalJSON(b []byte) error
type ClusterAutoRestartMessageEnablementDetails ¶
type ClusterAutoRestartMessageEnablementDetails struct {
// The feature is force enabled if compliance mode is active
ForcedForComplianceMode bool `json:"forced_for_compliance_mode,omitempty"`
// getShieldEntitlementEnable)
UnavailableForDisabledEntitlement bool `json:"unavailable_for_disabled_entitlement,omitempty"`
UnavailableForNonEnterpriseTier bool `json:"unavailable_for_non_enterprise_tier,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
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.
func (ClusterAutoRestartMessageEnablementDetails) MarshalJSON ¶
func (s ClusterAutoRestartMessageEnablementDetails) MarshalJSON() ([]byte, error)
func (*ClusterAutoRestartMessageEnablementDetails) UnmarshalJSON ¶
func (s *ClusterAutoRestartMessageEnablementDetails) UnmarshalJSON(b []byte) error
type ClusterAutoRestartMessageMaintenanceWindow ¶
type ClusterAutoRestartMessageMaintenanceWindow struct {
WeekDayBasedSchedule *ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule `json:"week_day_based_schedule,omitempty"`
}
func (*ClusterAutoRestartMessageMaintenanceWindow) UnmarshalJSON ¶ added in v0.174.0
func (s *ClusterAutoRestartMessageMaintenanceWindow) UnmarshalJSON(b []byte) error
type ClusterAutoRestartMessageMaintenanceWindowDayOfWeek ¶
type ClusterAutoRestartMessageMaintenanceWindowDayOfWeek string
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekFriday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `FRIDAY`
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekMonday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `MONDAY`
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekSaturday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `SATURDAY`
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekSunday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `SUNDAY`
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekThursday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `THURSDAY`
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekTuesday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `TUESDAY`
const ClusterAutoRestartMessageMaintenanceWindowDayOfWeekWednesday ClusterAutoRestartMessageMaintenanceWindowDayOfWeek = `WEDNESDAY`
func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Set ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Set(v string) error
Set raw string value and validate it against allowed values
func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) String ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) String() string
String representation for fmt.Print
func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Type ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Type() string
Type always returns ClusterAutoRestartMessageMaintenanceWindowDayOfWeek to satisfy [pflag.Value] interface
func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Values ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Values() []ClusterAutoRestartMessageMaintenanceWindowDayOfWeek
Values returns all possible values for ClusterAutoRestartMessageMaintenanceWindowDayOfWeek.
There is no guarantee on the order of the values in the slice.
type ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule ¶
type ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule struct {
DayOfWeek ClusterAutoRestartMessageMaintenanceWindowDayOfWeek `json:"day_of_week,omitempty"`
Frequency ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency `json:"frequency,omitempty"`
WindowStartTime *ClusterAutoRestartMessageMaintenanceWindowWindowStartTime `json:"window_start_time,omitempty"`
}
func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule) UnmarshalJSON ¶ added in v0.174.0
func (s *ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule) UnmarshalJSON(b []byte) error
type ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency ¶
type ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency string
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencyEveryWeek ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `EVERY_WEEK`
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencyFirstAndThirdOfMonth ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `FIRST_AND_THIRD_OF_MONTH`
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencyFirstOfMonth ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `FIRST_OF_MONTH`
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencyFourthOfMonth ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `FOURTH_OF_MONTH`
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencySecondAndFourthOfMonth ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `SECOND_AND_FOURTH_OF_MONTH`
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencySecondOfMonth ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `SECOND_OF_MONTH`
const ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequencyThirdOfMonth ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency = `THIRD_OF_MONTH`
func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Set ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Set(v string) error
Set raw string value and validate it against allowed values
func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) String ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) String() string
String representation for fmt.Print
func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Type ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Type() string
Type always returns ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency to satisfy [pflag.Value] interface
func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Values ¶
func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Values() []ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency
Values returns all possible values for ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency.
There is no guarantee on the order of the values in the slice.
type ClusterAutoRestartMessageMaintenanceWindowWindowStartTime ¶
type ClusterAutoRestartMessageMaintenanceWindowWindowStartTime struct {
Hours int `json:"hours,omitempty"`
Minutes int `json:"minutes,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) MarshalJSON ¶
func (s ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) MarshalJSON() ([]byte, error)
func (*ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) UnmarshalJSON ¶
func (s *ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) UnmarshalJSON(b []byte) error
type CollaborationPlatformConnectivityMessage ¶ added in v0.141.0
type CollaborationPlatformConnectivityMessage struct {
Connectivity CollaborationPlatformConnectivityMessageConnectivity `json:"connectivity"`
}
Controls which external collaboration platforms (Slack, Microsoft Teams) can connect to a workspace. Defaults to ALLOW_ALL.
func (*CollaborationPlatformConnectivityMessage) UnmarshalJSON ¶ added in v0.174.0
func (s *CollaborationPlatformConnectivityMessage) UnmarshalJSON(b []byte) error
type CollaborationPlatformConnectivityMessageConnectivity ¶ added in v0.141.0
type CollaborationPlatformConnectivityMessageConnectivity string
const CollaborationPlatformConnectivityMessageConnectivityAllowAll CollaborationPlatformConnectivityMessageConnectivity = `ALLOW_ALL`
const CollaborationPlatformConnectivityMessageConnectivityAllowSlack CollaborationPlatformConnectivityMessageConnectivity = `ALLOW_SLACK`
const CollaborationPlatformConnectivityMessageConnectivityAllowTeams CollaborationPlatformConnectivityMessageConnectivity = `ALLOW_TEAMS`
const CollaborationPlatformConnectivityMessageConnectivityDenyAll CollaborationPlatformConnectivityMessageConnectivity = `DENY_ALL`
func (*CollaborationPlatformConnectivityMessageConnectivity) Set ¶ added in v0.141.0
func (f *CollaborationPlatformConnectivityMessageConnectivity) Set(v string) error
Set raw string value and validate it against allowed values
func (*CollaborationPlatformConnectivityMessageConnectivity) String ¶ added in v0.141.0
func (f *CollaborationPlatformConnectivityMessageConnectivity) String() string
String representation for fmt.Print
func (*CollaborationPlatformConnectivityMessageConnectivity) Type ¶ added in v0.141.0
func (f *CollaborationPlatformConnectivityMessageConnectivity) Type() string
Type always returns CollaborationPlatformConnectivityMessageConnectivity to satisfy [pflag.Value] interface
func (*CollaborationPlatformConnectivityMessageConnectivity) Values ¶ added in v0.141.0
func (f *CollaborationPlatformConnectivityMessageConnectivity) Values() []CollaborationPlatformConnectivityMessageConnectivity
Values returns all possible values for CollaborationPlatformConnectivityMessageConnectivity.
There is no guarantee on the order of the values in the slice.
type DashboardTheme ¶
type DashboardTheme struct {
// Color of the zero-value grid line, making it visually distinct from other
// grid lines.
AxisLineColor *DashboardThemeDashboardThemeColor `json:"axis_line_color,omitempty"`
// The background color of the dashboard canvas.
CanvasBackgroundColor *DashboardThemeDashboardThemeColor `json:"canvas_background_color,omitempty"`
// The continuous gradient configuration for the dashboard.
ContinuousGradient *DashboardThemeContinuousGradient `json:"continuous_gradient,omitempty"`
// The default font color applied to all text in the dashboard. Superseded
// by font_settings.base.font_color when font_settings is set. More specific
// font settings in turn override base.
FontColor *DashboardThemeDashboardThemeColor `json:"font_color,omitempty"`
// Font family to customize all text within the dashboard. Unsupported font
// names fall back to the default font. Superseded by
// font_settings.base.font_family when font_settings is set.
FontFamily string `json:"font_family,omitempty"`
// The per-category typography overrides for the dashboard.
FontSettings *DashboardThemeFontSettings `json:"font_settings,omitempty"`
// Color of chart grid lines in visualizations (horizontal and vertical
// guide lines).
GridLineColor *DashboardThemeDashboardThemeColor `json:"grid_line_color,omitempty"`
// The corner radius in pixels for rectangular marks in visualizations
// (bars, columns, histogram bins, etc.).
MarkCornerRadius int `json:"mark_corner_radius,omitempty"`
// The highlight color for selected elements in widgets.
SelectionColor *DashboardThemeDashboardThemeColor `json:"selection_color,omitempty"`
// The sentiment color palette for the dashboard.
SentimentColors *DashboardThemeSentimentColors `json:"sentiment_colors,omitempty"`
// The default vertical alignment for all text box widgets in the dashboard.
// Individual text box widgets can override this.
TextBoxVerticalAlign DashboardThemeVerticalAlign `json:"text_box_vertical_align,omitempty"`
// Color palette for visualizations. Colors are applied in order
// (visualization_color_01, visualization_color_02, etc.). Invalid color
// values are preserved but ignored during rendering.
VisualizationColor01 string `json:"visualization_color_01,omitempty"`
// The color at position 2 in the visualization color palette.
VisualizationColor02 string `json:"visualization_color_02,omitempty"`
// The color at position 3 in the visualization color palette.
VisualizationColor03 string `json:"visualization_color_03,omitempty"`
// The color at position 4 in the visualization color palette.
VisualizationColor04 string `json:"visualization_color_04,omitempty"`
// The color at position 5 in the visualization color palette.
VisualizationColor05 string `json:"visualization_color_05,omitempty"`
// The color at position 6 in the visualization color palette.
VisualizationColor06 string `json:"visualization_color_06,omitempty"`
// The color at position 7 in the visualization color palette.
VisualizationColor07 string `json:"visualization_color_07,omitempty"`
// The color at position 8 in the visualization color palette.
VisualizationColor08 string `json:"visualization_color_08,omitempty"`
// The color at position 9 in the visualization color palette.
VisualizationColor09 string `json:"visualization_color_09,omitempty"`
// The color at position 10 in the visualization color palette.
VisualizationColor10 string `json:"visualization_color_10,omitempty"`
// The color at position 11 in the visualization color palette.
VisualizationColor11 string `json:"visualization_color_11,omitempty"`
// The color at position 12 in the visualization color palette.
VisualizationColor12 string `json:"visualization_color_12,omitempty"`
// The color at position 13 in the visualization color palette.
VisualizationColor13 string `json:"visualization_color_13,omitempty"`
// The color at position 14 in the visualization color palette.
VisualizationColor14 string `json:"visualization_color_14,omitempty"`
// The color at position 15 in the visualization color palette.
VisualizationColor15 string `json:"visualization_color_15,omitempty"`
// The color at position 16 in the visualization color palette.
VisualizationColor16 string `json:"visualization_color_16,omitempty"`
// The color at position 17 in the visualization color palette.
VisualizationColor17 string `json:"visualization_color_17,omitempty"`
// The color at position 18 in the visualization color palette.
VisualizationColor18 string `json:"visualization_color_18,omitempty"`
// The color at position 19 in the visualization color palette.
VisualizationColor19 string `json:"visualization_color_19,omitempty"`
// The color at position 20 in the visualization color palette.
VisualizationColor20 string `json:"visualization_color_20,omitempty"`
// The background color of widgets.
WidgetBackgroundColor *DashboardThemeDashboardThemeColor `json:"widget_background_color,omitempty"`
// The border color of widgets.
WidgetBorderColor *DashboardThemeDashboardThemeColor `json:"widget_border_color,omitempty"`
// The widget border radius in pixels.
WidgetCornerRadius int `json:"widget_corner_radius,omitempty"`
// Alignment setting for all widget titles and descriptions at the dashboard
// level.
WidgetHeaderAlignment DashboardThemeAlignment `json:"widget_header_alignment,omitempty"`
// The gap between widgets in pixels.
WidgetMargin int `json:"widget_margin,omitempty"`
// The content padding inside each widget in pixels.
WidgetPadding int `json:"widget_padding,omitempty"`
// The shadow intensity level applied to widgets (0 = no shadow, 100 =
// maximum). The actual CSS box-shadow is computed at render time from this
// value, factoring in background colors and color mode.
WidgetShadow int `json:"widget_shadow,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
Theme settings for customizing AI/BI dashboard UI, including visualization colors, font colors, background colors, and more.
func (DashboardTheme) MarshalJSON ¶
func (s DashboardTheme) MarshalJSON() ([]byte, error)
func (*DashboardTheme) UnmarshalJSON ¶
func (s *DashboardTheme) UnmarshalJSON(b []byte) error
type DashboardThemeAlignment ¶
type DashboardThemeAlignment string
Horizontal alignment options for widget titles and descriptions.
const DashboardThemeAlignmentCenter DashboardThemeAlignment = `CENTER`
const DashboardThemeAlignmentLeft DashboardThemeAlignment = `LEFT`
const DashboardThemeAlignmentRight DashboardThemeAlignment = `RIGHT`
func (*DashboardThemeAlignment) Set ¶
func (f *DashboardThemeAlignment) Set(v string) error
Set raw string value and validate it against allowed values
func (*DashboardThemeAlignment) String ¶
func (f *DashboardThemeAlignment) String() string
String representation for fmt.Print
func (*DashboardThemeAlignment) Type ¶
func (f *DashboardThemeAlignment) Type() string
Type always returns DashboardThemeAlignment to satisfy [pflag.Value] interface
func (*DashboardThemeAlignment) Values ¶
func (f *DashboardThemeAlignment) Values() []DashboardThemeAlignment
Values returns all possible values for DashboardThemeAlignment.
There is no guarantee on the order of the values in the slice.
type DashboardThemeContinuousGradient ¶
type DashboardThemeContinuousGradient struct {
// Gradient value used when the dashboard is rendered in dark mode.
DarkMode *DashboardThemeContinuousGradientGradientValue `json:"dark_mode,omitempty"`
// Gradient value used when the dashboard is rendered in light mode.
LightMode *DashboardThemeContinuousGradientGradientValue `json:"light_mode,omitempty"`
}
Configuration for continuous color gradients, with separate values for light and dark mode. Each mode's gradient can reference the visualization color palette via from_categorical_index, use a named color scheme, or define a custom sequential or diverging ramp.
func (*DashboardThemeContinuousGradient) UnmarshalJSON ¶
func (s *DashboardThemeContinuousGradient) UnmarshalJSON(b []byte) error
type DashboardThemeContinuousGradientCustomDivergingRamp ¶
type DashboardThemeContinuousGradientCustomDivergingRamp struct {
// The color at the end of the gradient (highest value).
End *DashboardThemeDashboardThemeColor `json:"end,omitempty"`
// The color at the midpoint of the gradient.
Mid *DashboardThemeDashboardThemeColor `json:"mid,omitempty"`
// The color at the start of the gradient (lowest value).
Start *DashboardThemeDashboardThemeColor `json:"start,omitempty"`
}
A custom three-stop diverging gradient ramp.
func (*DashboardThemeContinuousGradientCustomDivergingRamp) UnmarshalJSON ¶
func (s *DashboardThemeContinuousGradientCustomDivergingRamp) UnmarshalJSON(b []byte) error
type DashboardThemeContinuousGradientCustomSequentialRamp ¶
type DashboardThemeContinuousGradientCustomSequentialRamp struct {
// The color at the end of the gradient (highest value).
End *DashboardThemeDashboardThemeColor `json:"end,omitempty"`
// The color at the start of the gradient (lowest value).
Start *DashboardThemeDashboardThemeColor `json:"start,omitempty"`
}
A custom two-stop sequential gradient ramp.
func (*DashboardThemeContinuousGradientCustomSequentialRamp) UnmarshalJSON ¶
func (s *DashboardThemeContinuousGradientCustomSequentialRamp) UnmarshalJSON(b []byte) error
type DashboardThemeContinuousGradientGradientValue ¶
type DashboardThemeContinuousGradientGradientValue struct {
// A static color string (for example, '#FF0000').
Color string `json:"color,omitempty"`
// A named color scheme (for example, 'blues', 'viridis', 'spectral').
ColorScheme string `json:"color_scheme,omitempty"`
// A custom three-stop diverging gradient.
CustomDiverging *DashboardThemeContinuousGradientCustomDivergingRamp `json:"custom_diverging,omitempty"`
// A custom two-stop sequential gradient.
CustomSequential *DashboardThemeContinuousGradientCustomSequentialRamp `json:"custom_sequential,omitempty"`
// A 0-based index into the visualization color palette, where 0 is
// visualization_color_01. Valid values are 0 to 19.
FromCategoricalIndex int `json:"from_categorical_index,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
The gradient for one color mode. Set at most one field.
func (DashboardThemeContinuousGradientGradientValue) MarshalJSON ¶
func (s DashboardThemeContinuousGradientGradientValue) MarshalJSON() ([]byte, error)
func (*DashboardThemeContinuousGradientGradientValue) UnmarshalJSON ¶
func (s *DashboardThemeContinuousGradientGradientValue) UnmarshalJSON(b []byte) error
type DashboardThemeDashboardThemeColor ¶
type DashboardThemeDashboardThemeColor struct {
// The color used when the dashboard is rendered in dark mode (for example,
// '#FF0000').
Dark string `json:"dark,omitempty"`
// The color used when the dashboard is rendered in light mode (for example,
// '#FF0000').
Light string `json:"light,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
Represents a color value with optional overrides for light and dark modes. Authors can customize colors separately to cater to each mode, based on the viewer's user-level theme preference.
func (DashboardThemeDashboardThemeColor) MarshalJSON ¶
func (s DashboardThemeDashboardThemeColor) MarshalJSON() ([]byte, error)
func (*DashboardThemeDashboardThemeColor) UnmarshalJSON ¶
func (s *DashboardThemeDashboardThemeColor) UnmarshalJSON(b []byte) error
type DashboardThemeFontConfig ¶
type DashboardThemeFontConfig struct {
// The font color applied to text in this category.
FontColor *DashboardThemeDashboardThemeColor `json:"font_color,omitempty"`
// The font family name used for text in this category.
FontFamily string `json:"font_family,omitempty"`
// The font size in pixels.
FontSize int `json:"font_size,omitempty"`
// The font style (slant) applied to text in this category.
FontStyle DashboardThemeFontStyle `json:"font_style,omitempty"`
// The font weight value (for example, 400 for normal, 700 for bold).
FontWeight int `json:"font_weight,omitempty"`
// The text case transformation applied to text in this category.
TextCase DashboardThemeTextCase `json:"text_case,omitempty"`
// The text decoration applied to text in this category.
TextDecoration DashboardThemeTextDecoration `json:"text_decoration,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
Defines the typography settings for a single text category.
func (DashboardThemeFontConfig) MarshalJSON ¶
func (s DashboardThemeFontConfig) MarshalJSON() ([]byte, error)
func (*DashboardThemeFontConfig) UnmarshalJSON ¶
func (s *DashboardThemeFontConfig) UnmarshalJSON(b []byte) error
type DashboardThemeFontSettings ¶
type DashboardThemeFontSettings struct {
// The default font config applied to all text unless overridden by a more
// specific category.
Base *DashboardThemeFontConfig `json:"base,omitempty"`
// The font config applied to field titles (for example, axis titles, table
// heading titles).
FieldTitle *DashboardThemeFontConfig `json:"field_title,omitempty"`
// The font config applied to field values (for example, axis tick labels,
// table cell values, tooltip values).
FieldValue *DashboardThemeFontConfig `json:"field_value,omitempty"`
// The font config applied to widget descriptions.
WidgetDescription *DashboardThemeFontConfig `json:"widget_description,omitempty"`
// The font config applied to widget titles.
WidgetTitle *DashboardThemeFontConfig `json:"widget_title,omitempty"`
}
Per-category typography overrides. When font_settings.base is set, it takes precedence over the top-level font_family and font_color. More specific categories (widget_title, widget_description, field_title, field_value) in turn override base.
func (*DashboardThemeFontSettings) UnmarshalJSON ¶
func (s *DashboardThemeFontSettings) UnmarshalJSON(b []byte) error
type DashboardThemeFontStyle ¶
type DashboardThemeFontStyle string
Defines the font style (slant) applied to rendered text.
const DashboardThemeFontStyleFontStyleItalic DashboardThemeFontStyle = `FONT_STYLE_ITALIC`
const DashboardThemeFontStyleFontStyleNormal DashboardThemeFontStyle = `FONT_STYLE_NORMAL`
func (*DashboardThemeFontStyle) Set ¶
func (f *DashboardThemeFontStyle) Set(v string) error
Set raw string value and validate it against allowed values
func (*DashboardThemeFontStyle) String ¶
func (f *DashboardThemeFontStyle) String() string
String representation for fmt.Print
func (*DashboardThemeFontStyle) Type ¶
func (f *DashboardThemeFontStyle) Type() string
Type always returns DashboardThemeFontStyle to satisfy [pflag.Value] interface
func (*DashboardThemeFontStyle) Values ¶
func (f *DashboardThemeFontStyle) Values() []DashboardThemeFontStyle
Values returns all possible values for DashboardThemeFontStyle.
There is no guarantee on the order of the values in the slice.
type DashboardThemeSentimentColors ¶
type DashboardThemeSentimentColors struct {
// The color applied to negative sentiment values.
Negative *DashboardThemeDashboardThemeColor `json:"negative,omitempty"`
// The color applied to neutral sentiment values.
Neutral *DashboardThemeDashboardThemeColor `json:"neutral,omitempty"`
// The color applied to positive sentiment values.
Positive *DashboardThemeDashboardThemeColor `json:"positive,omitempty"`
}
Shared sentiment colors reusable across visualizations, primarily for conditional formatting, ensuring consistent positive, negative, and neutral meaning throughout the dashboard.
func (*DashboardThemeSentimentColors) UnmarshalJSON ¶
func (s *DashboardThemeSentimentColors) UnmarshalJSON(b []byte) error
type DashboardThemeTextCase ¶
type DashboardThemeTextCase string
Defines the text case transformation applied to rendered text.
const DashboardThemeTextCaseTextCaseCapitalize DashboardThemeTextCase = `TEXT_CASE_CAPITALIZE`
const DashboardThemeTextCaseTextCaseLowercase DashboardThemeTextCase = `TEXT_CASE_LOWERCASE`
const DashboardThemeTextCaseTextCaseUppercase DashboardThemeTextCase = `TEXT_CASE_UPPERCASE`
func (*DashboardThemeTextCase) Set ¶
func (f *DashboardThemeTextCase) Set(v string) error
Set raw string value and validate it against allowed values
func (*DashboardThemeTextCase) String ¶
func (f *DashboardThemeTextCase) String() string
String representation for fmt.Print
func (*DashboardThemeTextCase) Type ¶
func (f *DashboardThemeTextCase) Type() string
Type always returns DashboardThemeTextCase to satisfy [pflag.Value] interface
func (*DashboardThemeTextCase) Values ¶
func (f *DashboardThemeTextCase) Values() []DashboardThemeTextCase
Values returns all possible values for DashboardThemeTextCase.
There is no guarantee on the order of the values in the slice.
type DashboardThemeTextDecoration ¶
type DashboardThemeTextDecoration string
Defines the decoration line applied to rendered text.
const DashboardThemeTextDecorationTextDecorationNone DashboardThemeTextDecoration = `TEXT_DECORATION_NONE`
const DashboardThemeTextDecorationTextDecorationUnderline DashboardThemeTextDecoration = `TEXT_DECORATION_UNDERLINE`
func (*DashboardThemeTextDecoration) Set ¶
func (f *DashboardThemeTextDecoration) Set(v string) error
Set raw string value and validate it against allowed values
func (*DashboardThemeTextDecoration) String ¶
func (f *DashboardThemeTextDecoration) String() string
String representation for fmt.Print
func (*DashboardThemeTextDecoration) Type ¶
func (f *DashboardThemeTextDecoration) Type() string
Type always returns DashboardThemeTextDecoration to satisfy [pflag.Value] interface
func (*DashboardThemeTextDecoration) Values ¶
func (f *DashboardThemeTextDecoration) Values() []DashboardThemeTextDecoration
Values returns all possible values for DashboardThemeTextDecoration.
There is no guarantee on the order of the values in the slice.
type DashboardThemeVerticalAlign ¶
type DashboardThemeVerticalAlign string
Vertical alignment options for text box content.
const DashboardThemeVerticalAlignVerticalAlignBottom DashboardThemeVerticalAlign = `VERTICAL_ALIGN_BOTTOM`
const DashboardThemeVerticalAlignVerticalAlignCenter DashboardThemeVerticalAlign = `VERTICAL_ALIGN_CENTER`
const DashboardThemeVerticalAlignVerticalAlignTop DashboardThemeVerticalAlign = `VERTICAL_ALIGN_TOP`
func (*DashboardThemeVerticalAlign) Set ¶
func (f *DashboardThemeVerticalAlign) Set(v string) error
Set raw string value and validate it against allowed values
func (*DashboardThemeVerticalAlign) String ¶
func (f *DashboardThemeVerticalAlign) String() string
String representation for fmt.Print
func (*DashboardThemeVerticalAlign) Type ¶
func (f *DashboardThemeVerticalAlign) Type() string
Type always returns DashboardThemeVerticalAlign to satisfy [pflag.Value] interface
func (*DashboardThemeVerticalAlign) Values ¶
func (f *DashboardThemeVerticalAlign) Values() []DashboardThemeVerticalAlign
Values returns all possible values for DashboardThemeVerticalAlign.
There is no guarantee on the order of the values in the slice.
type GetPublicAccountSettingRequest ¶
type GetPublicAccountSettingRequest struct {
Name string `json:"-" url:"-"`
}
func (*GetPublicAccountSettingRequest) UnmarshalJSON ¶ added in v0.174.0
func (s *GetPublicAccountSettingRequest) UnmarshalJSON(b []byte) error
type GetPublicAccountUserPreferenceRequest ¶ added in v0.98.0
type GetPublicAccountUserPreferenceRequest struct {
// User Setting name.
Name string `json:"-" url:"-"`
// User ID of the user whose setting is being retrieved.
UserId string `json:"-" url:"-"`
}
func (*GetPublicAccountUserPreferenceRequest) UnmarshalJSON ¶ added in v0.174.0
func (s *GetPublicAccountUserPreferenceRequest) UnmarshalJSON(b []byte) error
type GetPublicWorkspaceSettingRequest ¶
type GetPublicWorkspaceSettingRequest struct {
// Name of the setting
Name string `json:"-" url:"-"`
}
func (*GetPublicWorkspaceSettingRequest) UnmarshalJSON ¶ added in v0.174.0
func (s *GetPublicWorkspaceSettingRequest) UnmarshalJSON(b []byte) error
type IntegerMessage ¶
type IntegerMessage struct {
Value int `json:"value,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (IntegerMessage) MarshalJSON ¶
func (s IntegerMessage) MarshalJSON() ([]byte, error)
func (*IntegerMessage) UnmarshalJSON ¶
func (s *IntegerMessage) UnmarshalJSON(b []byte) error
type ListAccountSettingsMetadataRequest ¶
type ListAccountSettingsMetadataRequest 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 `json:"-" url:"page_size,omitempty"`
// 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 `json:"-" url:"page_token,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListAccountSettingsMetadataRequest) MarshalJSON ¶
func (s ListAccountSettingsMetadataRequest) MarshalJSON() ([]byte, error)
func (*ListAccountSettingsMetadataRequest) UnmarshalJSON ¶
func (s *ListAccountSettingsMetadataRequest) UnmarshalJSON(b []byte) error
type ListAccountSettingsMetadataResponse ¶
type ListAccountSettingsMetadataResponse struct {
// 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 `json:"next_page_token,omitempty"`
// List of all settings available via public APIs and their metadata
SettingsMetadata []SettingsMetadata `json:"settings_metadata,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListAccountSettingsMetadataResponse) MarshalJSON ¶
func (s ListAccountSettingsMetadataResponse) MarshalJSON() ([]byte, error)
func (*ListAccountSettingsMetadataResponse) UnmarshalJSON ¶
func (s *ListAccountSettingsMetadataResponse) UnmarshalJSON(b []byte) error
type ListAccountUserPreferencesMetadataRequest ¶ added in v0.98.0
type ListAccountUserPreferencesMetadataRequest 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 `json:"-" url:"page_size,omitempty"`
// 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 `json:"-" url:"page_token,omitempty"`
// User ID of the user whose settings metadata is being retrieved.
UserId string `json:"-" url:"-"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListAccountUserPreferencesMetadataRequest) MarshalJSON ¶ added in v0.98.0
func (s ListAccountUserPreferencesMetadataRequest) MarshalJSON() ([]byte, error)
func (*ListAccountUserPreferencesMetadataRequest) UnmarshalJSON ¶ added in v0.98.0
func (s *ListAccountUserPreferencesMetadataRequest) UnmarshalJSON(b []byte) error
type ListAccountUserPreferencesMetadataResponse ¶ added in v0.98.0
type ListAccountUserPreferencesMetadataResponse struct {
// 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 `json:"next_page_token,omitempty"`
// List of all settings available via public APIs and their metadata
SettingsMetadata []SettingsMetadata `json:"settings_metadata,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListAccountUserPreferencesMetadataResponse) MarshalJSON ¶ added in v0.98.0
func (s ListAccountUserPreferencesMetadataResponse) MarshalJSON() ([]byte, error)
func (*ListAccountUserPreferencesMetadataResponse) UnmarshalJSON ¶ added in v0.98.0
func (s *ListAccountUserPreferencesMetadataResponse) UnmarshalJSON(b []byte) error
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 `json:"-" url:"page_size,omitempty"`
// 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 `json:"-" url:"page_token,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListWorkspaceSettingsMetadataRequest) MarshalJSON ¶
func (s ListWorkspaceSettingsMetadataRequest) MarshalJSON() ([]byte, error)
func (*ListWorkspaceSettingsMetadataRequest) UnmarshalJSON ¶
func (s *ListWorkspaceSettingsMetadataRequest) UnmarshalJSON(b []byte) error
type ListWorkspaceSettingsMetadataResponse ¶
type ListWorkspaceSettingsMetadataResponse struct {
// 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 `json:"next_page_token,omitempty"`
// List of all settings available via public APIs and their metadata
SettingsMetadata []SettingsMetadata `json:"settings_metadata,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListWorkspaceSettingsMetadataResponse) MarshalJSON ¶
func (s ListWorkspaceSettingsMetadataResponse) MarshalJSON() ([]byte, error)
func (*ListWorkspaceSettingsMetadataResponse) UnmarshalJSON ¶
func (s *ListWorkspaceSettingsMetadataResponse) UnmarshalJSON(b []byte) error
type OperationalEmailCustomRecipientMessage ¶ added in v0.134.0
type OperationalEmailCustomRecipientMessage struct {
Email string `json:"email,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (OperationalEmailCustomRecipientMessage) MarshalJSON ¶ added in v0.134.0
func (s OperationalEmailCustomRecipientMessage) MarshalJSON() ([]byte, error)
func (*OperationalEmailCustomRecipientMessage) UnmarshalJSON ¶ added in v0.134.0
func (s *OperationalEmailCustomRecipientMessage) UnmarshalJSON(b []byte) error
type PatchPublicAccountSettingRequest ¶
type PatchPublicAccountSettingRequest struct {
Name string `json:"-" url:"-"`
Setting Setting `json:"setting"`
}
func (*PatchPublicAccountSettingRequest) UnmarshalJSON ¶ added in v0.174.0
func (s *PatchPublicAccountSettingRequest) UnmarshalJSON(b []byte) error
type PatchPublicAccountUserPreferenceRequest ¶ added in v0.98.0
type PatchPublicAccountUserPreferenceRequest struct {
Name string `json:"-" url:"-"`
Setting UserPreference `json:"setting"`
// User ID of the user whose setting is being updated.
UserId string `json:"-" url:"-"`
}
func (*PatchPublicAccountUserPreferenceRequest) UnmarshalJSON ¶ added in v0.174.0
func (s *PatchPublicAccountUserPreferenceRequest) UnmarshalJSON(b []byte) error
type PatchPublicWorkspaceSettingRequest ¶
type PatchPublicWorkspaceSettingRequest struct {
// Name of the setting
Name string `json:"-" url:"-"`
Setting Setting `json:"setting"`
}
func (*PatchPublicWorkspaceSettingRequest) UnmarshalJSON ¶ added in v0.174.0
func (s *PatchPublicWorkspaceSettingRequest) UnmarshalJSON(b []byte) error
type PersonalComputeMessage ¶
type PersonalComputeMessage struct {
Value PersonalComputeMessagePersonalComputeMessageEnum `json:"value,omitempty"`
}
func (*PersonalComputeMessage) UnmarshalJSON ¶ added in v0.174.0
func (s *PersonalComputeMessage) UnmarshalJSON(b []byte) error
type PersonalComputeMessagePersonalComputeMessageEnum ¶
type PersonalComputeMessagePersonalComputeMessageEnum 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 PersonalComputeMessagePersonalComputeMessageEnumDelegate PersonalComputeMessagePersonalComputeMessageEnum = `DELEGATE`
const PersonalComputeMessagePersonalComputeMessageEnumOn PersonalComputeMessagePersonalComputeMessageEnum = `ON`
func (*PersonalComputeMessagePersonalComputeMessageEnum) Set ¶
func (f *PersonalComputeMessagePersonalComputeMessageEnum) Set(v string) error
Set raw string value and validate it against allowed values
func (*PersonalComputeMessagePersonalComputeMessageEnum) String ¶
func (f *PersonalComputeMessagePersonalComputeMessageEnum) String() string
String representation for fmt.Print
func (*PersonalComputeMessagePersonalComputeMessageEnum) Type ¶
func (f *PersonalComputeMessagePersonalComputeMessageEnum) Type() string
Type always returns PersonalComputeMessagePersonalComputeMessageEnum to satisfy [pflag.Value] interface
func (*PersonalComputeMessagePersonalComputeMessageEnum) Values ¶
func (f *PersonalComputeMessagePersonalComputeMessageEnum) Values() []PersonalComputeMessagePersonalComputeMessageEnum
Values returns all possible values for PersonalComputeMessagePersonalComputeMessageEnum.
There is no guarantee on the order of the values in the slice.
type PreviewPhase ¶ added in v0.132.0
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 PreviewPhaseBeta PreviewPhase = `BETA`
const PreviewPhaseGa PreviewPhase = `GA`
const PreviewPhaseGaSoon PreviewPhase = `GA_SOON`
const PreviewPhasePrivatePreview PreviewPhase = `PRIVATE_PREVIEW`
const PreviewPhasePublicPreview PreviewPhase = `PUBLIC_PREVIEW`
func (*PreviewPhase) Set ¶ added in v0.132.0
func (f *PreviewPhase) Set(v string) error
Set raw string value and validate it against allowed values
func (*PreviewPhase) String ¶ added in v0.132.0
func (f *PreviewPhase) String() string
String representation for fmt.Print
func (*PreviewPhase) Type ¶ added in v0.132.0
func (f *PreviewPhase) Type() string
Type always returns PreviewPhase to satisfy [pflag.Value] interface
func (*PreviewPhase) Values ¶ added in v0.132.0
func (f *PreviewPhase) Values() []PreviewPhase
Values returns all possible values for PreviewPhase.
There is no guarantee on the order of the values in the slice.
type RestrictWorkspaceAdminsMessage ¶
type RestrictWorkspaceAdminsMessage struct {
// When true, workspace admins cannot create governance tags. ALLOW_ALL
// status does not override this; they are independent.
DisableGovTagCreation bool `json:"disable_gov_tag_creation,omitempty"`
Status RestrictWorkspaceAdminsMessageStatus `json:"status"`
ForceSendFields []string `json:"-" url:"-"`
}
func (RestrictWorkspaceAdminsMessage) MarshalJSON ¶ added in v0.125.0
func (s RestrictWorkspaceAdminsMessage) MarshalJSON() ([]byte, error)
func (*RestrictWorkspaceAdminsMessage) UnmarshalJSON ¶ added in v0.125.0
func (s *RestrictWorkspaceAdminsMessage) UnmarshalJSON(b []byte) error
type RestrictWorkspaceAdminsMessageStatus ¶
type RestrictWorkspaceAdminsMessageStatus string
const RestrictWorkspaceAdminsMessageStatusAllowAll RestrictWorkspaceAdminsMessageStatus = `ALLOW_ALL`
const RestrictWorkspaceAdminsMessageStatusRestrictTokensAndJobRunAs RestrictWorkspaceAdminsMessageStatus = `RESTRICT_TOKENS_AND_JOB_RUN_AS`
func (*RestrictWorkspaceAdminsMessageStatus) Set ¶
func (f *RestrictWorkspaceAdminsMessageStatus) Set(v string) error
Set raw string value and validate it against allowed values
func (*RestrictWorkspaceAdminsMessageStatus) String ¶
func (f *RestrictWorkspaceAdminsMessageStatus) String() string
String representation for fmt.Print
func (*RestrictWorkspaceAdminsMessageStatus) Type ¶
func (f *RestrictWorkspaceAdminsMessageStatus) Type() string
Type always returns RestrictWorkspaceAdminsMessageStatus to satisfy [pflag.Value] interface
func (*RestrictWorkspaceAdminsMessageStatus) Values ¶
func (f *RestrictWorkspaceAdminsMessageStatus) Values() []RestrictWorkspaceAdminsMessageStatus
Values returns all possible values for RestrictWorkspaceAdminsMessageStatus.
There is no guarantee on the order of the values in the slice.
type Setting ¶
type Setting struct {
// 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.
AibiDashboardEmbeddingAccessPolicy *AibiDashboardEmbeddingAccessPolicy `json:"aibi_dashboard_embedding_access_policy,omitempty"`
// 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.
AibiDashboardEmbeddingApprovedDomains *AibiDashboardEmbeddingApprovedDomains `json:"aibi_dashboard_embedding_approved_domains,omitempty"`
// 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.
AllowedAppsUserApiScopes *AllowedAppsUserApiScopesMessage `json:"allowed_apps_user_api_scopes,omitempty"`
// 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.
AutomaticClusterUpdateWorkspace *ClusterAutoRestartMessage `json:"automatic_cluster_update_workspace,omitempty"`
// Setting value for boolean type setting. This is the setting value set by
// consumers, check effective_boolean_val for final setting value.
BooleanVal *BooleanMessage `json:"boolean_val,omitempty"`
// Setting value for collaboration_platform_connectivity setting. This is
// the setting value set by consumers, check
// effective_collaboration_platform_connectivity for final setting value.
CollaborationPlatformConnectivity *CollaborationPlatformConnectivityMessage `json:"collaboration_platform_connectivity,omitempty"`
// 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.
EffectiveAibiDashboardEmbeddingAccessPolicy *AibiDashboardEmbeddingAccessPolicy `json:"effective_aibi_dashboard_embedding_access_policy,omitempty"`
// 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.
EffectiveAibiDashboardEmbeddingApprovedDomains *AibiDashboardEmbeddingApprovedDomains `json:"effective_aibi_dashboard_embedding_approved_domains,omitempty"`
// 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.
EffectiveAllowedAppsUserApiScopes *AllowedAppsUserApiScopesMessage `json:"effective_allowed_apps_user_api_scopes,omitempty"`
// 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.
EffectiveAutomaticClusterUpdateWorkspace *ClusterAutoRestartMessage `json:"effective_automatic_cluster_update_workspace,omitempty"`
// Effective setting value for boolean type setting. This is the final
// effective value of setting. To set a value use boolean_val.
EffectiveBooleanVal *BooleanMessage `json:"effective_boolean_val,omitempty"`
// Effective setting value for collaboration_platform_connectivity setting.
// This is the final effective value of setting. To set a value use
// collaboration_platform_connectivity.
EffectiveCollaborationPlatformConnectivity *CollaborationPlatformConnectivityMessage `json:"effective_collaboration_platform_connectivity,omitempty"`
// Effective setting value for integer type setting. This is the final
// effective value of setting. To set a value use integer_val.
EffectiveIntegerVal *IntegerMessage `json:"effective_integer_val,omitempty"`
// 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.
EffectiveOperationalEmailCustomRecipient *OperationalEmailCustomRecipientMessage `json:"effective_operational_email_custom_recipient,omitempty"`
// Effective setting value for personal_compute setting. This is the final
// effective value of setting. To set a value use personal_compute.
EffectivePersonalCompute *PersonalComputeMessage `json:"effective_personal_compute,omitempty"`
// Effective setting value for restrict_workspace_admins setting. This is
// the final effective value of setting. To set a value use
// restrict_workspace_admins.
EffectiveRestrictWorkspaceAdmins *RestrictWorkspaceAdminsMessage `json:"effective_restrict_workspace_admins,omitempty"`
// Effective setting value for string type setting. This is the final
// effective value of setting. To set a value use string_val.
EffectiveStringVal *StringMessage `json:"effective_string_val,omitempty"`
// Effective setting value for the workspace_dashboard_theme setting. This
// is the final effective value of the setting. To set a value, use
// workspace_dashboard_theme.
EffectiveWorkspaceDashboardTheme *DashboardTheme `json:"effective_workspace_dashboard_theme,omitempty"`
// Effective setting value for workspace_label setting. This is the final
// effective value of setting. To set a value use workspace_label.
EffectiveWorkspaceLabel *WorkspaceLabelMessage `json:"effective_workspace_label,omitempty"`
// Setting value for integer type setting. This is the setting value set by
// consumers, check effective_integer_val for final setting value.
IntegerVal *IntegerMessage `json:"integer_val,omitempty"`
// Name of the setting.
Name string `json:"name,omitempty"`
// 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.
OperationalEmailCustomRecipient *OperationalEmailCustomRecipientMessage `json:"operational_email_custom_recipient,omitempty"`
// Setting value for personal_compute setting. This is the setting value set
// by consumers, check effective_personal_compute for final setting value.
PersonalCompute *PersonalComputeMessage `json:"personal_compute,omitempty"`
// Setting value for restrict_workspace_admins setting. This is the setting
// value set by consumers, check effective_restrict_workspace_admins for
// final setting value.
RestrictWorkspaceAdmins *RestrictWorkspaceAdminsMessage `json:"restrict_workspace_admins,omitempty"`
// Setting value for string type setting. This is the setting value set by
// consumers, check effective_string_val for final setting value.
StringVal *StringMessage `json:"string_val,omitempty"`
// Setting value for the workspace_dashboard_theme setting. This is the
// setting value set by consumers. Check effective_workspace_dashboard_theme
// for the final setting value.
WorkspaceDashboardTheme *DashboardTheme `json:"workspace_dashboard_theme,omitempty"`
// Setting value for workspace_label setting. This is the setting value set
// by consumers, check effective_workspace_label for final setting value.
WorkspaceLabel *WorkspaceLabelMessage `json:"workspace_label,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (Setting) MarshalJSON ¶
func (*Setting) UnmarshalJSON ¶
type SettingsMetadata ¶
type SettingsMetadata struct {
// Setting description for what this setting controls
Description string `json:"description,omitempty"`
// Human-readable display name for the setting or feature preview. This
// field may be unset if no display name is available.
DisplayName string `json:"display_name,omitempty"`
// Link to databricks documentation for the setting
DocsLink string `json:"docs_link,omitempty"`
// Name of the setting.
Name string `json:"name,omitempty"`
// Preview phase for feature preview settings. This field is not set for
// non-preview settings.
PreviewPhase PreviewPhase `json:"preview_phase,omitempty"`
// Sample message depicting the type of the setting. To set this setting,
// the value sent must match this type.
Type string `json:"type,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (SettingsMetadata) MarshalJSON ¶
func (s SettingsMetadata) MarshalJSON() ([]byte, error)
func (*SettingsMetadata) UnmarshalJSON ¶
func (s *SettingsMetadata) UnmarshalJSON(b []byte) error
type StringMessage ¶
type StringMessage struct {
// Represents a generic string value.
Value string `json:"value,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (StringMessage) MarshalJSON ¶
func (s StringMessage) MarshalJSON() ([]byte, error)
func (*StringMessage) UnmarshalJSON ¶
func (s *StringMessage) UnmarshalJSON(b []byte) error
type UserPreference ¶ added in v0.98.0
type UserPreference struct {
BooleanVal *BooleanMessage `json:"boolean_val,omitempty"`
EffectiveBooleanVal *BooleanMessage `json:"effective_boolean_val,omitempty"`
EffectiveStringVal *StringMessage `json:"effective_string_val,omitempty"`
// Name of the setting.
Name string `json:"name,omitempty"`
StringVal *StringMessage `json:"string_val,omitempty"`
// User ID of the user.
UserId string `json:"user_id,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
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.
func (UserPreference) MarshalJSON ¶ added in v0.98.0
func (s UserPreference) MarshalJSON() ([]byte, error)
func (*UserPreference) UnmarshalJSON ¶ added in v0.98.0
func (s *UserPreference) UnmarshalJSON(b []byte) error
type WorkspaceLabelMessage ¶
type WorkspaceLabelMessage struct {
Color string `json:"color,omitempty"`
Label string `json:"label,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
Workspace label and color for display (e.g. in account console).
func (WorkspaceLabelMessage) MarshalJSON ¶
func (s WorkspaceLabelMessage) MarshalJSON() ([]byte, error)
func (*WorkspaceLabelMessage) UnmarshalJSON ¶
func (s *WorkspaceLabelMessage) UnmarshalJSON(b []byte) error
type WorkspaceSettingsV2API ¶
type WorkspaceSettingsV2API struct {
// contains filtered or unexported fields
}
APIs to manage workspace level settings
func NewWorkspaceSettingsV2 ¶
func NewWorkspaceSettingsV2(client *client.DatabricksClient) *WorkspaceSettingsV2API
func (*WorkspaceSettingsV2API) GetPublicWorkspaceSetting ¶
func (a *WorkspaceSettingsV2API) GetPublicWorkspaceSetting(ctx context.Context, request GetPublicWorkspaceSettingRequest) (*Setting, error)
func (*WorkspaceSettingsV2API) ListWorkspaceSettingsMetadata ¶
func (a *WorkspaceSettingsV2API) ListWorkspaceSettingsMetadata(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) listing.Iterator[SettingsMetadata]
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 (*WorkspaceSettingsV2API) ListWorkspaceSettingsMetadataAll ¶
func (a *WorkspaceSettingsV2API) ListWorkspaceSettingsMetadataAll(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) ([]SettingsMetadata, 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 (*WorkspaceSettingsV2API) PatchPublicWorkspaceSetting ¶
func (a *WorkspaceSettingsV2API) PatchPublicWorkspaceSetting(ctx context.Context, request PatchPublicWorkspaceSettingRequest) (*Setting, error)
type WorkspaceSettingsV2Interface ¶
type WorkspaceSettingsV2Interface interface {
// Get a setting value at workspace level. See
// :method:settingsv2/listworkspacesettingsmetadata for list of setting
// available via public APIs.
GetPublicWorkspaceSetting(ctx context.Context, request GetPublicWorkspaceSettingRequest) (*Setting, 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
//
// This method is generated by Databricks SDK Code Generator.
ListWorkspaceSettingsMetadata(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) listing.Iterator[SettingsMetadata]
// List valid setting keys and metadata. These settings are available to be
// referenced via GET :method:settingsv2/getpublicworkspacesetting and PATCH
// :method:settingsv2/patchpublicworkspacesetting APIs
//
// This method is generated by Databricks SDK Code Generator.
ListWorkspaceSettingsMetadataAll(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) ([]SettingsMetadata, 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.
PatchPublicWorkspaceSetting(ctx context.Context, request PatchPublicWorkspaceSettingRequest) (*Setting, error)
}
type WorkspaceSettingsV2Service
deprecated
type WorkspaceSettingsV2Service interface {
// Get a setting value at workspace level. See
// :method:settingsv2/listworkspacesettingsmetadata for list of setting
// available via public APIs.
GetPublicWorkspaceSetting(ctx context.Context, request GetPublicWorkspaceSettingRequest) (*Setting, 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
ListWorkspaceSettingsMetadata(ctx context.Context, request ListWorkspaceSettingsMetadataRequest) (*ListWorkspaceSettingsMetadataResponse, 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.
PatchPublicWorkspaceSetting(ctx context.Context, request PatchPublicWorkspaceSettingRequest) (*Setting, error)
}
APIs to manage workspace level settings
Deprecated: Do not use this interface, it will be removed in a future version of the SDK.