provisioning

type AwsCredentials struct {
	StsRole *StsRole `json:"sts_role,omitempty"`
}

type AwsKeyInfo struct {
	// The AWS KMS key alias.
	KeyAlias string `json:"key_alias,omitempty"`
	// The AWS KMS key's Amazon Resource Name (ARN).
	KeyArn string `json:"key_arn"`
	// The AWS KMS key region.
	KeyRegion string `json:"key_region"`
	// This field applies only if the `use_cases` property includes `STORAGE`.
	// If this is set to true or omitted, the key is also used to encrypt
	// cluster EBS volumes. If you do not want to use this key for encrypting
	// EBS volumes, set to false.
	ReuseKeyForClusterVolumes bool `json:"reuse_key_for_cluster_volumes,omitempty"`

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

type AzureKeyInfo struct {
	// The Disk Encryption Set id that is used to represent the key info used
	// for Managed Disk BYOK use case
	DiskEncryptionSetId string `json:"disk_encryption_set_id,omitempty"`
	// The structure to store key access credential This is set if the Managed
	// Identity is being used to access the Azure Key Vault key.
	KeyAccessConfiguration *KeyAccessConfiguration `json:"key_access_configuration,omitempty"`
	// The name of the key in KeyVault.
	KeyName string `json:"key_name,omitempty"`
	// The base URI of the KeyVault.
	KeyVaultUri string `json:"key_vault_uri,omitempty"`
	// The tenant id where the KeyVault lives.
	TenantId string `json:"tenant_id,omitempty"`
	// The current key version.
	Version string `json:"version,omitempty"`

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

type AzureWorkspaceInfo struct {
	// Azure Resource Group name
	ResourceGroup string `json:"resource_group,omitempty"`
	// Azure Subscription ID
	SubscriptionId string `json:"subscription_id,omitempty"`

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

type CloudResourceContainer struct {
	Gcp *CustomerFacingGcpCloudResourceContainer `json:"gcp,omitempty"`
}

type CreateAwsKeyInfo struct {
	// The AWS KMS key alias.
	KeyAlias string `json:"key_alias,omitempty"`
	// The AWS KMS key's Amazon Resource Name (ARN).
	KeyArn string `json:"key_arn"`
	// The AWS KMS key region.
	KeyRegion string `json:"key_region,omitempty"`
	// This field applies only if the `use_cases` property includes `STORAGE`.
	// If this is set to true or omitted, the key is also used to encrypt
	// cluster EBS volumes. If you do not want to use this key for encrypting
	// EBS volumes, set to false.
	ReuseKeyForClusterVolumes bool `json:"reuse_key_for_cluster_volumes,omitempty"`

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

type CreateCredentialAwsCredentials struct {
	StsRole *CreateCredentialStsRole `json:"sts_role,omitempty"`
}

type CreateCredentialRequest struct {
	AwsCredentials CreateCredentialAwsCredentials `json:"aws_credentials"`
	// The human-readable name of the credential configuration object.
	CredentialsName string `json:"credentials_name"`
}

type CreateCredentialStsRole struct {
	// The Amazon Resource Name (ARN) of the cross account IAM role.
	RoleArn string `json:"role_arn,omitempty"`

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

type CreateCustomerManagedKeyRequest struct {
	AwsKeyInfo *CreateAwsKeyInfo `json:"aws_key_info,omitempty"`

	GcpKeyInfo *CreateGcpKeyInfo `json:"gcp_key_info,omitempty"`
	// The cases that the key can be used for.
	UseCases []KeyUseCase `json:"use_cases"`
}

type CreateGcpKeyInfo struct {
	// Globally unique service account email that has access to the KMS key. The
	// service account exists within the Databricks CP project.
	GcpServiceAccount *GcpServiceAccount `json:"gcp_service_account,omitempty"`
	// Globally unique kms key resource id of the form
	// projects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4
	KmsKeyId string `json:"kms_key_id"`
}

type CreateNetworkRequest struct {
	GcpNetworkInfo *GcpNetworkInfo `json:"gcp_network_info,omitempty"`
	// The human-readable name of the network configuration.
	NetworkName string `json:"network_name,omitempty"`
	// IDs of one to five security groups associated with this network. Security
	// group IDs **cannot** be used in multiple network configurations.
	SecurityGroupIds []string `json:"security_group_ids,omitempty"`
	// IDs of at least two subnets associated with this network. Subnet IDs
	// **cannot** be used in multiple network configurations.
	SubnetIds []string `json:"subnet_ids,omitempty"`

	VpcEndpoints *NetworkVpcEndpoints `json:"vpc_endpoints,omitempty"`
	// The ID of the VPC associated with this network configuration. VPC IDs can
	// be used in multiple networks.
	VpcId string `json:"vpc_id,omitempty"`

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

type CreatePrivateAccessSettingsRequest struct {
	// An array of Databricks VPC endpoint IDs. This is the Databricks ID
	// returned when registering the VPC endpoint configuration in your
	// Databricks account. This is not the ID of the VPC endpoint in AWS. Only
	// used when private_access_level is set to ENDPOINT. This is an allow list
	// of VPC endpoints registered in your Databricks account that can connect
	// to your workspace over AWS PrivateLink. Note: If hybrid access to your
	// workspace is enabled by setting public_access_enabled to true, this
	// control only works for PrivateLink connections. To control how your
	// workspace is accessed via public internet, see IP access lists.
	AllowedVpcEndpointIds []string `json:"allowed_vpc_endpoint_ids,omitempty"`
	// The private access level controls which VPC endpoints can connect to the
	// UI or API of any workspace that attaches this private access settings
	// object. `ACCOUNT` level access (the default) allows only VPC endpoints
	// that are registered in your Databricks account connect to your workspace.
	// `ENDPOINT` level access allows only specified VPC endpoints connect to
	// your workspace. For details, see allowed_vpc_endpoint_ids.
	PrivateAccessLevel PrivateAccessLevel `json:"private_access_level,omitempty"`
	// The human-readable name of the private access settings object.
	PrivateAccessSettingsName string `json:"private_access_settings_name,omitempty"`
	// Determines if the workspace can be accessed over public internet. For
	// fully private workspaces, you can optionally specify false, but only if
	// you implement both the front-end and the back-end PrivateLink
	// connections. Otherwise, specify true, which means that public access is
	// enabled.
	PublicAccessEnabled bool `json:"public_access_enabled,omitempty"`
	// The AWS region for workspaces attached to this private access settings
	// object.
	Region string `json:"region,omitempty"`

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

type CreateStorageConfigurationRequest struct {
	// Optional IAM role that is used to access the workspace catalog which is
	// created during workspace creation for UC by Default. If a storage
	// configuration with this field populated is used to create a workspace,
	// then a workspace catalog is created together with the workspace. The
	// workspace catalog shares the root bucket with internal workspace storage
	// (including DBFS root) but uses a dedicated bucket path prefix.
	RoleArn string `json:"role_arn,omitempty"`
	// Root S3 bucket information.
	RootBucketInfo RootBucketInfo `json:"root_bucket_info"`
	// The human-readable name of the storage configuration.
	StorageConfigurationName string `json:"storage_configuration_name"`

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

type CreateVpcEndpointRequest struct {
	// The ID of the VPC endpoint object in AWS.
	AwsVpcEndpointId string `json:"aws_vpc_endpoint_id,omitempty"`
	// The cloud info of this vpc endpoint.
	GcpVpcEndpointInfo *GcpVpcEndpointInfo `json:"gcp_vpc_endpoint_info,omitempty"`
	// The region in which this VPC endpoint object exists.
	Region string `json:"region,omitempty"`
	// The human-readable name of the storage configuration.
	VpcEndpointName string `json:"vpc_endpoint_name,omitempty"`

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

type CreateWorkspaceRequest struct {
	AwsRegion string `json:"aws_region,omitempty"`
	// The cloud name. This field always has the value `gcp`.
	Cloud string `json:"cloud,omitempty"`

	CloudResourceContainer *CloudResourceContainer `json:"cloud_resource_container,omitempty"`
	// If the compute mode is `SERVERLESS`, a serverless workspace is created
	// that comes pre-configured with serverless compute and default storage,
	// providing a fully-managed, enterprise-ready SaaS experience. This means
	// you don't need to provide any resources managed by you, such as
	// credentials, storage, or network. If the compute mode is `HYBRID` (which
	// is the default option), a classic workspace is created that uses
	// customer-managed resources.
	ComputeMode CustomerFacingComputeMode `json:"compute_mode,omitempty"`
	// ID of the workspace's credential configuration object.
	CredentialsId string `json:"credentials_id,omitempty"`
	// The custom tags key-value pairing that is attached to this workspace. The
	// key-value pair is a string of utf-8 characters. The value can be an empty
	// string, with maximum length of 255 characters. The key can be of maximum
	// length of 127 characters, and cannot be empty.
	CustomTags map[string]string `json:"custom_tags,omitempty"`
	// The deployment name defines part of the subdomain for the workspace. The
	// workspace URL for the web application and REST APIs is
	// <workspace-deployment-name>.cloud.databricks.com. For example, if the
	// deployment name is abcsales, your workspace URL will be
	// https://abcsales.cloud.databricks.com. Hyphens are allowed. This property
	// supports only the set of characters that are allowed in a subdomain. To
	// set this value, you must have a deployment name prefix. Contact your
	// Databricks account team to add an account deployment name prefix to your
	// account. Workspace deployment names follow the account prefix and a
	// hyphen. For example, if your account's deployment prefix is acme and the
	// workspace deployment name is workspace-1, the JSON response for the
	// deployment_name field becomes acme-workspace-1. The workspace URL would
	// be acme-workspace-1.cloud.databricks.com. You can also set the
	// deployment_name to the reserved keyword EMPTY if you want the deployment
	// name to only include the deployment prefix. For example, if your
	// account's deployment prefix is acme and the workspace deployment name is
	// EMPTY, the deployment_name becomes acme only and the workspace URL is
	// acme.cloud.databricks.com. This value must be unique across all
	// non-deleted deployments across all AWS regions. If a new workspace omits
	// this property, the server generates a unique deployment name for you with
	// the pattern dbc-xxxxxxxx-xxxx.
	DeploymentName string `json:"deployment_name,omitempty"`

	GcpManagedNetworkConfig *GcpManagedNetworkConfig `json:"gcp_managed_network_config,omitempty"`

	GkeConfig *GkeConfig `json:"gke_config,omitempty"`
	// The Google Cloud region of the workspace data plane in your Google
	// account (for example, `us-east4`).
	Location string `json:"location,omitempty"`
	// The ID of the workspace's managed services encryption key configuration
	// object. This is used to help protect and control access to the
	// workspace's notebooks, secrets, Databricks SQL queries, and query
	// history. The provided key configuration object property use_cases must
	// contain MANAGED_SERVICES.
	ManagedServicesCustomerManagedKeyId string `json:"managed_services_customer_managed_key_id,omitempty"`
	// The object ID of network connectivity config. Once assigned, the
	// workspace serverless compute resources use the same set of stable IP CIDR
	// blocks and optional private link to access your resources.
	NetworkConnectivityConfigId string `json:"network_connectivity_config_id,omitempty"`
	// The ID of the workspace's network configuration object. To use AWS
	// PrivateLink, this field is required.
	NetworkId string `json:"network_id,omitempty"`

	PricingTier PricingTier `json:"pricing_tier,omitempty"`
	// ID of the workspace's private access settings object. Only used for
	// PrivateLink. You must specify this ID if you are using [AWS PrivateLink]
	// for either front-end (user-to-workspace connection), back-end (data plane
	// to control plane connection), or both connection types. Before
	// configuring PrivateLink, read the [Databricks article about
	// PrivateLink].",
	//
	// [AWS PrivateLink]: https://aws.amazon.com/privatelink/
	// [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
	PrivateAccessSettingsId string `json:"private_access_settings_id,omitempty"`
	// ID of the workspace's storage configuration object.
	StorageConfigurationId string `json:"storage_configuration_id,omitempty"`
	// The ID of the workspace's storage encryption key configuration object.
	// This is used to encrypt the workspace's root S3 bucket (root DBFS and
	// system data) and, optionally, cluster EBS volumes. The provided key
	// configuration object property use_cases must contain STORAGE.
	StorageCustomerManagedKeyId string `json:"storage_customer_managed_key_id,omitempty"`
	// The human-readable name of the workspace.
	WorkspaceName string `json:"workspace_name,omitempty"`

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

type Credential struct {
	// The Databricks account ID that hosts the credential.
	AccountId string `json:"account_id,omitempty"`

	AwsCredentials *AwsCredentials `json:"aws_credentials,omitempty"`
	// Time in epoch milliseconds when the credential was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Databricks credential configuration ID.
	CredentialsId string `json:"credentials_id,omitempty"`
	// The human-readable name of the credential configuration object.
	CredentialsName string `json:"credentials_name,omitempty"`

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

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

type CredentialsInterface interface {

	// Creates a Databricks credential configuration that represents cloud
	// cross-account credentials for a specified account. Databricks uses this to
	// set up network infrastructure properly to host Databricks clusters. For your
	// AWS IAM role, you need to trust the External ID (the Databricks Account API
	// account ID) in the returned credential object, and configure the required
	// access policy.
	//
	// Save the response's `credentials_id` field, which is the ID for your new
	// credential configuration object.
	//
	// For information about how to create a new workspace with this API, see
	// [Create a new workspace using the Account API]
	//
	// [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html
	Create(ctx context.Context, request CreateCredentialRequest) (*Credential, error)

	// Deletes a Databricks credential configuration object for an account, both
	// specified by ID. You cannot delete a credential that is associated with any
	// workspace.
	Delete(ctx context.Context, request DeleteCredentialRequest) (*Credential, error)

	// Deletes a Databricks credential configuration object for an account, both
	// specified by ID. You cannot delete a credential that is associated with any
	// workspace.
	DeleteByCredentialsId(ctx context.Context, credentialsId string) (*Credential, error)

	// Gets a Databricks credential configuration object for an account, both
	// specified by ID.
	Get(ctx context.Context, request GetCredentialRequest) (*Credential, error)

	// Gets a Databricks credential configuration object for an account, both
	// specified by ID.
	GetByCredentialsId(ctx context.Context, credentialsId string) (*Credential, error)

	// List Databricks credential configuration objects for an account, specified by
	// ID.
	List(ctx context.Context) ([]Credential, error)

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

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

type CustomerFacingComputeMode string

type CustomerFacingGcpCloudResourceContainer struct {
	ProjectId string `json:"project_id,omitempty"`

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

type CustomerFacingStorageMode string

type CustomerManagedKey struct {
	// The Databricks account ID that holds the customer-managed key.
	AccountId string `json:"account_id,omitempty"`

	AwsKeyInfo *AwsKeyInfo `json:"aws_key_info,omitempty"`

	AzureKeyInfo *AzureKeyInfo `json:"azure_key_info,omitempty"`
	// Time in epoch milliseconds when the customer key was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// ID of the encryption key configuration object.
	CustomerManagedKeyId string `json:"customer_managed_key_id,omitempty"`

	GcpKeyInfo *GcpKeyInfo `json:"gcp_key_info,omitempty"`
	// The cases that the key can be used for.
	UseCases []KeyUseCase `json:"use_cases,omitempty"`

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

type DeleteCredentialRequest struct {
	// Databricks Account API credential configuration ID
	CredentialsId string `json:"-" url:"-"`
}

type DeleteEncryptionKeyRequest struct {
	// Databricks encryption key configuration ID.
	CustomerManagedKeyId string `json:"-" url:"-"`
}

type DeleteNetworkRequest struct {
	// Databricks Account API network configuration ID.
	NetworkId string `json:"-" url:"-"`
}

type DeletePrivateAccesRequest struct {
	PrivateAccessSettingsId string `json:"-" url:"-"`
}

type DeleteStorageRequest struct {
	StorageConfigurationId string `json:"-" url:"-"`
}

type DeleteVpcEndpointRequest struct {
	VpcEndpointId string `json:"-" url:"-"`
}

type DeleteWorkspaceRequest struct {
	WorkspaceId int64 `json:"-" url:"-"`
}

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

type EncryptionKeysInterface interface {

	// Creates a customer-managed key configuration object for an account, specified
	// by ID. This operation uploads a reference to a customer-managed key to
	// Databricks. If the key is assigned as a workspace's customer-managed key for
	// managed services, Databricks uses the key to encrypt the workspaces notebooks
	// and secrets in the control plane, in addition to Databricks SQL queries and
	// query history. If it is specified as a workspace's customer-managed key for
	// workspace storage, the key encrypts the workspace's root S3 bucket (which
	// contains the workspace's root DBFS and system data) and, optionally, cluster
	// EBS volume data.
	//
	// **Important**: Customer-managed keys are supported only for some deployment
	// types, subscription types, and AWS regions that currently support creation of
	// Databricks workspaces.
	//
	// This operation is available only if your account is on the E2 version of the
	// platform or on a select custom plan that allows multiple workspaces per
	// account.
	Create(ctx context.Context, request CreateCustomerManagedKeyRequest) (*CustomerManagedKey, error)

	// Deletes a customer-managed key configuration object for an account. You
	// cannot delete a configuration that is associated with a running workspace.
	Delete(ctx context.Context, request DeleteEncryptionKeyRequest) (*CustomerManagedKey, error)

	// Deletes a customer-managed key configuration object for an account. You
	// cannot delete a configuration that is associated with a running workspace.
	DeleteByCustomerManagedKeyId(ctx context.Context, customerManagedKeyId string) (*CustomerManagedKey, error)

	// Gets a customer-managed key configuration object for an account, specified by
	// ID. This operation uploads a reference to a customer-managed key to
	// Databricks. If assigned as a workspace's customer-managed key for managed
	// services, Databricks uses the key to encrypt the workspaces notebooks and
	// secrets in the control plane, in addition to Databricks SQL queries and query
	// history. If it is specified as a workspace's customer-managed key for
	// storage, the key encrypts the workspace's root S3 bucket (which contains the
	// workspace's root DBFS and system data) and, optionally, cluster EBS volume
	// data.
	//
	// **Important**: Customer-managed keys are supported only for some deployment
	// types, subscription types, and AWS regions.
	//
	// This operation is available only if your account is on the E2 version of the
	// platform.",
	Get(ctx context.Context, request GetEncryptionKeyRequest) (*CustomerManagedKey, error)

	// Gets a customer-managed key configuration object for an account, specified by
	// ID. This operation uploads a reference to a customer-managed key to
	// Databricks. If assigned as a workspace's customer-managed key for managed
	// services, Databricks uses the key to encrypt the workspaces notebooks and
	// secrets in the control plane, in addition to Databricks SQL queries and query
	// history. If it is specified as a workspace's customer-managed key for
	// storage, the key encrypts the workspace's root S3 bucket (which contains the
	// workspace's root DBFS and system data) and, optionally, cluster EBS volume
	// data.
	//
	// **Important**: Customer-managed keys are supported only for some deployment
	// types, subscription types, and AWS regions.
	//
	// This operation is available only if your account is on the E2 version of the
	// platform.",
	GetByCustomerManagedKeyId(ctx context.Context, customerManagedKeyId string) (*CustomerManagedKey, error)

	// Lists Databricks customer-managed key configurations for an account.
	List(ctx context.Context) ([]CustomerManagedKey, error)
}

type EndpointUseCase string

type ErrorType string

type GcpCommonNetworkConfig struct {
	// The IP range that will be used to allocate GKE cluster master resources
	// from. This field must not be set if
	// gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.
	GkeClusterMasterIpRange string `json:"gke_cluster_master_ip_range,omitempty"`
	// The type of network connectivity of the GKE cluster.
	GkeConnectivityType GkeConfigConnectivityType `json:"gke_connectivity_type,omitempty"`

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

type GcpKeyInfo struct {
	// Globally unique service account email that has access to the KMS key. The
	// service account exists within the Databricks CP project.
	GcpServiceAccount *GcpServiceAccount `json:"gcp_service_account,omitempty"`
	// Globally unique kms key resource id of the form
	// projects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4
	KmsKeyId string `json:"kms_key_id"`
}

type GcpManagedNetworkConfig struct {
	// The IP range that will be used to allocate GKE cluster Pods from.
	GkeClusterPodIpRange string `json:"gke_cluster_pod_ip_range,omitempty"`
	// The IP range that will be used to allocate GKE cluster Services from.
	GkeClusterServiceIpRange string `json:"gke_cluster_service_ip_range,omitempty"`
	// The IP range which will be used to allocate GKE cluster nodes from. Note:
	// Pods, services and master IP range must be mutually exclusive.
	SubnetCidr string `json:"subnet_cidr,omitempty"`

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

type GcpNetworkInfo struct {
	// The GCP project ID for network resources. This project is where the VPC
	// and subnet resides.
	NetworkProjectId string `json:"network_project_id"`
	// Name of the secondary range within the subnet that will be used by GKE as
	// Pod IP range. This is BYO VPC specific. DB VPC uses
	// network.getGcpManagedNetworkConfig.getGkeClusterPodIpRange
	PodIpRangeName string `json:"pod_ip_range_name"`
	// Name of the secondary range within the subnet that will be used by GKE as
	// Service IP range.
	ServiceIpRangeName string `json:"service_ip_range_name"`
	// The customer-provided Subnet ID that will be available to Clusters in
	// Workspaces using this Network.
	SubnetId string `json:"subnet_id"`

	SubnetRegion string `json:"subnet_region"`
	// The customer-provided VPC ID.
	VpcId string `json:"vpc_id"`
}

type GcpServiceAccount struct {
	ServiceAccountEmail string `json:"service_account_email,omitempty"`

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

type GcpVpcEndpointInfo struct {
	EndpointRegion string `json:"endpoint_region"`

	ProjectId string `json:"project_id"`

	PscConnectionId string `json:"psc_connection_id,omitempty"`

	PscEndpointName string `json:"psc_endpoint_name"`

	ServiceAttachmentId string `json:"service_attachment_id,omitempty"`

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

type GetCredentialRequest struct {
	// Credential configuration ID
	CredentialsId string `json:"-" url:"-"`
}

type GetEncryptionKeyRequest struct {
	// Databricks encryption key configuration ID.
	CustomerManagedKeyId string `json:"-" url:"-"`
}

type GetNetworkRequest struct {
	// Databricks Account API network configuration ID.
	NetworkId string `json:"-" url:"-"`
}

type GetPrivateAccesRequest struct {
	PrivateAccessSettingsId string `json:"-" url:"-"`
}

type GetStorageRequest struct {
	StorageConfigurationId string `json:"-" url:"-"`
}

type GetVpcEndpointRequest struct {
	// Databricks VPC endpoint ID.
	VpcEndpointId string `json:"-" url:"-"`
}

type GetWorkspaceRequest struct {
	WorkspaceId int64 `json:"-" url:"-"`
}

type GkeConfig struct {
	// The type of network connectivity of the GKE cluster.
	ConnectivityType GkeConfigConnectivityType `json:"connectivity_type,omitempty"`
	// The IP range that will be used to allocate GKE cluster master resources
	// from. This field must not be set if
	// gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.
	MasterIpRange string `json:"master_ip_range,omitempty"`

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

type GkeConfigConnectivityType string

type KeyAccessConfiguration struct {
	CredentialId string `json:"credential_id,omitempty"`

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

type KeyUseCase string

type Network struct {
	// The Databricks account ID associated with this network configuration.
	AccountId string `json:"account_id,omitempty"`
	// Time in epoch milliseconds when the network was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Array of error messages about the network configuration.
	ErrorMessages []NetworkHealth `json:"error_messages,omitempty"`

	GcpNetworkInfo *GcpNetworkInfo `json:"gcp_network_info,omitempty"`
	// The Databricks network configuration ID.
	NetworkId string `json:"network_id,omitempty"`
	// The human-readable name of the network configuration.
	NetworkName string `json:"network_name,omitempty"`
	// IDs of one to five security groups associated with this network. Security
	// group IDs **cannot** be used in multiple network configurations.
	SecurityGroupIds []string `json:"security_group_ids,omitempty"`
	// IDs of at least two subnets associated with this network. Subnet IDs
	// **cannot** be used in multiple network configurations.
	SubnetIds []string `json:"subnet_ids,omitempty"`

	VpcEndpoints *NetworkVpcEndpoints `json:"vpc_endpoints,omitempty"`
	// The ID of the VPC associated with this network configuration. VPC IDs can
	// be used in multiple networks.
	VpcId string `json:"vpc_id,omitempty"`

	VpcStatus VpcStatus `json:"vpc_status,omitempty"`
	// Array of warning messages about the network configuration.
	WarningMessages []NetworkWarning `json:"warning_messages,omitempty"`
	// Workspace ID associated with this network configuration.
	WorkspaceId int64 `json:"workspace_id,omitempty"`

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

type NetworkHealth struct {
	// Details of the error.
	ErrorMessage string `json:"error_message,omitempty"`

	ErrorType ErrorType `json:"error_type,omitempty"`

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

type NetworkVpcEndpoints struct {
	// The VPC endpoint ID used by this network to access the Databricks secure
	// cluster connectivity relay.
	DataplaneRelay []string `json:"dataplane_relay,omitempty"`
	// The VPC endpoint ID used by this network to access the Databricks REST
	// API.
	RestApi []string `json:"rest_api,omitempty"`
}

type NetworkWarning struct {
	// Details of the warning.
	WarningMessage string `json:"warning_message,omitempty"`

	WarningType WarningType `json:"warning_type,omitempty"`

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

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

type NetworksInterface interface {

	// Creates a Databricks network configuration that represents an VPC and its
	// resources. The VPC will be used for new Databricks clusters. This requires a
	// pre-existing VPC and subnets.
	Create(ctx context.Context, request CreateNetworkRequest) (*Network, error)

	// Deletes a Databricks network configuration, which represents a cloud VPC and
	// its resources. You cannot delete a network that is associated with a
	// workspace.
	//
	// This operation is available only if your account is on the E2 version of the
	// platform.
	Delete(ctx context.Context, request DeleteNetworkRequest) (*Network, error)

	// Deletes a Databricks network configuration, which represents a cloud VPC and
	// its resources. You cannot delete a network that is associated with a
	// workspace.
	//
	// This operation is available only if your account is on the E2 version of the
	// platform.
	DeleteByNetworkId(ctx context.Context, networkId string) (*Network, error)

	// Gets a Databricks network configuration, which represents a cloud VPC and its
	// resources.
	Get(ctx context.Context, request GetNetworkRequest) (*Network, error)

	// Gets a Databricks network configuration, which represents a cloud VPC and its
	// resources.
	GetByNetworkId(ctx context.Context, networkId string) (*Network, error)

	// Lists Databricks network configurations for an account.
	List(ctx context.Context) ([]Network, error)

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

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

type PricingTier string

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

type PrivateAccessInterface interface {

	// Creates a private access settings configuration, which represents network
	// access restrictions for workspace resources. Private access settings
	// configure whether workspaces can be accessed from the public internet or only
	// from private endpoints.
	Create(ctx context.Context, request CreatePrivateAccessSettingsRequest) (*PrivateAccessSettings, error)

	// Deletes a Databricks private access settings configuration, both specified by
	// ID.
	Delete(ctx context.Context, request DeletePrivateAccesRequest) (*PrivateAccessSettings, error)

	// Deletes a Databricks private access settings configuration, both specified by
	// ID.
	DeleteByPrivateAccessSettingsId(ctx context.Context, privateAccessSettingsId string) (*PrivateAccessSettings, error)

	// Gets a Databricks private access settings configuration, both specified by
	// ID.
	Get(ctx context.Context, request GetPrivateAccesRequest) (*PrivateAccessSettings, error)

	// Gets a Databricks private access settings configuration, both specified by
	// ID.
	GetByPrivateAccessSettingsId(ctx context.Context, privateAccessSettingsId string) (*PrivateAccessSettings, error)

	// Lists Databricks private access settings for an account.
	List(ctx context.Context) ([]PrivateAccessSettings, error)

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

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

	// Updates an existing private access settings object, which specifies how your
	// workspace is accessed over AWS PrivateLink. To use AWS PrivateLink, a
	// workspace must have a private access settings object referenced by ID in the
	// workspace's private_access_settings_id property. This operation completely
	// overwrites your existing private access settings object attached to your
	// workspaces. All workspaces attached to the private access settings are
	// affected by any change. If public_access_enabled, private_access_level, or
	// allowed_vpc_endpoint_ids are updated, effects of these changes might take
	// several minutes to propagate to the workspace API. You can share one private
	// access settings object with multiple workspaces in a single account. However,
	// private access settings are specific to AWS regions, so only workspaces in
	// the same AWS region can use a given private access settings object. Before
	// configuring PrivateLink, read the Databricks article about PrivateLink.
	Replace(ctx context.Context, request ReplacePrivateAccessSettingsRequest) (*PrivateAccessSettings, error)
}

type PrivateAccessLevel string

type PrivateAccessSettings struct {
	// The Databricks account ID that hosts the private access settings.
	AccountId string `json:"account_id,omitempty"`
	// An array of Databricks VPC endpoint IDs. This is the Databricks ID that
	// is returned when registering the VPC endpoint configuration in your
	// Databricks account. This is not the ID of the VPC endpoint in AWS. Only
	// used when private_access_level is set to ENDPOINT. This is an allow list
	// of VPC endpoints that in your account that can connect to your workspace
	// over AWS PrivateLink. If hybrid access to your workspace is enabled by
	// setting public_access_enabled to true, this control only works for
	// PrivateLink connections. To control how your workspace is accessed via
	// public internet, see IP access lists.
	AllowedVpcEndpointIds []string `json:"allowed_vpc_endpoint_ids,omitempty"`
	// The private access level controls which VPC endpoints can connect to the
	// UI or API of any workspace that attaches this private access settings
	// object. `ACCOUNT` level access (the default) allows only VPC endpoints
	// that are registered in your Databricks account connect to your workspace.
	// `ENDPOINT` level access allows only specified VPC endpoints connect to
	// your workspace. For details, see allowed_vpc_endpoint_ids.
	PrivateAccessLevel PrivateAccessLevel `json:"private_access_level,omitempty"`
	// Databricks private access settings ID.
	PrivateAccessSettingsId string `json:"private_access_settings_id,omitempty"`
	// The human-readable name of the private access settings object.
	PrivateAccessSettingsName string `json:"private_access_settings_name,omitempty"`
	// Determines if the workspace can be accessed over public internet. For
	// fully private workspaces, you can optionally specify false, but only if
	// you implement both the front-end and the back-end PrivateLink
	// connections. Otherwise, specify true, which means that public access is
	// enabled.
	PublicAccessEnabled bool `json:"public_access_enabled,omitempty"`
	// The AWS region for workspaces attached to this private access settings
	// object.
	Region string `json:"region,omitempty"`

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

type ReplacePrivateAccessSettingsRequest struct {
	// Properties of the new private access settings object.
	CustomerFacingPrivateAccessSettings PrivateAccessSettings `json:"customer_facing_private_access_settings"`
	// Databricks private access settings ID.
	PrivateAccessSettingsId string `json:"-" url:"-"`
}

type RootBucketInfo struct {
	// Name of the S3 bucket
	BucketName string `json:"bucket_name,omitempty"`

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

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

type StorageConfiguration struct {
	// The Databricks account ID associated with this storage configuration.
	AccountId string `json:"account_id,omitempty"`
	// Time in epoch milliseconds when the storage configuration was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// Optional IAM role that is used to access the workspace catalog which is
	// created during workspace creation for UC by Default. If a storage
	// configuration with this field populated is used to create a workspace,
	// then a workspace catalog is created together with the workspace. The
	// workspace catalog shares the root bucket with internal workspace storage
	// (including DBFS root) but uses a dedicated bucket path prefix.
	RoleArn string `json:"role_arn,omitempty"`
	// The root bucket information for the storage configuration.
	RootBucketInfo *RootBucketInfo `json:"root_bucket_info,omitempty"`
	// Databricks storage configuration ID.
	StorageConfigurationId string `json:"storage_configuration_id,omitempty"`
	// The human-readable name of the storage configuration.
	StorageConfigurationName string `json:"storage_configuration_name,omitempty"`

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

type StorageInterface interface {

	// Creates a Databricks storage configuration for an account.
	Create(ctx context.Context, request CreateStorageConfigurationRequest) (*StorageConfiguration, error)

	// Deletes a Databricks storage configuration. You cannot delete a storage
	// configuration that is associated with any workspace.
	Delete(ctx context.Context, request DeleteStorageRequest) (*StorageConfiguration, error)

	// Deletes a Databricks storage configuration. You cannot delete a storage
	// configuration that is associated with any workspace.
	DeleteByStorageConfigurationId(ctx context.Context, storageConfigurationId string) (*StorageConfiguration, error)

	// Gets a Databricks storage configuration for an account, both specified by ID.
	Get(ctx context.Context, request GetStorageRequest) (*StorageConfiguration, error)

	// Gets a Databricks storage configuration for an account, both specified by ID.
	GetByStorageConfigurationId(ctx context.Context, storageConfigurationId string) (*StorageConfiguration, error)

	// Lists Databricks storage configurations for an account, specified by ID.
	List(ctx context.Context) ([]StorageConfiguration, error)

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

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

type StsRole struct {
	// The Amazon Resource Name (ARN) of the cross account IAM role.
	RoleArn string `json:"role_arn,omitempty"`

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

type UpdateWorkspaceRequest struct {
	CustomerFacingWorkspace Workspace `json:"customer_facing_workspace"`
	// 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.
	UpdateMask string `json:"-" url:"update_mask,omitempty"`
	// A unique integer ID for the workspace
	WorkspaceId int64 `json:"-" url:"-"`

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

type VpcEndpoint struct {
	// The Databricks account ID that hosts the VPC endpoint configuration. TODO
	// - This may signal an OpenAPI diff; it does not show up in the generated
	// spec
	AccountId string `json:"account_id,omitempty"`
	// The AWS Account in which the VPC endpoint object exists.
	AwsAccountId string `json:"aws_account_id,omitempty"`
	// The ID of the Databricks [endpoint service] that this VPC endpoint is
	// connected to. For a list of endpoint service IDs for each supported AWS
	// region, see the [Databricks PrivateLink documentation].
	//
	// [Databricks PrivateLink documentation]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
	// [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html
	AwsEndpointServiceId string `json:"aws_endpoint_service_id,omitempty"`
	// The ID of the VPC endpoint object in AWS.
	AwsVpcEndpointId string `json:"aws_vpc_endpoint_id,omitempty"`
	// The cloud info of this vpc endpoint. Info for a GCP vpc endpoint.
	GcpVpcEndpointInfo *GcpVpcEndpointInfo `json:"gcp_vpc_endpoint_info,omitempty"`
	// The AWS region in which this VPC endpoint object exists.
	Region string `json:"region,omitempty"`
	// The current state (such as `available` or `rejected`) of the VPC
	// endpoint. Derived from AWS. For the full set of values, see [AWS
	// DescribeVpcEndpoint documentation].
	//
	// [AWS DescribeVpcEndpoint documentation]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html
	State string `json:"state,omitempty"`
	// This enumeration represents the type of Databricks VPC endpoint service
	// that was used when creating this VPC endpoint. If the VPC endpoint
	// connects to the Databricks control plane for either the front-end
	// connection or the back-end REST API connection, the value is
	// WORKSPACE_ACCESS. If the VPC endpoint connects to the Databricks
	// workspace for the back-end secure cluster connectivity relay, the value
	// is DATAPLANE_RELAY_ACCESS.
	UseCase EndpointUseCase `json:"use_case,omitempty"`
	// Databricks VPC endpoint ID. This is the Databricks-specific name of the
	// VPC endpoint. Do not confuse this with the `aws_vpc_endpoint_id`, which
	// is the ID within AWS of the VPC endpoint.
	VpcEndpointId string `json:"vpc_endpoint_id,omitempty"`
	// The human-readable name of the storage configuration.
	VpcEndpointName string `json:"vpc_endpoint_name,omitempty"`

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

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

type VpcEndpointsInterface interface {

	// Creates a VPC endpoint configuration, which represents a [VPC endpoint]
	// object in AWS used to communicate privately with Databricks over [AWS
	// PrivateLink].
	//
	// After you create the VPC endpoint configuration, the Databricks [endpoint
	// service] automatically accepts the VPC endpoint.
	//
	// Before configuring PrivateLink, read the [Databricks article about
	// PrivateLink].
	//
	// [AWS PrivateLink]: https://aws.amazon.com/privatelink
	// [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
	// [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html
	// [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html
	Create(ctx context.Context, request CreateVpcEndpointRequest) (*VpcEndpoint, error)

	// Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC
	// endpoint configuration that is associated with any workspace.
	Delete(ctx context.Context, request DeleteVpcEndpointRequest) (*VpcEndpoint, error)

	// Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC
	// endpoint configuration that is associated with any workspace.
	DeleteByVpcEndpointId(ctx context.Context, vpcEndpointId string) (*VpcEndpoint, error)

	// Gets a VPC endpoint configuration, which represents a [VPC endpoint] object
	// in AWS used to communicate privately with Databricks over [AWS PrivateLink].
	//
	// [AWS PrivateLink]: https://aws.amazon.com/privatelink
	// [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html
	Get(ctx context.Context, request GetVpcEndpointRequest) (*VpcEndpoint, error)

	// Gets a VPC endpoint configuration, which represents a [VPC endpoint] object
	// in AWS used to communicate privately with Databricks over [AWS PrivateLink].
	//
	// [AWS PrivateLink]: https://aws.amazon.com/privatelink
	// [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html
	GetByVpcEndpointId(ctx context.Context, vpcEndpointId string) (*VpcEndpoint, error)

	// Lists Databricks VPC endpoint configurations for an account.
	List(ctx context.Context) ([]VpcEndpoint, error)

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

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

type VpcStatus string

type WaitGetWorkspaceRunning[R any] struct {
	Response    *R
	WorkspaceId int64 `json:"workspace_id"`
	Poll        func(time.Duration, func(*Workspace)) (*Workspace, error)
	// contains filtered or unexported fields
}

type WarningType string

type Workspace struct {
	// Databricks account ID.
	AccountId string `json:"account_id,omitempty"`

	AwsRegion string `json:"aws_region,omitempty"`

	AzureWorkspaceInfo *AzureWorkspaceInfo `json:"azure_workspace_info,omitempty"`
	// The cloud name. This field can have values like `azure`, `gcp`.
	Cloud string `json:"cloud,omitempty"`

	CloudResourceContainer *CloudResourceContainer `json:"cloud_resource_container,omitempty"`
	// The compute mode of the workspace.
	ComputeMode CustomerFacingComputeMode `json:"compute_mode,omitempty"`
	// Time in epoch milliseconds when the workspace was created.
	CreationTime int64 `json:"creation_time,omitempty"`
	// ID of the workspace's credential configuration object.
	CredentialsId string `json:"credentials_id,omitempty"`
	// The custom tags key-value pairing that is attached to this workspace. The
	// key-value pair is a string of utf-8 characters. The value can be an empty
	// string, with maximum length of 255 characters. The key can be of maximum
	// length of 127 characters, and cannot be empty.
	CustomTags map[string]string `json:"custom_tags,omitempty"`

	DeploymentName string `json:"deployment_name,omitempty"`
	// A client owned field used to indicate the workspace status that the
	// client expects to be in. For now this is only used to unblock Temporal
	// workflow for GCP least privileged workspace.
	ExpectedWorkspaceStatus WorkspaceStatus `json:"expected_workspace_status,omitempty"`

	GcpManagedNetworkConfig *GcpManagedNetworkConfig `json:"gcp_managed_network_config,omitempty"`

	GkeConfig *GkeConfig `json:"gke_config,omitempty"`
	// The Google Cloud region of the workspace data plane in your Google
	// account (for example, `us-east4`).
	Location string `json:"location,omitempty"`
	// ID of the key configuration for encrypting managed services.
	ManagedServicesCustomerManagedKeyId string `json:"managed_services_customer_managed_key_id,omitempty"`
	// The network configuration for the workspace.
	//
	// DEPRECATED. Use `network_id` instead.
	Network *WorkspaceNetwork `json:"network,omitempty"`
	// The object ID of network connectivity config.
	NetworkConnectivityConfigId string `json:"network_connectivity_config_id,omitempty"`
	// If this workspace is BYO VPC, then the network_id will be populated. If
	// this workspace is not BYO VPC, then the network_id will be empty.
	NetworkId string `json:"network_id,omitempty"`

	PricingTier PricingTier `json:"pricing_tier,omitempty"`
	// ID of the workspace's private access settings object. Only used for
	// PrivateLink. You must specify this ID if you are using [AWS PrivateLink]
	// for either front-end (user-to-workspace connection), back-end (data plane
	// to control plane connection), or both connection types.
	//
	// Before configuring PrivateLink, read the [Databricks article about
	// PrivateLink].",
	//
	// [AWS PrivateLink]: https://aws.amazon.com/privatelink/
	// [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html
	PrivateAccessSettingsId string `json:"private_access_settings_id,omitempty"`
	// ID of the workspace's storage configuration object.
	StorageConfigurationId string `json:"storage_configuration_id,omitempty"`
	// ID of the key configuration for encrypting workspace storage.
	StorageCustomerManagedKeyId string `json:"storage_customer_managed_key_id,omitempty"`
	// The storage mode of the workspace.
	StorageMode CustomerFacingStorageMode `json:"storage_mode,omitempty"`
	// A unique integer ID for the workspace
	WorkspaceId int64 `json:"workspace_id,omitempty"`
	// The human-readable name of the workspace.
	WorkspaceName string `json:"workspace_name,omitempty"`
	// The status of a workspace
	WorkspaceStatus WorkspaceStatus `json:"workspace_status,omitempty"`
	// Message describing the current workspace status.
	WorkspaceStatusMessage string `json:"workspace_status_message,omitempty"`

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

type WorkspaceNetwork struct {
	// The shared network config for GCP workspace. This object has common
	// network configurations that are network attributions of a workspace. This
	// object is input-only.
	GcpCommonNetworkConfig *GcpCommonNetworkConfig `json:"gcp_common_network_config,omitempty"`
	// The mutually exclusive network deployment modes. The option decides which
	// network mode the workspace will use. The network config for GCP workspace
	// with Databricks managed network. This object is input-only and will not
	// be provided when listing workspaces. See go/gcp-byovpc-alpha-design for
	// interface decisions.
	GcpManagedNetworkConfig *GcpManagedNetworkConfig `json:"gcp_managed_network_config,omitempty"`
	// The ID of the network object, if the workspace is a BYOVPC workspace.
	// This should apply to workspaces on all clouds in internal services. In
	// accounts-rest-api, user will use workspace.network_id for input and
	// output instead. Currently (2021-06-19) the network ID is only used by
	// GCP.
	NetworkId string `json:"network_id,omitempty"`

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

type WorkspaceStatus string

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

type WorkspacesInterface interface {

	// WaitGetWorkspaceRunning repeatedly calls [WorkspacesAPI.Get] and waits to reach RUNNING state
	WaitGetWorkspaceRunning(ctx context.Context, workspaceId int64,
		timeout time.Duration, callback func(*Workspace)) (*Workspace, error)

	// Creates a new workspace using a credential configuration and a storage
	// configuration, an optional network configuration (if using a customer-managed
	// VPC), an optional managed services key configuration (if using
	// customer-managed keys for managed services), and an optional storage key
	// configuration (if using customer-managed keys for storage). The key
	// configurations used for managed services and storage encryption can be the
	// same or different.
	//
	// Important: This operation is asynchronous. A response with HTTP status code
	// 200 means the request has been accepted and is in progress, but does not mean
	// that the workspace deployed successfully and is running. The initial
	// workspace status is typically PROVISIONING. Use the workspace ID
	// (workspace_id) field in the response to identify the new workspace and make
	// repeated GET requests with the workspace ID and check its status. The
	// workspace becomes available when the status changes to RUNNING.
	//
	// You can share one customer-managed VPC with multiple workspaces in a single
	// account. It is not required to create a new VPC for each workspace. However,
	// you cannot reuse subnets or Security Groups between workspaces. If you plan
	// to share one VPC with multiple workspaces, make sure you size your VPC and
	// subnets accordingly. Because a Databricks Account API network configuration
	// encapsulates this information, you cannot reuse a Databricks Account API
	// network configuration across workspaces.
	//
	// For information about how to create a new workspace with this API including
	// error handling, see [Create a new workspace using the Account API].
	//
	// Important: Customer-managed VPCs, PrivateLink, and customer-managed keys are
	// supported on a limited set of deployment and subscription types. If you have
	// questions about availability, contact your Databricks representative.
	//
	// This operation is available only if your account is on the E2 version of the
	// platform or on a select custom plan that allows multiple workspaces per
	// account.
	//
	// [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html
	Create(ctx context.Context, createWorkspaceRequest CreateWorkspaceRequest) (*WaitGetWorkspaceRunning[Workspace], error)

	// Calls [WorkspacesAPIInterface.Create] and waits to reach RUNNING state
	//
	// You can override the default timeout of 20 minutes by calling adding
	// retries.Timeout[Workspace](60*time.Minute) functional option.
	//
	// Deprecated: use [WorkspacesAPIInterface.Create].Get() or [WorkspacesAPIInterface.WaitGetWorkspaceRunning]
	CreateAndWait(ctx context.Context, createWorkspaceRequest CreateWorkspaceRequest, options ...retries.Option[Workspace]) (*Workspace, error)

	// Deletes a Databricks workspace, both specified by ID.
	Delete(ctx context.Context, request DeleteWorkspaceRequest) (*Workspace, error)

	// Deletes a Databricks workspace, both specified by ID.
	DeleteByWorkspaceId(ctx context.Context, workspaceId int64) (*Workspace, error)

	// Gets information including status for a Databricks workspace, specified by
	// ID. In the response, the `workspace_status` field indicates the current
	// status. After initial workspace creation (which is asynchronous), make
	// repeated `GET` requests with the workspace ID and check its status. The
	// workspace becomes available when the status changes to `RUNNING`. For
	// information about how to create a new workspace with this API **including
	// error handling**, see [Create a new workspace using the Account API].
	//
	// [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html
	Get(ctx context.Context, request GetWorkspaceRequest) (*Workspace, error)

	// Gets information including status for a Databricks workspace, specified by
	// ID. In the response, the `workspace_status` field indicates the current
	// status. After initial workspace creation (which is asynchronous), make
	// repeated `GET` requests with the workspace ID and check its status. The
	// workspace becomes available when the status changes to `RUNNING`. For
	// information about how to create a new workspace with this API **including
	// error handling**, see [Create a new workspace using the Account API].
	//
	// [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html
	GetByWorkspaceId(ctx context.Context, workspaceId int64) (*Workspace, error)

	// Lists Databricks workspaces for an account.
	List(ctx context.Context) ([]Workspace, error)

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

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

	// Updates a workspace.
	Update(ctx context.Context, updateWorkspaceRequest UpdateWorkspaceRequest) (*WaitGetWorkspaceRunning[Workspace], error)

	// Calls [WorkspacesAPIInterface.Update] and waits to reach RUNNING state
	//
	// You can override the default timeout of 20 minutes by calling adding
	// retries.Timeout[Workspace](60*time.Minute) functional option.
	//
	// Deprecated: use [WorkspacesAPIInterface.Update].Get() or [WorkspacesAPIInterface.WaitGetWorkspaceRunning]
	UpdateAndWait(ctx context.Context, updateWorkspaceRequest UpdateWorkspaceRequest, options ...retries.Option[Workspace]) (*Workspace, error)
}