settings

package
v0.76.0 Latest Latest
Warning

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

 Go to latest Published: Jul 17, 2025 License: Apache-2.0 Imports: 7 Imported by: 41

Documentation

Overview

These APIs allow you to manage Account Ip Access Lists, Account Settings, Aibi Dashboard Embedding Access Policy, Aibi Dashboard Embedding Approved Domains, Automatic Cluster Update, Compliance Security Profile, Credentials Manager, Csp Enablement Account, Dashboard Email Subscriptions, Default Namespace, Default Warehouse Id, Disable Legacy Access, Disable Legacy Dbfs, Disable Legacy Features, Enable Export Notebook, Enable Ip Access Lists, Enable Notebook Table Clipboard, Enable Results Downloading, Enhanced Security Monitoring, Esm Enablement Account, Ip Access Lists, Llm Proxy Partner Powered Account, Llm Proxy Partner Powered Enforce, Llm Proxy Partner Powered Workspace, Network Connectivity, Network Policies, Notification Destinations, Personal Compute, Restrict Workspace Admins, Settings, Sql Results Download, Token Management, Tokens, Workspace Conf, Workspace Network Configuration, etc.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountIpAccessEnable added in v0.57.0 

type AccountIpAccessEnable struct {
	AcctIpAclEnable BooleanMessage `json:"acct_ip_acl_enable"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (AccountIpAccessEnable) MarshalJSON added in v0.57.0 

func (s AccountIpAccessEnable) MarshalJSON() ([]byte, error)

func (*AccountIpAccessEnable) UnmarshalJSON added in v0.57.0 

func (s *AccountIpAccessEnable) UnmarshalJSON(b []byte) error

type AccountIpAccessListsAPI 

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

The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.

Account IP Access Lists affect web application access and REST API access to the account console and account APIs. If the feature is disabled for the account, all access is allowed for this account. There is support for allow lists (inclusion) and block lists (exclusion).

When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists.

If there is at least one allow list for the account, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the account, all IP addresses are allowed.

For all allow lists and block lists combined, the account supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.

After changes to the account-level IP access lists, it can take a few minutes for changes to take effect.

func NewAccountIpAccessLists 

func NewAccountIpAccessLists(client *client.DatabricksClient) *AccountIpAccessListsAPI

func (*AccountIpAccessListsAPI) Create 

func (a *AccountIpAccessListsAPI) Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error)

func (*AccountIpAccessListsAPI) Delete 

func (a *AccountIpAccessListsAPI) Delete(ctx context.Context, request DeleteAccountIpAccessListRequest) error

func (*AccountIpAccessListsAPI) DeleteByIpAccessListId 

func (a *AccountIpAccessListsAPI) DeleteByIpAccessListId(ctx context.Context, ipAccessListId string) error

Deletes an IP access list, specified by its list ID.

func (*AccountIpAccessListsAPI) Get 

func (a *AccountIpAccessListsAPI) Get(ctx context.Context, request GetAccountIpAccessListRequest) (*GetIpAccessListResponse, error)

func (*AccountIpAccessListsAPI) GetByIpAccessListId 

func (a *AccountIpAccessListsAPI) GetByIpAccessListId(ctx context.Context, ipAccessListId string) (*GetIpAccessListResponse, error)

Gets an IP access list, specified by its list ID.

func (*AccountIpAccessListsAPI) GetByLabel 

func (a *AccountIpAccessListsAPI) GetByLabel(ctx context.Context, name string) (*IpAccessListInfo, error)

GetByLabel calls AccountIpAccessListsAPI.IpAccessListInfoLabelToListIdMap and returns a single IpAccessListInfo.

Returns an error if there's more than one IpAccessListInfo with the same .Label.

Note: All IpAccessListInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*AccountIpAccessListsAPI) IpAccessListInfoLabelToListIdMap 

func (a *AccountIpAccessListsAPI) IpAccessListInfoLabelToListIdMap(ctx context.Context) (map[string]string, error)

IpAccessListInfoLabelToListIdMap calls AccountIpAccessListsAPI.ListAll and creates a map of results with IpAccessListInfo.Label as key and IpAccessListInfo.ListId as value.

Returns an error if there's more than one IpAccessListInfo with the same .Label.

Note: All IpAccessListInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*AccountIpAccessListsAPI) List added in v0.24.0 

func (a *AccountIpAccessListsAPI) List(ctx context.Context) listing.Iterator[IpAccessListInfo]

Gets all IP access lists for the specified account.

func (*AccountIpAccessListsAPI) ListAll 

func (a *AccountIpAccessListsAPI) ListAll(ctx context.Context) ([]IpAccessListInfo, error)

Gets all IP access lists for the specified account.

func (*AccountIpAccessListsAPI) Replace 

func (a *AccountIpAccessListsAPI) Replace(ctx context.Context, request ReplaceIpAccessList) error

func (*AccountIpAccessListsAPI) Update 

func (a *AccountIpAccessListsAPI) Update(ctx context.Context, request UpdateIpAccessList) error

type AccountIpAccessListsInterface added in v0.29.0 

type AccountIpAccessListsInterface interface {

	// Creates an IP access list for the account.
	//
	// A list can be an allow list or a block list. See the top of this file for a
	// description of how the server treats allow lists and block lists at runtime.
	//
	// When creating or updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a maximum of
	// 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to
	// exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
	// * If the new list would block the calling user's current IP, error 400 is
	// returned with `error_code` value `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect.
	Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error)

	// Deletes an IP access list, specified by its list ID.
	Delete(ctx context.Context, request DeleteAccountIpAccessListRequest) error

	// Deletes an IP access list, specified by its list ID.
	DeleteByIpAccessListId(ctx context.Context, ipAccessListId string) error

	// Gets an IP access list, specified by its list ID.
	Get(ctx context.Context, request GetAccountIpAccessListRequest) (*GetIpAccessListResponse, error)

	// Gets an IP access list, specified by its list ID.
	GetByIpAccessListId(ctx context.Context, ipAccessListId string) (*GetIpAccessListResponse, error)

	// Gets all IP access lists for the specified account.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context) listing.Iterator[IpAccessListInfo]

	// Gets all IP access lists for the specified account.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context) ([]IpAccessListInfo, error)

	// IpAccessListInfoLabelToListIdMap calls [AccountIpAccessListsAPI.ListAll] and creates a map of results with [IpAccessListInfo].Label as key and [IpAccessListInfo].ListId as value.
	//
	// Returns an error if there's more than one [IpAccessListInfo] with the same .Label.
	//
	// Note: All [IpAccessListInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	IpAccessListInfoLabelToListIdMap(ctx context.Context) (map[string]string, error)

	// GetByLabel calls [AccountIpAccessListsAPI.IpAccessListInfoLabelToListIdMap] and returns a single [IpAccessListInfo].
	//
	// Returns an error if there's more than one [IpAccessListInfo] with the same .Label.
	//
	// Note: All [IpAccessListInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByLabel(ctx context.Context, name string) (*IpAccessListInfo, error)

	// Replaces an IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file for
	// a description of how the server treats allow lists and block lists at run
	// time. When replacing an IP access list: * For all allow lists and block lists
	// combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR
	// counts as a single value. Attempts to exceed that number return error 400
	// with `error_code` value `QUOTA_EXCEEDED`. * If the resulting list would block
	// the calling user's current IP, error 400 is returned with `error_code` value
	// `INVALID_STATE`. It can take a few minutes for the changes to take effect.
	Replace(ctx context.Context, request ReplaceIpAccessList) error

	// Updates an existing IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file for
	// a description of how the server treats allow lists and block lists at run
	// time.
	//
	// When updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a maximum of
	// 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to
	// exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
	// * If the updated list would block the calling user's current IP, error 400 is
	// returned with `error_code` value `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect.
	Update(ctx context.Context, request UpdateIpAccessList) error
}

type AccountIpAccessListsService deprecated 

type AccountIpAccessListsService interface {

	// Creates an IP access list for the account.
	//
	// A list can be an allow list or a block list. See the top of this file for
	// a description of how the server treats allow lists and block lists at
	// runtime.
	//
	// When creating or updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a
	// maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.
	// Attempts to exceed that number return error 400 with `error_code` value
	// `QUOTA_EXCEEDED`. * If the new list would block the calling user's
	// current IP, error 400 is returned with `error_code` value
	// `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect.
	Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error)

	// Deletes an IP access list, specified by its list ID.
	Delete(ctx context.Context, request DeleteAccountIpAccessListRequest) error

	// Gets an IP access list, specified by its list ID.
	Get(ctx context.Context, request GetAccountIpAccessListRequest) (*GetIpAccessListResponse, error)

	// Gets all IP access lists for the specified account.
	List(ctx context.Context) (*GetIpAccessListsResponse, error)

	// Replaces an IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file
	// for a description of how the server treats allow lists and block lists at
	// run time. When replacing an IP access list: * For all allow lists and
	// block lists combined, the API supports a maximum of 1000 IP/CIDR values,
	// where one CIDR counts as a single value. Attempts to exceed that number
	// return error 400 with `error_code` value `QUOTA_EXCEEDED`. * If the
	// resulting list would block the calling user's current IP, error 400 is
	// returned with `error_code` value `INVALID_STATE`. It can take a few
	// minutes for the changes to take effect.
	Replace(ctx context.Context, request ReplaceIpAccessList) error

	// Updates an existing IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file
	// for a description of how the server treats allow lists and block lists at
	// run time.
	//
	// When updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a
	// maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.
	// Attempts to exceed that number return error 400 with `error_code` value
	// `QUOTA_EXCEEDED`. * If the updated list would block the calling user's
	// current IP, error 400 is returned with `error_code` value
	// `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect.
	Update(ctx context.Context, request UpdateIpAccessList) error
}

The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.

Account IP Access Lists affect web application access and REST API access to the account console and account APIs. If the feature is disabled for the account, all access is allowed for this account. There is support for allow lists (inclusion) and block lists (exclusion).

When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists.

If there is at least one allow list for the account, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the account, all IP addresses are allowed.

For all allow lists and block lists combined, the account supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.

After changes to the account-level IP access lists, it can take a few minutes for changes to take effect.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type AccountNetworkPolicy added in v0.70.0 

type AccountNetworkPolicy struct {
	// The associated account ID for this Network Policy object.
	AccountId string `json:"account_id,omitempty"`
	// The network policies applying for egress traffic.
	Egress *NetworkPolicyEgress `json:"egress,omitempty"`
	// The unique identifier for the network policy.
	NetworkPolicyId string `json:"network_policy_id,omitempty"`

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

func (AccountNetworkPolicy) MarshalJSON added in v0.70.0 

func (s AccountNetworkPolicy) MarshalJSON() ([]byte, error)

func (*AccountNetworkPolicy) UnmarshalJSON added in v0.70.0 

func (s *AccountNetworkPolicy) UnmarshalJSON(b []byte) error

type AccountSettingsAPI added in v0.10.0 

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

Accounts Settings API allows users to manage settings at the account level.

func NewAccountSettings added in v0.10.0 

func NewAccountSettings(client *client.DatabricksClient) *AccountSettingsAPI

func (*AccountSettingsAPI) CspEnablementAccount added in v0.34.0 

func (a *AccountSettingsAPI) CspEnablementAccount() CspEnablementAccountInterface

func (*AccountSettingsAPI) DisableLegacyFeatures added in v0.47.0 

func (a *AccountSettingsAPI) DisableLegacyFeatures() DisableLegacyFeaturesInterface

func (*AccountSettingsAPI) EnableIpAccessLists added in v0.57.0 

func (a *AccountSettingsAPI) EnableIpAccessLists() EnableIpAccessListsInterface

func (*AccountSettingsAPI) EsmEnablementAccount added in v0.34.0 

func (a *AccountSettingsAPI) EsmEnablementAccount() EsmEnablementAccountInterface

func (*AccountSettingsAPI) LlmProxyPartnerPoweredAccount added in v0.69.0 

func (a *AccountSettingsAPI) LlmProxyPartnerPoweredAccount() LlmProxyPartnerPoweredAccountInterface

func (*AccountSettingsAPI) LlmProxyPartnerPoweredEnforce added in v0.69.0 

func (a *AccountSettingsAPI) LlmProxyPartnerPoweredEnforce() LlmProxyPartnerPoweredEnforceInterface

func (*AccountSettingsAPI) PersonalCompute added in v0.34.0 

func (a *AccountSettingsAPI) PersonalCompute() PersonalComputeInterface

type AccountSettingsInterface added in v0.29.0 

type AccountSettingsInterface interface {

	// The compliance security profile settings at the account level control
	// whether to enable it for new workspaces. By default, this account-level
	// setting is disabled for new workspaces. After workspace creation, account
	// admins can enable the compliance security profile individually for each
	// workspace.
	//
	// This settings can be disabled so that new workspaces do not have
	// compliance security profile enabled by default.
	CspEnablementAccount() CspEnablementAccountInterface

	// Disable legacy features for new Databricks workspaces.
	//
	// For newly created workspaces: 1. Disables the use of DBFS root and
	// mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of
	// ‘No-isolation clusters’. 4. Disables Databricks Runtime versions
	// prior to 13.3LTS.
	DisableLegacyFeatures() DisableLegacyFeaturesInterface

	// Controls the enforcement of IP access lists for accessing the account
	// console. Allowing you to enable or disable restricted access based on IP
	// addresses.
	EnableIpAccessLists() EnableIpAccessListsInterface

	// The enhanced security monitoring setting at the account level controls
	// whether to enable the feature on new workspaces. By default, this
	// account-level setting is disabled for new workspaces. After workspace
	// creation, account admins can enable enhanced security monitoring
	// individually for each workspace.
	EsmEnablementAccount() EsmEnablementAccountInterface

	// Determines if partner powered models are enabled or not for a specific
	// account
	LlmProxyPartnerPoweredAccount() LlmProxyPartnerPoweredAccountInterface

	// Determines if the account-level partner-powered setting value is enforced
	// upon the workspace-level partner-powered setting
	LlmProxyPartnerPoweredEnforce() LlmProxyPartnerPoweredEnforceInterface

	// The Personal Compute enablement setting lets you control which users can
	// use the Personal Compute default policy to create compute resources. By
	// default all users in all workspaces have access (ON), but you can change
	// the setting to instead let individual workspaces configure access control
	// (DELEGATE).
	//
	// There is only one instance of this setting per account. Since this
	// setting has a default value, this setting is present on all accounts even
	// though it's never set on a given account. Deletion reverts the value of
	// the setting back to the default value.
	PersonalCompute() PersonalComputeInterface
}

type AccountSettingsService deprecated added in v0.10.0 

type AccountSettingsService interface {
}

Accounts Settings API allows users to manage settings at the account level.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type AibiDashboardEmbeddingAccessPolicy added in v0.50.0 

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

type AibiDashboardEmbeddingAccessPolicyAPI added in v0.50.0 

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

Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level. By default, this setting is conditionally enabled (ALLOW_APPROVED_DOMAINS).

func NewAibiDashboardEmbeddingAccessPolicy added in v0.50.0 

func NewAibiDashboardEmbeddingAccessPolicy(client *client.DatabricksClient) *AibiDashboardEmbeddingAccessPolicyAPI

func (*AibiDashboardEmbeddingAccessPolicyAPI) Delete added in v0.53.0 

func (a *AibiDashboardEmbeddingAccessPolicyAPI) Delete(ctx context.Context, request DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) (*DeleteAibiDashboardEmbeddingAccessPolicySettingResponse, error)

func (*AibiDashboardEmbeddingAccessPolicyAPI) Get added in v0.50.0 

func (a *AibiDashboardEmbeddingAccessPolicyAPI) Get(ctx context.Context, request GetAibiDashboardEmbeddingAccessPolicySettingRequest) (*AibiDashboardEmbeddingAccessPolicySetting, error)

func (*AibiDashboardEmbeddingAccessPolicyAPI) Update added in v0.50.0 

func (a *AibiDashboardEmbeddingAccessPolicyAPI) Update(ctx context.Context, request UpdateAibiDashboardEmbeddingAccessPolicySettingRequest) (*AibiDashboardEmbeddingAccessPolicySetting, error)

type AibiDashboardEmbeddingAccessPolicyAccessPolicyType added in v0.50.0 

type AibiDashboardEmbeddingAccessPolicyAccessPolicyType string
const AibiDashboardEmbeddingAccessPolicyAccessPolicyTypeAllowAllDomains AibiDashboardEmbeddingAccessPolicyAccessPolicyType = `ALLOW_ALL_DOMAINS`
const AibiDashboardEmbeddingAccessPolicyAccessPolicyTypeAllowApprovedDomains AibiDashboardEmbeddingAccessPolicyAccessPolicyType = `ALLOW_APPROVED_DOMAINS`
const AibiDashboardEmbeddingAccessPolicyAccessPolicyTypeDenyAllDomains AibiDashboardEmbeddingAccessPolicyAccessPolicyType = `DENY_ALL_DOMAINS`

func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Set added in v0.50.0 

func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Set(v string) error

Set raw string value and validate it against allowed values

func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) String added in v0.50.0 

func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) String() string

String representation for fmt.Print

func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Type added in v0.50.0 

func (f *AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Type() string

Type always returns AibiDashboardEmbeddingAccessPolicyAccessPolicyType to satisfy [pflag.Value] interface

func (*AibiDashboardEmbeddingAccessPolicyAccessPolicyType) Values added in v0.72.0 

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 AibiDashboardEmbeddingAccessPolicyInterface added in v0.50.0 

type AibiDashboardEmbeddingAccessPolicyInterface interface {

	// Delete the AI/BI dashboard embedding access policy, reverting back to the
	// default.
	Delete(ctx context.Context, request DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) (*DeleteAibiDashboardEmbeddingAccessPolicySettingResponse, error)

	// Retrieves the AI/BI dashboard embedding access policy. The default setting is
	// ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on
	// approved domains.
	Get(ctx context.Context, request GetAibiDashboardEmbeddingAccessPolicySettingRequest) (*AibiDashboardEmbeddingAccessPolicySetting, error)

	// Updates the AI/BI dashboard embedding access policy at the workspace level.
	Update(ctx context.Context, request UpdateAibiDashboardEmbeddingAccessPolicySettingRequest) (*AibiDashboardEmbeddingAccessPolicySetting, error)
}

type AibiDashboardEmbeddingAccessPolicyService deprecated added in v0.50.0 

type AibiDashboardEmbeddingAccessPolicyService interface {

	// Delete the AI/BI dashboard embedding access policy, reverting back to the
	// default.
	Delete(ctx context.Context, request DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) (*DeleteAibiDashboardEmbeddingAccessPolicySettingResponse, error)

	// Retrieves the AI/BI dashboard embedding access policy. The default
	// setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be
	// embedded on approved domains.
	Get(ctx context.Context, request GetAibiDashboardEmbeddingAccessPolicySettingRequest) (*AibiDashboardEmbeddingAccessPolicySetting, error)

	// Updates the AI/BI dashboard embedding access policy at the workspace
	// level.
	Update(ctx context.Context, request UpdateAibiDashboardEmbeddingAccessPolicySettingRequest) (*AibiDashboardEmbeddingAccessPolicySetting, error)
}

Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level. By default, this setting is conditionally enabled (ALLOW_APPROVED_DOMAINS).

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type AibiDashboardEmbeddingAccessPolicySetting added in v0.50.0 

type AibiDashboardEmbeddingAccessPolicySetting struct {
	AibiDashboardEmbeddingAccessPolicy AibiDashboardEmbeddingAccessPolicy `json:"aibi_dashboard_embedding_access_policy"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (AibiDashboardEmbeddingAccessPolicySetting) MarshalJSON added in v0.50.0 

func (s AibiDashboardEmbeddingAccessPolicySetting) MarshalJSON() ([]byte, error)

func (*AibiDashboardEmbeddingAccessPolicySetting) UnmarshalJSON added in v0.50.0 

func (s *AibiDashboardEmbeddingAccessPolicySetting) UnmarshalJSON(b []byte) error

type AibiDashboardEmbeddingApprovedDomains added in v0.50.0 

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

type AibiDashboardEmbeddingApprovedDomainsAPI added in v0.50.0 

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

Controls the list of domains approved to host the embedded AI/BI dashboards. The approved domains list can't be mutated when the current access policy is not set to ALLOW_APPROVED_DOMAINS.

func NewAibiDashboardEmbeddingApprovedDomains added in v0.50.0 

func NewAibiDashboardEmbeddingApprovedDomains(client *client.DatabricksClient) *AibiDashboardEmbeddingApprovedDomainsAPI

func (*AibiDashboardEmbeddingApprovedDomainsAPI) Delete added in v0.53.0 

func (a *AibiDashboardEmbeddingApprovedDomainsAPI) Delete(ctx context.Context, request DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse, error)

func (*AibiDashboardEmbeddingApprovedDomainsAPI) Get added in v0.50.0 

func (a *AibiDashboardEmbeddingApprovedDomainsAPI) Get(ctx context.Context, request GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)

func (*AibiDashboardEmbeddingApprovedDomainsAPI) Update added in v0.50.0 

func (a *AibiDashboardEmbeddingApprovedDomainsAPI) Update(ctx context.Context, request UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)

type AibiDashboardEmbeddingApprovedDomainsInterface added in v0.50.0 

type AibiDashboardEmbeddingApprovedDomainsInterface interface {

	// Delete the list of domains approved to host embedded AI/BI dashboards,
	// reverting back to the default empty list.
	Delete(ctx context.Context, request DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse, error)

	// Retrieves the list of domains approved to host embedded AI/BI dashboards.
	Get(ctx context.Context, request GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)

	// Updates the list of domains approved to host embedded AI/BI dashboards. This
	// update will fail if the current workspace access policy is not
	// ALLOW_APPROVED_DOMAINS.
	Update(ctx context.Context, request UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)
}

type AibiDashboardEmbeddingApprovedDomainsService deprecated added in v0.50.0 

type AibiDashboardEmbeddingApprovedDomainsService interface {

	// Delete the list of domains approved to host embedded AI/BI dashboards,
	// reverting back to the default empty list.
	Delete(ctx context.Context, request DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse, error)

	// Retrieves the list of domains approved to host embedded AI/BI dashboards.
	Get(ctx context.Context, request GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)

	// Updates the list of domains approved to host embedded AI/BI dashboards.
	// This update will fail if the current workspace access policy is not
	// ALLOW_APPROVED_DOMAINS.
	Update(ctx context.Context, request UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest) (*AibiDashboardEmbeddingApprovedDomainsSetting, error)
}

Controls the list of domains approved to host the embedded AI/BI dashboards. The approved domains list can't be mutated when the current access policy is not set to ALLOW_APPROVED_DOMAINS.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type AibiDashboardEmbeddingApprovedDomainsSetting added in v0.50.0 

type AibiDashboardEmbeddingApprovedDomainsSetting struct {
	AibiDashboardEmbeddingApprovedDomains AibiDashboardEmbeddingApprovedDomains `json:"aibi_dashboard_embedding_approved_domains"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (AibiDashboardEmbeddingApprovedDomainsSetting) MarshalJSON added in v0.50.0 

func (s AibiDashboardEmbeddingApprovedDomainsSetting) MarshalJSON() ([]byte, error)

func (*AibiDashboardEmbeddingApprovedDomainsSetting) UnmarshalJSON added in v0.50.0 

func (s *AibiDashboardEmbeddingApprovedDomainsSetting) UnmarshalJSON(b []byte) error

type AutomaticClusterUpdateAPI added in v0.34.0 

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

Controls whether automatic cluster update is enabled for the current workspace. By default, it is turned off.

func NewAutomaticClusterUpdate added in v0.34.0 

func NewAutomaticClusterUpdate(client *client.DatabricksClient) *AutomaticClusterUpdateAPI

func (*AutomaticClusterUpdateAPI) Get added in v0.34.0 

func (a *AutomaticClusterUpdateAPI) Get(ctx context.Context, request GetAutomaticClusterUpdateSettingRequest) (*AutomaticClusterUpdateSetting, error)

func (*AutomaticClusterUpdateAPI) Update added in v0.34.0 

func (a *AutomaticClusterUpdateAPI) Update(ctx context.Context, request UpdateAutomaticClusterUpdateSettingRequest) (*AutomaticClusterUpdateSetting, error)

type AutomaticClusterUpdateInterface added in v0.34.0 

type AutomaticClusterUpdateInterface interface {

	// Gets the automatic cluster update setting.
	Get(ctx context.Context, request GetAutomaticClusterUpdateSettingRequest) (*AutomaticClusterUpdateSetting, error)

	// Updates the automatic cluster update setting for the workspace. A fresh etag
	// needs to be provided in `PATCH` requests (as part of the setting field). The
	// etag can be retrieved by making a `GET` request before the `PATCH` request.
	// If the setting is updated concurrently, `PATCH` fails with 409 and the
	// request must be retried by using the fresh etag in the 409 response.
	Update(ctx context.Context, request UpdateAutomaticClusterUpdateSettingRequest) (*AutomaticClusterUpdateSetting, error)
}

type AutomaticClusterUpdateService deprecated added in v0.34.0 

type AutomaticClusterUpdateService interface {

	// Gets the automatic cluster update setting.
	Get(ctx context.Context, request GetAutomaticClusterUpdateSettingRequest) (*AutomaticClusterUpdateSetting, error)

	// Updates the automatic cluster update setting for the workspace. A fresh
	// etag needs to be provided in `PATCH` requests (as part of the setting
	// field). The etag can be retrieved by making a `GET` request before the
	// `PATCH` request. If the setting is updated concurrently, `PATCH` fails
	// with 409 and the request must be retried by using the fresh etag in the
	// 409 response.
	Update(ctx context.Context, request UpdateAutomaticClusterUpdateSettingRequest) (*AutomaticClusterUpdateSetting, error)
}

Controls whether automatic cluster update is enabled for the current workspace. By default, it is turned off.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type AutomaticClusterUpdateSetting added in v0.34.0 

type AutomaticClusterUpdateSetting struct {
	AutomaticClusterUpdateWorkspace ClusterAutoRestartMessage `json:"automatic_cluster_update_workspace"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (AutomaticClusterUpdateSetting) MarshalJSON added in v0.34.0 

func (s AutomaticClusterUpdateSetting) MarshalJSON() ([]byte, error)

func (*AutomaticClusterUpdateSetting) UnmarshalJSON added in v0.34.0 

func (s *AutomaticClusterUpdateSetting) UnmarshalJSON(b []byte) error

type BooleanMessage added in v0.47.0 

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

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

func (BooleanMessage) MarshalJSON added in v0.47.0 

func (s BooleanMessage) MarshalJSON() ([]byte, error)

func (*BooleanMessage) UnmarshalJSON added in v0.47.0 

func (s *BooleanMessage) UnmarshalJSON(b []byte) error

type ClusterAutoRestartMessage added in v0.34.0 

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 added in v0.34.0 

func (s ClusterAutoRestartMessage) MarshalJSON() ([]byte, error)

func (*ClusterAutoRestartMessage) UnmarshalJSON added in v0.34.0 

func (s *ClusterAutoRestartMessage) UnmarshalJSON(b []byte) error

type ClusterAutoRestartMessageEnablementDetails added in v0.34.0 

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

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 added in v0.34.0 

func (s ClusterAutoRestartMessageEnablementDetails) MarshalJSON() ([]byte, error)

func (*ClusterAutoRestartMessageEnablementDetails) UnmarshalJSON added in v0.34.0 

func (s *ClusterAutoRestartMessageEnablementDetails) UnmarshalJSON(b []byte) error

type ClusterAutoRestartMessageMaintenanceWindow added in v0.34.0 

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

type ClusterAutoRestartMessageMaintenanceWindowDayOfWeek added in v0.34.0 

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 added in v0.34.0 

func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Set(v string) error

Set raw string value and validate it against allowed values

func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) String added in v0.34.0 

func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) String() string

String representation for fmt.Print

func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Type added in v0.34.0 

func (f *ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Type() string

Type always returns ClusterAutoRestartMessageMaintenanceWindowDayOfWeek to satisfy [pflag.Value] interface

func (*ClusterAutoRestartMessageMaintenanceWindowDayOfWeek) Values added in v0.72.0 

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 added in v0.34.0 

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

	Frequency ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency `json:"frequency,omitempty"`

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

type ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency added in v0.34.0 

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 added in v0.34.0 

func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Set(v string) error

Set raw string value and validate it against allowed values

func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) String added in v0.34.0 

func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) String() string

String representation for fmt.Print

func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Type added in v0.34.0 

func (f *ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Type() string

Type always returns ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency to satisfy [pflag.Value] interface

func (*ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency) Values added in v0.72.0 

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 added in v0.34.0 

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

	Minutes int `json:"minutes,omitempty"`

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

func (ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) MarshalJSON added in v0.34.0 

func (s ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) MarshalJSON() ([]byte, error)

func (*ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) UnmarshalJSON added in v0.34.0 

func (s *ClusterAutoRestartMessageMaintenanceWindowWindowStartTime) UnmarshalJSON(b []byte) error

type ComplianceSecurityProfile added in v0.40.0 

type ComplianceSecurityProfile struct {
	// Set by customers when they request Compliance Security Profile (CSP)
	ComplianceStandards []ComplianceStandard `json:"compliance_standards,omitempty"`

	IsEnabled bool `json:"is_enabled,omitempty"`

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

SHIELD feature: CSP

func (ComplianceSecurityProfile) MarshalJSON added in v0.40.0 

func (s ComplianceSecurityProfile) MarshalJSON() ([]byte, error)

func (*ComplianceSecurityProfile) UnmarshalJSON added in v0.40.0 

func (s *ComplianceSecurityProfile) UnmarshalJSON(b []byte) error

type ComplianceSecurityProfileAPI added in v0.40.0 

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

Controls whether to enable the compliance security profile for the current workspace. Enabling it on a workspace is permanent. By default, it is turned off.

This settings can NOT be disabled once it is enabled.

func NewComplianceSecurityProfile added in v0.40.0 

func NewComplianceSecurityProfile(client *client.DatabricksClient) *ComplianceSecurityProfileAPI

func (*ComplianceSecurityProfileAPI) Get added in v0.40.0 

func (a *ComplianceSecurityProfileAPI) Get(ctx context.Context, request GetComplianceSecurityProfileSettingRequest) (*ComplianceSecurityProfileSetting, error)

func (*ComplianceSecurityProfileAPI) Update added in v0.40.0 

func (a *ComplianceSecurityProfileAPI) Update(ctx context.Context, request UpdateComplianceSecurityProfileSettingRequest) (*ComplianceSecurityProfileSetting, error)

type ComplianceSecurityProfileInterface added in v0.40.0 

type ComplianceSecurityProfileInterface interface {

	// Gets the compliance security profile setting.
	Get(ctx context.Context, request GetComplianceSecurityProfileSettingRequest) (*ComplianceSecurityProfileSetting, error)

	// Updates the compliance security profile setting for the workspace. A fresh
	// etag needs to be provided in `PATCH` requests (as part of the setting field).
	// The etag can be retrieved by making a `GET` request before the `PATCH`
	// request. If the setting is updated concurrently, `PATCH` fails with 409 and
	// the request must be retried by using the fresh etag in the 409 response.
	Update(ctx context.Context, request UpdateComplianceSecurityProfileSettingRequest) (*ComplianceSecurityProfileSetting, error)
}

type ComplianceSecurityProfileService deprecated added in v0.40.0 

type ComplianceSecurityProfileService interface {

	// Gets the compliance security profile setting.
	Get(ctx context.Context, request GetComplianceSecurityProfileSettingRequest) (*ComplianceSecurityProfileSetting, error)

	// Updates the compliance security profile setting for the workspace. A
	// fresh etag needs to be provided in `PATCH` requests (as part of the
	// setting field). The etag can be retrieved by making a `GET` request
	// before the `PATCH` request. If the setting is updated concurrently,
	// `PATCH` fails with 409 and the request must be retried by using the fresh
	// etag in the 409 response.
	Update(ctx context.Context, request UpdateComplianceSecurityProfileSettingRequest) (*ComplianceSecurityProfileSetting, error)
}

Controls whether to enable the compliance security profile for the current workspace. Enabling it on a workspace is permanent. By default, it is turned off.

This settings can NOT be disabled once it is enabled.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type ComplianceSecurityProfileSetting added in v0.40.0 

type ComplianceSecurityProfileSetting struct {
	ComplianceSecurityProfileWorkspace ComplianceSecurityProfile `json:"compliance_security_profile_workspace"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (ComplianceSecurityProfileSetting) MarshalJSON added in v0.40.0 

func (s ComplianceSecurityProfileSetting) MarshalJSON() ([]byte, error)

func (*ComplianceSecurityProfileSetting) UnmarshalJSON added in v0.40.0 

func (s *ComplianceSecurityProfileSetting) UnmarshalJSON(b []byte) error

type ComplianceStandard added in v0.34.0 

type ComplianceStandard string

Compliance stardard for SHIELD customers 

const ComplianceStandardCanadaProtectedB ComplianceStandard = `CANADA_PROTECTED_B`
const ComplianceStandardCyberEssentialPlus ComplianceStandard = `CYBER_ESSENTIAL_PLUS`
const ComplianceStandardFedrampHigh ComplianceStandard = `FEDRAMP_HIGH`
const ComplianceStandardFedrampIl5 ComplianceStandard = `FEDRAMP_IL5`
const ComplianceStandardFedrampModerate ComplianceStandard = `FEDRAMP_MODERATE`
const ComplianceStandardHipaa ComplianceStandard = `HIPAA`
const ComplianceStandardHitrust ComplianceStandard = `HITRUST`
const ComplianceStandardIrapProtected ComplianceStandard = `IRAP_PROTECTED`
const ComplianceStandardIsmap ComplianceStandard = `ISMAP`
const ComplianceStandardItarEar ComplianceStandard = `ITAR_EAR`
const ComplianceStandardKFsi ComplianceStandard = `K_FSI`
const ComplianceStandardNone ComplianceStandard = `NONE`
const ComplianceStandardPciDss ComplianceStandard = `PCI_DSS`

func (*ComplianceStandard) Set added in v0.34.0 

func (f *ComplianceStandard) Set(v string) error

Set raw string value and validate it against allowed values

func (*ComplianceStandard) String added in v0.34.0 

func (f *ComplianceStandard) String() string

String representation for fmt.Print

func (*ComplianceStandard) Type added in v0.34.0 

func (f *ComplianceStandard) Type() string

Type always returns ComplianceStandard to satisfy [pflag.Value] interface

func (*ComplianceStandard) Values added in v0.72.0 

func (f *ComplianceStandard) Values() []ComplianceStandard

Values returns all possible values for ComplianceStandard.

There is no guarantee on the order of the values in the slice.

type Config added in v0.44.0 

type Config struct {
	Email *EmailConfig `json:"email,omitempty"`

	GenericWebhook *GenericWebhookConfig `json:"generic_webhook,omitempty"`

	MicrosoftTeams *MicrosoftTeamsConfig `json:"microsoft_teams,omitempty"`

	Pagerduty *PagerdutyConfig `json:"pagerduty,omitempty"`

	Slack *SlackConfig `json:"slack,omitempty"`
}

type CreateIpAccessList 

type CreateIpAccessList struct {
	IpAddresses []string `json:"ip_addresses,omitempty"`
	// Label for the IP access list. This **cannot** be empty.
	Label string `json:"label"`

	ListType ListType `json:"list_type"`
}

Details required to configure a block list or allow list.

type CreateIpAccessListResponse 

type CreateIpAccessListResponse struct {
	IpAccessList *IpAccessListInfo `json:"ip_access_list,omitempty"`
}

An IP access list was successfully created.

type CreateNetworkConnectivityConfigRequest added in v0.25.0 

type CreateNetworkConnectivityConfigRequest struct {
	NetworkConnectivityConfig CreateNetworkConnectivityConfiguration `json:"network_connectivity_config"`
}

type CreateNetworkConnectivityConfiguration added in v0.66.0 

type CreateNetworkConnectivityConfiguration struct {
	// The name of the network connectivity configuration. The name can contain
	// alphanumeric characters, hyphens, and underscores. The length must be
	// between 3 and 30 characters. The name must match the regular expression
	// ^[0-9a-zA-Z-_]{3,30}$
	Name string `json:"name"`
	// The region for the network connectivity configuration. Only workspaces in
	// the same region can be attached to the network connectivity
	// configuration.
	Region string `json:"region"`
}

Properties of the new network connectivity configuration.

type CreateNetworkPolicyRequest added in v0.70.0 

type CreateNetworkPolicyRequest struct {
	// Network policy configuration details.
	NetworkPolicy AccountNetworkPolicy `json:"network_policy"`
}

type CreateNotificationDestinationRequest added in v0.44.0 

type CreateNotificationDestinationRequest struct {
	// The configuration for the notification destination. Must wrap EXACTLY one
	// of the nested configs.
	Config *Config `json:"config,omitempty"`
	// The display name for the notification destination.
	DisplayName string `json:"display_name,omitempty"`

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

func (CreateNotificationDestinationRequest) MarshalJSON added in v0.44.0 

func (s CreateNotificationDestinationRequest) MarshalJSON() ([]byte, error)

func (*CreateNotificationDestinationRequest) UnmarshalJSON added in v0.44.0 

func (s *CreateNotificationDestinationRequest) UnmarshalJSON(b []byte) error

type CreateOboTokenRequest 

type CreateOboTokenRequest struct {
	// Application ID of the service principal.
	ApplicationId string `json:"application_id"`
	// Comment that describes the purpose of the token.
	Comment string `json:"comment,omitempty"`
	// The number of seconds before the token expires.
	LifetimeSeconds int64 `json:"lifetime_seconds,omitempty"`

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

Configuration details for creating on-behalf tokens.

func (CreateOboTokenRequest) MarshalJSON added in v0.23.0 

func (s CreateOboTokenRequest) MarshalJSON() ([]byte, error)

func (*CreateOboTokenRequest) UnmarshalJSON added in v0.23.0 

func (s *CreateOboTokenRequest) UnmarshalJSON(b []byte) error

type CreateOboTokenResponse 

type CreateOboTokenResponse struct {
	TokenInfo *TokenInfo `json:"token_info,omitempty"`
	// Value of the token.
	TokenValue string `json:"token_value,omitempty"`

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

An on-behalf token was successfully created for the service principal.

func (CreateOboTokenResponse) MarshalJSON added in v0.23.0 

func (s CreateOboTokenResponse) MarshalJSON() ([]byte, error)

func (*CreateOboTokenResponse) UnmarshalJSON added in v0.23.0 

func (s *CreateOboTokenResponse) UnmarshalJSON(b []byte) error

type CreatePrivateEndpointRule added in v0.66.0 

type CreatePrivateEndpointRule struct {
	// Only used by private endpoints to customer-managed private endpoint
	// services.
	//
	// Domain names of target private link service. When updating this field,
	// the full list of target domain_names must be specified.
	DomainNames []string `json:"domain_names,omitempty"`
	// The full target AWS endpoint service name that connects to the
	// destination resources of the private endpoint.
	EndpointService string `json:"endpoint_service,omitempty"`
	// Not used by customer-managed private endpoint services.
	//
	// The sub-resource type (group ID) of the target resource. Note that to
	// connect to workspace root storage (root DBFS), you need two endpoints,
	// one for blob and one for dfs.
	GroupId string `json:"group_id,omitempty"`
	// The Azure resource ID of the target resource.
	ResourceId string `json:"resource_id,omitempty"`
	// Only used by private endpoints towards AWS S3 service.
	//
	// The globally unique S3 bucket names that will be accessed via the VPC
	// endpoint. The bucket names must be in the same region as the NCC/endpoint
	// service. When updating this field, we perform full update on this field.
	// Please ensure a full list of desired resource_names is provided.
	ResourceNames []string `json:"resource_names,omitempty"`

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

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

func (CreatePrivateEndpointRule) MarshalJSON added in v0.66.0 

func (s CreatePrivateEndpointRule) MarshalJSON() ([]byte, error)

func (*CreatePrivateEndpointRule) UnmarshalJSON added in v0.66.0 

func (s *CreatePrivateEndpointRule) UnmarshalJSON(b []byte) error

type CreatePrivateEndpointRuleRequest added in v0.25.0 

type CreatePrivateEndpointRuleRequest struct {
	// Your Network Connectivity Configuration ID.
	NetworkConnectivityConfigId string `json:"-" url:"-"`

	PrivateEndpointRule CreatePrivateEndpointRule `json:"private_endpoint_rule"`
}

type CreateTokenRequest 

type CreateTokenRequest struct {
	// Optional description to attach to the token.
	Comment string `json:"comment,omitempty"`
	// The lifetime of the token, in seconds.
	//
	// If the lifetime is not specified, this token remains valid indefinitely.
	LifetimeSeconds int64 `json:"lifetime_seconds,omitempty"`

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

func (CreateTokenRequest) MarshalJSON added in v0.23.0 

func (s CreateTokenRequest) MarshalJSON() ([]byte, error)

func (*CreateTokenRequest) UnmarshalJSON added in v0.23.0 

func (s *CreateTokenRequest) UnmarshalJSON(b []byte) error

type CreateTokenResponse 

type CreateTokenResponse struct {
	// The information for the new token.
	TokenInfo *PublicTokenInfo `json:"token_info,omitempty"`
	// The value of the new token.
	TokenValue string `json:"token_value,omitempty"`

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

func (CreateTokenResponse) MarshalJSON added in v0.23.0 

func (s CreateTokenResponse) MarshalJSON() ([]byte, error)

func (*CreateTokenResponse) UnmarshalJSON added in v0.23.0 

func (s *CreateTokenResponse) UnmarshalJSON(b []byte) error

type CredentialsManagerAPI added in v0.20.0 

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

Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens.

func NewCredentialsManager added in v0.20.0 

func NewCredentialsManager(client *client.DatabricksClient) *CredentialsManagerAPI

func (*CredentialsManagerAPI) ExchangeToken added in v0.20.0 

func (a *CredentialsManagerAPI) ExchangeToken(ctx context.Context, request ExchangeTokenRequest) (*ExchangeTokenResponse, error)

type CredentialsManagerInterface added in v0.29.0 

type CredentialsManagerInterface interface {

	// Exchange tokens with an Identity Provider to get a new access token. It
	// allows specifying scopes to determine token permissions.
	ExchangeToken(ctx context.Context, request ExchangeTokenRequest) (*ExchangeTokenResponse, error)
}

type CredentialsManagerService deprecated added in v0.20.0 

type CredentialsManagerService interface {

	// Exchange tokens with an Identity Provider to get a new access token. It
	// allows specifying scopes to determine token permissions.
	ExchangeToken(ctx context.Context, request ExchangeTokenRequest) (*ExchangeTokenResponse, error)
}

Credentials manager interacts with with Identity Providers to to perform token exchanges using stored credentials and refresh tokens.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type CspEnablementAccount added in v0.34.0 

type CspEnablementAccount struct {
	// Set by customers when they request Compliance Security Profile (CSP)
	// Invariants are enforced in Settings policy.
	ComplianceStandards []ComplianceStandard `json:"compliance_standards,omitempty"`
	// Enforced = it cannot be overriden at workspace level.
	IsEnforced bool `json:"is_enforced,omitempty"`

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

Account level policy for CSP

func (CspEnablementAccount) MarshalJSON added in v0.34.0 

func (s CspEnablementAccount) MarshalJSON() ([]byte, error)

func (*CspEnablementAccount) UnmarshalJSON added in v0.34.0 

func (s *CspEnablementAccount) UnmarshalJSON(b []byte) error

type CspEnablementAccountAPI added in v0.34.0 

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

The compliance security profile settings at the account level control whether to enable it for new workspaces. By default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable the compliance security profile individually for each workspace.

This settings can be disabled so that new workspaces do not have compliance security profile enabled by default.

func NewCspEnablementAccount added in v0.34.0 

func NewCspEnablementAccount(client *client.DatabricksClient) *CspEnablementAccountAPI

func (*CspEnablementAccountAPI) Get added in v0.34.0 

func (a *CspEnablementAccountAPI) Get(ctx context.Context, request GetCspEnablementAccountSettingRequest) (*CspEnablementAccountSetting, error)

func (*CspEnablementAccountAPI) Update added in v0.34.0 

func (a *CspEnablementAccountAPI) Update(ctx context.Context, request UpdateCspEnablementAccountSettingRequest) (*CspEnablementAccountSetting, error)

type CspEnablementAccountInterface added in v0.34.0 

type CspEnablementAccountInterface interface {

	// Gets the compliance security profile setting for new workspaces.
	Get(ctx context.Context, request GetCspEnablementAccountSettingRequest) (*CspEnablementAccountSetting, error)

	// Updates the value of the compliance security profile setting for new
	// workspaces.
	Update(ctx context.Context, request UpdateCspEnablementAccountSettingRequest) (*CspEnablementAccountSetting, error)
}

type CspEnablementAccountService deprecated added in v0.34.0 

type CspEnablementAccountService interface {

	// Gets the compliance security profile setting for new workspaces.
	Get(ctx context.Context, request GetCspEnablementAccountSettingRequest) (*CspEnablementAccountSetting, error)

	// Updates the value of the compliance security profile setting for new
	// workspaces.
	Update(ctx context.Context, request UpdateCspEnablementAccountSettingRequest) (*CspEnablementAccountSetting, error)
}

The compliance security profile settings at the account level control whether to enable it for new workspaces. By default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable the compliance security profile individually for each workspace.

This settings can be disabled so that new workspaces do not have compliance security profile enabled by default.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type CspEnablementAccountSetting added in v0.34.0 

type CspEnablementAccountSetting struct {
	CspEnablementAccount CspEnablementAccount `json:"csp_enablement_account"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (CspEnablementAccountSetting) MarshalJSON added in v0.34.0 

func (s CspEnablementAccountSetting) MarshalJSON() ([]byte, error)

func (*CspEnablementAccountSetting) UnmarshalJSON added in v0.34.0 

func (s *CspEnablementAccountSetting) UnmarshalJSON(b []byte) error

type CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule added in v0.72.0 

type CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule struct {
	// Databricks account ID. You can find your account ID from the Accounts
	// Console.
	AccountId string `json:"account_id,omitempty"`
	// The current status of this private endpoint. The private endpoint rules
	// are effective only if the connection state is ESTABLISHED. Remember that
	// you must approve new endpoints on your resources in the AWS console
	// before they take effect. The possible values are: - PENDING: The endpoint
	// has been created and pending approval. - ESTABLISHED: The endpoint has
	// been approved and is ready to use in your serverless compute resources. -
	// REJECTED: Connection was rejected by the private link resource owner. -
	// DISCONNECTED: Connection was removed by the private link resource owner,
	// the private endpoint becomes informative and should be deleted for
	// clean-up. - EXPIRED: If the endpoint is created but not approved in 14
	// days, it is EXPIRED.
	ConnectionState CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState `json:"connection_state,omitempty"`
	// Time in epoch milliseconds when this object was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Whether this private endpoint is deactivated.
	Deactivated bool `json:"deactivated,omitempty"`
	// Time in epoch milliseconds when this object was deactivated.
	DeactivatedAt int64 `json:"deactivated_at,omitempty"`
	// Only used by private endpoints towards a VPC endpoint service for
	// customer-managed VPC endpoint service.
	//
	// The target AWS resource FQDNs accessible via the VPC endpoint service.
	// When updating this field, we perform full update on this field. Please
	// ensure a full list of desired domain_names is provided.
	DomainNames []string `json:"domain_names,omitempty"`
	// Only used by private endpoints towards an AWS S3 service.
	//
	// Update this field to activate/deactivate this private endpoint to allow
	// egress access from serverless compute resources.
	Enabled bool `json:"enabled,omitempty"`
	// The full target AWS endpoint service name that connects to the
	// destination resources of the private endpoint.
	EndpointService string `json:"endpoint_service,omitempty"`
	// The ID of a network connectivity configuration, which is the parent
	// resource of this private endpoint rule object.
	NetworkConnectivityConfigId string `json:"network_connectivity_config_id,omitempty"`
	// Only used by private endpoints towards AWS S3 service.
	//
	// The globally unique S3 bucket names that will be accessed via the VPC
	// endpoint. The bucket names must be in the same region as the NCC/endpoint
	// service. When updating this field, we perform full update on this field.
	// Please ensure a full list of desired resource_names is provided.
	ResourceNames []string `json:"resource_names,omitempty"`
	// The ID of a private endpoint rule.
	RuleId string `json:"rule_id,omitempty"`
	// Time in epoch milliseconds when this object was updated.
	UpdatedTime int64 `json:"updated_time,omitempty"`
	// The AWS VPC endpoint ID. You can use this ID to identify VPC endpoint
	// created by Databricks.
	VpcEndpointId string `json:"vpc_endpoint_id,omitempty"`

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

Properties of the new private endpoint rule. Note that for private endpoints towards a VPC endpoint service behind a customer-managed NLB, you must approve the endpoint in AWS console after initialization.

func (CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule) MarshalJSON added in v0.72.0 

func (s CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule) MarshalJSON() ([]byte, error)

func (*CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule) UnmarshalJSON added in v0.72.0 

func (s *CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule) UnmarshalJSON(b []byte) error

type CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState added in v0.72.0 

type CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState string
const CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionStateDisconnected CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState = `DISCONNECTED`
const CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionStateEstablished CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState = `ESTABLISHED`
const CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionStateExpired CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState = `EXPIRED`
const CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionStatePending CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState = `PENDING`
const CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionStateRejected CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState = `REJECTED`

func (*CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) Set added in v0.72.0 

func (f *CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) Set(v string) error

Set raw string value and validate it against allowed values

func (*CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) String added in v0.72.0 

func (f *CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) String() string

String representation for fmt.Print

func (*CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) Type added in v0.72.0 

func (f *CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) Type() string

Type always returns CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState to satisfy [pflag.Value] interface

func (*CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) Values added in v0.72.0 

func (f *CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState) Values() []CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState

Values returns all possible values for CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState.

There is no guarantee on the order of the values in the slice.

type DashboardEmailSubscriptions added in v0.72.0 

type DashboardEmailSubscriptions struct {
	BooleanVal BooleanMessage `json:"boolean_val"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (DashboardEmailSubscriptions) MarshalJSON added in v0.72.0 

func (s DashboardEmailSubscriptions) MarshalJSON() ([]byte, error)

func (*DashboardEmailSubscriptions) UnmarshalJSON added in v0.72.0 

func (s *DashboardEmailSubscriptions) UnmarshalJSON(b []byte) error

type DashboardEmailSubscriptionsAPI added in v0.72.0 

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

Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can send subscription emails containing PDFs and/or images of the dashboard. By default, this setting is enabled (set to `true`)

func NewDashboardEmailSubscriptions added in v0.72.0 

func NewDashboardEmailSubscriptions(client *client.DatabricksClient) *DashboardEmailSubscriptionsAPI

func (*DashboardEmailSubscriptionsAPI) Delete added in v0.72.0 

func (a *DashboardEmailSubscriptionsAPI) Delete(ctx context.Context, request DeleteDashboardEmailSubscriptionsRequest) (*DeleteDashboardEmailSubscriptionsResponse, error)

func (*DashboardEmailSubscriptionsAPI) Get added in v0.72.0 

func (a *DashboardEmailSubscriptionsAPI) Get(ctx context.Context, request GetDashboardEmailSubscriptionsRequest) (*DashboardEmailSubscriptions, error)

func (*DashboardEmailSubscriptionsAPI) Update added in v0.72.0 

func (a *DashboardEmailSubscriptionsAPI) Update(ctx context.Context, request UpdateDashboardEmailSubscriptionsRequest) (*DashboardEmailSubscriptions, error)

type DashboardEmailSubscriptionsInterface added in v0.72.0 

type DashboardEmailSubscriptionsInterface interface {

	// Reverts the Dashboard Email Subscriptions setting to its default value.
	Delete(ctx context.Context, request DeleteDashboardEmailSubscriptionsRequest) (*DeleteDashboardEmailSubscriptionsResponse, error)

	// Gets the Dashboard Email Subscriptions setting.
	Get(ctx context.Context, request GetDashboardEmailSubscriptionsRequest) (*DashboardEmailSubscriptions, error)

	// Updates the Dashboard Email Subscriptions setting.
	Update(ctx context.Context, request UpdateDashboardEmailSubscriptionsRequest) (*DashboardEmailSubscriptions, error)
}

type DashboardEmailSubscriptionsService deprecated added in v0.72.0 

type DashboardEmailSubscriptionsService interface {

	// Reverts the Dashboard Email Subscriptions setting to its default value.
	Delete(ctx context.Context, request DeleteDashboardEmailSubscriptionsRequest) (*DeleteDashboardEmailSubscriptionsResponse, error)

	// Gets the Dashboard Email Subscriptions setting.
	Get(ctx context.Context, request GetDashboardEmailSubscriptionsRequest) (*DashboardEmailSubscriptions, error)

	// Updates the Dashboard Email Subscriptions setting.
	Update(ctx context.Context, request UpdateDashboardEmailSubscriptionsRequest) (*DashboardEmailSubscriptions, error)
}

Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can send subscription emails containing PDFs and/or images of the dashboard. By default, this setting is enabled (set to `true`)

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type DefaultNamespaceAPI added in v0.34.0 

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

The default namespace setting API allows users to configure the default namespace for a Databricks workspace.

Through this API, users can retrieve, set, or modify the default namespace used when queries do not reference a fully qualified three-level name. For example, if you use the API to set 'retail_prod' as the default catalog, then a query 'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed).

This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

func NewDefaultNamespace added in v0.34.0 

func NewDefaultNamespace(client *client.DatabricksClient) *DefaultNamespaceAPI

func (*DefaultNamespaceAPI) Delete added in v0.34.0 

func (a *DefaultNamespaceAPI) Delete(ctx context.Context, request DeleteDefaultNamespaceSettingRequest) (*DeleteDefaultNamespaceSettingResponse, error)

func (*DefaultNamespaceAPI) Get added in v0.34.0 

func (a *DefaultNamespaceAPI) Get(ctx context.Context, request GetDefaultNamespaceSettingRequest) (*DefaultNamespaceSetting, error)

func (*DefaultNamespaceAPI) Update added in v0.34.0 

func (a *DefaultNamespaceAPI) Update(ctx context.Context, request UpdateDefaultNamespaceSettingRequest) (*DefaultNamespaceSetting, error)

type DefaultNamespaceInterface added in v0.34.0 

type DefaultNamespaceInterface interface {

	// Deletes the default namespace setting for the workspace. A fresh etag needs
	// to be provided in `DELETE` requests (as a query parameter). The etag can be
	// retrieved by making a `GET` request before the `DELETE` request. If the
	// setting is updated/deleted concurrently, `DELETE` fails with 409 and the
	// request must be retried by using the fresh etag in the 409 response.
	Delete(ctx context.Context, request DeleteDefaultNamespaceSettingRequest) (*DeleteDefaultNamespaceSettingResponse, error)

	// Gets the default namespace setting.
	Get(ctx context.Context, request GetDefaultNamespaceSettingRequest) (*DefaultNamespaceSetting, error)

	// Updates the default namespace setting for the workspace. A fresh etag needs
	// to be provided in `PATCH` requests (as part of the setting field). The etag
	// can be retrieved by making a `GET` request before the `PATCH` request. Note
	// that if the setting does not exist, `GET` returns a NOT_FOUND error and the
	// etag is present in the error response, which should be set in the `PATCH`
	// request. If the setting is updated concurrently, `PATCH` fails with 409 and
	// the request must be retried by using the fresh etag in the 409 response.
	Update(ctx context.Context, request UpdateDefaultNamespaceSettingRequest) (*DefaultNamespaceSetting, error)
}

type DefaultNamespaceService deprecated added in v0.34.0 

type DefaultNamespaceService interface {

	// Deletes the default namespace setting for the workspace. A fresh etag
	// needs to be provided in `DELETE` requests (as a query parameter). The
	// etag can be retrieved by making a `GET` request before the `DELETE`
	// request. If the setting is updated/deleted concurrently, `DELETE` fails
	// with 409 and the request must be retried by using the fresh etag in the
	// 409 response.
	Delete(ctx context.Context, request DeleteDefaultNamespaceSettingRequest) (*DeleteDefaultNamespaceSettingResponse, error)

	// Gets the default namespace setting.
	Get(ctx context.Context, request GetDefaultNamespaceSettingRequest) (*DefaultNamespaceSetting, error)

	// Updates the default namespace setting for the workspace. A fresh etag
	// needs to be provided in `PATCH` requests (as part of the setting field).
	// The etag can be retrieved by making a `GET` request before the `PATCH`
	// request. Note that if the setting does not exist, `GET` returns a
	// NOT_FOUND error and the etag is present in the error response, which
	// should be set in the `PATCH` request. If the setting is updated
	// concurrently, `PATCH` fails with 409 and the request must be retried by
	// using the fresh etag in the 409 response.
	Update(ctx context.Context, request UpdateDefaultNamespaceSettingRequest) (*DefaultNamespaceSetting, error)
}

The default namespace setting API allows users to configure the default namespace for a Databricks workspace.

Through this API, users can retrieve, set, or modify the default namespace used when queries do not reference a fully qualified three-level name. For example, if you use the API to set 'retail_prod' as the default catalog, then a query 'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed).

This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type DefaultNamespaceSetting added in v0.21.0 

type DefaultNamespaceSetting struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`

	Namespace StringMessage `json:"namespace"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

This represents the setting configuration for the default namespace in the Databricks workspace. Setting the default catalog for the workspace determines the catalog that is used when queries do not reference a fully qualified 3 level name. For example, if the default catalog is set to 'retail_prod' then a query 'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed). This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

func (DefaultNamespaceSetting) MarshalJSON added in v0.23.0 

func (s DefaultNamespaceSetting) MarshalJSON() ([]byte, error)

func (*DefaultNamespaceSetting) UnmarshalJSON added in v0.23.0 

func (s *DefaultNamespaceSetting) UnmarshalJSON(b []byte) error

type DefaultWarehouseId added in v0.75.0 

type DefaultWarehouseId struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

	StringVal StringMessage `json:"string_val"`

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

func (DefaultWarehouseId) MarshalJSON added in v0.75.0 

func (s DefaultWarehouseId) MarshalJSON() ([]byte, error)

func (*DefaultWarehouseId) UnmarshalJSON added in v0.75.0 

func (s *DefaultWarehouseId) UnmarshalJSON(b []byte) error

type DefaultWarehouseIdAPI added in v0.75.0 

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

Warehouse to be selected by default for users in this workspace. Covers SQL workloads only and can be overridden by users.

func NewDefaultWarehouseId added in v0.75.0 

func NewDefaultWarehouseId(client *client.DatabricksClient) *DefaultWarehouseIdAPI

func (*DefaultWarehouseIdAPI) Delete added in v0.75.0 

func (a *DefaultWarehouseIdAPI) Delete(ctx context.Context, request DeleteDefaultWarehouseIdRequest) (*DeleteDefaultWarehouseIdResponse, error)

func (*DefaultWarehouseIdAPI) Get added in v0.75.0 

func (a *DefaultWarehouseIdAPI) Get(ctx context.Context, request GetDefaultWarehouseIdRequest) (*DefaultWarehouseId, error)

func (*DefaultWarehouseIdAPI) Update added in v0.75.0 

func (a *DefaultWarehouseIdAPI) Update(ctx context.Context, request UpdateDefaultWarehouseIdRequest) (*DefaultWarehouseId, error)

type DefaultWarehouseIdInterface added in v0.75.0 

type DefaultWarehouseIdInterface interface {

	// Reverts the Default Warehouse Id setting to its default value.
	Delete(ctx context.Context, request DeleteDefaultWarehouseIdRequest) (*DeleteDefaultWarehouseIdResponse, error)

	// Gets the Default Warehouse Id setting.
	Get(ctx context.Context, request GetDefaultWarehouseIdRequest) (*DefaultWarehouseId, error)

	// Updates the Default Warehouse Id setting.
	Update(ctx context.Context, request UpdateDefaultWarehouseIdRequest) (*DefaultWarehouseId, error)
}

type DefaultWarehouseIdService deprecated added in v0.75.0 

type DefaultWarehouseIdService interface {

	// Reverts the Default Warehouse Id setting to its default value.
	Delete(ctx context.Context, request DeleteDefaultWarehouseIdRequest) (*DeleteDefaultWarehouseIdResponse, error)

	// Gets the Default Warehouse Id setting.
	Get(ctx context.Context, request GetDefaultWarehouseIdRequest) (*DefaultWarehouseId, error)

	// Updates the Default Warehouse Id setting.
	Update(ctx context.Context, request UpdateDefaultWarehouseIdRequest) (*DefaultWarehouseId, error)
}

Warehouse to be selected by default for users in this workspace. Covers SQL workloads only and can be overridden by users.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type DeleteAccountIpAccessEnableRequest added in v0.57.0 

type DeleteAccountIpAccessEnableRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteAccountIpAccessEnableRequest) MarshalJSON added in v0.57.0 

func (s DeleteAccountIpAccessEnableRequest) MarshalJSON() ([]byte, error)

func (*DeleteAccountIpAccessEnableRequest) UnmarshalJSON added in v0.57.0 

func (s *DeleteAccountIpAccessEnableRequest) UnmarshalJSON(b []byte) error

type DeleteAccountIpAccessEnableResponse added in v0.57.0 

type DeleteAccountIpAccessEnableResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteAccountIpAccessListRequest 

type DeleteAccountIpAccessListRequest struct {
	// The ID for the corresponding IP access list
	IpAccessListId string `json:"-" url:"-"`
}

type DeleteAibiDashboardEmbeddingAccessPolicySettingRequest added in v0.53.0 

type DeleteAibiDashboardEmbeddingAccessPolicySettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) MarshalJSON added in v0.53.0 

func (s DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) MarshalJSON() ([]byte, error)

func (*DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) UnmarshalJSON added in v0.53.0 

func (s *DeleteAibiDashboardEmbeddingAccessPolicySettingRequest) UnmarshalJSON(b []byte) error

type DeleteAibiDashboardEmbeddingAccessPolicySettingResponse added in v0.53.0 

type DeleteAibiDashboardEmbeddingAccessPolicySettingResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest added in v0.53.0 

type DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) MarshalJSON added in v0.53.0 

func (s DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) MarshalJSON() ([]byte, error)

func (*DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) UnmarshalJSON added in v0.53.0 

func (s *DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest) UnmarshalJSON(b []byte) error

type DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse added in v0.53.0 

type DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteDashboardEmailSubscriptionsRequest added in v0.72.0 

type DeleteDashboardEmailSubscriptionsRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteDashboardEmailSubscriptionsRequest) MarshalJSON added in v0.72.0 

func (s DeleteDashboardEmailSubscriptionsRequest) MarshalJSON() ([]byte, error)

func (*DeleteDashboardEmailSubscriptionsRequest) UnmarshalJSON added in v0.72.0 

func (s *DeleteDashboardEmailSubscriptionsRequest) UnmarshalJSON(b []byte) error

type DeleteDashboardEmailSubscriptionsResponse added in v0.72.0 

type DeleteDashboardEmailSubscriptionsResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteDefaultNamespaceSettingRequest added in v0.31.0 

type DeleteDefaultNamespaceSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteDefaultNamespaceSettingRequest) MarshalJSON added in v0.31.0 

func (s DeleteDefaultNamespaceSettingRequest) MarshalJSON() ([]byte, error)

func (*DeleteDefaultNamespaceSettingRequest) UnmarshalJSON added in v0.31.0 

func (s *DeleteDefaultNamespaceSettingRequest) UnmarshalJSON(b []byte) error

type DeleteDefaultNamespaceSettingResponse added in v0.31.0 

type DeleteDefaultNamespaceSettingResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteDefaultWarehouseIdRequest added in v0.75.0 

type DeleteDefaultWarehouseIdRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteDefaultWarehouseIdRequest) MarshalJSON added in v0.75.0 

func (s DeleteDefaultWarehouseIdRequest) MarshalJSON() ([]byte, error)

func (*DeleteDefaultWarehouseIdRequest) UnmarshalJSON added in v0.75.0 

func (s *DeleteDefaultWarehouseIdRequest) UnmarshalJSON(b []byte) error

type DeleteDefaultWarehouseIdResponse added in v0.75.0 

type DeleteDefaultWarehouseIdResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteDisableLegacyAccessRequest added in v0.47.0 

type DeleteDisableLegacyAccessRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteDisableLegacyAccessRequest) MarshalJSON added in v0.47.0 

func (s DeleteDisableLegacyAccessRequest) MarshalJSON() ([]byte, error)

func (*DeleteDisableLegacyAccessRequest) UnmarshalJSON added in v0.47.0 

func (s *DeleteDisableLegacyAccessRequest) UnmarshalJSON(b []byte) error

type DeleteDisableLegacyAccessResponse added in v0.47.0 

type DeleteDisableLegacyAccessResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteDisableLegacyDbfsRequest added in v0.49.0 

type DeleteDisableLegacyDbfsRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteDisableLegacyDbfsRequest) MarshalJSON added in v0.49.0 

func (s DeleteDisableLegacyDbfsRequest) MarshalJSON() ([]byte, error)

func (*DeleteDisableLegacyDbfsRequest) UnmarshalJSON added in v0.49.0 

func (s *DeleteDisableLegacyDbfsRequest) UnmarshalJSON(b []byte) error

type DeleteDisableLegacyDbfsResponse added in v0.49.0 

type DeleteDisableLegacyDbfsResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteDisableLegacyFeaturesRequest added in v0.47.0 

type DeleteDisableLegacyFeaturesRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteDisableLegacyFeaturesRequest) MarshalJSON added in v0.47.0 

func (s DeleteDisableLegacyFeaturesRequest) MarshalJSON() ([]byte, error)

func (*DeleteDisableLegacyFeaturesRequest) UnmarshalJSON added in v0.47.0 

func (s *DeleteDisableLegacyFeaturesRequest) UnmarshalJSON(b []byte) error

type DeleteDisableLegacyFeaturesResponse added in v0.47.0 

type DeleteDisableLegacyFeaturesResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteIpAccessListRequest 

type DeleteIpAccessListRequest struct {
	// The ID for the corresponding IP access list
	IpAccessListId string `json:"-" url:"-"`
}

type DeleteLlmProxyPartnerPoweredWorkspaceRequest added in v0.69.0 

type DeleteLlmProxyPartnerPoweredWorkspaceRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteLlmProxyPartnerPoweredWorkspaceRequest) MarshalJSON added in v0.69.0 

func (s DeleteLlmProxyPartnerPoweredWorkspaceRequest) MarshalJSON() ([]byte, error)

func (*DeleteLlmProxyPartnerPoweredWorkspaceRequest) UnmarshalJSON added in v0.69.0 

func (s *DeleteLlmProxyPartnerPoweredWorkspaceRequest) UnmarshalJSON(b []byte) error

type DeleteLlmProxyPartnerPoweredWorkspaceResponse added in v0.69.0 

type DeleteLlmProxyPartnerPoweredWorkspaceResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteNetworkConnectivityConfigurationRequest added in v0.25.0 

type DeleteNetworkConnectivityConfigurationRequest struct {
	// Your Network Connectivity Configuration ID.
	NetworkConnectivityConfigId string `json:"-" url:"-"`
}

type DeleteNetworkPolicyRequest added in v0.70.0 

type DeleteNetworkPolicyRequest struct {
	// The unique identifier of the network policy to delete.
	NetworkPolicyId string `json:"-" url:"-"`
}

type DeleteNotificationDestinationRequest added in v0.44.0 

type DeleteNotificationDestinationRequest struct {
	Id string `json:"-" url:"-"`
}

type DeletePersonalComputeSettingRequest added in v0.11.0 

type DeletePersonalComputeSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeletePersonalComputeSettingRequest) MarshalJSON added in v0.31.0 

func (s DeletePersonalComputeSettingRequest) MarshalJSON() ([]byte, error)

func (*DeletePersonalComputeSettingRequest) UnmarshalJSON added in v0.31.0 

func (s *DeletePersonalComputeSettingRequest) UnmarshalJSON(b []byte) error

type DeletePersonalComputeSettingResponse added in v0.11.0 

type DeletePersonalComputeSettingResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeletePrivateEndpointRuleRequest added in v0.25.0 

type DeletePrivateEndpointRuleRequest struct {
	// Your Network Connectvity Configuration ID.
	NetworkConnectivityConfigId string `json:"-" url:"-"`
	// Your private endpoint rule ID.
	PrivateEndpointRuleId string `json:"-" url:"-"`
}

type DeleteRestrictWorkspaceAdminsSettingRequest added in v0.31.0 

type DeleteRestrictWorkspaceAdminsSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteRestrictWorkspaceAdminsSettingRequest) MarshalJSON added in v0.31.0 

func (s DeleteRestrictWorkspaceAdminsSettingRequest) MarshalJSON() ([]byte, error)

func (*DeleteRestrictWorkspaceAdminsSettingRequest) UnmarshalJSON added in v0.31.0 

func (s *DeleteRestrictWorkspaceAdminsSettingRequest) UnmarshalJSON(b []byte) error

type DeleteRestrictWorkspaceAdminsSettingResponse added in v0.31.0 

type DeleteRestrictWorkspaceAdminsSettingResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteSqlResultsDownloadRequest added in v0.72.0 

type DeleteSqlResultsDownloadRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (DeleteSqlResultsDownloadRequest) MarshalJSON added in v0.72.0 

func (s DeleteSqlResultsDownloadRequest) MarshalJSON() ([]byte, error)

func (*DeleteSqlResultsDownloadRequest) UnmarshalJSON added in v0.72.0 

func (s *DeleteSqlResultsDownloadRequest) UnmarshalJSON(b []byte) error

type DeleteSqlResultsDownloadResponse added in v0.72.0 

type DeleteSqlResultsDownloadResponse struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"etag"`
}

The etag is returned.

type DeleteTokenManagementRequest 

type DeleteTokenManagementRequest struct {
	// The ID of the token to revoke.
	TokenId string `json:"-" url:"-"`
}

type DestinationType added in v0.44.0 

type DestinationType string
const DestinationTypeEmail DestinationType = `EMAIL`
const DestinationTypeMicrosoftTeams DestinationType = `MICROSOFT_TEAMS`
const DestinationTypePagerduty DestinationType = `PAGERDUTY`
const DestinationTypeSlack DestinationType = `SLACK`
const DestinationTypeWebhook DestinationType = `WEBHOOK`

func (*DestinationType) Set added in v0.44.0 

func (f *DestinationType) Set(v string) error

Set raw string value and validate it against allowed values

func (*DestinationType) String added in v0.44.0 

func (f *DestinationType) String() string

String representation for fmt.Print

func (*DestinationType) Type added in v0.44.0 

func (f *DestinationType) Type() string

Type always returns DestinationType to satisfy [pflag.Value] interface

func (*DestinationType) Values added in v0.72.0 

func (f *DestinationType) Values() []DestinationType

Values returns all possible values for DestinationType.

There is no guarantee on the order of the values in the slice.

type DisableLegacyAccess added in v0.47.0 

type DisableLegacyAccess struct {
	DisableLegacyAccess BooleanMessage `json:"disable_legacy_access"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (DisableLegacyAccess) MarshalJSON added in v0.47.0 

func (s DisableLegacyAccess) MarshalJSON() ([]byte, error)

func (*DisableLegacyAccess) UnmarshalJSON added in v0.47.0 

func (s *DisableLegacyAccess) UnmarshalJSON(b []byte) error

type DisableLegacyAccessAPI added in v0.47.0 

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

'Disabling legacy access' has the following impacts:

1. Disables direct access to Hive Metastores from the workspace. However, you can still access a Hive Metastore through Hive Metastore federation. 2. Disables fallback mode on external location access from the workspace. 3. Disables Databricks Runtime versions prior to 13.3LTS.

func NewDisableLegacyAccess added in v0.47.0 

func NewDisableLegacyAccess(client *client.DatabricksClient) *DisableLegacyAccessAPI

func (*DisableLegacyAccessAPI) Delete added in v0.47.0 

func (a *DisableLegacyAccessAPI) Delete(ctx context.Context, request DeleteDisableLegacyAccessRequest) (*DeleteDisableLegacyAccessResponse, error)

func (*DisableLegacyAccessAPI) Get added in v0.47.0 

func (a *DisableLegacyAccessAPI) Get(ctx context.Context, request GetDisableLegacyAccessRequest) (*DisableLegacyAccess, error)

func (*DisableLegacyAccessAPI) Update added in v0.47.0 

func (a *DisableLegacyAccessAPI) Update(ctx context.Context, request UpdateDisableLegacyAccessRequest) (*DisableLegacyAccess, error)

type DisableLegacyAccessInterface added in v0.47.0 

type DisableLegacyAccessInterface interface {

	// Deletes legacy access disablement status.
	Delete(ctx context.Context, request DeleteDisableLegacyAccessRequest) (*DeleteDisableLegacyAccessResponse, error)

	// Retrieves legacy access disablement Status.
	Get(ctx context.Context, request GetDisableLegacyAccessRequest) (*DisableLegacyAccess, error)

	// Updates legacy access disablement status.
	Update(ctx context.Context, request UpdateDisableLegacyAccessRequest) (*DisableLegacyAccess, error)
}

type DisableLegacyAccessService deprecated added in v0.47.0 

type DisableLegacyAccessService interface {

	// Deletes legacy access disablement status.
	Delete(ctx context.Context, request DeleteDisableLegacyAccessRequest) (*DeleteDisableLegacyAccessResponse, error)

	// Retrieves legacy access disablement Status.
	Get(ctx context.Context, request GetDisableLegacyAccessRequest) (*DisableLegacyAccess, error)

	// Updates legacy access disablement status.
	Update(ctx context.Context, request UpdateDisableLegacyAccessRequest) (*DisableLegacyAccess, error)
}

'Disabling legacy access' has the following impacts:

1. Disables direct access to Hive Metastores from the workspace. However, you can still access a Hive Metastore through Hive Metastore federation. 2. Disables fallback mode on external location access from the workspace. 3. Disables Databricks Runtime versions prior to 13.3LTS.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type DisableLegacyDbfs added in v0.49.0 

type DisableLegacyDbfs struct {
	DisableLegacyDbfs BooleanMessage `json:"disable_legacy_dbfs"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (DisableLegacyDbfs) MarshalJSON added in v0.49.0 

func (s DisableLegacyDbfs) MarshalJSON() ([]byte, error)

func (*DisableLegacyDbfs) UnmarshalJSON added in v0.49.0 

func (s *DisableLegacyDbfs) UnmarshalJSON(b []byte) error

type DisableLegacyDbfsAPI added in v0.49.0 

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

Disabling legacy DBFS has the following implications:

1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation of new mounts). 2. Disables Databricks Runtime versions prior to 13.3LTS.

When the setting is off, all DBFS functionality is enabled and no restrictions are imposed on Databricks Runtime versions. This setting can take up to 20 minutes to take effect and requires a manual restart of all-purpose compute clusters and SQL warehouses.

func NewDisableLegacyDbfs added in v0.49.0 

func NewDisableLegacyDbfs(client *client.DatabricksClient) *DisableLegacyDbfsAPI

func (*DisableLegacyDbfsAPI) Delete added in v0.49.0 

func (a *DisableLegacyDbfsAPI) Delete(ctx context.Context, request DeleteDisableLegacyDbfsRequest) (*DeleteDisableLegacyDbfsResponse, error)

func (*DisableLegacyDbfsAPI) Get added in v0.49.0 

func (a *DisableLegacyDbfsAPI) Get(ctx context.Context, request GetDisableLegacyDbfsRequest) (*DisableLegacyDbfs, error)

func (*DisableLegacyDbfsAPI) Update added in v0.49.0 

func (a *DisableLegacyDbfsAPI) Update(ctx context.Context, request UpdateDisableLegacyDbfsRequest) (*DisableLegacyDbfs, error)

type DisableLegacyDbfsInterface added in v0.49.0 

type DisableLegacyDbfsInterface interface {

	// Deletes the disable legacy DBFS setting for a workspace, reverting back to
	// the default.
	Delete(ctx context.Context, request DeleteDisableLegacyDbfsRequest) (*DeleteDisableLegacyDbfsResponse, error)

	// Gets the disable legacy DBFS setting.
	Get(ctx context.Context, request GetDisableLegacyDbfsRequest) (*DisableLegacyDbfs, error)

	// Updates the disable legacy DBFS setting for the workspace.
	Update(ctx context.Context, request UpdateDisableLegacyDbfsRequest) (*DisableLegacyDbfs, error)
}

type DisableLegacyDbfsService deprecated added in v0.49.0 

type DisableLegacyDbfsService interface {

	// Deletes the disable legacy DBFS setting for a workspace, reverting back
	// to the default.
	Delete(ctx context.Context, request DeleteDisableLegacyDbfsRequest) (*DeleteDisableLegacyDbfsResponse, error)

	// Gets the disable legacy DBFS setting.
	Get(ctx context.Context, request GetDisableLegacyDbfsRequest) (*DisableLegacyDbfs, error)

	// Updates the disable legacy DBFS setting for the workspace.
	Update(ctx context.Context, request UpdateDisableLegacyDbfsRequest) (*DisableLegacyDbfs, error)
}

Disabling legacy DBFS has the following implications:

1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation of new mounts). 2. Disables Databricks Runtime versions prior to 13.3LTS.

When the setting is off, all DBFS functionality is enabled and no restrictions are imposed on Databricks Runtime versions. This setting can take up to 20 minutes to take effect and requires a manual restart of all-purpose compute clusters and SQL warehouses.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type DisableLegacyFeatures added in v0.47.0 

type DisableLegacyFeatures struct {
	DisableLegacyFeatures BooleanMessage `json:"disable_legacy_features"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (DisableLegacyFeatures) MarshalJSON added in v0.47.0 

func (s DisableLegacyFeatures) MarshalJSON() ([]byte, error)

func (*DisableLegacyFeatures) UnmarshalJSON added in v0.47.0 

func (s *DisableLegacyFeatures) UnmarshalJSON(b []byte) error

type DisableLegacyFeaturesAPI added in v0.47.0 

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

Disable legacy features for new Databricks workspaces.

For newly created workspaces: 1. Disables the use of DBFS root and mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of ‘No-isolation clusters’. 4. Disables Databricks Runtime versions prior to 13.3LTS.

func NewDisableLegacyFeatures added in v0.47.0 

func NewDisableLegacyFeatures(client *client.DatabricksClient) *DisableLegacyFeaturesAPI

func (*DisableLegacyFeaturesAPI) Delete added in v0.47.0 

func (a *DisableLegacyFeaturesAPI) Delete(ctx context.Context, request DeleteDisableLegacyFeaturesRequest) (*DeleteDisableLegacyFeaturesResponse, error)

func (*DisableLegacyFeaturesAPI) Get added in v0.47.0 

func (a *DisableLegacyFeaturesAPI) Get(ctx context.Context, request GetDisableLegacyFeaturesRequest) (*DisableLegacyFeatures, error)

func (*DisableLegacyFeaturesAPI) Update added in v0.47.0 

func (a *DisableLegacyFeaturesAPI) Update(ctx context.Context, request UpdateDisableLegacyFeaturesRequest) (*DisableLegacyFeatures, error)

type DisableLegacyFeaturesInterface added in v0.47.0 

type DisableLegacyFeaturesInterface interface {

	// Deletes the disable legacy features setting.
	Delete(ctx context.Context, request DeleteDisableLegacyFeaturesRequest) (*DeleteDisableLegacyFeaturesResponse, error)

	// Gets the value of the disable legacy features setting.
	Get(ctx context.Context, request GetDisableLegacyFeaturesRequest) (*DisableLegacyFeatures, error)

	// Updates the value of the disable legacy features setting.
	Update(ctx context.Context, request UpdateDisableLegacyFeaturesRequest) (*DisableLegacyFeatures, error)
}

type DisableLegacyFeaturesService deprecated added in v0.47.0 

type DisableLegacyFeaturesService interface {

	// Deletes the disable legacy features setting.
	Delete(ctx context.Context, request DeleteDisableLegacyFeaturesRequest) (*DeleteDisableLegacyFeaturesResponse, error)

	// Gets the value of the disable legacy features setting.
	Get(ctx context.Context, request GetDisableLegacyFeaturesRequest) (*DisableLegacyFeatures, error)

	// Updates the value of the disable legacy features setting.
	Update(ctx context.Context, request UpdateDisableLegacyFeaturesRequest) (*DisableLegacyFeatures, error)
}

Disable legacy features for new Databricks workspaces.

For newly created workspaces: 1. Disables the use of DBFS root and mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of ‘No-isolation clusters’. 4. Disables Databricks Runtime versions prior to 13.3LTS.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EgressNetworkPolicy added in v0.53.0 

type EgressNetworkPolicy struct {
	// The access policy enforced for egress traffic to the internet.
	InternetAccess *EgressNetworkPolicyInternetAccessPolicy `json:"internet_access,omitempty"`
}

The network policies applying for egress traffic. This message is used by the UI/REST API. We translate this message to the format expected by the dataplane in Lakehouse Network Manager (for the format expected by the dataplane, see networkconfig.textproto).

type EgressNetworkPolicyInternetAccessPolicy added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicy struct {
	AllowedInternetDestinations []EgressNetworkPolicyInternetAccessPolicyInternetDestination `json:"allowed_internet_destinations,omitempty"`

	AllowedStorageDestinations []EgressNetworkPolicyInternetAccessPolicyStorageDestination `json:"allowed_storage_destinations,omitempty"`
	// Optional. If not specified, assume the policy is enforced for all
	// workloads.
	LogOnlyMode *EgressNetworkPolicyInternetAccessPolicyLogOnlyMode `json:"log_only_mode,omitempty"`

	RestrictionMode EgressNetworkPolicyInternetAccessPolicyRestrictionMode `json:"restriction_mode,omitempty"`
}

type EgressNetworkPolicyInternetAccessPolicyInternetDestination added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyInternetDestination struct {
	Destination string `json:"destination,omitempty"`

	Protocol EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol `json:"protocol,omitempty"`

	Type EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType `json:"type,omitempty"`

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

Users can specify accessible internet destinations when outbound access is restricted. We only support domain name (FQDN) destinations for the time being, though going forwards we want to support host names and IP addresses.

func (EgressNetworkPolicyInternetAccessPolicyInternetDestination) MarshalJSON added in v0.53.0 

func (s EgressNetworkPolicyInternetAccessPolicyInternetDestination) MarshalJSON() ([]byte, error)

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestination) UnmarshalJSON added in v0.53.0 

func (s *EgressNetworkPolicyInternetAccessPolicyInternetDestination) UnmarshalJSON(b []byte) error

type EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol string

The filtering protocol used by the DP. For private and public preview, SEG will only support TCP filtering (i.e. DNS based filtering, filtering by destination IP address), so protocol will be set to TCP by default and hidden from the user. In the future, users may be able to select HTTP filtering (i.e. SNI based filtering, filtering by FQDN). 

const EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocolTcp EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol = `TCP`

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) Set added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) String added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) Type added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) Type() string

Type always returns EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) Values added in v0.72.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol) Values() []EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol

Values returns all possible values for EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType string
const EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationTypeFqdn EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType = `FQDN`

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) Set added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) String added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) Type added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) Type() string

Type always returns EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) Values added in v0.72.0 

func (f *EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType) Values() []EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType

Values returns all possible values for EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyInternetAccessPolicyLogOnlyMode added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyLogOnlyMode struct {
	LogOnlyModeType EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType `json:"log_only_mode_type,omitempty"`

	Workloads []EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType `json:"workloads,omitempty"`
}

type EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType string
const EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeTypeAllServices EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType = `ALL_SERVICES`
const EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeTypeSelectedServices EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType = `SELECTED_SERVICES`

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) Set added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) String added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) Type added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) Type() string

Type always returns EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) Values added in v0.72.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType) Values() []EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType

Values returns all possible values for EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType string

The values should match the list of workloads used in networkconfig.proto 

const EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadTypeDbsql EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType = `DBSQL`
const EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadTypeMlServing EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType = `ML_SERVING`

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) Set added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) String added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) Type added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) Type() string

Type always returns EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) Values added in v0.72.0 

func (f *EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType) Values() []EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType

Values returns all possible values for EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyInternetAccessPolicyRestrictionMode added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyRestrictionMode string

At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can only access explicitly allowed internet and storage destinations, as well as UC connections and external locations. PRIVATE_ACCESS_ONLY (not used): Databricks can only access destinations via private link. 

const EgressNetworkPolicyInternetAccessPolicyRestrictionModeFullAccess EgressNetworkPolicyInternetAccessPolicyRestrictionMode = `FULL_ACCESS`
const EgressNetworkPolicyInternetAccessPolicyRestrictionModePrivateAccessOnly EgressNetworkPolicyInternetAccessPolicyRestrictionMode = `PRIVATE_ACCESS_ONLY`
const EgressNetworkPolicyInternetAccessPolicyRestrictionModeRestrictedAccess EgressNetworkPolicyInternetAccessPolicyRestrictionMode = `RESTRICTED_ACCESS`

func (*EgressNetworkPolicyInternetAccessPolicyRestrictionMode) Set added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyRestrictionMode) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyInternetAccessPolicyRestrictionMode) String added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyRestrictionMode) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyInternetAccessPolicyRestrictionMode) Type added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyRestrictionMode) Type() string

Type always returns EgressNetworkPolicyInternetAccessPolicyRestrictionMode to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyInternetAccessPolicyRestrictionMode) Values added in v0.72.0 

func (f *EgressNetworkPolicyInternetAccessPolicyRestrictionMode) Values() []EgressNetworkPolicyInternetAccessPolicyRestrictionMode

Values returns all possible values for EgressNetworkPolicyInternetAccessPolicyRestrictionMode.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyInternetAccessPolicyStorageDestination added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyStorageDestination struct {
	AllowedPaths []string `json:"allowed_paths,omitempty"`

	AzureContainer string `json:"azure_container,omitempty"`

	AzureDnsZone string `json:"azure_dns_zone,omitempty"`

	AzureStorageAccount string `json:"azure_storage_account,omitempty"`

	AzureStorageService string `json:"azure_storage_service,omitempty"`

	BucketName string `json:"bucket_name,omitempty"`

	Region string `json:"region,omitempty"`

	Type EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType `json:"type,omitempty"`

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

Users can specify accessible storage destinations.

func (EgressNetworkPolicyInternetAccessPolicyStorageDestination) MarshalJSON added in v0.53.0 

func (s EgressNetworkPolicyInternetAccessPolicyStorageDestination) MarshalJSON() ([]byte, error)

func (*EgressNetworkPolicyInternetAccessPolicyStorageDestination) UnmarshalJSON added in v0.53.0 

func (s *EgressNetworkPolicyInternetAccessPolicyStorageDestination) UnmarshalJSON(b []byte) error

type EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType added in v0.53.0 

type EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType string
const EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationTypeAwsS3 EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType = `AWS_S3`
const EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationTypeAzureStorage EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType = `AZURE_STORAGE`
const EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationTypeCloudflareR2 EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType = `CLOUDFLARE_R2`
const EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationTypeGoogleCloudStorage EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType = `GOOGLE_CLOUD_STORAGE`

func (*EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) Set added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) String added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) Type added in v0.53.0 

func (f *EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) Type() string

Type always returns EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) Values added in v0.72.0 

func (f *EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType) Values() []EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType

Values returns all possible values for EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyNetworkAccessPolicy added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicy struct {
	// List of internet destinations that serverless workloads are allowed to
	// access when in RESTRICTED_ACCESS mode.
	AllowedInternetDestinations []EgressNetworkPolicyNetworkAccessPolicyInternetDestination `json:"allowed_internet_destinations,omitempty"`
	// List of storage destinations that serverless workloads are allowed to
	// access when in RESTRICTED_ACCESS mode.
	AllowedStorageDestinations []EgressNetworkPolicyNetworkAccessPolicyStorageDestination `json:"allowed_storage_destinations,omitempty"`
	// Optional. When policy_enforcement is not provided, we default to
	// ENFORCE_MODE_ALL_SERVICES
	PolicyEnforcement *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement `json:"policy_enforcement,omitempty"`
	// The restriction mode that controls how serverless workloads can access
	// the internet.
	RestrictionMode EgressNetworkPolicyNetworkAccessPolicyRestrictionMode `json:"restriction_mode"`
}

type EgressNetworkPolicyNetworkAccessPolicyInternetDestination added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyInternetDestination struct {
	// The internet destination to which access will be allowed. Format
	// dependent on the destination type.
	Destination string `json:"destination,omitempty"`
	// The type of internet destination. Currently only DNS_NAME is supported.
	InternetDestinationType EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType `json:"internet_destination_type,omitempty"`

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

Users can specify accessible internet destinations when outbound access is restricted. We only support DNS_NAME (FQDN format) destinations for the time being. Going forward we may extend support to host names and IP addresses.

func (EgressNetworkPolicyNetworkAccessPolicyInternetDestination) MarshalJSON added in v0.70.0 

func (s EgressNetworkPolicyNetworkAccessPolicyInternetDestination) MarshalJSON() ([]byte, error)

func (*EgressNetworkPolicyNetworkAccessPolicyInternetDestination) UnmarshalJSON added in v0.70.0 

func (s *EgressNetworkPolicyNetworkAccessPolicyInternetDestination) UnmarshalJSON(b []byte) error

type EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType string
const EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationTypeDnsName EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType = `DNS_NAME`

func (*EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) Set added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) String added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) Type added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) Type() string

Type always returns EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) Values added in v0.72.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType) Values() []EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType

Values returns all possible values for EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement struct {
	// When empty, it means dry run for all products. When non-empty, it means
	// dry run for specific products and for the other products, they will run
	// in enforced mode.
	DryRunModeProductFilter []EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter `json:"dry_run_mode_product_filter,omitempty"`
	// The mode of policy enforcement. ENFORCED blocks traffic that violates
	// policy, while DRY_RUN only logs violations without blocking. When not
	// specified, defaults to ENFORCED.
	EnforcementMode EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode `json:"enforcement_mode,omitempty"`
}

type EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter string

The values should match the list of workloads used in networkconfig.proto 

const EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilterDbsql EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter = `DBSQL`
const EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilterMlServing EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter = `ML_SERVING`

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) Set added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) String added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) Type added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) Type() string

Type always returns EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) Values added in v0.72.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter) Values() []EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter

Values returns all possible values for EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode string
const EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementModeDryRun EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode = `DRY_RUN`
const EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementModeEnforced EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode = `ENFORCED`

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) Set added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) String added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) Type added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) Type() string

Type always returns EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) Values added in v0.72.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode) Values() []EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode

Values returns all possible values for EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyNetworkAccessPolicyRestrictionMode added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyRestrictionMode string

At which level can Databricks and Databricks managed compute access Internet. FULL_ACCESS: Databricks can access Internet. No blocking rules will apply. RESTRICTED_ACCESS: Databricks can only access explicitly allowed internet and storage destinations, as well as UC connections and external locations. 

const EgressNetworkPolicyNetworkAccessPolicyRestrictionModeFullAccess EgressNetworkPolicyNetworkAccessPolicyRestrictionMode = `FULL_ACCESS`
const EgressNetworkPolicyNetworkAccessPolicyRestrictionModeRestrictedAccess EgressNetworkPolicyNetworkAccessPolicyRestrictionMode = `RESTRICTED_ACCESS`

func (*EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) Set added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) String added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) Type added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) Type() string

Type always returns EgressNetworkPolicyNetworkAccessPolicyRestrictionMode to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) Values added in v0.72.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyRestrictionMode) Values() []EgressNetworkPolicyNetworkAccessPolicyRestrictionMode

Values returns all possible values for EgressNetworkPolicyNetworkAccessPolicyRestrictionMode.

There is no guarantee on the order of the values in the slice.

type EgressNetworkPolicyNetworkAccessPolicyStorageDestination added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyStorageDestination struct {
	// The Azure storage account name.
	AzureStorageAccount string `json:"azure_storage_account,omitempty"`
	// The Azure storage service type (blob, dfs, etc.).
	AzureStorageService string `json:"azure_storage_service,omitempty"`

	BucketName string `json:"bucket_name,omitempty"`

	Region string `json:"region,omitempty"`
	// The type of storage destination.
	StorageDestinationType EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType `json:"storage_destination_type,omitempty"`

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

Users can specify accessible storage destinations.

func (EgressNetworkPolicyNetworkAccessPolicyStorageDestination) MarshalJSON added in v0.70.0 

func (s EgressNetworkPolicyNetworkAccessPolicyStorageDestination) MarshalJSON() ([]byte, error)

func (*EgressNetworkPolicyNetworkAccessPolicyStorageDestination) UnmarshalJSON added in v0.70.0 

func (s *EgressNetworkPolicyNetworkAccessPolicyStorageDestination) UnmarshalJSON(b []byte) error

type EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType added in v0.70.0 

type EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType string
const EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationTypeAwsS3 EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType = `AWS_S3`
const EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationTypeAzureStorage EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType = `AZURE_STORAGE`
const EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationTypeGoogleCloudStorage EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType = `GOOGLE_CLOUD_STORAGE`

func (*EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) Set added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) String added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) String() string

String representation for fmt.Print

func (*EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) Type added in v0.70.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) Type() string

Type always returns EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType to satisfy [pflag.Value] interface

func (*EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) Values added in v0.72.0 

func (f *EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType) Values() []EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType

Values returns all possible values for EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType.

There is no guarantee on the order of the values in the slice.

type EgressResourceType added in v0.66.0 

type EgressResourceType string

The target resources that are supported by Network Connectivity Config. Note: some egress types can support general types that are not defined in EgressResourceType. E.g.: Azure private endpoint supports private link enabled Azure services. 

const EgressResourceTypeAzureBlobStorage EgressResourceType = `AZURE_BLOB_STORAGE`

func (*EgressResourceType) Set added in v0.66.0 

func (f *EgressResourceType) Set(v string) error

Set raw string value and validate it against allowed values

func (*EgressResourceType) String added in v0.66.0 

func (f *EgressResourceType) String() string

String representation for fmt.Print

func (*EgressResourceType) Type added in v0.66.0 

func (f *EgressResourceType) Type() string

Type always returns EgressResourceType to satisfy [pflag.Value] interface

func (*EgressResourceType) Values added in v0.72.0 

func (f *EgressResourceType) Values() []EgressResourceType

Values returns all possible values for EgressResourceType.

There is no guarantee on the order of the values in the slice.

type EmailConfig added in v0.44.0 

type EmailConfig struct {
	// Email addresses to notify.
	Addresses []string `json:"addresses,omitempty"`
}

type EnableExportNotebook added in v0.63.0 

type EnableExportNotebook struct {
	BooleanVal *BooleanMessage `json:"boolean_val,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (EnableExportNotebook) MarshalJSON added in v0.63.0 

func (s EnableExportNotebook) MarshalJSON() ([]byte, error)

func (*EnableExportNotebook) UnmarshalJSON added in v0.63.0 

func (s *EnableExportNotebook) UnmarshalJSON(b []byte) error

type EnableExportNotebookAPI added in v0.63.0 

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

Controls whether users can export notebooks and files from the Workspace UI. By default, this setting is enabled.

func NewEnableExportNotebook added in v0.63.0 

func NewEnableExportNotebook(client *client.DatabricksClient) *EnableExportNotebookAPI

func (*EnableExportNotebookAPI) GetEnableExportNotebook added in v0.63.0 

func (a *EnableExportNotebookAPI) GetEnableExportNotebook(ctx context.Context) (*EnableExportNotebook, error)

func (*EnableExportNotebookAPI) PatchEnableExportNotebook added in v0.63.0 

func (a *EnableExportNotebookAPI) PatchEnableExportNotebook(ctx context.Context, request UpdateEnableExportNotebookRequest) (*EnableExportNotebook, error)

type EnableExportNotebookInterface added in v0.63.0 

type EnableExportNotebookInterface interface {

	// Gets the Notebook and File exporting setting.
	GetEnableExportNotebook(ctx context.Context) (*EnableExportNotebook, error)

	// Updates the Notebook and File exporting setting. The model follows eventual
	// consistency, which means the get after the update operation might receive
	// stale values for some time.
	PatchEnableExportNotebook(ctx context.Context, request UpdateEnableExportNotebookRequest) (*EnableExportNotebook, error)
}

type EnableExportNotebookService deprecated added in v0.63.0 

type EnableExportNotebookService interface {

	// Gets the Notebook and File exporting setting.
	GetEnableExportNotebook(ctx context.Context) (*EnableExportNotebook, error)

	// Updates the Notebook and File exporting setting. The model follows
	// eventual consistency, which means the get after the update operation
	// might receive stale values for some time.
	PatchEnableExportNotebook(ctx context.Context, request UpdateEnableExportNotebookRequest) (*EnableExportNotebook, error)
}

Controls whether users can export notebooks and files from the Workspace UI. By default, this setting is enabled.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EnableIpAccessListsAPI added in v0.57.0 

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

Controls the enforcement of IP access lists for accessing the account console. Allowing you to enable or disable restricted access based on IP addresses.

func NewEnableIpAccessLists added in v0.57.0 

func NewEnableIpAccessLists(client *client.DatabricksClient) *EnableIpAccessListsAPI

func (*EnableIpAccessListsAPI) Delete added in v0.57.0 

func (a *EnableIpAccessListsAPI) Delete(ctx context.Context, request DeleteAccountIpAccessEnableRequest) (*DeleteAccountIpAccessEnableResponse, error)

func (*EnableIpAccessListsAPI) Get added in v0.57.0 

func (a *EnableIpAccessListsAPI) Get(ctx context.Context, request GetAccountIpAccessEnableRequest) (*AccountIpAccessEnable, error)

func (*EnableIpAccessListsAPI) Update added in v0.57.0 

func (a *EnableIpAccessListsAPI) Update(ctx context.Context, request UpdateAccountIpAccessEnableRequest) (*AccountIpAccessEnable, error)

type EnableIpAccessListsInterface added in v0.57.0 

type EnableIpAccessListsInterface interface {

	// Reverts the value of the account IP access toggle setting to default (ON)
	Delete(ctx context.Context, request DeleteAccountIpAccessEnableRequest) (*DeleteAccountIpAccessEnableResponse, error)

	// Gets the value of the account IP access toggle setting.
	Get(ctx context.Context, request GetAccountIpAccessEnableRequest) (*AccountIpAccessEnable, error)

	// Updates the value of the account IP access toggle setting.
	Update(ctx context.Context, request UpdateAccountIpAccessEnableRequest) (*AccountIpAccessEnable, error)
}

type EnableIpAccessListsService deprecated added in v0.57.0 

type EnableIpAccessListsService interface {

	// Reverts the value of the account IP access toggle setting to default (ON)
	Delete(ctx context.Context, request DeleteAccountIpAccessEnableRequest) (*DeleteAccountIpAccessEnableResponse, error)

	// Gets the value of the account IP access toggle setting.
	Get(ctx context.Context, request GetAccountIpAccessEnableRequest) (*AccountIpAccessEnable, error)

	// Updates the value of the account IP access toggle setting.
	Update(ctx context.Context, request UpdateAccountIpAccessEnableRequest) (*AccountIpAccessEnable, error)
}

Controls the enforcement of IP access lists for accessing the account console. Allowing you to enable or disable restricted access based on IP addresses.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EnableNotebookTableClipboard added in v0.63.0 

type EnableNotebookTableClipboard struct {
	BooleanVal *BooleanMessage `json:"boolean_val,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (EnableNotebookTableClipboard) MarshalJSON added in v0.63.0 

func (s EnableNotebookTableClipboard) MarshalJSON() ([]byte, error)

func (*EnableNotebookTableClipboard) UnmarshalJSON added in v0.63.0 

func (s *EnableNotebookTableClipboard) UnmarshalJSON(b []byte) error

type EnableNotebookTableClipboardAPI added in v0.63.0 

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

Controls whether users can copy tabular data to the clipboard via the UI. By default, this setting is enabled.

func NewEnableNotebookTableClipboard added in v0.63.0 

func NewEnableNotebookTableClipboard(client *client.DatabricksClient) *EnableNotebookTableClipboardAPI

func (*EnableNotebookTableClipboardAPI) GetEnableNotebookTableClipboard added in v0.63.0 

func (a *EnableNotebookTableClipboardAPI) GetEnableNotebookTableClipboard(ctx context.Context) (*EnableNotebookTableClipboard, error)

func (*EnableNotebookTableClipboardAPI) PatchEnableNotebookTableClipboard added in v0.63.0 

func (a *EnableNotebookTableClipboardAPI) PatchEnableNotebookTableClipboard(ctx context.Context, request UpdateEnableNotebookTableClipboardRequest) (*EnableNotebookTableClipboard, error)

type EnableNotebookTableClipboardInterface added in v0.63.0 

type EnableNotebookTableClipboardInterface interface {

	// Gets the Results Table Clipboard features setting.
	GetEnableNotebookTableClipboard(ctx context.Context) (*EnableNotebookTableClipboard, error)

	// Updates the Results Table Clipboard features setting. The model follows
	// eventual consistency, which means the get after the update operation might
	// receive stale values for some time.
	PatchEnableNotebookTableClipboard(ctx context.Context, request UpdateEnableNotebookTableClipboardRequest) (*EnableNotebookTableClipboard, error)
}

type EnableNotebookTableClipboardService deprecated added in v0.63.0 

type EnableNotebookTableClipboardService interface {

	// Gets the Results Table Clipboard features setting.
	GetEnableNotebookTableClipboard(ctx context.Context) (*EnableNotebookTableClipboard, error)

	// Updates the Results Table Clipboard features setting. The model follows
	// eventual consistency, which means the get after the update operation
	// might receive stale values for some time.
	PatchEnableNotebookTableClipboard(ctx context.Context, request UpdateEnableNotebookTableClipboardRequest) (*EnableNotebookTableClipboard, error)
}

Controls whether users can copy tabular data to the clipboard via the UI. By default, this setting is enabled.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EnableResultsDownloading added in v0.63.0 

type EnableResultsDownloading struct {
	BooleanVal *BooleanMessage `json:"boolean_val,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (EnableResultsDownloading) MarshalJSON added in v0.63.0 

func (s EnableResultsDownloading) MarshalJSON() ([]byte, error)

func (*EnableResultsDownloading) UnmarshalJSON added in v0.63.0 

func (s *EnableResultsDownloading) UnmarshalJSON(b []byte) error

type EnableResultsDownloadingAPI added in v0.63.0 

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

Controls whether users can download notebook results. By default, this setting is enabled.

func NewEnableResultsDownloading added in v0.63.0 

func NewEnableResultsDownloading(client *client.DatabricksClient) *EnableResultsDownloadingAPI

func (*EnableResultsDownloadingAPI) GetEnableResultsDownloading added in v0.63.0 

func (a *EnableResultsDownloadingAPI) GetEnableResultsDownloading(ctx context.Context) (*EnableResultsDownloading, error)

func (*EnableResultsDownloadingAPI) PatchEnableResultsDownloading added in v0.63.0 

func (a *EnableResultsDownloadingAPI) PatchEnableResultsDownloading(ctx context.Context, request UpdateEnableResultsDownloadingRequest) (*EnableResultsDownloading, error)

type EnableResultsDownloadingInterface added in v0.63.0 

type EnableResultsDownloadingInterface interface {

	// Gets the Notebook results download setting.
	GetEnableResultsDownloading(ctx context.Context) (*EnableResultsDownloading, error)

	// Updates the Notebook results download setting. The model follows eventual
	// consistency, which means the get after the update operation might receive
	// stale values for some time.
	PatchEnableResultsDownloading(ctx context.Context, request UpdateEnableResultsDownloadingRequest) (*EnableResultsDownloading, error)
}

type EnableResultsDownloadingService deprecated added in v0.63.0 

type EnableResultsDownloadingService interface {

	// Gets the Notebook results download setting.
	GetEnableResultsDownloading(ctx context.Context) (*EnableResultsDownloading, error)

	// Updates the Notebook results download setting. The model follows eventual
	// consistency, which means the get after the update operation might receive
	// stale values for some time.
	PatchEnableResultsDownloading(ctx context.Context, request UpdateEnableResultsDownloadingRequest) (*EnableResultsDownloading, error)
}

Controls whether users can download notebook results. By default, this setting is enabled.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EnhancedSecurityMonitoring added in v0.40.0 

type EnhancedSecurityMonitoring struct {
	IsEnabled bool `json:"is_enabled,omitempty"`

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

SHIELD feature: ESM

func (EnhancedSecurityMonitoring) MarshalJSON added in v0.40.0 

func (s EnhancedSecurityMonitoring) MarshalJSON() ([]byte, error)

func (*EnhancedSecurityMonitoring) UnmarshalJSON added in v0.40.0 

func (s *EnhancedSecurityMonitoring) UnmarshalJSON(b []byte) error

type EnhancedSecurityMonitoringAPI added in v0.40.0 

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

Controls whether enhanced security monitoring is enabled for the current workspace. If the compliance security profile is enabled, this is automatically enabled. By default, it is disabled. However, if the compliance security profile is enabled, this is automatically enabled.

If the compliance security profile is disabled, you can enable or disable this setting and it is not permanent.

func NewEnhancedSecurityMonitoring added in v0.40.0 

func NewEnhancedSecurityMonitoring(client *client.DatabricksClient) *EnhancedSecurityMonitoringAPI

func (*EnhancedSecurityMonitoringAPI) Get added in v0.40.0 

func (a *EnhancedSecurityMonitoringAPI) Get(ctx context.Context, request GetEnhancedSecurityMonitoringSettingRequest) (*EnhancedSecurityMonitoringSetting, error)

func (*EnhancedSecurityMonitoringAPI) Update added in v0.40.0 

func (a *EnhancedSecurityMonitoringAPI) Update(ctx context.Context, request UpdateEnhancedSecurityMonitoringSettingRequest) (*EnhancedSecurityMonitoringSetting, error)

type EnhancedSecurityMonitoringInterface added in v0.40.0 

type EnhancedSecurityMonitoringInterface interface {

	// Gets the enhanced security monitoring setting.
	Get(ctx context.Context, request GetEnhancedSecurityMonitoringSettingRequest) (*EnhancedSecurityMonitoringSetting, error)

	// Updates the enhanced security monitoring setting for the workspace. A fresh
	// etag needs to be provided in `PATCH` requests (as part of the setting field).
	// The etag can be retrieved by making a `GET` request before the `PATCH`
	// request. If the setting is updated concurrently, `PATCH` fails with 409 and
	// the request must be retried by using the fresh etag in the 409 response.
	Update(ctx context.Context, request UpdateEnhancedSecurityMonitoringSettingRequest) (*EnhancedSecurityMonitoringSetting, error)
}

type EnhancedSecurityMonitoringService deprecated added in v0.40.0 

type EnhancedSecurityMonitoringService interface {

	// Gets the enhanced security monitoring setting.
	Get(ctx context.Context, request GetEnhancedSecurityMonitoringSettingRequest) (*EnhancedSecurityMonitoringSetting, error)

	// Updates the enhanced security monitoring setting for the workspace. A
	// fresh etag needs to be provided in `PATCH` requests (as part of the
	// setting field). The etag can be retrieved by making a `GET` request
	// before the `PATCH` request. If the setting is updated concurrently,
	// `PATCH` fails with 409 and the request must be retried by using the fresh
	// etag in the 409 response.
	Update(ctx context.Context, request UpdateEnhancedSecurityMonitoringSettingRequest) (*EnhancedSecurityMonitoringSetting, error)
}

Controls whether enhanced security monitoring is enabled for the current workspace. If the compliance security profile is enabled, this is automatically enabled. By default, it is disabled. However, if the compliance security profile is enabled, this is automatically enabled.

If the compliance security profile is disabled, you can enable or disable this setting and it is not permanent.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EnhancedSecurityMonitoringSetting added in v0.40.0 

type EnhancedSecurityMonitoringSetting struct {
	EnhancedSecurityMonitoringWorkspace EnhancedSecurityMonitoring `json:"enhanced_security_monitoring_workspace"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (EnhancedSecurityMonitoringSetting) MarshalJSON added in v0.40.0 

func (s EnhancedSecurityMonitoringSetting) MarshalJSON() ([]byte, error)

func (*EnhancedSecurityMonitoringSetting) UnmarshalJSON added in v0.40.0 

func (s *EnhancedSecurityMonitoringSetting) UnmarshalJSON(b []byte) error

type EsmEnablementAccount added in v0.34.0 

type EsmEnablementAccount struct {
	IsEnforced bool `json:"is_enforced,omitempty"`

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

Account level policy for ESM

func (EsmEnablementAccount) MarshalJSON added in v0.34.0 

func (s EsmEnablementAccount) MarshalJSON() ([]byte, error)

func (*EsmEnablementAccount) UnmarshalJSON added in v0.34.0 

func (s *EsmEnablementAccount) UnmarshalJSON(b []byte) error

type EsmEnablementAccountAPI added in v0.34.0 

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

The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces. By default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable enhanced security monitoring individually for each workspace.

func NewEsmEnablementAccount added in v0.34.0 

func NewEsmEnablementAccount(client *client.DatabricksClient) *EsmEnablementAccountAPI

func (*EsmEnablementAccountAPI) Get added in v0.34.0 

func (a *EsmEnablementAccountAPI) Get(ctx context.Context, request GetEsmEnablementAccountSettingRequest) (*EsmEnablementAccountSetting, error)

func (*EsmEnablementAccountAPI) Update added in v0.34.0 

func (a *EsmEnablementAccountAPI) Update(ctx context.Context, request UpdateEsmEnablementAccountSettingRequest) (*EsmEnablementAccountSetting, error)

type EsmEnablementAccountInterface added in v0.34.0 

type EsmEnablementAccountInterface interface {

	// Gets the enhanced security monitoring setting for new workspaces.
	Get(ctx context.Context, request GetEsmEnablementAccountSettingRequest) (*EsmEnablementAccountSetting, error)

	// Updates the value of the enhanced security monitoring setting for new
	// workspaces.
	Update(ctx context.Context, request UpdateEsmEnablementAccountSettingRequest) (*EsmEnablementAccountSetting, error)
}

type EsmEnablementAccountService deprecated added in v0.34.0 

type EsmEnablementAccountService interface {

	// Gets the enhanced security monitoring setting for new workspaces.
	Get(ctx context.Context, request GetEsmEnablementAccountSettingRequest) (*EsmEnablementAccountSetting, error)

	// Updates the value of the enhanced security monitoring setting for new
	// workspaces.
	Update(ctx context.Context, request UpdateEsmEnablementAccountSettingRequest) (*EsmEnablementAccountSetting, error)
}

The enhanced security monitoring setting at the account level controls whether to enable the feature on new workspaces. By default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable enhanced security monitoring individually for each workspace.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type EsmEnablementAccountSetting added in v0.34.0 

type EsmEnablementAccountSetting struct {
	EsmEnablementAccount EsmEnablementAccount `json:"esm_enablement_account"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (EsmEnablementAccountSetting) MarshalJSON added in v0.34.0 

func (s EsmEnablementAccountSetting) MarshalJSON() ([]byte, error)

func (*EsmEnablementAccountSetting) UnmarshalJSON added in v0.34.0 

func (s *EsmEnablementAccountSetting) UnmarshalJSON(b []byte) error

type ExchangeToken added in v0.20.0 

type ExchangeToken struct {
	// The requested token.
	Credential string `json:"credential,omitempty"`
	// The end-of-life timestamp of the token. The value is in milliseconds
	// since the Unix epoch.
	CredentialEolTime int64 `json:"credentialEolTime,omitempty"`
	// User ID of the user that owns this token.
	OwnerId int64 `json:"ownerId,omitempty"`
	// The scopes of access granted in the token.
	Scopes []string `json:"scopes,omitempty"`
	// The type of this exchange token
	TokenType TokenType `json:"tokenType,omitempty"`

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

The exchange token is the result of the token exchange with the IdP

func (ExchangeToken) MarshalJSON added in v0.23.0 

func (s ExchangeToken) MarshalJSON() ([]byte, error)

func (*ExchangeToken) UnmarshalJSON added in v0.23.0 

func (s *ExchangeToken) UnmarshalJSON(b []byte) error

type ExchangeTokenRequest added in v0.20.0 

type ExchangeTokenRequest struct {
	// The partition of Credentials store
	PartitionId PartitionId `json:"partitionId"`
	// Array of scopes for the token request.
	Scopes []string `json:"scopes"`
	// A list of token types being requested
	TokenType []TokenType `json:"tokenType"`
}

Exchange a token with the IdP

type ExchangeTokenResponse added in v0.20.0 

type ExchangeTokenResponse struct {
	Values []ExchangeToken `json:"values,omitempty"`
}

Exhanged tokens were successfully returned.

type FetchIpAccessListResponse 

type FetchIpAccessListResponse struct {
	IpAccessList *IpAccessListInfo `json:"ip_access_list,omitempty"`
}

An IP access list was successfully returned.

type GenericWebhookConfig added in v0.44.0 

type GenericWebhookConfig struct {
	// [Input-Only][Optional] Password for webhook.
	Password string `json:"password,omitempty"`
	// [Output-Only] Whether password is set.
	PasswordSet bool `json:"password_set,omitempty"`
	// [Input-Only] URL for webhook.
	Url string `json:"url,omitempty"`
	// [Output-Only] Whether URL is set.
	UrlSet bool `json:"url_set,omitempty"`
	// [Input-Only][Optional] Username for webhook.
	Username string `json:"username,omitempty"`
	// [Output-Only] Whether username is set.
	UsernameSet bool `json:"username_set,omitempty"`

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

func (GenericWebhookConfig) MarshalJSON added in v0.44.0 

func (s GenericWebhookConfig) MarshalJSON() ([]byte, error)

func (*GenericWebhookConfig) UnmarshalJSON added in v0.44.0 

func (s *GenericWebhookConfig) UnmarshalJSON(b []byte) error

type GetAccountIpAccessEnableRequest added in v0.57.0 

type GetAccountIpAccessEnableRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetAccountIpAccessEnableRequest) MarshalJSON added in v0.57.0 

func (s GetAccountIpAccessEnableRequest) MarshalJSON() ([]byte, error)

func (*GetAccountIpAccessEnableRequest) UnmarshalJSON added in v0.57.0 

func (s *GetAccountIpAccessEnableRequest) UnmarshalJSON(b []byte) error

type GetAccountIpAccessListRequest 

type GetAccountIpAccessListRequest struct {
	// The ID for the corresponding IP access list
	IpAccessListId string `json:"-" url:"-"`
}

type GetAibiDashboardEmbeddingAccessPolicySettingRequest added in v0.50.0 

type GetAibiDashboardEmbeddingAccessPolicySettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetAibiDashboardEmbeddingAccessPolicySettingRequest) MarshalJSON added in v0.50.0 

func (s GetAibiDashboardEmbeddingAccessPolicySettingRequest) MarshalJSON() ([]byte, error)

func (*GetAibiDashboardEmbeddingAccessPolicySettingRequest) UnmarshalJSON added in v0.50.0 

func (s *GetAibiDashboardEmbeddingAccessPolicySettingRequest) UnmarshalJSON(b []byte) error

type GetAibiDashboardEmbeddingApprovedDomainsSettingRequest added in v0.50.0 

type GetAibiDashboardEmbeddingApprovedDomainsSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) MarshalJSON added in v0.50.0 

func (s GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) MarshalJSON() ([]byte, error)

func (*GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) UnmarshalJSON added in v0.50.0 

func (s *GetAibiDashboardEmbeddingApprovedDomainsSettingRequest) UnmarshalJSON(b []byte) error

type GetAutomaticClusterUpdateSettingRequest added in v0.36.0 

type GetAutomaticClusterUpdateSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetAutomaticClusterUpdateSettingRequest) MarshalJSON added in v0.36.0 

func (s GetAutomaticClusterUpdateSettingRequest) MarshalJSON() ([]byte, error)

func (*GetAutomaticClusterUpdateSettingRequest) UnmarshalJSON added in v0.36.0 

func (s *GetAutomaticClusterUpdateSettingRequest) UnmarshalJSON(b []byte) error

type GetComplianceSecurityProfileSettingRequest added in v0.40.0 

type GetComplianceSecurityProfileSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetComplianceSecurityProfileSettingRequest) MarshalJSON added in v0.40.0 

func (s GetComplianceSecurityProfileSettingRequest) MarshalJSON() ([]byte, error)

func (*GetComplianceSecurityProfileSettingRequest) UnmarshalJSON added in v0.40.0 

func (s *GetComplianceSecurityProfileSettingRequest) UnmarshalJSON(b []byte) error

type GetCspEnablementAccountSettingRequest added in v0.36.0 

type GetCspEnablementAccountSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetCspEnablementAccountSettingRequest) MarshalJSON added in v0.36.0 

func (s GetCspEnablementAccountSettingRequest) MarshalJSON() ([]byte, error)

func (*GetCspEnablementAccountSettingRequest) UnmarshalJSON added in v0.36.0 

func (s *GetCspEnablementAccountSettingRequest) UnmarshalJSON(b []byte) error

type GetDashboardEmailSubscriptionsRequest added in v0.72.0 

type GetDashboardEmailSubscriptionsRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetDashboardEmailSubscriptionsRequest) MarshalJSON added in v0.72.0 

func (s GetDashboardEmailSubscriptionsRequest) MarshalJSON() ([]byte, error)

func (*GetDashboardEmailSubscriptionsRequest) UnmarshalJSON added in v0.72.0 

func (s *GetDashboardEmailSubscriptionsRequest) UnmarshalJSON(b []byte) error

type GetDefaultNamespaceSettingRequest added in v0.31.0 

type GetDefaultNamespaceSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetDefaultNamespaceSettingRequest) MarshalJSON added in v0.31.0 

func (s GetDefaultNamespaceSettingRequest) MarshalJSON() ([]byte, error)

func (*GetDefaultNamespaceSettingRequest) UnmarshalJSON added in v0.31.0 

func (s *GetDefaultNamespaceSettingRequest) UnmarshalJSON(b []byte) error

type GetDefaultWarehouseIdRequest added in v0.75.0 

type GetDefaultWarehouseIdRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetDefaultWarehouseIdRequest) MarshalJSON added in v0.75.0 

func (s GetDefaultWarehouseIdRequest) MarshalJSON() ([]byte, error)

func (*GetDefaultWarehouseIdRequest) UnmarshalJSON added in v0.75.0 

func (s *GetDefaultWarehouseIdRequest) UnmarshalJSON(b []byte) error

type GetDisableLegacyAccessRequest added in v0.47.0 

type GetDisableLegacyAccessRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetDisableLegacyAccessRequest) MarshalJSON added in v0.47.0 

func (s GetDisableLegacyAccessRequest) MarshalJSON() ([]byte, error)

func (*GetDisableLegacyAccessRequest) UnmarshalJSON added in v0.47.0 

func (s *GetDisableLegacyAccessRequest) UnmarshalJSON(b []byte) error

type GetDisableLegacyDbfsRequest added in v0.49.0 

type GetDisableLegacyDbfsRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetDisableLegacyDbfsRequest) MarshalJSON added in v0.49.0 

func (s GetDisableLegacyDbfsRequest) MarshalJSON() ([]byte, error)

func (*GetDisableLegacyDbfsRequest) UnmarshalJSON added in v0.49.0 

func (s *GetDisableLegacyDbfsRequest) UnmarshalJSON(b []byte) error

type GetDisableLegacyFeaturesRequest added in v0.47.0 

type GetDisableLegacyFeaturesRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetDisableLegacyFeaturesRequest) MarshalJSON added in v0.47.0 

func (s GetDisableLegacyFeaturesRequest) MarshalJSON() ([]byte, error)

func (*GetDisableLegacyFeaturesRequest) UnmarshalJSON added in v0.47.0 

func (s *GetDisableLegacyFeaturesRequest) UnmarshalJSON(b []byte) error

type GetEnhancedSecurityMonitoringSettingRequest added in v0.40.0 

type GetEnhancedSecurityMonitoringSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetEnhancedSecurityMonitoringSettingRequest) MarshalJSON added in v0.40.0 

func (s GetEnhancedSecurityMonitoringSettingRequest) MarshalJSON() ([]byte, error)

func (*GetEnhancedSecurityMonitoringSettingRequest) UnmarshalJSON added in v0.40.0 

func (s *GetEnhancedSecurityMonitoringSettingRequest) UnmarshalJSON(b []byte) error

type GetEsmEnablementAccountSettingRequest added in v0.36.0 

type GetEsmEnablementAccountSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetEsmEnablementAccountSettingRequest) MarshalJSON added in v0.36.0 

func (s GetEsmEnablementAccountSettingRequest) MarshalJSON() ([]byte, error)

func (*GetEsmEnablementAccountSettingRequest) UnmarshalJSON added in v0.36.0 

func (s *GetEsmEnablementAccountSettingRequest) UnmarshalJSON(b []byte) error

type GetIpAccessListRequest 

type GetIpAccessListRequest struct {
	// The ID for the corresponding IP access list
	IpAccessListId string `json:"-" url:"-"`
}

type GetIpAccessListResponse 

type GetIpAccessListResponse struct {
	IpAccessList *IpAccessListInfo `json:"ip_access_list,omitempty"`
}

type GetIpAccessListsResponse 

type GetIpAccessListsResponse struct {
	IpAccessLists []IpAccessListInfo `json:"ip_access_lists,omitempty"`
}

IP access lists were successfully returned.

type GetLlmProxyPartnerPoweredAccountRequest added in v0.69.0 

type GetLlmProxyPartnerPoweredAccountRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetLlmProxyPartnerPoweredAccountRequest) MarshalJSON added in v0.69.0 

func (s GetLlmProxyPartnerPoweredAccountRequest) MarshalJSON() ([]byte, error)

func (*GetLlmProxyPartnerPoweredAccountRequest) UnmarshalJSON added in v0.69.0 

func (s *GetLlmProxyPartnerPoweredAccountRequest) UnmarshalJSON(b []byte) error

type GetLlmProxyPartnerPoweredEnforceRequest added in v0.69.0 

type GetLlmProxyPartnerPoweredEnforceRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetLlmProxyPartnerPoweredEnforceRequest) MarshalJSON added in v0.69.0 

func (s GetLlmProxyPartnerPoweredEnforceRequest) MarshalJSON() ([]byte, error)

func (*GetLlmProxyPartnerPoweredEnforceRequest) UnmarshalJSON added in v0.69.0 

func (s *GetLlmProxyPartnerPoweredEnforceRequest) UnmarshalJSON(b []byte) error

type GetLlmProxyPartnerPoweredWorkspaceRequest added in v0.69.0 

type GetLlmProxyPartnerPoweredWorkspaceRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetLlmProxyPartnerPoweredWorkspaceRequest) MarshalJSON added in v0.69.0 

func (s GetLlmProxyPartnerPoweredWorkspaceRequest) MarshalJSON() ([]byte, error)

func (*GetLlmProxyPartnerPoweredWorkspaceRequest) UnmarshalJSON added in v0.69.0 

func (s *GetLlmProxyPartnerPoweredWorkspaceRequest) UnmarshalJSON(b []byte) error

type GetNetworkConnectivityConfigurationRequest added in v0.25.0 

type GetNetworkConnectivityConfigurationRequest struct {
	// Your Network Connectivity Configuration ID.
	NetworkConnectivityConfigId string `json:"-" url:"-"`
}

type GetNetworkPolicyRequest added in v0.70.0 

type GetNetworkPolicyRequest struct {
	// The unique identifier of the network policy to retrieve.
	NetworkPolicyId string `json:"-" url:"-"`
}

type GetNotificationDestinationRequest added in v0.44.0 

type GetNotificationDestinationRequest struct {
	Id string `json:"-" url:"-"`
}

type GetPersonalComputeSettingRequest added in v0.31.0 

type GetPersonalComputeSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetPersonalComputeSettingRequest) MarshalJSON added in v0.31.0 

func (s GetPersonalComputeSettingRequest) MarshalJSON() ([]byte, error)

func (*GetPersonalComputeSettingRequest) UnmarshalJSON added in v0.31.0 

func (s *GetPersonalComputeSettingRequest) UnmarshalJSON(b []byte) error

type GetPrivateEndpointRuleRequest added in v0.25.0 

type GetPrivateEndpointRuleRequest struct {
	// Your Network Connectvity Configuration ID.
	NetworkConnectivityConfigId string `json:"-" url:"-"`
	// Your private endpoint rule ID.
	PrivateEndpointRuleId string `json:"-" url:"-"`
}

type GetRestrictWorkspaceAdminsSettingRequest added in v0.31.0 

type GetRestrictWorkspaceAdminsSettingRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetRestrictWorkspaceAdminsSettingRequest) MarshalJSON added in v0.31.0 

func (s GetRestrictWorkspaceAdminsSettingRequest) MarshalJSON() ([]byte, error)

func (*GetRestrictWorkspaceAdminsSettingRequest) UnmarshalJSON added in v0.31.0 

func (s *GetRestrictWorkspaceAdminsSettingRequest) UnmarshalJSON(b []byte) error

type GetSqlResultsDownloadRequest added in v0.72.0 

type GetSqlResultsDownloadRequest struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// delete pattern to perform setting deletions in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// DELETE request to identify the rule set version you are deleting.
	Etag string `json:"-" url:"etag,omitempty"`

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

func (GetSqlResultsDownloadRequest) MarshalJSON added in v0.72.0 

func (s GetSqlResultsDownloadRequest) MarshalJSON() ([]byte, error)

func (*GetSqlResultsDownloadRequest) UnmarshalJSON added in v0.72.0 

func (s *GetSqlResultsDownloadRequest) UnmarshalJSON(b []byte) error

type GetStatusRequest 

type GetStatusRequest struct {
	Keys string `json:"-" url:"keys"`
}

type GetTokenManagementRequest 

type GetTokenManagementRequest struct {
	// The ID of the token to get.
	TokenId string `json:"-" url:"-"`
}

type GetTokenPermissionLevelsResponse added in v0.15.0 

type GetTokenPermissionLevelsResponse struct {
	// Specific permission levels
	PermissionLevels []TokenPermissionsDescription `json:"permission_levels,omitempty"`
}

type GetTokenResponse added in v0.30.0 

type GetTokenResponse struct {
	TokenInfo *TokenInfo `json:"token_info,omitempty"`
}

Token with specified Token ID was successfully returned.

type GetWorkspaceNetworkOptionRequest added in v0.70.0 

type GetWorkspaceNetworkOptionRequest struct {
	// The workspace ID.
	WorkspaceId int64 `json:"-" url:"-"`
}

type IpAccessListInfo 

type IpAccessListInfo struct {
	// Total number of IP or CIDR values.
	AddressCount int `json:"address_count,omitempty"`
	// Creation timestamp in milliseconds.
	CreatedAt int64 `json:"created_at,omitempty"`
	// User ID of the user who created this list.
	CreatedBy int64 `json:"created_by,omitempty"`
	// Specifies whether this IP access list is enabled.
	Enabled bool `json:"enabled,omitempty"`

	IpAddresses []string `json:"ip_addresses,omitempty"`
	// Label for the IP access list. This **cannot** be empty.
	Label string `json:"label,omitempty"`
	// Universally unique identifier (UUID) of the IP access list.
	ListId string `json:"list_id,omitempty"`

	ListType ListType `json:"list_type,omitempty"`
	// Update timestamp in milliseconds.
	UpdatedAt int64 `json:"updated_at,omitempty"`
	// User ID of the user who updated this list.
	UpdatedBy int64 `json:"updated_by,omitempty"`

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

Definition of an IP Access list

func (IpAccessListInfo) MarshalJSON added in v0.23.0 

func (s IpAccessListInfo) MarshalJSON() ([]byte, error)

func (*IpAccessListInfo) UnmarshalJSON added in v0.23.0 

func (s *IpAccessListInfo) UnmarshalJSON(b []byte) error

type IpAccessListsAPI 

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

IP Access List enables admins to configure IP access lists.

IP access lists affect web application access and REST API access to this workspace only. If the feature is disabled for a workspace, all access is allowed for this workspace. There is support for allow lists (inclusion) and block lists (exclusion).

When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists.

If there is at least one allow list for the workspace, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the workspace, all IP addresses are allowed.

For all allow lists and block lists combined, the workspace supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.

After changes to the IP access list feature, it can take a few minutes for changes to take effect.

func NewIpAccessLists 

func NewIpAccessLists(client *client.DatabricksClient) *IpAccessListsAPI

func (*IpAccessListsAPI) Create 

func (a *IpAccessListsAPI) Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error)
Example (IpAccessLists) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

created, err := w.IpAccessLists.Create(ctx, settings.CreateIpAccessList{
	Label:       fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	IpAddresses: []string{"1.0.0.0/16"},
	ListType:    settings.ListTypeBlock,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", created)

// cleanup

err = w.IpAccessLists.DeleteByIpAccessListId(ctx, created.IpAccessList.ListId)
if err != nil {
	panic(err)
}

func (*IpAccessListsAPI) Delete 

func (a *IpAccessListsAPI) Delete(ctx context.Context, request DeleteIpAccessListRequest) error

func (*IpAccessListsAPI) DeleteByIpAccessListId 

func (a *IpAccessListsAPI) DeleteByIpAccessListId(ctx context.Context, ipAccessListId string) error

Deletes an IP access list, specified by its list ID.

func (*IpAccessListsAPI) Get 

func (a *IpAccessListsAPI) Get(ctx context.Context, request GetIpAccessListRequest) (*FetchIpAccessListResponse, error)
Example (IpAccessLists) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

created, err := w.IpAccessLists.Create(ctx, settings.CreateIpAccessList{
	Label:       fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	IpAddresses: []string{"1.0.0.0/16"},
	ListType:    settings.ListTypeBlock,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", created)

byId, err := w.IpAccessLists.GetByIpAccessListId(ctx, created.IpAccessList.ListId)
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", byId)

// cleanup

err = w.IpAccessLists.DeleteByIpAccessListId(ctx, created.IpAccessList.ListId)
if err != nil {
	panic(err)
}

func (*IpAccessListsAPI) GetByIpAccessListId 

func (a *IpAccessListsAPI) GetByIpAccessListId(ctx context.Context, ipAccessListId string) (*FetchIpAccessListResponse, error)

Gets an IP access list, specified by its list ID.

func (*IpAccessListsAPI) GetByLabel 

func (a *IpAccessListsAPI) GetByLabel(ctx context.Context, name string) (*IpAccessListInfo, error)

GetByLabel calls IpAccessListsAPI.IpAccessListInfoLabelToListIdMap and returns a single IpAccessListInfo.

Returns an error if there's more than one IpAccessListInfo with the same .Label.

Note: All IpAccessListInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*IpAccessListsAPI) IpAccessListInfoLabelToListIdMap 

func (a *IpAccessListsAPI) IpAccessListInfoLabelToListIdMap(ctx context.Context) (map[string]string, error)

IpAccessListInfoLabelToListIdMap calls IpAccessListsAPI.ListAll and creates a map of results with IpAccessListInfo.Label as key and IpAccessListInfo.ListId as value.

Returns an error if there's more than one IpAccessListInfo with the same .Label.

Note: All IpAccessListInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*IpAccessListsAPI) List added in v0.24.0 

func (a *IpAccessListsAPI) List(ctx context.Context) listing.Iterator[IpAccessListInfo]

Gets all IP access lists for the specified workspace.

Example (IpAccessLists) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

all, err := w.IpAccessLists.ListAll(ctx)
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", all)

func (*IpAccessListsAPI) ListAll 

func (a *IpAccessListsAPI) ListAll(ctx context.Context) ([]IpAccessListInfo, error)

Gets all IP access lists for the specified workspace.

func (*IpAccessListsAPI) Replace 

func (a *IpAccessListsAPI) Replace(ctx context.Context, request ReplaceIpAccessList) error
Example (IpAccessLists) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

created, err := w.IpAccessLists.Create(ctx, settings.CreateIpAccessList{
	Label:       fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	IpAddresses: []string{"1.0.0.0/16"},
	ListType:    settings.ListTypeBlock,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", created)

err = w.IpAccessLists.Replace(ctx, settings.ReplaceIpAccessList{
	IpAccessListId: created.IpAccessList.ListId,
	Label:          fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	IpAddresses:    []string{"1.0.0.0/24"},
	ListType:       settings.ListTypeBlock,
	Enabled:        false,
})
if err != nil {
	panic(err)
}

// cleanup

err = w.IpAccessLists.DeleteByIpAccessListId(ctx, created.IpAccessList.ListId)
if err != nil {
	panic(err)
}

func (*IpAccessListsAPI) Update 

func (a *IpAccessListsAPI) Update(ctx context.Context, request UpdateIpAccessList) error

type IpAccessListsInterface added in v0.29.0 

type IpAccessListsInterface interface {

	// Creates an IP access list for this workspace.
	//
	// A list can be an allow list or a block list. See the top of this file for a
	// description of how the server treats allow lists and block lists at runtime.
	//
	// When creating or updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a maximum of
	// 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to
	// exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
	// * If the new list would block the calling user's current IP, error 400 is
	// returned with `error_code` value `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect. **Note**: Your new
	// IP access list has no effect until you enable the feature. See
	// :method:workspaceconf/setStatus
	Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error)

	// Deletes an IP access list, specified by its list ID.
	Delete(ctx context.Context, request DeleteIpAccessListRequest) error

	// Deletes an IP access list, specified by its list ID.
	DeleteByIpAccessListId(ctx context.Context, ipAccessListId string) error

	// Gets an IP access list, specified by its list ID.
	Get(ctx context.Context, request GetIpAccessListRequest) (*FetchIpAccessListResponse, error)

	// Gets an IP access list, specified by its list ID.
	GetByIpAccessListId(ctx context.Context, ipAccessListId string) (*FetchIpAccessListResponse, error)

	// Gets all IP access lists for the specified workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context) listing.Iterator[IpAccessListInfo]

	// Gets all IP access lists for the specified workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context) ([]IpAccessListInfo, error)

	// IpAccessListInfoLabelToListIdMap calls [IpAccessListsAPI.ListAll] and creates a map of results with [IpAccessListInfo].Label as key and [IpAccessListInfo].ListId as value.
	//
	// Returns an error if there's more than one [IpAccessListInfo] with the same .Label.
	//
	// Note: All [IpAccessListInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	IpAccessListInfoLabelToListIdMap(ctx context.Context) (map[string]string, error)

	// GetByLabel calls [IpAccessListsAPI.IpAccessListInfoLabelToListIdMap] and returns a single [IpAccessListInfo].
	//
	// Returns an error if there's more than one [IpAccessListInfo] with the same .Label.
	//
	// Note: All [IpAccessListInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByLabel(ctx context.Context, name string) (*IpAccessListInfo, error)

	// Replaces an IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file for
	// a description of how the server treats allow lists and block lists at run
	// time. When replacing an IP access list: * For all allow lists and block lists
	// combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR
	// counts as a single value. Attempts to exceed that number return error 400
	// with `error_code` value `QUOTA_EXCEEDED`. * If the resulting list would block
	// the calling user's current IP, error 400 is returned with `error_code` value
	// `INVALID_STATE`. It can take a few minutes for the changes to take effect.
	// Note that your resulting IP access list has no effect until you enable the
	// feature. See :method:workspaceconf/setStatus.
	Replace(ctx context.Context, request ReplaceIpAccessList) error

	// Updates an existing IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file for
	// a description of how the server treats allow lists and block lists at run
	// time.
	//
	// When updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a maximum of
	// 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to
	// exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`.
	// * If the updated list would block the calling user's current IP, error 400 is
	// returned with `error_code` value `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect. Note that your
	// resulting IP access list has no effect until you enable the feature. See
	// :method:workspaceconf/setStatus.
	Update(ctx context.Context, request UpdateIpAccessList) error
}

type IpAccessListsService deprecated 

type IpAccessListsService interface {

	// Creates an IP access list for this workspace.
	//
	// A list can be an allow list or a block list. See the top of this file for
	// a description of how the server treats allow lists and block lists at
	// runtime.
	//
	// When creating or updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a
	// maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.
	// Attempts to exceed that number return error 400 with `error_code` value
	// `QUOTA_EXCEEDED`. * If the new list would block the calling user's
	// current IP, error 400 is returned with `error_code` value
	// `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect. **Note**: Your
	// new IP access list has no effect until you enable the feature. See
	// :method:workspaceconf/setStatus
	Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error)

	// Deletes an IP access list, specified by its list ID.
	Delete(ctx context.Context, request DeleteIpAccessListRequest) error

	// Gets an IP access list, specified by its list ID.
	Get(ctx context.Context, request GetIpAccessListRequest) (*FetchIpAccessListResponse, error)

	// Gets all IP access lists for the specified workspace.
	List(ctx context.Context) (*ListIpAccessListResponse, error)

	// Replaces an IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file
	// for a description of how the server treats allow lists and block lists at
	// run time. When replacing an IP access list: * For all allow lists and
	// block lists combined, the API supports a maximum of 1000 IP/CIDR values,
	// where one CIDR counts as a single value. Attempts to exceed that number
	// return error 400 with `error_code` value `QUOTA_EXCEEDED`. * If the
	// resulting list would block the calling user's current IP, error 400 is
	// returned with `error_code` value `INVALID_STATE`. It can take a few
	// minutes for the changes to take effect. Note that your resulting IP
	// access list has no effect until you enable the feature. See
	// :method:workspaceconf/setStatus.
	Replace(ctx context.Context, request ReplaceIpAccessList) error

	// Updates an existing IP access list, specified by its ID.
	//
	// A list can include allow lists and block lists. See the top of this file
	// for a description of how the server treats allow lists and block lists at
	// run time.
	//
	// When updating an IP access list:
	//
	// * For all allow lists and block lists combined, the API supports a
	// maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.
	// Attempts to exceed that number return error 400 with `error_code` value
	// `QUOTA_EXCEEDED`. * If the updated list would block the calling user's
	// current IP, error 400 is returned with `error_code` value
	// `INVALID_STATE`.
	//
	// It can take a few minutes for the changes to take effect. Note that your
	// resulting IP access list has no effect until you enable the feature. See
	// :method:workspaceconf/setStatus.
	Update(ctx context.Context, request UpdateIpAccessList) error
}

IP Access List enables admins to configure IP access lists.

IP access lists affect web application access and REST API access to this workspace only. If the feature is disabled for a workspace, all access is allowed for this workspace. There is support for allow lists (inclusion) and block lists (exclusion).

When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists.

If there is at least one allow list for the workspace, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the workspace, all IP addresses are allowed.

For all allow lists and block lists combined, the workspace supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.

After changes to the IP access list feature, it can take a few minutes for changes to take effect.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type ListIpAccessListResponse added in v0.23.0 

type ListIpAccessListResponse struct {
	IpAccessLists []IpAccessListInfo `json:"ip_access_lists,omitempty"`
}

IP access lists were successfully returned.

type ListNetworkConnectivityConfigurationsRequest added in v0.26.0 

type ListNetworkConnectivityConfigurationsRequest struct {
	// Pagination token to go to next page based on previous query.
	PageToken string `json:"-" url:"page_token,omitempty"`

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

func (ListNetworkConnectivityConfigurationsRequest) MarshalJSON added in v0.26.0 

func (s ListNetworkConnectivityConfigurationsRequest) MarshalJSON() ([]byte, error)

func (*ListNetworkConnectivityConfigurationsRequest) UnmarshalJSON added in v0.26.0 

func (s *ListNetworkConnectivityConfigurationsRequest) UnmarshalJSON(b []byte) error

type ListNetworkConnectivityConfigurationsResponse added in v0.26.0 

type ListNetworkConnectivityConfigurationsResponse struct {
	Items []NetworkConnectivityConfiguration `json:"items,omitempty"`
	// A token that can be used to get the next page of results. If null, there
	// are no more results to show.
	NextPageToken string `json:"next_page_token,omitempty"`

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

The network connectivity configuration list was successfully retrieved.

func (ListNetworkConnectivityConfigurationsResponse) MarshalJSON added in v0.26.0 

func (s ListNetworkConnectivityConfigurationsResponse) MarshalJSON() ([]byte, error)

func (*ListNetworkConnectivityConfigurationsResponse) UnmarshalJSON added in v0.26.0 

func (s *ListNetworkConnectivityConfigurationsResponse) UnmarshalJSON(b []byte) error

type ListNetworkPoliciesRequest added in v0.70.0 

type ListNetworkPoliciesRequest struct {
	// Pagination token to go to next page based on previous query.
	PageToken string `json:"-" url:"page_token,omitempty"`

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

func (ListNetworkPoliciesRequest) MarshalJSON added in v0.70.0 

func (s ListNetworkPoliciesRequest) MarshalJSON() ([]byte, error)

func (*ListNetworkPoliciesRequest) UnmarshalJSON added in v0.70.0 

func (s *ListNetworkPoliciesRequest) UnmarshalJSON(b []byte) error

type ListNetworkPoliciesResponse added in v0.70.0 

type ListNetworkPoliciesResponse struct {
	// List of network policies.
	Items []AccountNetworkPolicy `json:"items,omitempty"`
	// A token that can be used to get the next page of results. If null, there
	// are no more results to show.
	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListNetworkPoliciesResponse) MarshalJSON added in v0.70.0 

func (s ListNetworkPoliciesResponse) MarshalJSON() ([]byte, error)

func (*ListNetworkPoliciesResponse) UnmarshalJSON added in v0.70.0 

func (s *ListNetworkPoliciesResponse) UnmarshalJSON(b []byte) error

type ListNotificationDestinationsRequest added in v0.44.0 

type ListNotificationDestinationsRequest struct {
	PageSize int64 `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

func (ListNotificationDestinationsRequest) MarshalJSON added in v0.44.0 

func (s ListNotificationDestinationsRequest) MarshalJSON() ([]byte, error)

func (*ListNotificationDestinationsRequest) UnmarshalJSON added in v0.44.0 

func (s *ListNotificationDestinationsRequest) UnmarshalJSON(b []byte) error

type ListNotificationDestinationsResponse added in v0.44.0 

type ListNotificationDestinationsResponse struct {
	// Page token for next of results.
	NextPageToken string `json:"next_page_token,omitempty"`

	Results []ListNotificationDestinationsResult `json:"results,omitempty"`

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

func (ListNotificationDestinationsResponse) MarshalJSON added in v0.44.0 

func (s ListNotificationDestinationsResponse) MarshalJSON() ([]byte, error)

func (*ListNotificationDestinationsResponse) UnmarshalJSON added in v0.44.0 

func (s *ListNotificationDestinationsResponse) UnmarshalJSON(b []byte) error

type ListNotificationDestinationsResult added in v0.44.0 

type ListNotificationDestinationsResult struct {
	// [Output-only] The type of the notification destination. The type can not
	// be changed once set.
	DestinationType DestinationType `json:"destination_type,omitempty"`
	// The display name for the notification destination.
	DisplayName string `json:"display_name,omitempty"`
	// UUID identifying notification destination.
	Id string `json:"id,omitempty"`

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

func (ListNotificationDestinationsResult) MarshalJSON added in v0.44.0 

func (s ListNotificationDestinationsResult) MarshalJSON() ([]byte, error)

func (*ListNotificationDestinationsResult) UnmarshalJSON added in v0.44.0 

func (s *ListNotificationDestinationsResult) UnmarshalJSON(b []byte) error

type ListPrivateEndpointRulesRequest added in v0.26.0 

type ListPrivateEndpointRulesRequest struct {
	// Your Network Connectvity Configuration ID.
	NetworkConnectivityConfigId string `json:"-" url:"-"`
	// Pagination token to go to next page based on previous query.
	PageToken string `json:"-" url:"page_token,omitempty"`

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

func (ListPrivateEndpointRulesRequest) MarshalJSON added in v0.26.0 

func (s ListPrivateEndpointRulesRequest) MarshalJSON() ([]byte, error)

func (*ListPrivateEndpointRulesRequest) UnmarshalJSON added in v0.26.0 

func (s *ListPrivateEndpointRulesRequest) UnmarshalJSON(b []byte) error

type ListPrivateEndpointRulesResponse added in v0.72.0 

type ListPrivateEndpointRulesResponse struct {
	Items []NccPrivateEndpointRule `json:"items,omitempty"`
	// A token that can be used to get the next page of results. If null, there
	// are no more results to show.
	NextPageToken string `json:"next_page_token,omitempty"`

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

The private endpoint rule list was successfully retrieved.

func (ListPrivateEndpointRulesResponse) MarshalJSON added in v0.72.0 

func (s ListPrivateEndpointRulesResponse) MarshalJSON() ([]byte, error)

func (*ListPrivateEndpointRulesResponse) UnmarshalJSON added in v0.72.0 

func (s *ListPrivateEndpointRulesResponse) UnmarshalJSON(b []byte) error

type ListPublicTokensResponse added in v0.29.0 

type ListPublicTokensResponse struct {
	// The information for each token.
	TokenInfos []PublicTokenInfo `json:"token_infos,omitempty"`
}

type ListTokenManagementRequest 

type ListTokenManagementRequest struct {
	// User ID of the user that created the token.
	CreatedById int64 `json:"-" url:"created_by_id,omitempty"`
	// Username of the user that created the token.
	CreatedByUsername string `json:"-" url:"created_by_username,omitempty"`

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

func (ListTokenManagementRequest) MarshalJSON added in v0.23.0 

func (s ListTokenManagementRequest) MarshalJSON() ([]byte, error)

func (*ListTokenManagementRequest) UnmarshalJSON added in v0.23.0 

func (s *ListTokenManagementRequest) UnmarshalJSON(b []byte) error

type ListTokensResponse 

type ListTokensResponse struct {
	// Token metadata of each user-created token in the workspace
	TokenInfos []TokenInfo `json:"token_infos,omitempty"`
}

Tokens were successfully returned.

type ListType 

type ListType string

Type of IP access list. Valid values are as follows and are case-sensitive:

* `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list. 

const ListTypeAllow ListType = `ALLOW`

An allow list. Include this IP or range. 

const ListTypeBlock ListType = `BLOCK`

A block list. Exclude this IP or range. IP addresses in the block list are excluded even if they are included in an allow list.

func (*ListType) Set 

func (f *ListType) Set(v string) error

Set raw string value and validate it against allowed values

func (*ListType) String 

func (f *ListType) String() string

String representation for fmt.Print

func (*ListType) Type 

func (f *ListType) Type() string

Type always returns ListType to satisfy [pflag.Value] interface

func (*ListType) Values added in v0.72.0 

func (f *ListType) Values() []ListType

Values returns all possible values for ListType.

There is no guarantee on the order of the values in the slice.

type LlmProxyPartnerPoweredAccount added in v0.69.0 

type LlmProxyPartnerPoweredAccount struct {
	BooleanVal BooleanMessage `json:"boolean_val"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (LlmProxyPartnerPoweredAccount) MarshalJSON added in v0.69.0 

func (s LlmProxyPartnerPoweredAccount) MarshalJSON() ([]byte, error)

func (*LlmProxyPartnerPoweredAccount) UnmarshalJSON added in v0.69.0 

func (s *LlmProxyPartnerPoweredAccount) UnmarshalJSON(b []byte) error

type LlmProxyPartnerPoweredAccountAPI added in v0.69.0 

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

Determines if partner powered models are enabled or not for a specific account

func NewLlmProxyPartnerPoweredAccount added in v0.69.0 

func NewLlmProxyPartnerPoweredAccount(client *client.DatabricksClient) *LlmProxyPartnerPoweredAccountAPI

func (*LlmProxyPartnerPoweredAccountAPI) Get added in v0.69.0 

func (a *LlmProxyPartnerPoweredAccountAPI) Get(ctx context.Context, request GetLlmProxyPartnerPoweredAccountRequest) (*LlmProxyPartnerPoweredAccount, error)

func (*LlmProxyPartnerPoweredAccountAPI) Update added in v0.69.0 

func (a *LlmProxyPartnerPoweredAccountAPI) Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredAccountRequest) (*LlmProxyPartnerPoweredAccount, error)

type LlmProxyPartnerPoweredAccountInterface added in v0.69.0 

type LlmProxyPartnerPoweredAccountInterface interface {

	// Gets the enable partner powered AI features account setting.
	Get(ctx context.Context, request GetLlmProxyPartnerPoweredAccountRequest) (*LlmProxyPartnerPoweredAccount, error)

	// Updates the enable partner powered AI features account setting.
	Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredAccountRequest) (*LlmProxyPartnerPoweredAccount, error)
}

type LlmProxyPartnerPoweredAccountService deprecated added in v0.69.0 

type LlmProxyPartnerPoweredAccountService interface {

	// Gets the enable partner powered AI features account setting.
	Get(ctx context.Context, request GetLlmProxyPartnerPoweredAccountRequest) (*LlmProxyPartnerPoweredAccount, error)

	// Updates the enable partner powered AI features account setting.
	Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredAccountRequest) (*LlmProxyPartnerPoweredAccount, error)
}

Determines if partner powered models are enabled or not for a specific account

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type LlmProxyPartnerPoweredEnforce added in v0.69.0 

type LlmProxyPartnerPoweredEnforce struct {
	BooleanVal BooleanMessage `json:"boolean_val"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (LlmProxyPartnerPoweredEnforce) MarshalJSON added in v0.69.0 

func (s LlmProxyPartnerPoweredEnforce) MarshalJSON() ([]byte, error)

func (*LlmProxyPartnerPoweredEnforce) UnmarshalJSON added in v0.69.0 

func (s *LlmProxyPartnerPoweredEnforce) UnmarshalJSON(b []byte) error

type LlmProxyPartnerPoweredEnforceAPI added in v0.69.0 

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

Determines if the account-level partner-powered setting value is enforced upon the workspace-level partner-powered setting

func NewLlmProxyPartnerPoweredEnforce added in v0.69.0 

func NewLlmProxyPartnerPoweredEnforce(client *client.DatabricksClient) *LlmProxyPartnerPoweredEnforceAPI

func (*LlmProxyPartnerPoweredEnforceAPI) Get added in v0.69.0 

func (a *LlmProxyPartnerPoweredEnforceAPI) Get(ctx context.Context, request GetLlmProxyPartnerPoweredEnforceRequest) (*LlmProxyPartnerPoweredEnforce, error)

func (*LlmProxyPartnerPoweredEnforceAPI) Update added in v0.69.0 

func (a *LlmProxyPartnerPoweredEnforceAPI) Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredEnforceRequest) (*LlmProxyPartnerPoweredEnforce, error)

type LlmProxyPartnerPoweredEnforceInterface added in v0.69.0 

type LlmProxyPartnerPoweredEnforceInterface interface {

	// Gets the enforcement status of partner powered AI features account setting.
	Get(ctx context.Context, request GetLlmProxyPartnerPoweredEnforceRequest) (*LlmProxyPartnerPoweredEnforce, error)

	// Updates the enable enforcement status of partner powered AI features account
	// setting.
	Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredEnforceRequest) (*LlmProxyPartnerPoweredEnforce, error)
}

type LlmProxyPartnerPoweredEnforceService deprecated added in v0.69.0 

type LlmProxyPartnerPoweredEnforceService interface {

	// Gets the enforcement status of partner powered AI features account
	// setting.
	Get(ctx context.Context, request GetLlmProxyPartnerPoweredEnforceRequest) (*LlmProxyPartnerPoweredEnforce, error)

	// Updates the enable enforcement status of partner powered AI features
	// account setting.
	Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredEnforceRequest) (*LlmProxyPartnerPoweredEnforce, error)
}

Determines if the account-level partner-powered setting value is enforced upon the workspace-level partner-powered setting

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type LlmProxyPartnerPoweredWorkspace added in v0.69.0 

type LlmProxyPartnerPoweredWorkspace struct {
	BooleanVal BooleanMessage `json:"boolean_val"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (LlmProxyPartnerPoweredWorkspace) MarshalJSON added in v0.69.0 

func (s LlmProxyPartnerPoweredWorkspace) MarshalJSON() ([]byte, error)

func (*LlmProxyPartnerPoweredWorkspace) UnmarshalJSON added in v0.69.0 

func (s *LlmProxyPartnerPoweredWorkspace) UnmarshalJSON(b []byte) error

type LlmProxyPartnerPoweredWorkspaceAPI added in v0.69.0 

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

Determines if partner powered models are enabled or not for a specific workspace

func NewLlmProxyPartnerPoweredWorkspace added in v0.69.0 

func NewLlmProxyPartnerPoweredWorkspace(client *client.DatabricksClient) *LlmProxyPartnerPoweredWorkspaceAPI

func (*LlmProxyPartnerPoweredWorkspaceAPI) Delete added in v0.69.0 

func (a *LlmProxyPartnerPoweredWorkspaceAPI) Delete(ctx context.Context, request DeleteLlmProxyPartnerPoweredWorkspaceRequest) (*DeleteLlmProxyPartnerPoweredWorkspaceResponse, error)

func (*LlmProxyPartnerPoweredWorkspaceAPI) Get added in v0.69.0 

func (a *LlmProxyPartnerPoweredWorkspaceAPI) Get(ctx context.Context, request GetLlmProxyPartnerPoweredWorkspaceRequest) (*LlmProxyPartnerPoweredWorkspace, error)

func (*LlmProxyPartnerPoweredWorkspaceAPI) Update added in v0.69.0 

func (a *LlmProxyPartnerPoweredWorkspaceAPI) Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredWorkspaceRequest) (*LlmProxyPartnerPoweredWorkspace, error)

type LlmProxyPartnerPoweredWorkspaceInterface added in v0.69.0 

type LlmProxyPartnerPoweredWorkspaceInterface interface {

	// Reverts the enable partner powered AI features workspace setting to its
	// default value.
	Delete(ctx context.Context, request DeleteLlmProxyPartnerPoweredWorkspaceRequest) (*DeleteLlmProxyPartnerPoweredWorkspaceResponse, error)

	// Gets the enable partner powered AI features workspace setting.
	Get(ctx context.Context, request GetLlmProxyPartnerPoweredWorkspaceRequest) (*LlmProxyPartnerPoweredWorkspace, error)

	// Updates the enable partner powered AI features workspace setting.
	Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredWorkspaceRequest) (*LlmProxyPartnerPoweredWorkspace, error)
}

type LlmProxyPartnerPoweredWorkspaceService deprecated added in v0.69.0 

type LlmProxyPartnerPoweredWorkspaceService interface {

	// Reverts the enable partner powered AI features workspace setting to its
	// default value.
	Delete(ctx context.Context, request DeleteLlmProxyPartnerPoweredWorkspaceRequest) (*DeleteLlmProxyPartnerPoweredWorkspaceResponse, error)

	// Gets the enable partner powered AI features workspace setting.
	Get(ctx context.Context, request GetLlmProxyPartnerPoweredWorkspaceRequest) (*LlmProxyPartnerPoweredWorkspace, error)

	// Updates the enable partner powered AI features workspace setting.
	Update(ctx context.Context, request UpdateLlmProxyPartnerPoweredWorkspaceRequest) (*LlmProxyPartnerPoweredWorkspace, error)
}

Determines if partner powered models are enabled or not for a specific workspace

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type MicrosoftTeamsConfig added in v0.44.0 

type MicrosoftTeamsConfig struct {
	// [Input-Only] URL for Microsoft Teams.
	Url string `json:"url,omitempty"`
	// [Output-Only] Whether URL is set.
	UrlSet bool `json:"url_set,omitempty"`

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

func (MicrosoftTeamsConfig) MarshalJSON added in v0.44.0 

func (s MicrosoftTeamsConfig) MarshalJSON() ([]byte, error)

func (*MicrosoftTeamsConfig) UnmarshalJSON added in v0.44.0 

func (s *MicrosoftTeamsConfig) UnmarshalJSON(b []byte) error

type NccAwsStableIpRule added in v0.34.0 

type NccAwsStableIpRule struct {
	// The list of stable IP CIDR blocks from which Databricks network traffic
	// originates when accessing your resources.
	CidrBlocks []string `json:"cidr_blocks,omitempty"`
}

The stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace.

type NccAzurePrivateEndpointRule added in v0.25.0 

type NccAzurePrivateEndpointRule struct {
	// The current status of this private endpoint. The private endpoint rules
	// are effective only if the connection state is ESTABLISHED. Remember that
	// you must approve new endpoints on your resources in the Azure portal
	// before they take effect. The possible values are: - INIT: (deprecated)
	// The endpoint has been created and pending approval. - PENDING: The
	// endpoint has been created and pending approval. - ESTABLISHED: The
	// endpoint has been approved and is ready to use in your serverless compute
	// resources. - REJECTED: Connection was rejected by the private link
	// resource owner. - DISCONNECTED: Connection was removed by the private
	// link resource owner, the private endpoint becomes informative and should
	// be deleted for clean-up. - EXPIRED: If the endpoint was created but not
	// approved in 14 days, it will be EXPIRED.
	ConnectionState NccAzurePrivateEndpointRuleConnectionState `json:"connection_state,omitempty"`
	// Time in epoch milliseconds when this object was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Whether this private endpoint is deactivated.
	Deactivated bool `json:"deactivated,omitempty"`
	// Time in epoch milliseconds when this object was deactivated.
	DeactivatedAt int64 `json:"deactivated_at,omitempty"`
	// Not used by customer-managed private endpoint services.
	//
	// Domain names of target private link service. When updating this field,
	// the full list of target domain_names must be specified.
	DomainNames []string `json:"domain_names,omitempty"`
	// The name of the Azure private endpoint resource.
	EndpointName string `json:"endpoint_name,omitempty"`
	// Only used by private endpoints to Azure first-party services.
	//
	// The sub-resource type (group ID) of the target resource. Note that to
	// connect to workspace root storage (root DBFS), you need two endpoints,
	// one for blob and one for dfs.
	GroupId string `json:"group_id,omitempty"`
	// The ID of a network connectivity configuration, which is the parent
	// resource of this private endpoint rule object.
	NetworkConnectivityConfigId string `json:"network_connectivity_config_id,omitempty"`
	// The Azure resource ID of the target resource.
	ResourceId string `json:"resource_id,omitempty"`
	// The ID of a private endpoint rule.
	RuleId string `json:"rule_id,omitempty"`
	// Time in epoch milliseconds when this object was updated.
	UpdatedTime int64 `json:"updated_time,omitempty"`

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

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

func (NccAzurePrivateEndpointRule) MarshalJSON added in v0.25.0 

func (s NccAzurePrivateEndpointRule) MarshalJSON() ([]byte, error)

func (*NccAzurePrivateEndpointRule) UnmarshalJSON added in v0.25.0 

func (s *NccAzurePrivateEndpointRule) UnmarshalJSON(b []byte) error

type NccAzurePrivateEndpointRuleConnectionState added in v0.25.0 

type NccAzurePrivateEndpointRuleConnectionState string
const NccAzurePrivateEndpointRuleConnectionStateDisconnected NccAzurePrivateEndpointRuleConnectionState = `DISCONNECTED`
const NccAzurePrivateEndpointRuleConnectionStateEstablished NccAzurePrivateEndpointRuleConnectionState = `ESTABLISHED`
const NccAzurePrivateEndpointRuleConnectionStateExpired NccAzurePrivateEndpointRuleConnectionState = `EXPIRED`
const NccAzurePrivateEndpointRuleConnectionStateInit NccAzurePrivateEndpointRuleConnectionState = `INIT`
const NccAzurePrivateEndpointRuleConnectionStatePending NccAzurePrivateEndpointRuleConnectionState = `PENDING`
const NccAzurePrivateEndpointRuleConnectionStateRejected NccAzurePrivateEndpointRuleConnectionState = `REJECTED`

func (*NccAzurePrivateEndpointRuleConnectionState) Set added in v0.25.0 

func (f *NccAzurePrivateEndpointRuleConnectionState) Set(v string) error

Set raw string value and validate it against allowed values

func (*NccAzurePrivateEndpointRuleConnectionState) String added in v0.25.0 

func (f *NccAzurePrivateEndpointRuleConnectionState) String() string

String representation for fmt.Print

func (*NccAzurePrivateEndpointRuleConnectionState) Type added in v0.25.0 

func (f *NccAzurePrivateEndpointRuleConnectionState) Type() string

Type always returns NccAzurePrivateEndpointRuleConnectionState to satisfy [pflag.Value] interface

func (*NccAzurePrivateEndpointRuleConnectionState) Values added in v0.72.0 

func (f *NccAzurePrivateEndpointRuleConnectionState) Values() []NccAzurePrivateEndpointRuleConnectionState

Values returns all possible values for NccAzurePrivateEndpointRuleConnectionState.

There is no guarantee on the order of the values in the slice.

type NccAzureServiceEndpointRule added in v0.25.0 

type NccAzureServiceEndpointRule struct {
	// The list of subnets from which Databricks network traffic originates when
	// accessing your Azure resources.
	Subnets []string `json:"subnets,omitempty"`
	// The Azure region in which this service endpoint rule applies..
	TargetRegion string `json:"target_region,omitempty"`
	// The Azure services to which this service endpoint rule applies to.
	TargetServices []EgressResourceType `json:"target_services,omitempty"`

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

The stable Azure service endpoints. You can configure the firewall of your Azure resources to allow traffic from your Databricks serverless compute resources.

func (NccAzureServiceEndpointRule) MarshalJSON added in v0.25.0 

func (s NccAzureServiceEndpointRule) MarshalJSON() ([]byte, error)

func (*NccAzureServiceEndpointRule) UnmarshalJSON added in v0.25.0 

func (s *NccAzureServiceEndpointRule) UnmarshalJSON(b []byte) error

type NccEgressConfig added in v0.25.0 

type NccEgressConfig struct {
	// The network connectivity rules that are applied by default without
	// resource specific configurations. You can find the stable network
	// information of your serverless compute resources here.
	DefaultRules *NccEgressDefaultRules `json:"default_rules,omitempty"`
	// The network connectivity rules that configured for each destinations.
	// These rules override default rules.
	TargetRules *NccEgressTargetRules `json:"target_rules,omitempty"`
}

type NccEgressDefaultRules added in v0.25.0 

type NccEgressDefaultRules struct {
	AwsStableIpRule *NccAwsStableIpRule `json:"aws_stable_ip_rule,omitempty"`

	AzureServiceEndpointRule *NccAzureServiceEndpointRule `json:"azure_service_endpoint_rule,omitempty"`
}

Default rules don't have specific targets.

type NccEgressTargetRules added in v0.25.0 

type NccEgressTargetRules struct {
	// AWS private endpoint rule controls the AWS private endpoint based egress
	// rules.
	AwsPrivateEndpointRules []CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule `json:"aws_private_endpoint_rules,omitempty"`

	AzurePrivateEndpointRules []NccAzurePrivateEndpointRule `json:"azure_private_endpoint_rules,omitempty"`
}

Target rule controls the egress rules that are dedicated to specific resources.

type NccPrivateEndpointRule added in v0.72.0 

type NccPrivateEndpointRule struct {
	// Databricks account ID. You can find your account ID from the Accounts
	// Console.
	AccountId string `json:"account_id,omitempty"`
	// The current status of this private endpoint. The private endpoint rules
	// are effective only if the connection state is ESTABLISHED. Remember that
	// you must approve new endpoints on your resources in the Cloud console
	// before they take effect. The possible values are: - PENDING: The endpoint
	// has been created and pending approval. - ESTABLISHED: The endpoint has
	// been approved and is ready to use in your serverless compute resources. -
	// REJECTED: Connection was rejected by the private link resource owner. -
	// DISCONNECTED: Connection was removed by the private link resource owner,
	// the private endpoint becomes informative and should be deleted for
	// clean-up. - EXPIRED: If the endpoint was created but not approved in 14
	// days, it will be EXPIRED.
	ConnectionState NccPrivateEndpointRulePrivateLinkConnectionState `json:"connection_state,omitempty"`
	// Time in epoch milliseconds when this object was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Whether this private endpoint is deactivated.
	Deactivated bool `json:"deactivated,omitempty"`
	// Time in epoch milliseconds when this object was deactivated.
	DeactivatedAt int64 `json:"deactivated_at,omitempty"`
	// Only used by private endpoints to customer-managed private endpoint
	// services.
	//
	// Domain names of target private link service. When updating this field,
	// the full list of target domain_names must be specified.
	DomainNames []string `json:"domain_names,omitempty"`
	// Only used by private endpoints towards an AWS S3 service.
	//
	// Update this field to activate/deactivate this private endpoint to allow
	// egress access from serverless compute resources.
	Enabled bool `json:"enabled,omitempty"`
	// The name of the Azure private endpoint resource.
	EndpointName string `json:"endpoint_name,omitempty"`
	// The full target AWS endpoint service name that connects to the
	// destination resources of the private endpoint.
	EndpointService string `json:"endpoint_service,omitempty"`
	// Not used by customer-managed private endpoint services.
	//
	// The sub-resource type (group ID) of the target resource. Note that to
	// connect to workspace root storage (root DBFS), you need two endpoints,
	// one for blob and one for dfs.
	GroupId string `json:"group_id,omitempty"`
	// The ID of a network connectivity configuration, which is the parent
	// resource of this private endpoint rule object.
	NetworkConnectivityConfigId string `json:"network_connectivity_config_id,omitempty"`
	// The Azure resource ID of the target resource.
	ResourceId string `json:"resource_id,omitempty"`
	// Only used by private endpoints towards AWS S3 service.
	//
	// The globally unique S3 bucket names that will be accessed via the VPC
	// endpoint. The bucket names must be in the same region as the NCC/endpoint
	// service. When updating this field, we perform full update on this field.
	// Please ensure a full list of desired resource_names is provided.
	ResourceNames []string `json:"resource_names,omitempty"`
	// The ID of a private endpoint rule.
	RuleId string `json:"rule_id,omitempty"`
	// Time in epoch milliseconds when this object was updated.
	UpdatedTime int64 `json:"updated_time,omitempty"`
	// The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint
	// created by Databricks.
	VpcEndpointId string `json:"vpc_endpoint_id,omitempty"`

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

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

func (NccPrivateEndpointRule) MarshalJSON added in v0.72.0 

func (s NccPrivateEndpointRule) MarshalJSON() ([]byte, error)

func (*NccPrivateEndpointRule) UnmarshalJSON added in v0.72.0 

func (s *NccPrivateEndpointRule) UnmarshalJSON(b []byte) error

type NccPrivateEndpointRulePrivateLinkConnectionState added in v0.72.0 

type NccPrivateEndpointRulePrivateLinkConnectionState string
const NccPrivateEndpointRulePrivateLinkConnectionStateDisconnected NccPrivateEndpointRulePrivateLinkConnectionState = `DISCONNECTED`
const NccPrivateEndpointRulePrivateLinkConnectionStateEstablished NccPrivateEndpointRulePrivateLinkConnectionState = `ESTABLISHED`
const NccPrivateEndpointRulePrivateLinkConnectionStateExpired NccPrivateEndpointRulePrivateLinkConnectionState = `EXPIRED`
const NccPrivateEndpointRulePrivateLinkConnectionStatePending NccPrivateEndpointRulePrivateLinkConnectionState = `PENDING`
const NccPrivateEndpointRulePrivateLinkConnectionStateRejected NccPrivateEndpointRulePrivateLinkConnectionState = `REJECTED`

func (*NccPrivateEndpointRulePrivateLinkConnectionState) Set added in v0.72.0 

func (f *NccPrivateEndpointRulePrivateLinkConnectionState) Set(v string) error

Set raw string value and validate it against allowed values

func (*NccPrivateEndpointRulePrivateLinkConnectionState) String added in v0.72.0 

func (f *NccPrivateEndpointRulePrivateLinkConnectionState) String() string

String representation for fmt.Print

func (*NccPrivateEndpointRulePrivateLinkConnectionState) Type added in v0.72.0 

func (f *NccPrivateEndpointRulePrivateLinkConnectionState) Type() string

Type always returns NccPrivateEndpointRulePrivateLinkConnectionState to satisfy [pflag.Value] interface

func (*NccPrivateEndpointRulePrivateLinkConnectionState) Values added in v0.72.0 

func (f *NccPrivateEndpointRulePrivateLinkConnectionState) Values() []NccPrivateEndpointRulePrivateLinkConnectionState

Values returns all possible values for NccPrivateEndpointRulePrivateLinkConnectionState.

There is no guarantee on the order of the values in the slice.

type NetworkConnectivityAPI added in v0.25.0 

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

These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources. This API provides stable subnets for your workspace so that you can configure your firewalls on your Azure Storage accounts to allow access from Databricks. You can also use the API to provision private endpoints for Databricks to privately connect serverless compute resources to your Azure resources using Azure Private Link. See configure serverless secure connectivity.

func NewNetworkConnectivity added in v0.25.0 

func NewNetworkConnectivity(client *client.DatabricksClient) *NetworkConnectivityAPI

func (*NetworkConnectivityAPI) CreateNetworkConnectivityConfiguration added in v0.25.0 

func (a *NetworkConnectivityAPI) CreateNetworkConnectivityConfiguration(ctx context.Context, request CreateNetworkConnectivityConfigRequest) (*NetworkConnectivityConfiguration, error)

func (*NetworkConnectivityAPI) CreatePrivateEndpointRule added in v0.25.0 

func (a *NetworkConnectivityAPI) CreatePrivateEndpointRule(ctx context.Context, request CreatePrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

func (*NetworkConnectivityAPI) DeleteNetworkConnectivityConfiguration added in v0.25.0 

func (a *NetworkConnectivityAPI) DeleteNetworkConnectivityConfiguration(ctx context.Context, request DeleteNetworkConnectivityConfigurationRequest) error

func (*NetworkConnectivityAPI) DeleteNetworkConnectivityConfigurationByNetworkConnectivityConfigId added in v0.25.0 

func (a *NetworkConnectivityAPI) DeleteNetworkConnectivityConfigurationByNetworkConnectivityConfigId(ctx context.Context, networkConnectivityConfigId string) error

Deletes a network connectivity configuration.

func (*NetworkConnectivityAPI) DeletePrivateEndpointRule added in v0.25.0 

func (a *NetworkConnectivityAPI) DeletePrivateEndpointRule(ctx context.Context, request DeletePrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

func (*NetworkConnectivityAPI) DeletePrivateEndpointRuleByNetworkConnectivityConfigIdAndPrivateEndpointRuleId added in v0.25.0 

func (a *NetworkConnectivityAPI) DeletePrivateEndpointRuleByNetworkConnectivityConfigIdAndPrivateEndpointRuleId(ctx context.Context, networkConnectivityConfigId string, privateEndpointRuleId string) (*NccPrivateEndpointRule, error)

Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED, the private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated and will be deleted after seven days of deactivation. When a private endpoint is deactivated, the `deactivated` field is set to `true` and the private endpoint is not available to your serverless compute resources.

func (*NetworkConnectivityAPI) GetNetworkConnectivityConfiguration added in v0.25.0 

func (a *NetworkConnectivityAPI) GetNetworkConnectivityConfiguration(ctx context.Context, request GetNetworkConnectivityConfigurationRequest) (*NetworkConnectivityConfiguration, error)

func (*NetworkConnectivityAPI) GetNetworkConnectivityConfigurationByNetworkConnectivityConfigId added in v0.25.0 

func (a *NetworkConnectivityAPI) GetNetworkConnectivityConfigurationByNetworkConnectivityConfigId(ctx context.Context, networkConnectivityConfigId string) (*NetworkConnectivityConfiguration, error)

Gets a network connectivity configuration.

func (*NetworkConnectivityAPI) GetPrivateEndpointRule added in v0.25.0 

func (a *NetworkConnectivityAPI) GetPrivateEndpointRule(ctx context.Context, request GetPrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

func (*NetworkConnectivityAPI) GetPrivateEndpointRuleByNetworkConnectivityConfigIdAndPrivateEndpointRuleId added in v0.25.0 

func (a *NetworkConnectivityAPI) GetPrivateEndpointRuleByNetworkConnectivityConfigIdAndPrivateEndpointRuleId(ctx context.Context, networkConnectivityConfigId string, privateEndpointRuleId string) (*NccPrivateEndpointRule, error)

Gets the private endpoint rule.

func (*NetworkConnectivityAPI) ListNetworkConnectivityConfigurations added in v0.26.0 

func (a *NetworkConnectivityAPI) ListNetworkConnectivityConfigurations(ctx context.Context, request ListNetworkConnectivityConfigurationsRequest) listing.Iterator[NetworkConnectivityConfiguration]

Gets an array of network connectivity configurations.

func (*NetworkConnectivityAPI) ListNetworkConnectivityConfigurationsAll added in v0.26.0 

func (a *NetworkConnectivityAPI) ListNetworkConnectivityConfigurationsAll(ctx context.Context, request ListNetworkConnectivityConfigurationsRequest) ([]NetworkConnectivityConfiguration, error)

Gets an array of network connectivity configurations.

func (*NetworkConnectivityAPI) ListPrivateEndpointRules added in v0.26.0 

func (a *NetworkConnectivityAPI) ListPrivateEndpointRules(ctx context.Context, request ListPrivateEndpointRulesRequest) listing.Iterator[NccPrivateEndpointRule]

Gets an array of private endpoint rules.

func (*NetworkConnectivityAPI) ListPrivateEndpointRulesAll added in v0.26.0 

func (a *NetworkConnectivityAPI) ListPrivateEndpointRulesAll(ctx context.Context, request ListPrivateEndpointRulesRequest) ([]NccPrivateEndpointRule, error)

Gets an array of private endpoint rules.

func (*NetworkConnectivityAPI) ListPrivateEndpointRulesByNetworkConnectivityConfigId added in v0.26.0 

func (a *NetworkConnectivityAPI) ListPrivateEndpointRulesByNetworkConnectivityConfigId(ctx context.Context, networkConnectivityConfigId string) (*ListPrivateEndpointRulesResponse, error)

Gets an array of private endpoint rules.

func (*NetworkConnectivityAPI) UpdatePrivateEndpointRule added in v0.72.0 

func (a *NetworkConnectivityAPI) UpdatePrivateEndpointRule(ctx context.Context, request UpdateNccPrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

type NetworkConnectivityConfiguration added in v0.25.0 

type NetworkConnectivityConfiguration struct {
	// Your Databricks account ID. You can find your account ID in your
	// Databricks accounts console.
	AccountId string `json:"account_id,omitempty"`
	// Time in epoch milliseconds when this object was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// The network connectivity rules that apply to network traffic from your
	// serverless compute resources.
	EgressConfig *NccEgressConfig `json:"egress_config,omitempty"`
	// The name of the network connectivity configuration. The name can contain
	// alphanumeric characters, hyphens, and underscores. The length must be
	// between 3 and 30 characters. The name must match the regular expression
	// ^[0-9a-zA-Z-_]{3,30}$
	Name string `json:"name,omitempty"`
	// Databricks network connectivity configuration ID.
	NetworkConnectivityConfigId string `json:"network_connectivity_config_id,omitempty"`
	// The region for the network connectivity configuration. Only workspaces in
	// the same region can be attached to the network connectivity
	// configuration.
	Region string `json:"region,omitempty"`
	// Time in epoch milliseconds when this object was updated.
	UpdatedTime int64 `json:"updated_time,omitempty"`

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

Properties of the new network connectivity configuration.

func (NetworkConnectivityConfiguration) MarshalJSON added in v0.25.0 

func (s NetworkConnectivityConfiguration) MarshalJSON() ([]byte, error)

func (*NetworkConnectivityConfiguration) UnmarshalJSON added in v0.25.0 

func (s *NetworkConnectivityConfiguration) UnmarshalJSON(b []byte) error

type NetworkConnectivityInterface added in v0.29.0 

type NetworkConnectivityInterface interface {

	// Creates a network connectivity configuration (NCC), which provides stable
	// Azure service subnets when accessing your Azure Storage accounts. You can
	// also use a network connectivity configuration to create Databricks managed
	// private endpoints so that Databricks serverless compute resources privately
	// access your resources.
	//
	// **IMPORTANT**: After you create the network connectivity configuration, you
	// must assign one or more workspaces to the new network connectivity
	// configuration. You can share one network connectivity configuration with
	// multiple workspaces from the same Azure region within the same Databricks
	// account. See [configure serverless secure connectivity].
	//
	// [configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security
	CreateNetworkConnectivityConfiguration(ctx context.Context, request CreateNetworkConnectivityConfigRequest) (*NetworkConnectivityConfiguration, error)

	// Create a private endpoint rule for the specified network connectivity config
	// object. Once the object is created, Databricks asynchronously provisions a
	// new Azure private endpoint to your specified Azure resource.
	//
	// **IMPORTANT**: You must use Azure portal or other Azure tools to approve the
	// private endpoint to complete the connection. To get the information of the
	// private endpoint created, make a `GET` request on the new private endpoint
	// rule. See [serverless private link].
	//
	// [serverless private link]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link
	CreatePrivateEndpointRule(ctx context.Context, request CreatePrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

	// Deletes a network connectivity configuration.
	DeleteNetworkConnectivityConfiguration(ctx context.Context, request DeleteNetworkConnectivityConfigurationRequest) error

	// Deletes a network connectivity configuration.
	DeleteNetworkConnectivityConfigurationByNetworkConnectivityConfigId(ctx context.Context, networkConnectivityConfigId string) error

	// Initiates deleting a private endpoint rule. If the connection state is
	// PENDING or EXPIRED, the private endpoint is immediately deleted. Otherwise,
	// the private endpoint is deactivated and will be deleted after seven days of
	// deactivation. When a private endpoint is deactivated, the `deactivated` field
	// is set to `true` and the private endpoint is not available to your serverless
	// compute resources.
	DeletePrivateEndpointRule(ctx context.Context, request DeletePrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

	// Initiates deleting a private endpoint rule. If the connection state is
	// PENDING or EXPIRED, the private endpoint is immediately deleted. Otherwise,
	// the private endpoint is deactivated and will be deleted after seven days of
	// deactivation. When a private endpoint is deactivated, the `deactivated` field
	// is set to `true` and the private endpoint is not available to your serverless
	// compute resources.
	DeletePrivateEndpointRuleByNetworkConnectivityConfigIdAndPrivateEndpointRuleId(ctx context.Context, networkConnectivityConfigId string, privateEndpointRuleId string) (*NccPrivateEndpointRule, error)

	// Gets a network connectivity configuration.
	GetNetworkConnectivityConfiguration(ctx context.Context, request GetNetworkConnectivityConfigurationRequest) (*NetworkConnectivityConfiguration, error)

	// Gets a network connectivity configuration.
	GetNetworkConnectivityConfigurationByNetworkConnectivityConfigId(ctx context.Context, networkConnectivityConfigId string) (*NetworkConnectivityConfiguration, error)

	// Gets the private endpoint rule.
	GetPrivateEndpointRule(ctx context.Context, request GetPrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

	// Gets the private endpoint rule.
	GetPrivateEndpointRuleByNetworkConnectivityConfigIdAndPrivateEndpointRuleId(ctx context.Context, networkConnectivityConfigId string, privateEndpointRuleId string) (*NccPrivateEndpointRule, error)

	// Gets an array of network connectivity configurations.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListNetworkConnectivityConfigurations(ctx context.Context, request ListNetworkConnectivityConfigurationsRequest) listing.Iterator[NetworkConnectivityConfiguration]

	// Gets an array of network connectivity configurations.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListNetworkConnectivityConfigurationsAll(ctx context.Context, request ListNetworkConnectivityConfigurationsRequest) ([]NetworkConnectivityConfiguration, error)

	// Gets an array of private endpoint rules.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListPrivateEndpointRules(ctx context.Context, request ListPrivateEndpointRulesRequest) listing.Iterator[NccPrivateEndpointRule]

	// Gets an array of private endpoint rules.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListPrivateEndpointRulesAll(ctx context.Context, request ListPrivateEndpointRulesRequest) ([]NccPrivateEndpointRule, error)

	// Gets an array of private endpoint rules.
	ListPrivateEndpointRulesByNetworkConnectivityConfigId(ctx context.Context, networkConnectivityConfigId string) (*ListPrivateEndpointRulesResponse, error)

	// Updates a private endpoint rule. Currently only a private endpoint rule to
	// customer-managed resources is allowed to be updated.
	UpdatePrivateEndpointRule(ctx context.Context, request UpdateNccPrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)
}

type NetworkConnectivityService deprecated added in v0.25.0 

type NetworkConnectivityService interface {

	// Creates a network connectivity configuration (NCC), which provides stable
	// Azure service subnets when accessing your Azure Storage accounts. You can
	// also use a network connectivity configuration to create Databricks
	// managed private endpoints so that Databricks serverless compute resources
	// privately access your resources.
	//
	// **IMPORTANT**: After you create the network connectivity configuration,
	// you must assign one or more workspaces to the new network connectivity
	// configuration. You can share one network connectivity configuration with
	// multiple workspaces from the same Azure region within the same Databricks
	// account. See [configure serverless secure connectivity].
	//
	// [configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security
	CreateNetworkConnectivityConfiguration(ctx context.Context, request CreateNetworkConnectivityConfigRequest) (*NetworkConnectivityConfiguration, error)

	// Create a private endpoint rule for the specified network connectivity
	// config object. Once the object is created, Databricks asynchronously
	// provisions a new Azure private endpoint to your specified Azure resource.
	//
	// **IMPORTANT**: You must use Azure portal or other Azure tools to approve
	// the private endpoint to complete the connection. To get the information
	// of the private endpoint created, make a `GET` request on the new private
	// endpoint rule. See [serverless private link].
	//
	// [serverless private link]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link
	CreatePrivateEndpointRule(ctx context.Context, request CreatePrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

	// Deletes a network connectivity configuration.
	DeleteNetworkConnectivityConfiguration(ctx context.Context, request DeleteNetworkConnectivityConfigurationRequest) error

	// Initiates deleting a private endpoint rule. If the connection state is
	// PENDING or EXPIRED, the private endpoint is immediately deleted.
	// Otherwise, the private endpoint is deactivated and will be deleted after
	// seven days of deactivation. When a private endpoint is deactivated, the
	// `deactivated` field is set to `true` and the private endpoint is not
	// available to your serverless compute resources.
	DeletePrivateEndpointRule(ctx context.Context, request DeletePrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

	// Gets a network connectivity configuration.
	GetNetworkConnectivityConfiguration(ctx context.Context, request GetNetworkConnectivityConfigurationRequest) (*NetworkConnectivityConfiguration, error)

	// Gets the private endpoint rule.
	GetPrivateEndpointRule(ctx context.Context, request GetPrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)

	// Gets an array of network connectivity configurations.
	ListNetworkConnectivityConfigurations(ctx context.Context, request ListNetworkConnectivityConfigurationsRequest) (*ListNetworkConnectivityConfigurationsResponse, error)

	// Gets an array of private endpoint rules.
	ListPrivateEndpointRules(ctx context.Context, request ListPrivateEndpointRulesRequest) (*ListPrivateEndpointRulesResponse, error)

	// Updates a private endpoint rule. Currently only a private endpoint rule
	// to customer-managed resources is allowed to be updated.
	UpdatePrivateEndpointRule(ctx context.Context, request UpdateNccPrivateEndpointRuleRequest) (*NccPrivateEndpointRule, error)
}

These APIs provide configurations for the network connectivity of your workspaces for serverless compute resources. This API provides stable subnets for your workspace so that you can configure your firewalls on your Azure Storage accounts to allow access from Databricks. You can also use the API to provision private endpoints for Databricks to privately connect serverless compute resources to your Azure resources using Azure Private Link. See configure serverless secure connectivity.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type NetworkPoliciesAPI added in v0.70.0 

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

These APIs manage network policies for this account. Network policies control which network destinations can be accessed from the Databricks environment. Each Databricks account includes a default policy named 'default-policy'. 'default-policy' is associated with any workspace lacking an explicit network policy assignment, and is automatically associated with each newly created workspace. 'default-policy' is reserved and cannot be deleted, but it can be updated to customize the default network access rules for your account.

func NewNetworkPolicies added in v0.70.0 

func NewNetworkPolicies(client *client.DatabricksClient) *NetworkPoliciesAPI

func (*NetworkPoliciesAPI) CreateNetworkPolicyRpc added in v0.70.0 

func (a *NetworkPoliciesAPI) CreateNetworkPolicyRpc(ctx context.Context, request CreateNetworkPolicyRequest) (*AccountNetworkPolicy, error)

func (*NetworkPoliciesAPI) DeleteNetworkPolicyRpc added in v0.70.0 

func (a *NetworkPoliciesAPI) DeleteNetworkPolicyRpc(ctx context.Context, request DeleteNetworkPolicyRequest) error

func (*NetworkPoliciesAPI) DeleteNetworkPolicyRpcByNetworkPolicyId added in v0.70.0 

func (a *NetworkPoliciesAPI) DeleteNetworkPolicyRpcByNetworkPolicyId(ctx context.Context, networkPolicyId string) error

Deletes a network policy. Cannot be called on 'default-policy'.

func (*NetworkPoliciesAPI) GetNetworkPolicyRpc added in v0.70.0 

func (a *NetworkPoliciesAPI) GetNetworkPolicyRpc(ctx context.Context, request GetNetworkPolicyRequest) (*AccountNetworkPolicy, error)

func (*NetworkPoliciesAPI) GetNetworkPolicyRpcByNetworkPolicyId added in v0.70.0 

func (a *NetworkPoliciesAPI) GetNetworkPolicyRpcByNetworkPolicyId(ctx context.Context, networkPolicyId string) (*AccountNetworkPolicy, error)

Gets a network policy.

func (*NetworkPoliciesAPI) ListNetworkPoliciesRpc added in v0.70.0 

func (a *NetworkPoliciesAPI) ListNetworkPoliciesRpc(ctx context.Context, request ListNetworkPoliciesRequest) listing.Iterator[AccountNetworkPolicy]

Gets an array of network policies.

func (*NetworkPoliciesAPI) ListNetworkPoliciesRpcAll added in v0.70.0 

func (a *NetworkPoliciesAPI) ListNetworkPoliciesRpcAll(ctx context.Context, request ListNetworkPoliciesRequest) ([]AccountNetworkPolicy, error)

Gets an array of network policies.

func (*NetworkPoliciesAPI) UpdateNetworkPolicyRpc added in v0.70.0 

func (a *NetworkPoliciesAPI) UpdateNetworkPolicyRpc(ctx context.Context, request UpdateNetworkPolicyRequest) (*AccountNetworkPolicy, error)

type NetworkPoliciesInterface added in v0.70.0 

type NetworkPoliciesInterface interface {

	// Creates a new network policy to manage which network destinations can be
	// accessed from the Databricks environment.
	CreateNetworkPolicyRpc(ctx context.Context, request CreateNetworkPolicyRequest) (*AccountNetworkPolicy, error)

	// Deletes a network policy. Cannot be called on 'default-policy'.
	DeleteNetworkPolicyRpc(ctx context.Context, request DeleteNetworkPolicyRequest) error

	// Deletes a network policy. Cannot be called on 'default-policy'.
	DeleteNetworkPolicyRpcByNetworkPolicyId(ctx context.Context, networkPolicyId string) error

	// Gets a network policy.
	GetNetworkPolicyRpc(ctx context.Context, request GetNetworkPolicyRequest) (*AccountNetworkPolicy, error)

	// Gets a network policy.
	GetNetworkPolicyRpcByNetworkPolicyId(ctx context.Context, networkPolicyId string) (*AccountNetworkPolicy, error)

	// Gets an array of network policies.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListNetworkPoliciesRpc(ctx context.Context, request ListNetworkPoliciesRequest) listing.Iterator[AccountNetworkPolicy]

	// Gets an array of network policies.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListNetworkPoliciesRpcAll(ctx context.Context, request ListNetworkPoliciesRequest) ([]AccountNetworkPolicy, error)

	// Updates a network policy. This allows you to modify the configuration of a
	// network policy.
	UpdateNetworkPolicyRpc(ctx context.Context, request UpdateNetworkPolicyRequest) (*AccountNetworkPolicy, error)
}

type NetworkPoliciesService deprecated added in v0.70.0 

type NetworkPoliciesService interface {

	// Creates a new network policy to manage which network destinations can be
	// accessed from the Databricks environment.
	CreateNetworkPolicyRpc(ctx context.Context, request CreateNetworkPolicyRequest) (*AccountNetworkPolicy, error)

	// Deletes a network policy. Cannot be called on 'default-policy'.
	DeleteNetworkPolicyRpc(ctx context.Context, request DeleteNetworkPolicyRequest) error

	// Gets a network policy.
	GetNetworkPolicyRpc(ctx context.Context, request GetNetworkPolicyRequest) (*AccountNetworkPolicy, error)

	// Gets an array of network policies.
	ListNetworkPoliciesRpc(ctx context.Context, request ListNetworkPoliciesRequest) (*ListNetworkPoliciesResponse, error)

	// Updates a network policy. This allows you to modify the configuration of
	// a network policy.
	UpdateNetworkPolicyRpc(ctx context.Context, request UpdateNetworkPolicyRequest) (*AccountNetworkPolicy, error)
}

These APIs manage network policies for this account. Network policies control which network destinations can be accessed from the Databricks environment. Each Databricks account includes a default policy named 'default-policy'. 'default-policy' is associated with any workspace lacking an explicit network policy assignment, and is automatically associated with each newly created workspace. 'default-policy' is reserved and cannot be deleted, but it can be updated to customize the default network access rules for your account.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type NetworkPolicyEgress added in v0.70.0 

type NetworkPolicyEgress struct {
	// The access policy enforced for egress traffic to the internet.
	NetworkAccess *EgressNetworkPolicyNetworkAccessPolicy `json:"network_access,omitempty"`
}

The network policies applying for egress traffic. This message is used by the UI/REST API. We translate this message to the format expected by the dataplane in Lakehouse Network Manager (for the format expected by the dataplane, see networkconfig.textproto). This policy should be consistent with [[com.databricks.api.proto.settingspolicy.EgressNetworkPolicy]]. Details see API-design: https://docs.google.com/document/d/1DKWO_FpZMCY4cF2O62LpwII1lx8gsnDGG-qgE3t3TOA/

type NotificationDestination added in v0.44.0 

type NotificationDestination struct {
	// The configuration for the notification destination. Will be exactly one
	// of the nested configs. Only returns for users with workspace admin
	// permissions.
	Config *Config `json:"config,omitempty"`
	// [Output-only] The type of the notification destination. The type can not
	// be changed once set.
	DestinationType DestinationType `json:"destination_type,omitempty"`
	// The display name for the notification destination.
	DisplayName string `json:"display_name,omitempty"`
	// UUID identifying notification destination.
	Id string `json:"id,omitempty"`

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

func (NotificationDestination) MarshalJSON added in v0.44.0 

func (s NotificationDestination) MarshalJSON() ([]byte, error)

func (*NotificationDestination) UnmarshalJSON added in v0.44.0 

func (s *NotificationDestination) UnmarshalJSON(b []byte) error

type NotificationDestinationsAPI added in v0.44.0 

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

The notification destinations API lets you programmatically manage a workspace's notification destinations. Notification destinations are used to send notifications for query alerts and jobs to destinations outside of Databricks. Only workspace admins can create, update, and delete notification destinations.

func NewNotificationDestinations added in v0.44.0 

func NewNotificationDestinations(client *client.DatabricksClient) *NotificationDestinationsAPI

func (*NotificationDestinationsAPI) Create added in v0.44.0 

func (a *NotificationDestinationsAPI) Create(ctx context.Context, request CreateNotificationDestinationRequest) (*NotificationDestination, error)

func (*NotificationDestinationsAPI) Delete added in v0.44.0 

func (a *NotificationDestinationsAPI) Delete(ctx context.Context, request DeleteNotificationDestinationRequest) error

func (*NotificationDestinationsAPI) DeleteById added in v0.44.0 

func (a *NotificationDestinationsAPI) DeleteById(ctx context.Context, id string) error

Deletes a notification destination. Requires workspace admin permissions.

func (*NotificationDestinationsAPI) Get added in v0.44.0 

func (a *NotificationDestinationsAPI) Get(ctx context.Context, request GetNotificationDestinationRequest) (*NotificationDestination, error)

func (*NotificationDestinationsAPI) GetById added in v0.44.0 

func (a *NotificationDestinationsAPI) GetById(ctx context.Context, id string) (*NotificationDestination, error)

Gets a notification destination.

func (*NotificationDestinationsAPI) List added in v0.44.0 

func (a *NotificationDestinationsAPI) List(ctx context.Context, request ListNotificationDestinationsRequest) listing.Iterator[ListNotificationDestinationsResult]

Lists notification destinations.

func (*NotificationDestinationsAPI) ListAll added in v0.44.0 

func (a *NotificationDestinationsAPI) ListAll(ctx context.Context, request ListNotificationDestinationsRequest) ([]ListNotificationDestinationsResult, error)

Lists notification destinations.

func (*NotificationDestinationsAPI) Update added in v0.44.0 

func (a *NotificationDestinationsAPI) Update(ctx context.Context, request UpdateNotificationDestinationRequest) (*NotificationDestination, error)

type NotificationDestinationsInterface added in v0.44.0 

type NotificationDestinationsInterface interface {

	// Creates a notification destination. Requires workspace admin permissions.
	Create(ctx context.Context, request CreateNotificationDestinationRequest) (*NotificationDestination, error)

	// Deletes a notification destination. Requires workspace admin permissions.
	Delete(ctx context.Context, request DeleteNotificationDestinationRequest) error

	// Deletes a notification destination. Requires workspace admin permissions.
	DeleteById(ctx context.Context, id string) error

	// Gets a notification destination.
	Get(ctx context.Context, request GetNotificationDestinationRequest) (*NotificationDestination, error)

	// Gets a notification destination.
	GetById(ctx context.Context, id string) (*NotificationDestination, error)

	// Lists notification destinations.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListNotificationDestinationsRequest) listing.Iterator[ListNotificationDestinationsResult]

	// Lists notification destinations.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListNotificationDestinationsRequest) ([]ListNotificationDestinationsResult, error)

	// Updates a notification destination. Requires workspace admin permissions. At
	// least one field is required in the request body.
	Update(ctx context.Context, request UpdateNotificationDestinationRequest) (*NotificationDestination, error)
}

type NotificationDestinationsService deprecated added in v0.44.0 

type NotificationDestinationsService interface {

	// Creates a notification destination. Requires workspace admin permissions.
	Create(ctx context.Context, request CreateNotificationDestinationRequest) (*NotificationDestination, error)

	// Deletes a notification destination. Requires workspace admin permissions.
	Delete(ctx context.Context, request DeleteNotificationDestinationRequest) error

	// Gets a notification destination.
	Get(ctx context.Context, request GetNotificationDestinationRequest) (*NotificationDestination, error)

	// Lists notification destinations.
	List(ctx context.Context, request ListNotificationDestinationsRequest) (*ListNotificationDestinationsResponse, error)

	// Updates a notification destination. Requires workspace admin permissions.
	// At least one field is required in the request body.
	Update(ctx context.Context, request UpdateNotificationDestinationRequest) (*NotificationDestination, error)
}

The notification destinations API lets you programmatically manage a workspace's notification destinations. Notification destinations are used to send notifications for query alerts and jobs to destinations outside of Databricks. Only workspace admins can create, update, and delete notification destinations.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type PagerdutyConfig added in v0.44.0 

type PagerdutyConfig struct {
	// [Input-Only] Integration key for PagerDuty.
	IntegrationKey string `json:"integration_key,omitempty"`
	// [Output-Only] Whether integration key is set.
	IntegrationKeySet bool `json:"integration_key_set,omitempty"`

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

func (PagerdutyConfig) MarshalJSON added in v0.44.0 

func (s PagerdutyConfig) MarshalJSON() ([]byte, error)

func (*PagerdutyConfig) UnmarshalJSON added in v0.44.0 

func (s *PagerdutyConfig) UnmarshalJSON(b []byte) error

type PartitionId added in v0.21.0 

type PartitionId struct {
	// The ID of the workspace.
	WorkspaceId int64 `json:"workspaceId,omitempty"`

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

Partition by workspace or account

func (PartitionId) MarshalJSON added in v0.23.0 

func (s PartitionId) MarshalJSON() ([]byte, error)

func (*PartitionId) UnmarshalJSON added in v0.23.0 

func (s *PartitionId) UnmarshalJSON(b []byte) error

type PersonalComputeAPI added in v0.34.0 

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

The Personal Compute enablement setting lets you control which users can use the Personal Compute default policy to create compute resources. By default all users in all workspaces have access (ON), but you can change the setting to instead let individual workspaces configure access control (DELEGATE).

There is only one instance of this setting per account. Since this setting has a default value, this setting is present on all accounts even though it's never set on a given account. Deletion reverts the value of the setting back to the default value.

func NewPersonalCompute added in v0.34.0 

func NewPersonalCompute(client *client.DatabricksClient) *PersonalComputeAPI

func (*PersonalComputeAPI) Delete added in v0.34.0 

func (a *PersonalComputeAPI) Delete(ctx context.Context, request DeletePersonalComputeSettingRequest) (*DeletePersonalComputeSettingResponse, error)

func (*PersonalComputeAPI) Get added in v0.34.0 

func (a *PersonalComputeAPI) Get(ctx context.Context, request GetPersonalComputeSettingRequest) (*PersonalComputeSetting, error)

func (*PersonalComputeAPI) Update added in v0.34.0 

func (a *PersonalComputeAPI) Update(ctx context.Context, request UpdatePersonalComputeSettingRequest) (*PersonalComputeSetting, error)

type PersonalComputeInterface added in v0.34.0 

type PersonalComputeInterface interface {

	// Reverts back the Personal Compute setting value to default (ON)
	Delete(ctx context.Context, request DeletePersonalComputeSettingRequest) (*DeletePersonalComputeSettingResponse, error)

	// Gets the value of the Personal Compute setting.
	Get(ctx context.Context, request GetPersonalComputeSettingRequest) (*PersonalComputeSetting, error)

	// Updates the value of the Personal Compute setting.
	Update(ctx context.Context, request UpdatePersonalComputeSettingRequest) (*PersonalComputeSetting, error)
}

type PersonalComputeMessage added in v0.10.0 

type PersonalComputeMessage struct {
	Value PersonalComputeMessageEnum `json:"value"`
}

type PersonalComputeMessageEnum added in v0.10.0 

type 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 PersonalComputeMessageEnumDelegate PersonalComputeMessageEnum = `DELEGATE`
const PersonalComputeMessageEnumOn PersonalComputeMessageEnum = `ON`

func (*PersonalComputeMessageEnum) Set added in v0.10.0 

func (f *PersonalComputeMessageEnum) Set(v string) error

Set raw string value and validate it against allowed values

func (*PersonalComputeMessageEnum) String added in v0.10.0 

func (f *PersonalComputeMessageEnum) String() string

String representation for fmt.Print

func (*PersonalComputeMessageEnum) Type added in v0.10.0 

func (f *PersonalComputeMessageEnum) Type() string

Type always returns PersonalComputeMessageEnum to satisfy [pflag.Value] interface

func (*PersonalComputeMessageEnum) Values added in v0.72.0 

func (f *PersonalComputeMessageEnum) Values() []PersonalComputeMessageEnum

Values returns all possible values for PersonalComputeMessageEnum.

There is no guarantee on the order of the values in the slice.

type PersonalComputeService deprecated added in v0.34.0 

type PersonalComputeService interface {

	// Reverts back the Personal Compute setting value to default (ON)
	Delete(ctx context.Context, request DeletePersonalComputeSettingRequest) (*DeletePersonalComputeSettingResponse, error)

	// Gets the value of the Personal Compute setting.
	Get(ctx context.Context, request GetPersonalComputeSettingRequest) (*PersonalComputeSetting, error)

	// Updates the value of the Personal Compute setting.
	Update(ctx context.Context, request UpdatePersonalComputeSettingRequest) (*PersonalComputeSetting, error)
}

The Personal Compute enablement setting lets you control which users can use the Personal Compute default policy to create compute resources. By default all users in all workspaces have access (ON), but you can change the setting to instead let individual workspaces configure access control (DELEGATE).

There is only one instance of this setting per account. Since this setting has a default value, this setting is present on all accounts even though it's never set on a given account. Deletion reverts the value of the setting back to the default value.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type PersonalComputeSetting added in v0.11.0 

type PersonalComputeSetting struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`

	PersonalCompute PersonalComputeMessage `json:"personal_compute"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (PersonalComputeSetting) MarshalJSON added in v0.23.0 

func (s PersonalComputeSetting) MarshalJSON() ([]byte, error)

func (*PersonalComputeSetting) UnmarshalJSON added in v0.23.0 

func (s *PersonalComputeSetting) UnmarshalJSON(b []byte) error

type PublicTokenInfo 

type PublicTokenInfo struct {
	// Comment the token was created with, if applicable.
	Comment string `json:"comment,omitempty"`
	// Server time (in epoch milliseconds) when the token was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Server time (in epoch milliseconds) when the token will expire, or -1 if
	// not applicable.
	ExpiryTime int64 `json:"expiry_time,omitempty"`
	// The ID of this token.
	TokenId string `json:"token_id,omitempty"`

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

func (PublicTokenInfo) MarshalJSON added in v0.23.0 

func (s PublicTokenInfo) MarshalJSON() ([]byte, error)

func (*PublicTokenInfo) UnmarshalJSON added in v0.23.0 

func (s *PublicTokenInfo) UnmarshalJSON(b []byte) error

type ReplaceIpAccessList 

type ReplaceIpAccessList struct {
	// Specifies whether this IP access list is enabled.
	Enabled bool `json:"enabled"`
	// The ID for the corresponding IP access list
	IpAccessListId string `json:"-" url:"-"`

	IpAddresses []string `json:"ip_addresses,omitempty"`
	// Label for the IP access list. This **cannot** be empty.
	Label string `json:"label"`

	ListType ListType `json:"list_type"`
}

Details required to replace an IP access list.

type RestrictWorkspaceAdminsAPI added in v0.34.0 

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

The Restrict Workspace Admins setting lets you control the capabilities of workspace admins. With the setting status set to ALLOW_ALL, workspace admins can create service principal personal access tokens on behalf of any service principal in their workspace. Workspace admins can also change a job owner to any user in their workspace. And they can change the job run_as setting to any user in their workspace or to a service principal on which they have the Service Principal User role. With the setting status set to RESTRICT_TOKENS_AND_JOB_RUN_AS, workspace admins can only create personal access tokens on behalf of service principals they have the Service Principal User role on. They can also only change a job owner to themselves. And they can change the job run_as setting to themselves or to a service principal on which they have the Service Principal User role.

func NewRestrictWorkspaceAdmins added in v0.34.0 

func NewRestrictWorkspaceAdmins(client *client.DatabricksClient) *RestrictWorkspaceAdminsAPI

func (*RestrictWorkspaceAdminsAPI) Delete added in v0.34.0 

func (a *RestrictWorkspaceAdminsAPI) Delete(ctx context.Context, request DeleteRestrictWorkspaceAdminsSettingRequest) (*DeleteRestrictWorkspaceAdminsSettingResponse, error)

func (*RestrictWorkspaceAdminsAPI) Get added in v0.34.0 

func (a *RestrictWorkspaceAdminsAPI) Get(ctx context.Context, request GetRestrictWorkspaceAdminsSettingRequest) (*RestrictWorkspaceAdminsSetting, error)

func (*RestrictWorkspaceAdminsAPI) Update added in v0.34.0 

func (a *RestrictWorkspaceAdminsAPI) Update(ctx context.Context, request UpdateRestrictWorkspaceAdminsSettingRequest) (*RestrictWorkspaceAdminsSetting, error)

type RestrictWorkspaceAdminsInterface added in v0.34.0 

type RestrictWorkspaceAdminsInterface interface {

	// Reverts the restrict workspace admins setting status for the workspace. A
	// fresh etag needs to be provided in `DELETE` requests (as a query parameter).
	// The etag can be retrieved by making a `GET` request before the DELETE
	// request. If the setting is updated/deleted concurrently, `DELETE` fails with
	// 409 and the request must be retried by using the fresh etag in the 409
	// response.
	Delete(ctx context.Context, request DeleteRestrictWorkspaceAdminsSettingRequest) (*DeleteRestrictWorkspaceAdminsSettingResponse, error)

	// Gets the restrict workspace admins setting.
	Get(ctx context.Context, request GetRestrictWorkspaceAdminsSettingRequest) (*RestrictWorkspaceAdminsSetting, error)

	// Updates the restrict workspace admins setting for the workspace. A fresh etag
	// needs to be provided in `PATCH` requests (as part of the setting field). The
	// etag can be retrieved by making a GET request before the `PATCH` request. If
	// the setting is updated concurrently, `PATCH` fails with 409 and the request
	// must be retried by using the fresh etag in the 409 response.
	Update(ctx context.Context, request UpdateRestrictWorkspaceAdminsSettingRequest) (*RestrictWorkspaceAdminsSetting, error)
}

type RestrictWorkspaceAdminsMessage added in v0.31.0 

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

type RestrictWorkspaceAdminsMessageStatus added in v0.31.0 

type RestrictWorkspaceAdminsMessageStatus string
const RestrictWorkspaceAdminsMessageStatusAllowAll RestrictWorkspaceAdminsMessageStatus = `ALLOW_ALL`
const RestrictWorkspaceAdminsMessageStatusRestrictTokensAndJobRunAs RestrictWorkspaceAdminsMessageStatus = `RESTRICT_TOKENS_AND_JOB_RUN_AS`

func (*RestrictWorkspaceAdminsMessageStatus) Set added in v0.31.0 

func (f *RestrictWorkspaceAdminsMessageStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*RestrictWorkspaceAdminsMessageStatus) String added in v0.31.0 

func (f *RestrictWorkspaceAdminsMessageStatus) String() string

String representation for fmt.Print

func (*RestrictWorkspaceAdminsMessageStatus) Type added in v0.31.0 

func (f *RestrictWorkspaceAdminsMessageStatus) Type() string

Type always returns RestrictWorkspaceAdminsMessageStatus to satisfy [pflag.Value] interface

func (*RestrictWorkspaceAdminsMessageStatus) Values added in v0.72.0 

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 RestrictWorkspaceAdminsService deprecated added in v0.34.0 

type RestrictWorkspaceAdminsService interface {

	// Reverts the restrict workspace admins setting status for the workspace. A
	// fresh etag needs to be provided in `DELETE` requests (as a query
	// parameter). The etag can be retrieved by making a `GET` request before
	// the DELETE request. If the setting is updated/deleted concurrently,
	// `DELETE` fails with 409 and the request must be retried by using the
	// fresh etag in the 409 response.
	Delete(ctx context.Context, request DeleteRestrictWorkspaceAdminsSettingRequest) (*DeleteRestrictWorkspaceAdminsSettingResponse, error)

	// Gets the restrict workspace admins setting.
	Get(ctx context.Context, request GetRestrictWorkspaceAdminsSettingRequest) (*RestrictWorkspaceAdminsSetting, error)

	// Updates the restrict workspace admins setting for the workspace. A fresh
	// etag needs to be provided in `PATCH` requests (as part of the setting
	// field). The etag can be retrieved by making a GET request before the
	// `PATCH` request. If the setting is updated concurrently, `PATCH` fails
	// with 409 and the request must be retried by using the fresh etag in the
	// 409 response.
	Update(ctx context.Context, request UpdateRestrictWorkspaceAdminsSettingRequest) (*RestrictWorkspaceAdminsSetting, error)
}

The Restrict Workspace Admins setting lets you control the capabilities of workspace admins. With the setting status set to ALLOW_ALL, workspace admins can create service principal personal access tokens on behalf of any service principal in their workspace. Workspace admins can also change a job owner to any user in their workspace. And they can change the job run_as setting to any user in their workspace or to a service principal on which they have the Service Principal User role. With the setting status set to RESTRICT_TOKENS_AND_JOB_RUN_AS, workspace admins can only create personal access tokens on behalf of service principals they have the Service Principal User role on. They can also only change a job owner to themselves. And they can change the job run_as setting to themselves or to a service principal on which they have the Service Principal User role.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type RestrictWorkspaceAdminsSetting added in v0.31.0 

type RestrictWorkspaceAdminsSetting struct {
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`

	RestrictWorkspaceAdmins RestrictWorkspaceAdminsMessage `json:"restrict_workspace_admins"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (RestrictWorkspaceAdminsSetting) MarshalJSON added in v0.31.0 

func (s RestrictWorkspaceAdminsSetting) MarshalJSON() ([]byte, error)

func (*RestrictWorkspaceAdminsSetting) UnmarshalJSON added in v0.31.0 

func (s *RestrictWorkspaceAdminsSetting) UnmarshalJSON(b []byte) error

type RevokeTokenRequest 

type RevokeTokenRequest struct {
	// The ID of the token to be revoked.
	TokenId string `json:"token_id"`
}

type SettingsAPI added in v0.21.0 

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

Workspace Settings API allows users to manage settings at the workspace level.

func NewSettings added in v0.21.0 

func NewSettings(client *client.DatabricksClient) *SettingsAPI

func (*SettingsAPI) AibiDashboardEmbeddingAccessPolicy added in v0.50.0 

func (a *SettingsAPI) AibiDashboardEmbeddingAccessPolicy() AibiDashboardEmbeddingAccessPolicyInterface

func (*SettingsAPI) AibiDashboardEmbeddingApprovedDomains added in v0.50.0 

func (a *SettingsAPI) AibiDashboardEmbeddingApprovedDomains() AibiDashboardEmbeddingApprovedDomainsInterface

func (*SettingsAPI) AutomaticClusterUpdate added in v0.34.0 

func (a *SettingsAPI) AutomaticClusterUpdate() AutomaticClusterUpdateInterface

func (*SettingsAPI) ComplianceSecurityProfile added in v0.40.0 

func (a *SettingsAPI) ComplianceSecurityProfile() ComplianceSecurityProfileInterface

func (*SettingsAPI) DashboardEmailSubscriptions added in v0.72.0 

func (a *SettingsAPI) DashboardEmailSubscriptions() DashboardEmailSubscriptionsInterface

func (*SettingsAPI) DefaultNamespace added in v0.34.0 

func (a *SettingsAPI) DefaultNamespace() DefaultNamespaceInterface

func (*SettingsAPI) DefaultWarehouseId added in v0.75.0 

func (a *SettingsAPI) DefaultWarehouseId() DefaultWarehouseIdInterface

func (*SettingsAPI) DisableLegacyAccess added in v0.47.0 

func (a *SettingsAPI) DisableLegacyAccess() DisableLegacyAccessInterface

func (*SettingsAPI) DisableLegacyDbfs added in v0.49.0 

func (a *SettingsAPI) DisableLegacyDbfs() DisableLegacyDbfsInterface

func (*SettingsAPI) EnableExportNotebook added in v0.63.0 

func (a *SettingsAPI) EnableExportNotebook() EnableExportNotebookInterface

func (*SettingsAPI) EnableNotebookTableClipboard added in v0.63.0 

func (a *SettingsAPI) EnableNotebookTableClipboard() EnableNotebookTableClipboardInterface

func (*SettingsAPI) EnableResultsDownloading added in v0.63.0 

func (a *SettingsAPI) EnableResultsDownloading() EnableResultsDownloadingInterface

func (*SettingsAPI) EnhancedSecurityMonitoring added in v0.40.0 

func (a *SettingsAPI) EnhancedSecurityMonitoring() EnhancedSecurityMonitoringInterface

func (*SettingsAPI) LlmProxyPartnerPoweredWorkspace added in v0.69.0 

func (a *SettingsAPI) LlmProxyPartnerPoweredWorkspace() LlmProxyPartnerPoweredWorkspaceInterface

func (*SettingsAPI) RestrictWorkspaceAdmins added in v0.34.0 

func (a *SettingsAPI) RestrictWorkspaceAdmins() RestrictWorkspaceAdminsInterface

func (*SettingsAPI) SqlResultsDownload added in v0.72.0 

func (a *SettingsAPI) SqlResultsDownload() SqlResultsDownloadInterface

type SettingsInterface added in v0.29.0 

type SettingsInterface interface {

	// Controls whether AI/BI published dashboard embedding is enabled,
	// conditionally enabled, or disabled at the workspace level. By default,
	// this setting is conditionally enabled (ALLOW_APPROVED_DOMAINS).
	AibiDashboardEmbeddingAccessPolicy() AibiDashboardEmbeddingAccessPolicyInterface

	// Controls the list of domains approved to host the embedded AI/BI
	// dashboards. The approved domains list can't be mutated when the current
	// access policy is not set to ALLOW_APPROVED_DOMAINS.
	AibiDashboardEmbeddingApprovedDomains() AibiDashboardEmbeddingApprovedDomainsInterface

	// Controls whether automatic cluster update is enabled for the current
	// workspace. By default, it is turned off.
	AutomaticClusterUpdate() AutomaticClusterUpdateInterface

	// Controls whether to enable the compliance security profile for the
	// current workspace. Enabling it on a workspace is permanent. By default,
	// it is turned off.
	//
	// This settings can NOT be disabled once it is enabled.
	ComplianceSecurityProfile() ComplianceSecurityProfileInterface

	// Controls whether schedules or workload tasks for refreshing AI/BI
	// Dashboards in the workspace can send subscription emails containing PDFs
	// and/or images of the dashboard. By default, this setting is enabled (set
	// to `true`)
	DashboardEmailSubscriptions() DashboardEmailSubscriptionsInterface

	// The default namespace setting API allows users to configure the default
	// namespace for a Databricks workspace.
	//
	// Through this API, users can retrieve, set, or modify the default
	// namespace used when queries do not reference a fully qualified
	// three-level name. For example, if you use the API to set 'retail_prod' as
	// the default catalog, then a query 'SELECT * FROM myTable' would reference
	// the object 'retail_prod.default.myTable' (the schema 'default' is always
	// assumed).
	//
	// This setting requires a restart of clusters and SQL warehouses to take
	// effect. Additionally, the default namespace only applies when using Unity
	// Catalog-enabled compute.
	DefaultNamespace() DefaultNamespaceInterface

	// Warehouse to be selected by default for users in this workspace. Covers
	// SQL workloads only and can be overridden by users.
	DefaultWarehouseId() DefaultWarehouseIdInterface

	// 'Disabling legacy access' has the following impacts:
	//
	// 1. Disables direct access to Hive Metastores from the workspace. However,
	// you can still access a Hive Metastore through Hive Metastore federation.
	// 2. Disables fallback mode on external location access from the workspace.
	// 3. Disables Databricks Runtime versions prior to 13.3LTS.
	DisableLegacyAccess() DisableLegacyAccessInterface

	// Disabling legacy DBFS has the following implications:
	//
	// 1. Access to DBFS root and DBFS mounts is disallowed (as well as the
	// creation of new mounts). 2. Disables Databricks Runtime versions prior to
	// 13.3LTS.
	//
	// When the setting is off, all DBFS functionality is enabled and no
	// restrictions are imposed on Databricks Runtime versions. This setting can
	// take up to 20 minutes to take effect and requires a manual restart of
	// all-purpose compute clusters and SQL warehouses.
	DisableLegacyDbfs() DisableLegacyDbfsInterface

	// Controls whether users can export notebooks and files from the Workspace
	// UI. By default, this setting is enabled.
	EnableExportNotebook() EnableExportNotebookInterface

	// Controls whether users can copy tabular data to the clipboard via the UI.
	// By default, this setting is enabled.
	EnableNotebookTableClipboard() EnableNotebookTableClipboardInterface

	// Controls whether users can download notebook results. By default, this
	// setting is enabled.
	EnableResultsDownloading() EnableResultsDownloadingInterface

	// Controls whether enhanced security monitoring is enabled for the current
	// workspace. If the compliance security profile is enabled, this is
	// automatically enabled. By default, it is disabled. However, if the
	// compliance security profile is enabled, this is automatically enabled.
	//
	// If the compliance security profile is disabled, you can enable or disable
	// this setting and it is not permanent.
	EnhancedSecurityMonitoring() EnhancedSecurityMonitoringInterface

	// Determines if partner powered models are enabled or not for a specific
	// workspace
	LlmProxyPartnerPoweredWorkspace() LlmProxyPartnerPoweredWorkspaceInterface

	// The Restrict Workspace Admins setting lets you control the capabilities
	// of workspace admins. With the setting status set to ALLOW_ALL, workspace
	// admins can create service principal personal access tokens on behalf of
	// any service principal in their workspace. Workspace admins can also
	// change a job owner to any user in their workspace. And they can change
	// the job run_as setting to any user in their workspace or to a service
	// principal on which they have the Service Principal User role. With the
	// setting status set to RESTRICT_TOKENS_AND_JOB_RUN_AS, workspace admins
	// can only create personal access tokens on behalf of service principals
	// they have the Service Principal User role on. They can also only change a
	// job owner to themselves. And they can change the job run_as setting to
	// themselves or to a service principal on which they have the Service
	// Principal User role.
	RestrictWorkspaceAdmins() RestrictWorkspaceAdminsInterface

	// Controls whether users within the workspace are allowed to download
	// results from the SQL Editor and AI/BI Dashboards UIs. By default, this
	// setting is enabled (set to `true`)
	SqlResultsDownload() SqlResultsDownloadInterface
}

type SettingsService deprecated added in v0.21.0 

type SettingsService interface {
}

Workspace Settings API allows users to manage settings at the workspace level.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type SlackConfig added in v0.44.0 

type SlackConfig struct {
	// [Input-Only] URL for Slack destination.
	Url string `json:"url,omitempty"`
	// [Output-Only] Whether URL is set.
	UrlSet bool `json:"url_set,omitempty"`

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

func (SlackConfig) MarshalJSON added in v0.44.0 

func (s SlackConfig) MarshalJSON() ([]byte, error)

func (*SlackConfig) UnmarshalJSON added in v0.44.0 

func (s *SlackConfig) UnmarshalJSON(b []byte) error

type SqlResultsDownload added in v0.72.0 

type SqlResultsDownload struct {
	BooleanVal BooleanMessage `json:"boolean_val"`
	// etag used for versioning. The response is at least as fresh as the eTag
	// provided. This is used for optimistic concurrency control as a way to
	// help prevent simultaneous writes of a setting overwriting each other. It
	// is strongly suggested that systems make use of the etag in the read ->
	// update pattern to perform setting updates in order to avoid race
	// conditions. That is, get an etag from a GET request, and pass it with the
	// PATCH request to identify the setting version you are updating.
	Etag string `json:"etag,omitempty"`
	// Name of the corresponding setting. This field is populated in the
	// response, but it will not be respected even if it's set in the request
	// body. The setting name in the path parameter will be respected instead.
	// Setting name is required to be 'default' if the setting only has one
	// instance per workspace.
	SettingName string `json:"setting_name,omitempty"`

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

func (SqlResultsDownload) MarshalJSON added in v0.72.0 

func (s SqlResultsDownload) MarshalJSON() ([]byte, error)

func (*SqlResultsDownload) UnmarshalJSON added in v0.72.0 

func (s *SqlResultsDownload) UnmarshalJSON(b []byte) error

type SqlResultsDownloadAPI added in v0.72.0 

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

Controls whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs. By default, this setting is enabled (set to `true`)

func NewSqlResultsDownload added in v0.72.0 

func NewSqlResultsDownload(client *client.DatabricksClient) *SqlResultsDownloadAPI

func (*SqlResultsDownloadAPI) Delete added in v0.72.0 

func (a *SqlResultsDownloadAPI) Delete(ctx context.Context, request DeleteSqlResultsDownloadRequest) (*DeleteSqlResultsDownloadResponse, error)

func (*SqlResultsDownloadAPI) Get added in v0.72.0 

func (a *SqlResultsDownloadAPI) Get(ctx context.Context, request GetSqlResultsDownloadRequest) (*SqlResultsDownload, error)

func (*SqlResultsDownloadAPI) Update added in v0.72.0 

func (a *SqlResultsDownloadAPI) Update(ctx context.Context, request UpdateSqlResultsDownloadRequest) (*SqlResultsDownload, error)

type SqlResultsDownloadInterface added in v0.72.0 

type SqlResultsDownloadInterface interface {

	// Reverts the SQL Results Download setting to its default value.
	Delete(ctx context.Context, request DeleteSqlResultsDownloadRequest) (*DeleteSqlResultsDownloadResponse, error)

	// Gets the SQL Results Download setting.
	Get(ctx context.Context, request GetSqlResultsDownloadRequest) (*SqlResultsDownload, error)

	// Updates the SQL Results Download setting.
	Update(ctx context.Context, request UpdateSqlResultsDownloadRequest) (*SqlResultsDownload, error)
}

type SqlResultsDownloadService deprecated added in v0.72.0 

type SqlResultsDownloadService interface {

	// Reverts the SQL Results Download setting to its default value.
	Delete(ctx context.Context, request DeleteSqlResultsDownloadRequest) (*DeleteSqlResultsDownloadResponse, error)

	// Gets the SQL Results Download setting.
	Get(ctx context.Context, request GetSqlResultsDownloadRequest) (*SqlResultsDownload, error)

	// Updates the SQL Results Download setting.
	Update(ctx context.Context, request UpdateSqlResultsDownloadRequest) (*SqlResultsDownload, error)
}

Controls whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs. By default, this setting is enabled (set to `true`)

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type StringMessage added in v0.21.0 

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

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

func (StringMessage) MarshalJSON added in v0.23.0 

func (s StringMessage) MarshalJSON() ([]byte, error)

func (*StringMessage) UnmarshalJSON added in v0.23.0 

func (s *StringMessage) UnmarshalJSON(b []byte) error

type TokenAccessControlRequest added in v0.15.0 

type TokenAccessControlRequest struct {
	// name of the group
	GroupName string `json:"group_name,omitempty"`

	PermissionLevel TokenPermissionLevel `json:"permission_level,omitempty"`
	// application ID of a service principal
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	UserName string `json:"user_name,omitempty"`

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

func (TokenAccessControlRequest) MarshalJSON added in v0.23.0 

func (s TokenAccessControlRequest) MarshalJSON() ([]byte, error)

func (*TokenAccessControlRequest) UnmarshalJSON added in v0.23.0 

func (s *TokenAccessControlRequest) UnmarshalJSON(b []byte) error

type TokenAccessControlResponse added in v0.15.0 

type TokenAccessControlResponse struct {
	// All permissions.
	AllPermissions []TokenPermission `json:"all_permissions,omitempty"`
	// Display name of the user or service principal.
	DisplayName string `json:"display_name,omitempty"`
	// name of the group
	GroupName string `json:"group_name,omitempty"`
	// Name of the service principal.
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	UserName string `json:"user_name,omitempty"`

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

func (TokenAccessControlResponse) MarshalJSON added in v0.23.0 

func (s TokenAccessControlResponse) MarshalJSON() ([]byte, error)

func (*TokenAccessControlResponse) UnmarshalJSON added in v0.23.0 

func (s *TokenAccessControlResponse) UnmarshalJSON(b []byte) error

type TokenInfo 

type TokenInfo struct {
	// Comment that describes the purpose of the token, specified by the token
	// creator.
	Comment string `json:"comment,omitempty"`
	// User ID of the user that created the token.
	CreatedById int64 `json:"created_by_id,omitempty"`
	// Username of the user that created the token.
	CreatedByUsername string `json:"created_by_username,omitempty"`
	// Timestamp when the token was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Timestamp when the token expires.
	ExpiryTime int64 `json:"expiry_time,omitempty"`
	// Approximate timestamp for the day the token was last used. Accurate up to
	// 1 day.
	LastUsedDay int64 `json:"last_used_day,omitempty"`
	// User ID of the user that owns the token.
	OwnerId int64 `json:"owner_id,omitempty"`
	// ID of the token.
	TokenId string `json:"token_id,omitempty"`
	// If applicable, the ID of the workspace that the token was created in.
	WorkspaceId int64 `json:"workspace_id,omitempty"`

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

func (TokenInfo) MarshalJSON added in v0.23.0 

func (s TokenInfo) MarshalJSON() ([]byte, error)

func (*TokenInfo) UnmarshalJSON added in v0.23.0 

func (s *TokenInfo) UnmarshalJSON(b []byte) error

type TokenManagementAPI 

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

Enables administrators to get all tokens and delete tokens for other users. Admins can either get every token, get a specific token by ID, or get all tokens for a particular user.

func NewTokenManagement 

func NewTokenManagement(client *client.DatabricksClient) *TokenManagementAPI

func (*TokenManagementAPI) CreateOboToken 

func (a *TokenManagementAPI) CreateOboToken(ctx context.Context, request CreateOboTokenRequest) (*CreateOboTokenResponse, error)
Example (CreateOboTokenOnAws) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

groups, err := w.Groups.GroupDisplayNameToIdMap(ctx, iam.ListGroupsRequest{})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", groups)

spn, err := w.ServicePrincipals.Create(ctx, iam.ServicePrincipal{
	DisplayName: fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	Groups: []iam.ComplexValue{iam.ComplexValue{
		Value: groups["admins"],
	}},
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", spn)

obo, err := w.TokenManagement.CreateOboToken(ctx, settings.CreateOboTokenRequest{
	ApplicationId:   spn.ApplicationId,
	LifetimeSeconds: 60,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", obo)

// cleanup

err = w.ServicePrincipals.DeleteById(ctx, spn.Id)
if err != nil {
	panic(err)
}
err = w.TokenManagement.DeleteByTokenId(ctx, obo.TokenInfo.TokenId)
if err != nil {
	panic(err)
}

func (*TokenManagementAPI) Delete 

func (a *TokenManagementAPI) Delete(ctx context.Context, request DeleteTokenManagementRequest) error

func (*TokenManagementAPI) DeleteByTokenId 

func (a *TokenManagementAPI) DeleteByTokenId(ctx context.Context, tokenId string) error

Deletes a token, specified by its ID.

func (*TokenManagementAPI) Get 

func (a *TokenManagementAPI) Get(ctx context.Context, request GetTokenManagementRequest) (*GetTokenResponse, error)
Example (CreateOboTokenOnAws) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

groups, err := w.Groups.GroupDisplayNameToIdMap(ctx, iam.ListGroupsRequest{})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", groups)

spn, err := w.ServicePrincipals.Create(ctx, iam.ServicePrincipal{
	DisplayName: fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	Groups: []iam.ComplexValue{iam.ComplexValue{
		Value: groups["admins"],
	}},
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", spn)

obo, err := w.TokenManagement.CreateOboToken(ctx, settings.CreateOboTokenRequest{
	ApplicationId:   spn.ApplicationId,
	LifetimeSeconds: 60,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", obo)

byId, err := w.TokenManagement.GetByTokenId(ctx, obo.TokenInfo.TokenId)
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", byId)

// cleanup

err = w.ServicePrincipals.DeleteById(ctx, spn.Id)
if err != nil {
	panic(err)
}
err = w.TokenManagement.DeleteByTokenId(ctx, obo.TokenInfo.TokenId)
if err != nil {
	panic(err)
}

func (*TokenManagementAPI) GetByComment 

func (a *TokenManagementAPI) GetByComment(ctx context.Context, name string) (*TokenInfo, error)

GetByComment calls TokenManagementAPI.TokenInfoCommentToTokenIdMap and returns a single TokenInfo.

Returns an error if there's more than one TokenInfo with the same .Comment.

Note: All TokenInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*TokenManagementAPI) GetByTokenId 

func (a *TokenManagementAPI) GetByTokenId(ctx context.Context, tokenId string) (*GetTokenResponse, error)

Gets information about a token, specified by its ID.

func (*TokenManagementAPI) GetPermissionLevels added in v0.19.0 

func (a *TokenManagementAPI) GetPermissionLevels(ctx context.Context) (*GetTokenPermissionLevelsResponse, error)

func (*TokenManagementAPI) GetPermissions added in v0.19.0 

func (a *TokenManagementAPI) GetPermissions(ctx context.Context) (*TokenPermissions, error)

func (*TokenManagementAPI) List added in v0.24.0 

func (a *TokenManagementAPI) List(ctx context.Context, request ListTokenManagementRequest) listing.Iterator[TokenInfo]

Lists all tokens associated with the specified workspace or user.

Example (CreateOboTokenOnAws) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

all, err := w.TokenManagement.ListAll(ctx, settings.ListTokenManagementRequest{})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", all)

func (*TokenManagementAPI) ListAll 

func (a *TokenManagementAPI) ListAll(ctx context.Context, request ListTokenManagementRequest) ([]TokenInfo, error)

Lists all tokens associated with the specified workspace or user.

func (*TokenManagementAPI) SetPermissions added in v0.19.0 

func (a *TokenManagementAPI) SetPermissions(ctx context.Context, request TokenPermissionsRequest) (*TokenPermissions, error)

func (*TokenManagementAPI) TokenInfoCommentToTokenIdMap added in v0.9.0 

func (a *TokenManagementAPI) TokenInfoCommentToTokenIdMap(ctx context.Context, request ListTokenManagementRequest) (map[string]string, error)

TokenInfoCommentToTokenIdMap calls TokenManagementAPI.ListAll and creates a map of results with TokenInfo.Comment as key and TokenInfo.TokenId as value.

Returns an error if there's more than one TokenInfo with the same .Comment.

Note: All TokenInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*TokenManagementAPI) UpdatePermissions added in v0.19.0 

func (a *TokenManagementAPI) UpdatePermissions(ctx context.Context, request TokenPermissionsRequest) (*TokenPermissions, error)

type TokenManagementInterface added in v0.29.0 

type TokenManagementInterface interface {

	// Creates a token on behalf of a service principal.
	CreateOboToken(ctx context.Context, request CreateOboTokenRequest) (*CreateOboTokenResponse, error)

	// Deletes a token, specified by its ID.
	Delete(ctx context.Context, request DeleteTokenManagementRequest) error

	// Deletes a token, specified by its ID.
	DeleteByTokenId(ctx context.Context, tokenId string) error

	// Gets information about a token, specified by its ID.
	Get(ctx context.Context, request GetTokenManagementRequest) (*GetTokenResponse, error)

	// Gets information about a token, specified by its ID.
	GetByTokenId(ctx context.Context, tokenId string) (*GetTokenResponse, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevels(ctx context.Context) (*GetTokenPermissionLevelsResponse, error)

	// Gets the permissions of all tokens. Tokens can inherit permissions from their
	// root object.
	GetPermissions(ctx context.Context) (*TokenPermissions, error)

	// Lists all tokens associated with the specified workspace or user.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListTokenManagementRequest) listing.Iterator[TokenInfo]

	// Lists all tokens associated with the specified workspace or user.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListTokenManagementRequest) ([]TokenInfo, error)

	// TokenInfoCommentToTokenIdMap calls [TokenManagementAPI.ListAll] and creates a map of results with [TokenInfo].Comment as key and [TokenInfo].TokenId as value.
	//
	// Returns an error if there's more than one [TokenInfo] with the same .Comment.
	//
	// Note: All [TokenInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	TokenInfoCommentToTokenIdMap(ctx context.Context, request ListTokenManagementRequest) (map[string]string, error)

	// GetByComment calls [TokenManagementAPI.TokenInfoCommentToTokenIdMap] and returns a single [TokenInfo].
	//
	// Returns an error if there's more than one [TokenInfo] with the same .Comment.
	//
	// Note: All [TokenInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByComment(ctx context.Context, name string) (*TokenInfo, error)

	// Sets permissions on an object, replacing existing permissions if they exist.
	// Deletes all direct permissions if none are specified. Objects can inherit
	// permissions from their root object.
	SetPermissions(ctx context.Context, request TokenPermissionsRequest) (*TokenPermissions, error)

	// Updates the permissions on all tokens. Tokens can inherit permissions from
	// their root object.
	UpdatePermissions(ctx context.Context, request TokenPermissionsRequest) (*TokenPermissions, error)
}

type TokenManagementService deprecated 

type TokenManagementService interface {

	// Creates a token on behalf of a service principal.
	CreateOboToken(ctx context.Context, request CreateOboTokenRequest) (*CreateOboTokenResponse, error)

	// Deletes a token, specified by its ID.
	Delete(ctx context.Context, request DeleteTokenManagementRequest) error

	// Gets information about a token, specified by its ID.
	Get(ctx context.Context, request GetTokenManagementRequest) (*GetTokenResponse, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevels(ctx context.Context) (*GetTokenPermissionLevelsResponse, error)

	// Gets the permissions of all tokens. Tokens can inherit permissions from
	// their root object.
	GetPermissions(ctx context.Context) (*TokenPermissions, error)

	// Lists all tokens associated with the specified workspace or user.
	List(ctx context.Context, request ListTokenManagementRequest) (*ListTokensResponse, error)

	// Sets permissions on an object, replacing existing permissions if they
	// exist. Deletes all direct permissions if none are specified. Objects can
	// inherit permissions from their root object.
	SetPermissions(ctx context.Context, request TokenPermissionsRequest) (*TokenPermissions, error)

	// Updates the permissions on all tokens. Tokens can inherit permissions
	// from their root object.
	UpdatePermissions(ctx context.Context, request TokenPermissionsRequest) (*TokenPermissions, error)
}

Enables administrators to get all tokens and delete tokens for other users. Admins can either get every token, get a specific token by ID, or get all tokens for a particular user.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type TokenPermission added in v0.15.0 

type TokenPermission struct {
	Inherited bool `json:"inherited,omitempty"`

	InheritedFromObject []string `json:"inherited_from_object,omitempty"`

	PermissionLevel TokenPermissionLevel `json:"permission_level,omitempty"`

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

func (TokenPermission) MarshalJSON added in v0.23.0 

func (s TokenPermission) MarshalJSON() ([]byte, error)

func (*TokenPermission) UnmarshalJSON added in v0.23.0 

func (s *TokenPermission) UnmarshalJSON(b []byte) error

type TokenPermissionLevel added in v0.15.0 

type TokenPermissionLevel string

Permission level 

const TokenPermissionLevelCanUse TokenPermissionLevel = `CAN_USE`

func (*TokenPermissionLevel) Set added in v0.15.0 

func (f *TokenPermissionLevel) Set(v string) error

Set raw string value and validate it against allowed values

func (*TokenPermissionLevel) String added in v0.15.0 

func (f *TokenPermissionLevel) String() string

String representation for fmt.Print

func (*TokenPermissionLevel) Type added in v0.15.0 

func (f *TokenPermissionLevel) Type() string

Type always returns TokenPermissionLevel to satisfy [pflag.Value] interface

func (*TokenPermissionLevel) Values added in v0.72.0 

func (f *TokenPermissionLevel) Values() []TokenPermissionLevel

Values returns all possible values for TokenPermissionLevel.

There is no guarantee on the order of the values in the slice.

type TokenPermissions added in v0.15.0 

type TokenPermissions struct {
	AccessControlList []TokenAccessControlResponse `json:"access_control_list,omitempty"`

	ObjectId string `json:"object_id,omitempty"`

	ObjectType string `json:"object_type,omitempty"`

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

func (TokenPermissions) MarshalJSON added in v0.23.0 

func (s TokenPermissions) MarshalJSON() ([]byte, error)

func (*TokenPermissions) UnmarshalJSON added in v0.23.0 

func (s *TokenPermissions) UnmarshalJSON(b []byte) error

type TokenPermissionsDescription added in v0.15.0 

type TokenPermissionsDescription struct {
	Description string `json:"description,omitempty"`

	PermissionLevel TokenPermissionLevel `json:"permission_level,omitempty"`

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

func (TokenPermissionsDescription) MarshalJSON added in v0.23.0 

func (s TokenPermissionsDescription) MarshalJSON() ([]byte, error)

func (*TokenPermissionsDescription) UnmarshalJSON added in v0.23.0 

func (s *TokenPermissionsDescription) UnmarshalJSON(b []byte) error

type TokenPermissionsRequest added in v0.15.0 

type TokenPermissionsRequest struct {
	AccessControlList []TokenAccessControlRequest `json:"access_control_list,omitempty"`
}

type TokenType added in v0.20.0 

type TokenType string

The type of token request. As of now, only `AZURE_ACTIVE_DIRECTORY_TOKEN` is supported. 

const TokenTypeArclightAzureExchangeToken TokenType = `ARCLIGHT_AZURE_EXCHANGE_TOKEN`
const TokenTypeArclightAzureExchangeTokenWithUserDelegationKey TokenType = `ARCLIGHT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY`
const TokenTypeArclightMultiTenantAzureExchangeToken TokenType = `ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN`
const TokenTypeArclightMultiTenantAzureExchangeTokenWithUserDelegationKey TokenType = `ARCLIGHT_MULTI_TENANT_AZURE_EXCHANGE_TOKEN_WITH_USER_DELEGATION_KEY`
const TokenTypeAzureActiveDirectoryToken TokenType = `AZURE_ACTIVE_DIRECTORY_TOKEN`

func (*TokenType) Set added in v0.20.0 

func (f *TokenType) Set(v string) error

Set raw string value and validate it against allowed values

func (*TokenType) String added in v0.20.0 

func (f *TokenType) String() string

String representation for fmt.Print

func (*TokenType) Type added in v0.20.0 

func (f *TokenType) Type() string

Type always returns TokenType to satisfy [pflag.Value] interface

func (*TokenType) Values added in v0.72.0 

func (f *TokenType) Values() []TokenType

Values returns all possible values for TokenType.

There is no guarantee on the order of the values in the slice.

type TokensAPI 

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

The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.

func NewTokens 

func NewTokens(client *client.DatabricksClient) *TokensAPI

func (*TokensAPI) Create 

func (a *TokensAPI) Create(ctx context.Context, request CreateTokenRequest) (*CreateTokenResponse, error)
Example (Tokens) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

token, err := w.Tokens.Create(ctx, settings.CreateTokenRequest{
	Comment:         fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	LifetimeSeconds: 300,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", token)

// cleanup

err = w.Tokens.DeleteByTokenId(ctx, token.TokenInfo.TokenId)
if err != nil {
	panic(err)
}

func (*TokensAPI) Delete 

func (a *TokensAPI) Delete(ctx context.Context, request RevokeTokenRequest) error

func (*TokensAPI) DeleteByTokenId 

func (a *TokensAPI) DeleteByTokenId(ctx context.Context, tokenId string) error

Revokes an access token.

If a token with the specified ID is not valid, this call returns an error **RESOURCE_DOES_NOT_EXIST**.

func (*TokensAPI) GetByComment 

func (a *TokensAPI) GetByComment(ctx context.Context, name string) (*PublicTokenInfo, error)

GetByComment calls TokensAPI.PublicTokenInfoCommentToTokenIdMap and returns a single PublicTokenInfo.

Returns an error if there's more than one PublicTokenInfo with the same .Comment.

Note: All PublicTokenInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

Example (Tokens) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

token, err := w.Tokens.Create(ctx, settings.CreateTokenRequest{
	Comment:         fmt.Sprintf("sdk-%x", time.Now().UnixNano()),
	LifetimeSeconds: 300,
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", token)

byName, err := w.Tokens.GetByComment(ctx, token.TokenInfo.Comment)
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", byName)

// cleanup

err = w.Tokens.DeleteByTokenId(ctx, token.TokenInfo.TokenId)
if err != nil {
	panic(err)
}

func (*TokensAPI) List added in v0.24.0 

func (a *TokensAPI) List(ctx context.Context) listing.Iterator[PublicTokenInfo]

Lists all the valid tokens for a user-workspace pair.

Example (Tokens) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

all, err := w.Tokens.ListAll(ctx)
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", all)

func (*TokensAPI) ListAll 

func (a *TokensAPI) ListAll(ctx context.Context) ([]PublicTokenInfo, error)

Lists all the valid tokens for a user-workspace pair.

func (*TokensAPI) PublicTokenInfoCommentToTokenIdMap 

func (a *TokensAPI) PublicTokenInfoCommentToTokenIdMap(ctx context.Context) (map[string]string, error)

PublicTokenInfoCommentToTokenIdMap calls TokensAPI.ListAll and creates a map of results with PublicTokenInfo.Comment as key and PublicTokenInfo.TokenId as value.

Returns an error if there's more than one PublicTokenInfo with the same .Comment.

Note: All PublicTokenInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

type TokensInterface added in v0.29.0 

type TokensInterface interface {

	// Creates and returns a token for a user. If this call is made through token
	// authentication, it creates a token with the same client ID as the
	// authenticated token. If the user's token quota is exceeded, this call returns
	// an error **QUOTA_EXCEEDED**.
	Create(ctx context.Context, request CreateTokenRequest) (*CreateTokenResponse, error)

	// Revokes an access token.
	//
	// If a token with the specified ID is not valid, this call returns an error
	// **RESOURCE_DOES_NOT_EXIST**.
	Delete(ctx context.Context, request RevokeTokenRequest) error

	// Revokes an access token.
	//
	// If a token with the specified ID is not valid, this call returns an error
	// **RESOURCE_DOES_NOT_EXIST**.
	DeleteByTokenId(ctx context.Context, tokenId string) error

	// Lists all the valid tokens for a user-workspace pair.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context) listing.Iterator[PublicTokenInfo]

	// Lists all the valid tokens for a user-workspace pair.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context) ([]PublicTokenInfo, error)

	// PublicTokenInfoCommentToTokenIdMap calls [TokensAPI.ListAll] and creates a map of results with [PublicTokenInfo].Comment as key and [PublicTokenInfo].TokenId as value.
	//
	// Returns an error if there's more than one [PublicTokenInfo] with the same .Comment.
	//
	// Note: All [PublicTokenInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	PublicTokenInfoCommentToTokenIdMap(ctx context.Context) (map[string]string, error)

	// GetByComment calls [TokensAPI.PublicTokenInfoCommentToTokenIdMap] and returns a single [PublicTokenInfo].
	//
	// Returns an error if there's more than one [PublicTokenInfo] with the same .Comment.
	//
	// Note: All [PublicTokenInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByComment(ctx context.Context, name string) (*PublicTokenInfo, error)
}

type TokensService deprecated 

type TokensService interface {

	// Creates and returns a token for a user. If this call is made through
	// token authentication, it creates a token with the same client ID as the
	// authenticated token. If the user's token quota is exceeded, this call
	// returns an error **QUOTA_EXCEEDED**.
	Create(ctx context.Context, request CreateTokenRequest) (*CreateTokenResponse, error)

	// Revokes an access token.
	//
	// If a token with the specified ID is not valid, this call returns an error
	// **RESOURCE_DOES_NOT_EXIST**.
	Delete(ctx context.Context, request RevokeTokenRequest) error

	// Lists all the valid tokens for a user-workspace pair.
	List(ctx context.Context) (*ListPublicTokensResponse, error)
}

The Token API allows you to create, list, and revoke tokens that can be used to authenticate and access Databricks REST APIs.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type UpdateAccountIpAccessEnableRequest added in v0.57.0 

type UpdateAccountIpAccessEnableRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting AccountIpAccessEnable `json:"setting"`
}

Details required to update a setting.

type UpdateAibiDashboardEmbeddingAccessPolicySettingRequest added in v0.50.0 

type UpdateAibiDashboardEmbeddingAccessPolicySettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting AibiDashboardEmbeddingAccessPolicySetting `json:"setting"`
}

Details required to update a setting.

type UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest added in v0.50.0 

type UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting AibiDashboardEmbeddingApprovedDomainsSetting `json:"setting"`
}

Details required to update a setting.

type UpdateAutomaticClusterUpdateSettingRequest added in v0.34.0 

type UpdateAutomaticClusterUpdateSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting AutomaticClusterUpdateSetting `json:"setting"`
}

Details required to update a setting.

type UpdateComplianceSecurityProfileSettingRequest added in v0.40.0 

type UpdateComplianceSecurityProfileSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting ComplianceSecurityProfileSetting `json:"setting"`
}

Details required to update a setting.

type UpdateCspEnablementAccountSettingRequest added in v0.34.0 

type UpdateCspEnablementAccountSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting CspEnablementAccountSetting `json:"setting"`
}

Details required to update a setting.

type UpdateDashboardEmailSubscriptionsRequest added in v0.72.0 

type UpdateDashboardEmailSubscriptionsRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting DashboardEmailSubscriptions `json:"setting"`
}

Details required to update a setting.

type UpdateDefaultNamespaceSettingRequest added in v0.31.0 

type UpdateDefaultNamespaceSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting DefaultNamespaceSetting `json:"setting"`
}

Details required to update a setting.

type UpdateDefaultWarehouseIdRequest added in v0.75.0 

type UpdateDefaultWarehouseIdRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting DefaultWarehouseId `json:"setting"`
}

Details required to update a setting.

type UpdateDisableLegacyAccessRequest added in v0.47.0 

type UpdateDisableLegacyAccessRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting DisableLegacyAccess `json:"setting"`
}

Details required to update a setting.

type UpdateDisableLegacyDbfsRequest added in v0.49.0 

type UpdateDisableLegacyDbfsRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting DisableLegacyDbfs `json:"setting"`
}

Details required to update a setting.

type UpdateDisableLegacyFeaturesRequest added in v0.47.0 

type UpdateDisableLegacyFeaturesRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting DisableLegacyFeatures `json:"setting"`
}

Details required to update a setting.

type UpdateEnableExportNotebookRequest added in v0.63.0 

type UpdateEnableExportNotebookRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting EnableExportNotebook `json:"setting"`
}

Details required to update a setting.

type UpdateEnableNotebookTableClipboardRequest added in v0.63.0 

type UpdateEnableNotebookTableClipboardRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting EnableNotebookTableClipboard `json:"setting"`
}

Details required to update a setting.

type UpdateEnableResultsDownloadingRequest added in v0.63.0 

type UpdateEnableResultsDownloadingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting EnableResultsDownloading `json:"setting"`
}

Details required to update a setting.

type UpdateEnhancedSecurityMonitoringSettingRequest added in v0.40.0 

type UpdateEnhancedSecurityMonitoringSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting EnhancedSecurityMonitoringSetting `json:"setting"`
}

Details required to update a setting.

type UpdateEsmEnablementAccountSettingRequest added in v0.34.0 

type UpdateEsmEnablementAccountSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting EsmEnablementAccountSetting `json:"setting"`
}

Details required to update a setting.

type UpdateIpAccessList 

type UpdateIpAccessList struct {
	// Specifies whether this IP access list is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// The ID for the corresponding IP access list
	IpAccessListId string `json:"-" url:"-"`

	IpAddresses []string `json:"ip_addresses,omitempty"`
	// Label for the IP access list. This **cannot** be empty.
	Label string `json:"label,omitempty"`

	ListType ListType `json:"list_type,omitempty"`

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

Details required to update an IP access list.

func (UpdateIpAccessList) MarshalJSON added in v0.23.0 

func (s UpdateIpAccessList) MarshalJSON() ([]byte, error)

func (*UpdateIpAccessList) UnmarshalJSON added in v0.23.0 

func (s *UpdateIpAccessList) UnmarshalJSON(b []byte) error

type UpdateLlmProxyPartnerPoweredAccountRequest added in v0.69.0 

type UpdateLlmProxyPartnerPoweredAccountRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting LlmProxyPartnerPoweredAccount `json:"setting"`
}

Details required to update a setting.

type UpdateLlmProxyPartnerPoweredEnforceRequest added in v0.69.0 

type UpdateLlmProxyPartnerPoweredEnforceRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting LlmProxyPartnerPoweredEnforce `json:"setting"`
}

Details required to update a setting.

type UpdateLlmProxyPartnerPoweredWorkspaceRequest added in v0.69.0 

type UpdateLlmProxyPartnerPoweredWorkspaceRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting LlmProxyPartnerPoweredWorkspace `json:"setting"`
}

Details required to update a setting.

type UpdateNccPrivateEndpointRuleRequest added in v0.72.0 

type UpdateNccPrivateEndpointRuleRequest struct {
	// The ID of a network connectivity configuration, which is the parent
	// resource of this private endpoint rule object.
	NetworkConnectivityConfigId string `json:"-" url:"-"`

	PrivateEndpointRule UpdatePrivateEndpointRule `json:"private_endpoint_rule"`
	// Your private endpoint rule ID.
	PrivateEndpointRuleId string `json:"-" url:"-"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	UpdateMask string `json:"-" url:"update_mask"`
}

type UpdateNetworkPolicyRequest added in v0.70.0 

type UpdateNetworkPolicyRequest struct {
	// Updated network policy configuration details.
	NetworkPolicy AccountNetworkPolicy `json:"network_policy"`
	// The unique identifier for the network policy.
	NetworkPolicyId string `json:"-" url:"-"`
}

type UpdateNotificationDestinationRequest added in v0.44.0 

type UpdateNotificationDestinationRequest struct {
	// The configuration for the notification destination. Must wrap EXACTLY one
	// of the nested configs.
	Config *Config `json:"config,omitempty"`
	// The display name for the notification destination.
	DisplayName string `json:"display_name,omitempty"`
	// UUID identifying notification destination.
	Id string `json:"-" url:"-"`

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

func (UpdateNotificationDestinationRequest) MarshalJSON added in v0.44.0 

func (s UpdateNotificationDestinationRequest) MarshalJSON() ([]byte, error)

func (*UpdateNotificationDestinationRequest) UnmarshalJSON added in v0.44.0 

func (s *UpdateNotificationDestinationRequest) UnmarshalJSON(b []byte) error

type UpdatePersonalComputeSettingRequest added in v0.11.0 

type UpdatePersonalComputeSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting PersonalComputeSetting `json:"setting"`
}

Details required to update a setting.

type UpdatePrivateEndpointRule added in v0.66.0 

type UpdatePrivateEndpointRule struct {
	// Only used by private endpoints to customer-managed private endpoint
	// services.
	//
	// Domain names of target private link service. When updating this field,
	// the full list of target domain_names must be specified.
	DomainNames []string `json:"domain_names,omitempty"`
	// Only used by private endpoints towards an AWS S3 service.
	//
	// Update this field to activate/deactivate this private endpoint to allow
	// egress access from serverless compute resources.
	Enabled bool `json:"enabled,omitempty"`
	// Only used by private endpoints towards AWS S3 service.
	//
	// The globally unique S3 bucket names that will be accessed via the VPC
	// endpoint. The bucket names must be in the same region as the NCC/endpoint
	// service. When updating this field, we perform full update on this field.
	// Please ensure a full list of desired resource_names is provided.
	ResourceNames []string `json:"resource_names,omitempty"`

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

Properties of the new private endpoint rule. Note that you must approve the endpoint in Azure portal after initialization.

func (UpdatePrivateEndpointRule) MarshalJSON added in v0.72.0 

func (s UpdatePrivateEndpointRule) MarshalJSON() ([]byte, error)

func (*UpdatePrivateEndpointRule) UnmarshalJSON added in v0.72.0 

func (s *UpdatePrivateEndpointRule) UnmarshalJSON(b []byte) error

type UpdateRestrictWorkspaceAdminsSettingRequest added in v0.31.0 

type UpdateRestrictWorkspaceAdminsSettingRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting RestrictWorkspaceAdminsSetting `json:"setting"`
}

Details required to update a setting.

type UpdateSqlResultsDownloadRequest added in v0.72.0 

type UpdateSqlResultsDownloadRequest struct {
	// This should always be set to true for Settings API. Added for AIP
	// compliance.
	AllowMissing bool `json:"allow_missing"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	FieldMask string `json:"field_mask"`

	Setting SqlResultsDownload `json:"setting"`
}

Details required to update a setting.

type UpdateWorkspaceNetworkOptionRequest added in v0.70.0 

type UpdateWorkspaceNetworkOptionRequest struct {
	// The workspace ID.
	WorkspaceId int64 `json:"-" url:"-"`
	// The network option details for the workspace.
	WorkspaceNetworkOption WorkspaceNetworkOption `json:"workspace_network_option"`
}

type WorkspaceConf 

type WorkspaceConf map[string]string

type WorkspaceConfAPI 

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

This API allows updating known workspace settings for advanced users.

func NewWorkspaceConf 

func NewWorkspaceConf(client *client.DatabricksClient) *WorkspaceConfAPI

func (*WorkspaceConfAPI) GetStatus 

func (a *WorkspaceConfAPI) GetStatus(ctx context.Context, request GetStatusRequest) (*map[string]string, error)
Example (Repos) 
ctx := context.Background()
w, err := databricks.NewWorkspaceClient()
if err != nil {
	panic(err)
}

conf, err := w.WorkspaceConf.GetStatus(ctx, settings.GetStatusRequest{
	Keys: "enableWorkspaceFilesystem",
})
if err != nil {
	panic(err)
}
logger.Infof(ctx, "found %v", conf)

func (*WorkspaceConfAPI) SetStatus 

func (a *WorkspaceConfAPI) SetStatus(ctx context.Context, request WorkspaceConf) error

type WorkspaceConfInterface added in v0.29.0 

type WorkspaceConfInterface interface {

	// Gets the configuration status for a workspace.
	GetStatus(ctx context.Context, request GetStatusRequest) (*map[string]string, error)

	// Sets the configuration status for a workspace, including enabling or
	// disabling it.
	SetStatus(ctx context.Context, request WorkspaceConf) error
}

type WorkspaceConfService deprecated 

type WorkspaceConfService interface {

	// Gets the configuration status for a workspace.
	GetStatus(ctx context.Context, request GetStatusRequest) (*map[string]string, error)

	// Sets the configuration status for a workspace, including enabling or
	// disabling it.
	SetStatus(ctx context.Context, request WorkspaceConf) error
}

This API allows updating known workspace settings for advanced users.

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type WorkspaceNetworkConfigurationAPI added in v0.70.0 

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

These APIs allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace. Each workspace is always associated with exactly one network policy that controls which network destinations can be accessed from the Databricks environment. By default, workspaces are associated with the 'default-policy' network policy. You cannot create or delete a workspace's network option, only update it to associate the workspace with a different policy

func NewWorkspaceNetworkConfiguration added in v0.70.0 

func NewWorkspaceNetworkConfiguration(client *client.DatabricksClient) *WorkspaceNetworkConfigurationAPI

func (*WorkspaceNetworkConfigurationAPI) GetWorkspaceNetworkOptionRpc added in v0.70.0 

func (a *WorkspaceNetworkConfigurationAPI) GetWorkspaceNetworkOptionRpc(ctx context.Context, request GetWorkspaceNetworkOptionRequest) (*WorkspaceNetworkOption, error)

func (*WorkspaceNetworkConfigurationAPI) GetWorkspaceNetworkOptionRpcByWorkspaceId added in v0.70.0 

func (a *WorkspaceNetworkConfigurationAPI) GetWorkspaceNetworkOptionRpcByWorkspaceId(ctx context.Context, workspaceId int64) (*WorkspaceNetworkOption, error)

Gets the network option for a workspace. Every workspace has exactly one network policy binding, with 'default-policy' used if no explicit assignment exists.

func (*WorkspaceNetworkConfigurationAPI) UpdateWorkspaceNetworkOptionRpc added in v0.70.0 

func (a *WorkspaceNetworkConfigurationAPI) UpdateWorkspaceNetworkOptionRpc(ctx context.Context, request UpdateWorkspaceNetworkOptionRequest) (*WorkspaceNetworkOption, error)

type WorkspaceNetworkConfigurationInterface added in v0.70.0 

type WorkspaceNetworkConfigurationInterface interface {

	// Gets the network option for a workspace. Every workspace has exactly one
	// network policy binding, with 'default-policy' used if no explicit assignment
	// exists.
	GetWorkspaceNetworkOptionRpc(ctx context.Context, request GetWorkspaceNetworkOptionRequest) (*WorkspaceNetworkOption, error)

	// Gets the network option for a workspace. Every workspace has exactly one
	// network policy binding, with 'default-policy' used if no explicit assignment
	// exists.
	GetWorkspaceNetworkOptionRpcByWorkspaceId(ctx context.Context, workspaceId int64) (*WorkspaceNetworkOption, error)

	// Updates the network option for a workspace. This operation associates the
	// workspace with the specified network policy. To revert to the default policy,
	// specify 'default-policy' as the network_policy_id.
	UpdateWorkspaceNetworkOptionRpc(ctx context.Context, request UpdateWorkspaceNetworkOptionRequest) (*WorkspaceNetworkOption, error)
}

type WorkspaceNetworkConfigurationService deprecated added in v0.70.0 

type WorkspaceNetworkConfigurationService interface {

	// Gets the network option for a workspace. Every workspace has exactly one
	// network policy binding, with 'default-policy' used if no explicit
	// assignment exists.
	GetWorkspaceNetworkOptionRpc(ctx context.Context, request GetWorkspaceNetworkOptionRequest) (*WorkspaceNetworkOption, error)

	// Updates the network option for a workspace. This operation associates the
	// workspace with the specified network policy. To revert to the default
	// policy, specify 'default-policy' as the network_policy_id.
	UpdateWorkspaceNetworkOptionRpc(ctx context.Context, request UpdateWorkspaceNetworkOptionRequest) (*WorkspaceNetworkOption, error)
}

These APIs allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace. Each workspace is always associated with exactly one network policy that controls which network destinations can be accessed from the Databricks environment. By default, workspaces are associated with the 'default-policy' network policy. You cannot create or delete a workspace's network option, only update it to associate the workspace with a different policy

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type WorkspaceNetworkOption added in v0.70.0 

type WorkspaceNetworkOption struct {
	// The network policy ID to apply to the workspace. This controls the
	// network access rules for all serverless compute resources in the
	// workspace. Each workspace can only be linked to one policy at a time. If
	// no policy is explicitly assigned, the workspace will use
	// 'default-policy'.
	NetworkPolicyId string `json:"network_policy_id,omitempty"`
	// The workspace ID.
	WorkspaceId int64 `json:"workspace_id,omitempty"`

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

func (WorkspaceNetworkOption) MarshalJSON added in v0.70.0 

func (s WorkspaceNetworkOption) MarshalJSON() ([]byte, error)

func (*WorkspaceNetworkOption) UnmarshalJSON added in v0.70.0 

func (s *WorkspaceNetworkOption) UnmarshalJSON(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.