settingsv2

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

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)

	// 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)

	// 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.
	PatchPublicAccountSetting(ctx context.Context, request PatchPublicAccountSettingRequest) (*Setting, error)
}

type AibiDashboardEmbeddingAccessPolicy struct {
	AccessPolicyType AibiDashboardEmbeddingAccessPolicyAccessPolicyType `json:"access_policy_type"`
}

type AibiDashboardEmbeddingAccessPolicyAccessPolicyType string

type AibiDashboardEmbeddingApprovedDomains struct {
	ApprovedDomains []string `json:"approved_domains,omitempty"`
}

type BooleanMessage struct {
	Value bool `json:"value,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

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:"-"`
}

type ClusterAutoRestartMessageEnablementDetails struct {
	// The feature is force enabled if compliance mode is active
	ForcedForComplianceMode bool `json:"forced_for_compliance_mode,omitempty"`
	// The feature is unavailable if the corresponding entitlement disabled (see
	// getShieldEntitlementEnable)
	UnavailableForDisabledEntitlement bool `json:"unavailable_for_disabled_entitlement,omitempty"`
	// The feature is unavailable if the customer doesn't have enterprise tier
	UnavailableForNonEnterpriseTier bool `json:"unavailable_for_non_enterprise_tier,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ClusterAutoRestartMessageMaintenanceWindow struct {
	WeekDayBasedSchedule *ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule `json:"week_day_based_schedule,omitempty"`
}

type ClusterAutoRestartMessageMaintenanceWindowDayOfWeek string

type ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule struct {
	DayOfWeek ClusterAutoRestartMessageMaintenanceWindowDayOfWeek `json:"day_of_week,omitempty"`

	Frequency ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency `json:"frequency,omitempty"`

	WindowStartTime *ClusterAutoRestartMessageMaintenanceWindowWindowStartTime `json:"window_start_time,omitempty"`
}

type ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency string

type ClusterAutoRestartMessageMaintenanceWindowWindowStartTime struct {
	Hours int `json:"hours,omitempty"`

	Minutes int `json:"minutes,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type GetPublicAccountSettingRequest struct {
	Name string `json:"-" url:"-"`
}

type GetPublicWorkspaceSettingRequest struct {
	// Name of the setting
	Name string `json:"-" url:"-"`
}

type IntegerMessage struct {
	Value int `json:"value,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

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:"-"`
}

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:"-"`
}

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:"-"`
}

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:"-"`
}

type PatchPublicAccountSettingRequest struct {
	Name string `json:"-" url:"-"`

	Setting Setting `json:"setting"`
}

type PatchPublicWorkspaceSettingRequest struct {
	// Name of the setting
	Name string `json:"-" url:"-"`

	Setting Setting `json:"setting"`
}

type PersonalComputeMessage struct {
	Value PersonalComputeMessagePersonalComputeMessageEnum `json:"value,omitempty"`
}

type PersonalComputeMessagePersonalComputeMessageEnum string

type RestrictWorkspaceAdminsMessage struct {
	Status RestrictWorkspaceAdminsMessageStatus `json:"status"`
}

type RestrictWorkspaceAdminsMessageStatus string

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 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"`
	// 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 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 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 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"`
	// 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 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"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SettingsMetadata struct {
	// Setting description for what this setting controls
	Description string `json:"description,omitempty"`
	// Link to databricks documentation for the setting
	DocsLink string `json:"docs_link,omitempty"`
	// Name of the setting.
	Name string `json:"name,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:"-"`
}

type StringMessage struct {
	// Represents a generic string value.
	Value string `json:"value,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

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

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.
	PatchPublicWorkspaceSetting(ctx context.Context, request PatchPublicWorkspaceSettingRequest) (*Setting, error)
}