instancepools

type AwsAvailability string

type AzureAvailability string

type AzureDiskVolumeType string

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

type CreateInstancePoolRequest struct {
	// Pool name requested by the user. Pool name must be unique. Length must be
	// between 1 and 100 characters.
	InstancePoolName *string
	// Minimum number of idle instances to keep in the instance pool
	MinIdleInstances *int
	// Maximum number of outstanding instances to keep in the pool, including both
	// instances used by clusters and idle instances. Clusters that require further
	// instance provisioning will fail during upsize requests.
	MaxCapacity *int
	// Attributes related to instance pools running on Amazon Web Services. If not
	// specified at pool creation, a set of default values will be used.
	AwsAttributes *InstancePoolAwsAttributes
	// This field encodes, through a single value, the resources available to each
	// of the Spark nodes in this cluster. For example, the Spark nodes can be
	// provisioned and optimized for memory or compute intensive workloads. A list
	// of available node types can be retrieved by using the
	// [clusters/listNodeTypes] API call.
	//
	// [clusters/listNodeTypes]: https://docs.databricks.com/api/workspace/clusters/listnodetypes
	NodeTypeId *string
	// Additional tags for pool resources. <Databricks> will tag all pool resources
	// (e.g., AWS instances and EBS volumes) with these tags in addition to
	// `default_tags`. Notes:
	//
	// - Currently, <Databricks> allows at most 45 custom tags
	CustomTags map[string]string
	// Automatically terminates the extra instances in the pool cache after they are
	// inactive for this time in minutes if min_idle_instances requirement is
	// already met. If not set, the extra pool instances will be automatically
	// terminated after a default timeout. If specified, the threshold must be
	// between 0 and 10000 minutes. Users can also set this value to 0 to instantly
	// remove idle instances from the cache if min cache size could still hold.
	IdleInstanceAutoterminationMinutes *int
	// Autoscaling Local Storage: when enabled, this instances in this pool will
	// dynamically acquire additional disk space when its Spark workers are running
	// low on disk space. In AWS, this feature requires specific AWS permissions to
	// function correctly - refer to the User Guide for more details.
	EnableElasticDisk *bool
	// Defines the specification of the disks that will be attached to all spark
	// containers.
	DiskSpec *DiskSpec
	// Custom Docker Image BYOC
	PreloadedDockerImages []DockerImage
	// A list containing at most one preloaded Spark image version for the pool.
	// Pool-backed clusters started with the preloaded Spark version will start
	// faster. A list of available Spark versions can be retrieved by using the
	// [clusters/sparkVersions] API call.
	//
	// [clusters/sparkVersions]: https://docs.databricks.com/api/workspace/clusters/sparkversions
	PreloadedSparkVersions []string
	// Attributes related to instance pools running on Azure. If not specified at
	// pool creation, a set of default values will be used.
	AzureAttributes *InstancePoolAzureAttributes
	// Attributes related to instance pools running on Google Cloud Platform. If not
	// specified at pool creation, a set of default values will be used.
	GcpAttributes *InstancePoolGcpAttributes
	// Flexible node type configuration for the pool.
	NodeTypeFlexibility *NodeTypeFlexibility
	// If set, what the configurable throughput (in Mb/s) for the remote disk is.
	// Currently only supported for GCP HYPERDISK_BALANCED types.
	RemoteDiskThroughput *int
	// If set, what the total initial volume size (in GB) of the remote disks should
	// be. Currently only supported for GCP HYPERDISK_BALANCED types.
	TotalInitialRemoteDiskSize *int
}

type CreateInstancePoolResponse struct {
	// The ID of the created instance pool.
	InstancePoolId *string
}

type DeleteInstancePoolRequest struct {
	// The instance pool to be terminated.
	InstancePoolId *string
}

type DeleteInstancePoolResponse struct {
}

type DiskSpec struct {
	// The type of disks that will be launched with this cluster.
	DiskType *DiskType
	// The number of disks launched for each instance: - This feature is only
	// enabled for supported node types. - Users can choose up to the limit of the
	// disks supported by the node type. - For node types with no OS disk, at least
	// one disk must be specified; otherwise, cluster creation will fail.
	//
	// If disks are attached, <Databricks> will configure Spark to use only the
	// disks for scratch storage, because heterogenously sized scratch devices can
	// lead to inefficient disk utilization. If no disks are attached, <Databricks>
	// will configure Spark to use instance store disks.
	//
	// Note: If disks are specified, then the Spark configuration `spark.local.dir`
	// will be overridden.
	//
	// Disks will be mounted at: - For AWS: `/ebs0`, `/ebs1`, and etc. - For Azure:
	// `/remote_volume0`, `/remote_volume1`, and etc.
	DiskCount *int
	// The size of each disk (in GiB) launched for each instance. Values must fall
	// into the supported range for a particular instance type.
	//
	// For AWS: - General Purpose SSD: 100 - 4096 GiB - Throughput Optimized HDD:
	// 500 - 4096 GiB
	//
	// For Azure: - Premium LRS (SSD): 1 - 1023 GiB - Standard LRS (HDD): 1- 1023
	// GiB
	DiskSize       *int
	DiskIops       *int
	DiskThroughput *int
}

type DiskType struct {
	RemoteVolumeType isDiskType_RemoteVolumeType
}

type DiskType_RemoteVolumeType_AzureDiskVolumeType struct {
	AzureDiskVolumeType AzureDiskVolumeType
}

type DiskType_RemoteVolumeType_EbsVolumeType struct {
	EbsVolumeType EbsVolumeType
}

type DockerBasicAuth struct {
	// Name of the user
	Username *string
	// Password of the user
	Password *string
}

type DockerImage struct {
	// URL of the docker image.
	Url        *string
	CredsOneof isDockerImage_CredsOneof
}

type DockerImage_CredsOneof_BasicAuth struct {
	BasicAuth DockerBasicAuth
}

type EbsVolumeType string

type EditInstancePoolRequest struct {
	// Instance pool ID
	InstancePoolId *string
	// Pool name requested by the user. Pool name must be unique. Length must be
	// between 1 and 100 characters.
	InstancePoolName *string
	// Minimum number of idle instances to keep in the instance pool
	MinIdleInstances *int
	// Maximum number of outstanding instances to keep in the pool, including both
	// instances used by clusters and idle instances. Clusters that require further
	// instance provisioning will fail during upsize requests.
	MaxCapacity *int
	// Attributes related to instance pools running on Amazon Web Services. If not
	// specified at pool creation, a set of default values will be used.
	AwsAttributes *InstancePoolAwsAttributes
	// This field encodes, through a single value, the resources available to each
	// of the Spark nodes in this cluster. For example, the Spark nodes can be
	// provisioned and optimized for memory or compute intensive workloads. A list
	// of available node types can be retrieved by using the
	// [clusters/listNodeTypes] API call.
	//
	// [clusters/listNodeTypes]: https://docs.databricks.com/api/workspace/clusters/listnodetypes
	NodeTypeId *string
	// Additional tags for pool resources. <Databricks> will tag all pool resources
	// (e.g., AWS instances and EBS volumes) with these tags in addition to
	// `default_tags`. Notes:
	//
	// - Currently, <Databricks> allows at most 45 custom tags
	CustomTags map[string]string
	// Automatically terminates the extra instances in the pool cache after they are
	// inactive for this time in minutes if min_idle_instances requirement is
	// already met. If not set, the extra pool instances will be automatically
	// terminated after a default timeout. If specified, the threshold must be
	// between 0 and 10000 minutes. Users can also set this value to 0 to instantly
	// remove idle instances from the cache if min cache size could still hold.
	IdleInstanceAutoterminationMinutes *int
	// Autoscaling Local Storage: when enabled, this instances in this pool will
	// dynamically acquire additional disk space when its Spark workers are running
	// low on disk space. In AWS, this feature requires specific AWS permissions to
	// function correctly - refer to the User Guide for more details.
	EnableElasticDisk *bool
	// Defines the specification of the disks that will be attached to all spark
	// containers.
	DiskSpec *DiskSpec
	// Custom Docker Image BYOC
	PreloadedDockerImages []DockerImage
	// A list containing at most one preloaded Spark image version for the pool.
	// Pool-backed clusters started with the preloaded Spark version will start
	// faster. A list of available Spark versions can be retrieved by using the
	// [clusters/sparkVersions] API call.
	//
	// [clusters/sparkVersions]: https://docs.databricks.com/api/workspace/clusters/sparkversions
	PreloadedSparkVersions []string
	// Attributes related to instance pools running on Azure. If not specified at
	// pool creation, a set of default values will be used.
	AzureAttributes *InstancePoolAzureAttributes
	// Attributes related to instance pools running on Google Cloud Platform. If not
	// specified at pool creation, a set of default values will be used.
	GcpAttributes *InstancePoolGcpAttributes
	// Flexible node type configuration for the pool.
	NodeTypeFlexibility *NodeTypeFlexibility
	// If set, what the configurable throughput (in Mb/s) for the remote disk is.
	// Currently only supported for GCP HYPERDISK_BALANCED types.
	RemoteDiskThroughput *int
	// If set, what the total initial volume size (in GB) of the remote disks should
	// be. Currently only supported for GCP HYPERDISK_BALANCED types.
	TotalInitialRemoteDiskSize *int
}

type EditInstancePoolResponse struct {
}

type GcpAvailability string

type GetInstancePoolRequest struct {
	// The canonical unique identifier for the instance pool.
	InstancePoolId *string
}

type GetInstancePoolResponse struct {
	// Usage statistics about the instance pool.
	Stats *InstancePoolStats
	// Status of failed pending instances in the pool.
	Status *InstancePoolStatus
	// Canonical unique identifier for the pool.
	InstancePoolId *string
	// Tags that are added by <Databricks> regardless of any “custom_tags“,
	// including:
	//
	// - Vendor: <Databricks>
	//
	// - InstancePoolCreator: <user_id_of_creator>
	//
	// - InstancePoolName: <name_of_pool>
	//
	// - InstancePoolId: <id_of_pool>
	DefaultTags map[string]string
	// Current state of the instance pool.
	State InstancePoolState
	// Pool name requested by the user. Pool name must be unique. Length must be
	// between 1 and 100 characters.
	InstancePoolName *string
	// Minimum number of idle instances to keep in the instance pool
	MinIdleInstances *int
	// Maximum number of outstanding instances to keep in the pool, including both
	// instances used by clusters and idle instances. Clusters that require further
	// instance provisioning will fail during upsize requests.
	MaxCapacity *int
	// Attributes related to instance pools running on Amazon Web Services. If not
	// specified at pool creation, a set of default values will be used.
	AwsAttributes *InstancePoolAwsAttributes
	// This field encodes, through a single value, the resources available to each
	// of the Spark nodes in this cluster. For example, the Spark nodes can be
	// provisioned and optimized for memory or compute intensive workloads. A list
	// of available node types can be retrieved by using the
	// [clusters/listNodeTypes] API call.
	//
	// [clusters/listNodeTypes]: https://docs.databricks.com/api/workspace/clusters/listnodetypes
	NodeTypeId *string
	// Additional tags for pool resources. <Databricks> will tag all pool resources
	// (e.g., AWS instances and EBS volumes) with these tags in addition to
	// `default_tags`. Notes:
	//
	// - Currently, <Databricks> allows at most 45 custom tags
	CustomTags map[string]string
	// Automatically terminates the extra instances in the pool cache after they are
	// inactive for this time in minutes if min_idle_instances requirement is
	// already met. If not set, the extra pool instances will be automatically
	// terminated after a default timeout. If specified, the threshold must be
	// between 0 and 10000 minutes. Users can also set this value to 0 to instantly
	// remove idle instances from the cache if min cache size could still hold.
	IdleInstanceAutoterminationMinutes *int
	// Autoscaling Local Storage: when enabled, this instances in this pool will
	// dynamically acquire additional disk space when its Spark workers are running
	// low on disk space. In AWS, this feature requires specific AWS permissions to
	// function correctly - refer to the User Guide for more details.
	EnableElasticDisk *bool
	// Defines the specification of the disks that will be attached to all spark
	// containers.
	DiskSpec *DiskSpec
	// Custom Docker Image BYOC
	PreloadedDockerImages []DockerImage
	// A list containing at most one preloaded Spark image version for the pool.
	// Pool-backed clusters started with the preloaded Spark version will start
	// faster. A list of available Spark versions can be retrieved by using the
	// [clusters/sparkVersions] API call.
	//
	// [clusters/sparkVersions]: https://docs.databricks.com/api/workspace/clusters/sparkversions
	PreloadedSparkVersions []string
	// Attributes related to instance pools running on Azure. If not specified at
	// pool creation, a set of default values will be used.
	AzureAttributes *InstancePoolAzureAttributes
	// Attributes related to instance pools running on Google Cloud Platform. If not
	// specified at pool creation, a set of default values will be used.
	GcpAttributes *InstancePoolGcpAttributes
	// Flexible node type configuration for the pool.
	NodeTypeFlexibility *NodeTypeFlexibility
	// If set, what the configurable throughput (in Mb/s) for the remote disk is.
	// Currently only supported for GCP HYPERDISK_BALANCED types.
	RemoteDiskThroughput *int
	// If set, what the total initial volume size (in GB) of the remote disks should
	// be. Currently only supported for GCP HYPERDISK_BALANCED types.
	TotalInitialRemoteDiskSize *int
}

type InstancePoolAndStats struct {
	// Usage statistics about the instance pool.
	Stats *InstancePoolStats
	// Status of failed pending instances in the pool.
	Status *InstancePoolStatus
	// Canonical unique identifier for the pool.
	InstancePoolId *string
	// Tags that are added by <Databricks> regardless of any “custom_tags“,
	// including:
	//
	// - Vendor: <Databricks>
	//
	// - InstancePoolCreator: <user_id_of_creator>
	//
	// - InstancePoolName: <name_of_pool>
	//
	// - InstancePoolId: <id_of_pool>
	DefaultTags map[string]string
	// Current state of the instance pool.
	State InstancePoolState
	// Pool name requested by the user. Pool name must be unique. Length must be
	// between 1 and 100 characters.
	InstancePoolName *string
	// Minimum number of idle instances to keep in the instance pool
	MinIdleInstances *int
	// Maximum number of outstanding instances to keep in the pool, including both
	// instances used by clusters and idle instances. Clusters that require further
	// instance provisioning will fail during upsize requests.
	MaxCapacity *int
	// Attributes related to instance pools running on Amazon Web Services. If not
	// specified at pool creation, a set of default values will be used.
	AwsAttributes *InstancePoolAwsAttributes
	// This field encodes, through a single value, the resources available to each
	// of the Spark nodes in this cluster. For example, the Spark nodes can be
	// provisioned and optimized for memory or compute intensive workloads. A list
	// of available node types can be retrieved by using the
	// [clusters/listNodeTypes] API call.
	//
	// [clusters/listNodeTypes]: https://docs.databricks.com/api/workspace/clusters/listnodetypes
	NodeTypeId *string
	// Additional tags for pool resources. <Databricks> will tag all pool resources
	// (e.g., AWS instances and EBS volumes) with these tags in addition to
	// `default_tags`. Notes:
	//
	// - Currently, <Databricks> allows at most 45 custom tags
	CustomTags map[string]string
	// Automatically terminates the extra instances in the pool cache after they are
	// inactive for this time in minutes if min_idle_instances requirement is
	// already met. If not set, the extra pool instances will be automatically
	// terminated after a default timeout. If specified, the threshold must be
	// between 0 and 10000 minutes. Users can also set this value to 0 to instantly
	// remove idle instances from the cache if min cache size could still hold.
	IdleInstanceAutoterminationMinutes *int
	// Autoscaling Local Storage: when enabled, this instances in this pool will
	// dynamically acquire additional disk space when its Spark workers are running
	// low on disk space. In AWS, this feature requires specific AWS permissions to
	// function correctly - refer to the User Guide for more details.
	EnableElasticDisk *bool
	// Defines the specification of the disks that will be attached to all spark
	// containers.
	DiskSpec *DiskSpec
	// Custom Docker Image BYOC
	PreloadedDockerImages []DockerImage
	// A list containing at most one preloaded Spark image version for the pool.
	// Pool-backed clusters started with the preloaded Spark version will start
	// faster. A list of available Spark versions can be retrieved by using the
	// [clusters/sparkVersions] API call.
	//
	// [clusters/sparkVersions]: https://docs.databricks.com/api/workspace/clusters/sparkversions
	PreloadedSparkVersions []string
	// Attributes related to instance pools running on Azure. If not specified at
	// pool creation, a set of default values will be used.
	AzureAttributes *InstancePoolAzureAttributes
	// Attributes related to instance pools running on Google Cloud Platform. If not
	// specified at pool creation, a set of default values will be used.
	GcpAttributes *InstancePoolGcpAttributes
	// Flexible node type configuration for the pool.
	NodeTypeFlexibility *NodeTypeFlexibility
	// If set, what the configurable throughput (in Mb/s) for the remote disk is.
	// Currently only supported for GCP HYPERDISK_BALANCED types.
	RemoteDiskThroughput *int
	// If set, what the total initial volume size (in GB) of the remote disks should
	// be. Currently only supported for GCP HYPERDISK_BALANCED types.
	TotalInitialRemoteDiskSize *int
}

type InstancePoolAwsAttributes struct {
	// Availability type used for the spot nodes.
	Availability AwsAvailability
	// Identifier for the availability zone/datacenter in which the cluster resides.
	// This string will be of a form like "us-west-2a". The provided availability
	// zone must be in the same region as the <Databricks> deployment. For example,
	// "us-west-2a" is not a valid zone id if the <Databricks> deployment resides in
	// the "us-east-1" region. This is an optional field at cluster creation, and if
	// not specified, a default zone will be used. The list of available zones as
	// well as the default value can be found by using the `List Zones` method.
	ZoneId *string
	// Calculates the bid price for AWS spot instances, as a percentage of the
	// corresponding instance type's on-demand price. For example, if this field is
	// set to 50, and the cluster needs a new `r3.xlarge` spot instance, then the
	// bid price is half of the price of on-demand `r3.xlarge` instances. Similarly,
	// if this field is set to 200, the bid price is twice the price of on-demand
	// `r3.xlarge` instances. If not specified, the default value is 100. When spot
	// instances are requested for this cluster, only spot instances whose bid price
	// percentage matches this field will be considered. Note that, for safety, we
	// enforce this field to be no more than 10000.
	SpotBidPricePercent *int
	// All AWS instances belonging to the instance pool will have this instance
	// profile. If omitted, instances will initially be launched with the
	// workspace's default instance profile. If defined, clusters that use the pool
	// will inherit the instance profile, and must not specify their own instance
	// profile on cluster creation or update. If the pool does not specify an
	// instance profile, clusters using the pool may specify any instance profile.
	// The instance profile must have previously been added to the <Databricks>
	// environment by an account administrator.
	//
	// This feature may only be available to certain customer plans.
	InstanceProfileArn *string
}

type InstancePoolAzureAttributes struct {
	// Availability type used for the spot nodes.
	Availability AzureAvailability
	// With variable pricing, you have option to set a max price, in US dollars
	// (USD) For example, the value 2 would be a max price of $2.00 USD per hour. If
	// you set the max price to be -1, the VM won't be evicted based on price. The
	// price for the VM will be the current price for spot or the price for a
	// standard VM, which ever is less, as long as there is capacity and quota
	// available.
	SpotBidMaxPrice *float64
	// The Azure capacity reservation group resource ID to use for launching VMs in
	// this pool. When specified, VMs will be launched using the provided capacity
	// reservation.
	//
	// NOTE: Omitting this field will clear any existing configured capacity
	// reservation group on the pool.
	//
	// Capacity reservations can only be specified when the workspace uses injected
	// vnet (i.e. customer defined vnet not managed by databricks). Ensure the
	// databricks-login-prod Enterprise Application is granted the following four
	// permissions: 1. Microsoft.Compute/capacityReservationGroups/read 2.
	// Microsoft.Compute/capacityReservationGroups/deploy/action 3.
	// Microsoft.Compute/capacityReservationGroups/capacityReservations/read 4.
	// Microsoft.Compute/capacityReservationGroups/capacityReservations/deploy/action
	//
	// Format:
	// `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}`
	CapacityReservationGroup *string
}

type InstancePoolGcpAttributes struct {
	GcpAvailability GcpAvailability
	// If provided, each node in the instance pool will have this number of local
	// SSDs attached. Each local SSD is 375GB in size. Refer to [GCP documentation]
	// for the supported number of local SSDs for each instance type.
	//
	// [GCP documentation]: https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds
	LocalSsdCount *int
	// Identifier for the availability zone/datacenter in which the cluster resides.
	// This string will be of a form like "us-west1-a". The provided availability
	// zone must be in the same region as the <Databricks> workspace. For example,
	// "us-west1-a" is not a valid zone id if the <Databricks> workspace resides in
	// the "us-east1" region. This is an optional field at instance pool creation,
	// and if not specified, a default zone will be used.
	//
	// This field can be one of the following: - "HA" => High availability, spread
	// nodes across availability zones for a <Databricks> deployment region - A GCP
	// availability zone => Pick One of the available zones for (machine type +
	// region) from https://cloud.google.com/compute/docs/regions-zones (e.g.
	// "us-west1-a").
	//
	// If empty, <Databricks> picks an availability zone to schedule the cluster on.
	ZoneId *string
}

type InstancePoolState string

type InstancePoolStats struct {
	// Number of active instances in the pool that are part of a cluster.
	UsedCount *int
	// Number of active instances in the pool that are NOT part of a cluster.
	IdleCount *int
	// Number of pending instances in the pool that are part of a cluster.
	PendingUsedCount *int
	// Number of pending instances in the pool that are NOT part of a cluster.
	PendingIdleCount *int
}

type InstancePoolStatus struct {
	// List of error messages for the failed pending instances. The
	// pending_instance_errors follows FIFO with maximum length of the min_idle of
	// the pool. The pending_instance_errors is emptied once the number of exiting
	// available instances reaches the min_idle of the pool.
	PendingInstanceErrors []PendingInstanceError
}

type ListInstancePoolsRequest struct {
}

type ListInstancePoolsResponse struct {
	InstancePools []InstancePoolAndStats
}

type NodeTypeFlexibility struct {
	// A list of node type IDs to use as fallbacks when the primary node type is
	// unavailable.
	AlternateNodeTypeIds []string
	// The AWS Context ID for EC2 Fleet. When set (non-empty), the value is passed
	// to AWS CreateFleet API to create the EC2 Fleet.
	AwsContextId *string
}

type PendingInstanceError struct {
	InstanceId *string
	Message    *string
}