sql_tf

package
v1.59.0 Latest Latest
Warning

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

 Go to latest Published: Nov 20, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControl 

type AccessControl struct {
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query *
	// `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`

	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*AccessControl) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AccessControl) SyncEffectiveFieldsDuringCreateOrUpdate(plan AccessControl)

func (*AccessControl) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AccessControl) SyncEffectiveFieldsDuringRead(existingState AccessControl)

type Alert 

type Alert struct {
	// Trigger conditions of the alert.
	Condition []AlertCondition `tfsdk:"condition" tf:"optional,object"`
	// The timestamp indicating when the alert was created.
	CreateTime types.String `tfsdk:"create_time" tf:"optional"`
	// Custom body of alert notification, if it exists. See [here] for custom
	// templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomBody types.String `tfsdk:"custom_body" tf:"optional"`
	// Custom subject of alert notification, if it exists. This can include
	// email subject entries and Slack notification headers, for example. See
	// [here] for custom templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomSubject types.String `tfsdk:"custom_subject" tf:"optional"`
	// The display name of the alert.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// UUID identifying the alert.
	Id types.String `tfsdk:"id" tf:"optional"`
	// The workspace state of the alert. Used for tracking trashed status.
	LifecycleState types.String `tfsdk:"lifecycle_state" tf:"optional"`
	// Whether to notify alert subscribers when alert returns back to normal.
	NotifyOnOk types.Bool `tfsdk:"notify_on_ok" tf:"optional"`
	// The owner's username. This field is set to "Unavailable" if the user has
	// been deleted.
	OwnerUserName types.String `tfsdk:"owner_user_name" tf:"optional"`
	// The workspace path of the folder containing the alert.
	ParentPath types.String `tfsdk:"parent_path" tf:"optional"`
	// UUID of the query attached to the alert.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// Number of seconds an alert must wait after being triggered to rearm
	// itself. After rearming, it can be triggered again. If 0 or not specified,
	// the alert will not be triggered again.
	SecondsToRetrigger types.Int64 `tfsdk:"seconds_to_retrigger" tf:"optional"`
	// Current state of the alert's trigger status. This field is set to UNKNOWN
	// if the alert has not yet been evaluated or ran into an error during the
	// last evaluation.
	State types.String `tfsdk:"state" tf:"optional"`
	// Timestamp when the alert was last triggered, if the alert has been
	// triggered before.
	TriggerTime types.String `tfsdk:"trigger_time" tf:"optional"`
	// The timestamp indicating when the alert was updated.
	UpdateTime types.String `tfsdk:"update_time" tf:"optional"`
}

func (*Alert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Alert) SyncEffectiveFieldsDuringCreateOrUpdate(plan Alert)

func (*Alert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Alert) SyncEffectiveFieldsDuringRead(existingState Alert)

type AlertCondition 

type AlertCondition struct {
	// Alert state if result is empty.
	EmptyResultState types.String `tfsdk:"empty_result_state" tf:"optional"`
	// Operator used for comparison in alert evaluation.
	Op types.String `tfsdk:"op" tf:"optional"`
	// Name of the column from the query result to use for comparison in alert
	// evaluation.
	Operand []AlertConditionOperand `tfsdk:"operand" tf:"optional,object"`
	// Threshold value used for comparison in alert evaluation.
	Threshold []AlertConditionThreshold `tfsdk:"threshold" tf:"optional,object"`
}

func (*AlertCondition) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertCondition) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertCondition)

func (*AlertCondition) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertCondition) SyncEffectiveFieldsDuringRead(existingState AlertCondition)

type AlertConditionOperand 

type AlertConditionOperand struct {
	Column []AlertOperandColumn `tfsdk:"column" tf:"optional,object"`
}

func (*AlertConditionOperand) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertConditionOperand) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertConditionOperand)

func (*AlertConditionOperand) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertConditionOperand) SyncEffectiveFieldsDuringRead(existingState AlertConditionOperand)

type AlertConditionThreshold 

type AlertConditionThreshold struct {
	Value []AlertOperandValue `tfsdk:"value" tf:"optional,object"`
}

func (*AlertConditionThreshold) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertConditionThreshold) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertConditionThreshold)

func (*AlertConditionThreshold) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertConditionThreshold) SyncEffectiveFieldsDuringRead(existingState AlertConditionThreshold)

type AlertOperandColumn 

type AlertOperandColumn struct {
	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*AlertOperandColumn) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertOperandColumn) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertOperandColumn)

func (*AlertOperandColumn) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertOperandColumn) SyncEffectiveFieldsDuringRead(existingState AlertOperandColumn)

type AlertOperandValue 

type AlertOperandValue struct {
	BoolValue types.Bool `tfsdk:"bool_value" tf:"optional"`

	DoubleValue types.Float64 `tfsdk:"double_value" tf:"optional"`

	StringValue types.String `tfsdk:"string_value" tf:"optional"`
}

func (*AlertOperandValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertOperandValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertOperandValue)

func (*AlertOperandValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertOperandValue) SyncEffectiveFieldsDuringRead(existingState AlertOperandValue)

type AlertOptions 

type AlertOptions struct {
	// Name of column in the query result to compare in alert evaluation.
	Column types.String `tfsdk:"column" tf:""`
	// Custom body of alert notification, if it exists. See [here] for custom
	// templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomBody types.String `tfsdk:"custom_body" tf:"optional"`
	// Custom subject of alert notification, if it exists. This includes email
	// subject, Slack notification header, etc. See [here] for custom templating
	// instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomSubject types.String `tfsdk:"custom_subject" tf:"optional"`
	// State that alert evaluates to when query result is empty.
	EmptyResultState types.String `tfsdk:"empty_result_state" tf:"optional"`
	// Whether or not the alert is muted. If an alert is muted, it will not
	// notify users and notification destinations when triggered.
	Muted types.Bool `tfsdk:"muted" tf:"optional"`
	// Operator used to compare in alert evaluation: `>`, `>=`, `<`, `<=`, `==`,
	// `!=`
	Op types.String `tfsdk:"op" tf:""`
	// Value used to compare in alert evaluation. Supported types include
	// strings (eg. 'foobar'), floats (eg. 123.4), and booleans (true).
	Value any `tfsdk:"value" tf:""`
}

Alert configuration options.

func (*AlertOptions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertOptions) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertOptions)

func (*AlertOptions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertOptions) SyncEffectiveFieldsDuringRead(existingState AlertOptions)

type AlertQuery 

type AlertQuery struct {
	// The timestamp when this query was created.
	CreatedAt types.String `tfsdk:"created_at" tf:"optional"`
	// Data source ID maps to the ID of the data source used by the resource and
	// is distinct from the warehouse ID. [Learn more]
	//
	// [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
	DataSourceId types.String `tfsdk:"data_source_id" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// Query ID.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Indicates whether the query is trashed. Trashed queries can't be used in
	// dashboards, or appear in search results. If this boolean is `true`, the
	// `options` property for this query includes a `moved_to_trash_at`
	// timestamp. Trashed queries are permanently deleted after 30 days.
	IsArchived types.Bool `tfsdk:"is_archived" tf:"optional"`
	// Whether the query is a draft. Draft queries only appear in list views for
	// their owners. Visualizations from draft queries cannot appear on
	// dashboards.
	IsDraft types.Bool `tfsdk:"is_draft" tf:"optional"`
	// Text parameter types are not safe from SQL injection for all types of
	// data source. Set this Boolean parameter to `true` if a query either does
	// not use any text type parameters or uses a data source type where text
	// type parameters are handled safely.
	IsSafe types.Bool `tfsdk:"is_safe" tf:"optional"`
	// The title of this query that appears in list views, widget headings, and
	// on the query page.
	Name types.String `tfsdk:"name" tf:"optional"`

	Options []QueryOptions `tfsdk:"options" tf:"optional,object"`
	// The text of the query to be run.
	Query types.String `tfsdk:"query" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// The timestamp at which this query was last updated.
	UpdatedAt types.String `tfsdk:"updated_at" tf:"optional"`
	// The ID of the user who owns the query.
	UserId types.Int64 `tfsdk:"user_id" tf:"optional"`
}

func (*AlertQuery) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AlertQuery) SyncEffectiveFieldsDuringCreateOrUpdate(plan AlertQuery)

func (*AlertQuery) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AlertQuery) SyncEffectiveFieldsDuringRead(existingState AlertQuery)

type BaseChunkInfo 

type BaseChunkInfo struct {
	// The number of bytes in the result chunk. This field is not available when
	// using `INLINE` disposition.
	ByteCount types.Int64 `tfsdk:"byte_count" tf:"optional"`
	// The position within the sequence of result set chunks.
	ChunkIndex types.Int64 `tfsdk:"chunk_index" tf:"optional"`
	// The number of rows within the result chunk.
	RowCount types.Int64 `tfsdk:"row_count" tf:"optional"`
	// The starting row offset within the result set.
	RowOffset types.Int64 `tfsdk:"row_offset" tf:"optional"`
}

Describes metadata for a particular chunk, within a result set; this structure is used both within a manifest, and when fetching individual chunk data or links.

func (*BaseChunkInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *BaseChunkInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan BaseChunkInfo)

func (*BaseChunkInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *BaseChunkInfo) SyncEffectiveFieldsDuringRead(existingState BaseChunkInfo)

type CancelExecutionRequest 

type CancelExecutionRequest struct {
	// The statement ID is returned upon successfully submitting a SQL
	// statement, and is a required reference for all subsequent calls.
	StatementId types.String `tfsdk:"-"`
}

Cancel statement execution

func (*CancelExecutionRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CancelExecutionRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CancelExecutionRequest)

func (*CancelExecutionRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CancelExecutionRequest) SyncEffectiveFieldsDuringRead(existingState CancelExecutionRequest)

type CancelExecutionResponse 

type CancelExecutionResponse struct {
}

func (*CancelExecutionResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CancelExecutionResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan CancelExecutionResponse)

func (*CancelExecutionResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CancelExecutionResponse) SyncEffectiveFieldsDuringRead(existingState CancelExecutionResponse)

type Channel 

type Channel struct {
	DbsqlVersion types.String `tfsdk:"dbsql_version" tf:"optional"`

	Name types.String `tfsdk:"name" tf:"optional"`
}

Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified.

func (*Channel) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Channel) SyncEffectiveFieldsDuringCreateOrUpdate(plan Channel)

func (*Channel) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Channel) SyncEffectiveFieldsDuringRead(existingState Channel)

type ChannelInfo 

type ChannelInfo struct {
	// DB SQL Version the Channel is mapped to.
	DbsqlVersion types.String `tfsdk:"dbsql_version" tf:"optional"`
	// Name of the channel
	Name types.String `tfsdk:"name" tf:"optional"`
}

Details about a Channel.

func (*ChannelInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ChannelInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan ChannelInfo)

func (*ChannelInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ChannelInfo) SyncEffectiveFieldsDuringRead(existingState ChannelInfo)

type ColumnInfo 

type ColumnInfo struct {
	// The name of the column.
	Name types.String `tfsdk:"name" tf:"optional"`
	// The ordinal position of the column (starting at position 0).
	Position types.Int64 `tfsdk:"position" tf:"optional"`
	// The format of the interval type.
	TypeIntervalType types.String `tfsdk:"type_interval_type" tf:"optional"`
	// The name of the base data type. This doesn't include details for complex
	// types such as STRUCT, MAP or ARRAY.
	TypeName types.String `tfsdk:"type_name" tf:"optional"`
	// Specifies the number of digits in a number. This applies to the DECIMAL
	// type.
	TypePrecision types.Int64 `tfsdk:"type_precision" tf:"optional"`
	// Specifies the number of digits to the right of the decimal point in a
	// number. This applies to the DECIMAL type.
	TypeScale types.Int64 `tfsdk:"type_scale" tf:"optional"`
	// The full SQL type specification.
	TypeText types.String `tfsdk:"type_text" tf:"optional"`
}

func (*ColumnInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ColumnInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan ColumnInfo)

func (*ColumnInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ColumnInfo) SyncEffectiveFieldsDuringRead(existingState ColumnInfo)

type CreateAlert 

type CreateAlert struct {
	// Name of the alert.
	Name types.String `tfsdk:"name" tf:""`
	// Alert configuration options.
	Options []AlertOptions `tfsdk:"options" tf:"object"`
	// The identifier of the workspace folder containing the object.
	Parent types.String `tfsdk:"parent" tf:"optional"`
	// Query ID.
	QueryId types.String `tfsdk:"query_id" tf:""`
	// Number of seconds after being triggered before the alert rearms itself
	// and can be triggered again. If `null`, alert will never be triggered
	// again.
	Rearm types.Int64 `tfsdk:"rearm" tf:"optional"`
}

func (*CreateAlert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateAlert) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateAlert)

func (*CreateAlert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateAlert) SyncEffectiveFieldsDuringRead(existingState CreateAlert)

type CreateAlertRequest 

type CreateAlertRequest struct {
	Alert []CreateAlertRequestAlert `tfsdk:"alert" tf:"optional,object"`
}

func (*CreateAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateAlertRequest)

func (*CreateAlertRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateAlertRequest) SyncEffectiveFieldsDuringRead(existingState CreateAlertRequest)

type CreateAlertRequestAlert 

type CreateAlertRequestAlert struct {
	// Trigger conditions of the alert.
	Condition []AlertCondition `tfsdk:"condition" tf:"optional,object"`
	// Custom body of alert notification, if it exists. See [here] for custom
	// templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomBody types.String `tfsdk:"custom_body" tf:"optional"`
	// Custom subject of alert notification, if it exists. This can include
	// email subject entries and Slack notification headers, for example. See
	// [here] for custom templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomSubject types.String `tfsdk:"custom_subject" tf:"optional"`
	// The display name of the alert.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// Whether to notify alert subscribers when alert returns back to normal.
	NotifyOnOk types.Bool `tfsdk:"notify_on_ok" tf:"optional"`
	// The workspace path of the folder containing the alert.
	ParentPath types.String `tfsdk:"parent_path" tf:"optional"`
	// UUID of the query attached to the alert.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// Number of seconds an alert must wait after being triggered to rearm
	// itself. After rearming, it can be triggered again. If 0 or not specified,
	// the alert will not be triggered again.
	SecondsToRetrigger types.Int64 `tfsdk:"seconds_to_retrigger" tf:"optional"`
}

func (*CreateAlertRequestAlert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateAlertRequestAlert) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateAlertRequestAlert)

func (*CreateAlertRequestAlert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateAlertRequestAlert) SyncEffectiveFieldsDuringRead(existingState CreateAlertRequestAlert)

type CreateQueryRequest 

type CreateQueryRequest struct {
	Query []CreateQueryRequestQuery `tfsdk:"query" tf:"optional,object"`
}

func (*CreateQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateQueryRequest)

func (*CreateQueryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateQueryRequest) SyncEffectiveFieldsDuringRead(existingState CreateQueryRequest)

type CreateQueryRequestQuery 

type CreateQueryRequestQuery struct {
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit types.Bool `tfsdk:"apply_auto_limit" tf:"optional"`
	// Name of the catalog where this query will be executed.
	Catalog types.String `tfsdk:"catalog" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// Display name of the query that appears in list views, widget headings,
	// and on the query page.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// List of query parameter definitions.
	Parameters []QueryParameter `tfsdk:"parameters" tf:"optional"`
	// Workspace path of the workspace folder containing the object.
	ParentPath types.String `tfsdk:"parent_path" tf:"optional"`
	// Text of the query to be run.
	QueryText types.String `tfsdk:"query_text" tf:"optional"`
	// Sets the "Run as" role for the object.
	RunAsMode types.String `tfsdk:"run_as_mode" tf:"optional"`
	// Name of the schema where this query will be executed.
	Schema types.String `tfsdk:"schema" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// ID of the SQL warehouse attached to the query.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*CreateQueryRequestQuery) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateQueryRequestQuery) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateQueryRequestQuery)

func (*CreateQueryRequestQuery) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateQueryRequestQuery) SyncEffectiveFieldsDuringRead(existingState CreateQueryRequestQuery)

type CreateQueryVisualizationsLegacyRequest 

type CreateQueryVisualizationsLegacyRequest struct {
	// A short description of this visualization. This is not displayed in the
	// UI.
	Description types.String `tfsdk:"description" tf:"optional"`
	// The name of the visualization that appears on dashboards and the query
	// screen.
	Name types.String `tfsdk:"name" tf:"optional"`
	// The options object varies widely from one visualization type to the next
	// and is unsupported. Databricks does not recommend modifying visualization
	// settings in JSON.
	Options any `tfsdk:"options" tf:""`
	// The identifier returned by :method:queries/create
	QueryId types.String `tfsdk:"query_id" tf:""`
	// The type of visualization: chart, table, pivot table, and so on.
	Type types.String `tfsdk:"type" tf:""`
}

Add visualization to a query

func (*CreateQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateQueryVisualizationsLegacyRequest)

func (*CreateQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringRead(existingState CreateQueryVisualizationsLegacyRequest)

type CreateVisualizationRequest 

type CreateVisualizationRequest struct {
	Visualization []CreateVisualizationRequestVisualization `tfsdk:"visualization" tf:"optional,object"`
}

func (*CreateVisualizationRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateVisualizationRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateVisualizationRequest)

func (*CreateVisualizationRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateVisualizationRequest) SyncEffectiveFieldsDuringRead(existingState CreateVisualizationRequest)

type CreateVisualizationRequestVisualization 

type CreateVisualizationRequestVisualization struct {
	// The display name of the visualization.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// UUID of the query that the visualization is attached to.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// The visualization options varies widely from one visualization type to
	// the next and is unsupported. Databricks does not recommend modifying
	// visualization options directly.
	SerializedOptions types.String `tfsdk:"serialized_options" tf:"optional"`
	// The visualization query plan varies widely from one visualization type to
	// the next and is unsupported. Databricks does not recommend modifying the
	// visualization query plan directly.
	SerializedQueryPlan types.String `tfsdk:"serialized_query_plan" tf:"optional"`
	// The type of visualization: counter, table, funnel, and so on.
	Type types.String `tfsdk:"type" tf:"optional"`
}

func (*CreateVisualizationRequestVisualization) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateVisualizationRequestVisualization) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateVisualizationRequestVisualization)

func (*CreateVisualizationRequestVisualization) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateVisualizationRequestVisualization) SyncEffectiveFieldsDuringRead(existingState CreateVisualizationRequestVisualization)

type CreateWarehouseRequest 

type CreateWarehouseRequest struct {
	// The amount of time in minutes that a SQL warehouse must be idle (i.e., no
	// RUNNING queries) before it is automatically stopped.
	//
	// Supported values: - Must be >= 0 mins for serverless warehouses - Must be
	// == 0 or >= 10 mins for non-serverless warehouses - 0 indicates no
	// autostop.
	//
	// Defaults to 120 mins
	AutoStopMins types.Int64 `tfsdk:"auto_stop_mins" tf:"optional"`
	// Channel Details
	Channel []Channel `tfsdk:"channel" tf:"optional,object"`
	// Size of the clusters allocated for this warehouse. Increasing the size of
	// a spark cluster allows you to run larger queries on it. If you want to
	// increase the number of concurrent queries, please tune max_num_clusters.
	//
	// Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large
	// - 2X-Large - 3X-Large - 4X-Large
	ClusterSize types.String `tfsdk:"cluster_size" tf:"optional"`
	// warehouse creator name
	CreatorName types.String `tfsdk:"creator_name" tf:"optional"`
	// Configures whether the warehouse should use Photon optimized clusters.
	//
	// Defaults to false.
	EnablePhoton types.Bool `tfsdk:"enable_photon" tf:"optional"`
	// Configures whether the warehouse should use serverless compute
	EnableServerlessCompute types.Bool `tfsdk:"enable_serverless_compute" tf:"optional"`
	// Deprecated. Instance profile used to pass IAM role to the cluster
	InstanceProfileArn types.String `tfsdk:"instance_profile_arn" tf:"optional"`
	// Maximum number of clusters that the autoscaler will create to handle
	// concurrent queries.
	//
	// Supported values: - Must be >= min_num_clusters - Must be <= 30.
	//
	// Defaults to min_clusters if unset.
	MaxNumClusters types.Int64 `tfsdk:"max_num_clusters" tf:"optional"`
	// Minimum number of available clusters that will be maintained for this SQL
	// warehouse. Increasing this will ensure that a larger number of clusters
	// are always running and therefore may reduce the cold start time for new
	// queries. This is similar to reserved vs. revocable cores in a resource
	// manager.
	//
	// Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30)
	//
	// Defaults to 1
	MinNumClusters types.Int64 `tfsdk:"min_num_clusters" tf:"optional"`
	// Logical name for the cluster.
	//
	// Supported values: - Must be unique within an org. - Must be less than 100
	// characters.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Configurations whether the warehouse should use spot instances.
	SpotInstancePolicy types.String `tfsdk:"spot_instance_policy" tf:"optional"`
	// A set of key-value pairs that will be tagged on all resources (e.g., AWS
	// instances and EBS volumes) associated with this SQL warehouse.
	//
	// Supported values: - Number of tags < 45.
	Tags []EndpointTags `tfsdk:"tags" tf:"optional,object"`
	// Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless
	// compute, you must set to `PRO` and also set the field
	// `enable_serverless_compute` to `true`.
	WarehouseType types.String `tfsdk:"warehouse_type" tf:"optional"`
}

func (*CreateWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateWarehouseRequest)

func (*CreateWarehouseRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateWarehouseRequest) SyncEffectiveFieldsDuringRead(existingState CreateWarehouseRequest)

type CreateWarehouseResponse 

type CreateWarehouseResponse struct {
	// Id for the SQL warehouse. This value is unique across all SQL warehouses.
	Id types.String `tfsdk:"id" tf:"optional"`
}

func (*CreateWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateWarehouseResponse)

func (*CreateWarehouseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateWarehouseResponse) SyncEffectiveFieldsDuringRead(existingState CreateWarehouseResponse)

type CreateWidget 

type CreateWidget struct {
	// Dashboard ID returned by :method:dashboards/create.
	DashboardId types.String `tfsdk:"dashboard_id" tf:""`
	// Widget ID returned by :method:dashboardwidgets/create
	Id types.String `tfsdk:"-"`

	Options []WidgetOptions `tfsdk:"options" tf:"object"`
	// If this is a textbox widget, the application displays this text. This
	// field is ignored if the widget contains a visualization in the
	// `visualization` field.
	Text types.String `tfsdk:"text" tf:"optional"`
	// Query Vizualization ID returned by :method:queryvisualizations/create.
	VisualizationId types.String `tfsdk:"visualization_id" tf:"optional"`
	// Width of a widget
	Width types.Int64 `tfsdk:"width" tf:""`
}

func (*CreateWidget) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateWidget) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateWidget)

func (*CreateWidget) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateWidget) SyncEffectiveFieldsDuringRead(existingState CreateWidget)

type Dashboard 

type Dashboard struct {
	// Whether the authenticated user can edit the query definition.
	CanEdit types.Bool `tfsdk:"can_edit" tf:"optional"`
	// Timestamp when this dashboard was created.
	CreatedAt types.String `tfsdk:"created_at" tf:"optional"`
	// In the web application, query filters that share a name are coupled to a
	// single selection box if this value is `true`.
	DashboardFiltersEnabled types.Bool `tfsdk:"dashboard_filters_enabled" tf:"optional"`
	// The ID for this dashboard.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Indicates whether a dashboard is trashed. Trashed dashboards won't appear
	// in list views. If this boolean is `true`, the `options` property for this
	// dashboard includes a `moved_to_trash_at` timestamp. Items in trash are
	// permanently deleted after 30 days.
	IsArchived types.Bool `tfsdk:"is_archived" tf:"optional"`
	// Whether a dashboard is a draft. Draft dashboards only appear in list
	// views for their owners.
	IsDraft types.Bool `tfsdk:"is_draft" tf:"optional"`
	// Indicates whether this query object appears in the current user's
	// favorites list. This flag determines whether the star icon for favorites
	// is selected.
	IsFavorite types.Bool `tfsdk:"is_favorite" tf:"optional"`
	// The title of the dashboard that appears in list views and at the top of
	// the dashboard page.
	Name types.String `tfsdk:"name" tf:"optional"`

	Options []DashboardOptions `tfsdk:"options" tf:"optional,object"`
	// The identifier of the workspace folder containing the object.
	Parent types.String `tfsdk:"parent" tf:"optional"`
	// * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query *
	// `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query
	PermissionTier types.String `tfsdk:"permission_tier" tf:"optional"`
	// URL slug. Usually mirrors the query name with dashes (`-`) instead of
	// spaces. Appears in the URL for this query.
	Slug types.String `tfsdk:"slug" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// Timestamp when this dashboard was last updated.
	UpdatedAt types.String `tfsdk:"updated_at" tf:"optional"`

	User []User `tfsdk:"user" tf:"optional,object"`
	// The ID of the user who owns the dashboard.
	UserId types.Int64 `tfsdk:"user_id" tf:"optional"`

	Widgets []Widget `tfsdk:"widgets" tf:"optional"`
}

A JSON representing a dashboard containing widgets of visualizations and text boxes.

func (*Dashboard) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Dashboard) SyncEffectiveFieldsDuringCreateOrUpdate(plan Dashboard)

func (*Dashboard) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Dashboard) SyncEffectiveFieldsDuringRead(existingState Dashboard)

type DashboardEditContent 

type DashboardEditContent struct {
	DashboardId types.String `tfsdk:"-"`
	// The title of this dashboard that appears in list views and at the top of
	// the dashboard page.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Sets the **Run as** role for the object. Must be set to one of `"viewer"`
	// (signifying "run as viewer" behavior) or `"owner"` (signifying "run as
	// owner" behavior)
	RunAsRole types.String `tfsdk:"run_as_role" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
}

func (*DashboardEditContent) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DashboardEditContent) SyncEffectiveFieldsDuringCreateOrUpdate(plan DashboardEditContent)

func (*DashboardEditContent) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DashboardEditContent) SyncEffectiveFieldsDuringRead(existingState DashboardEditContent)

type DashboardOptions 

type DashboardOptions struct {
	// The timestamp when this dashboard was moved to trash. Only present when
	// the `is_archived` property is `true`. Trashed items are deleted after
	// thirty days.
	MovedToTrashAt types.String `tfsdk:"moved_to_trash_at" tf:"optional"`
}

func (*DashboardOptions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DashboardOptions) SyncEffectiveFieldsDuringCreateOrUpdate(plan DashboardOptions)

func (*DashboardOptions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DashboardOptions) SyncEffectiveFieldsDuringRead(existingState DashboardOptions)

type DashboardPostContent 

type DashboardPostContent struct {
	// Indicates whether the dashboard filters are enabled
	DashboardFiltersEnabled types.Bool `tfsdk:"dashboard_filters_enabled" tf:"optional"`
	// Indicates whether this dashboard object should appear in the current
	// user's favorites list.
	IsFavorite types.Bool `tfsdk:"is_favorite" tf:"optional"`
	// The title of this dashboard that appears in list views and at the top of
	// the dashboard page.
	Name types.String `tfsdk:"name" tf:""`
	// The identifier of the workspace folder containing the object.
	Parent types.String `tfsdk:"parent" tf:"optional"`
	// Sets the **Run as** role for the object. Must be set to one of `"viewer"`
	// (signifying "run as viewer" behavior) or `"owner"` (signifying "run as
	// owner" behavior)
	RunAsRole types.String `tfsdk:"run_as_role" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
}

func (*DashboardPostContent) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DashboardPostContent) SyncEffectiveFieldsDuringCreateOrUpdate(plan DashboardPostContent)

func (*DashboardPostContent) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DashboardPostContent) SyncEffectiveFieldsDuringRead(existingState DashboardPostContent)

type DataSource 

type DataSource struct {
	// Data source ID maps to the ID of the data source used by the resource and
	// is distinct from the warehouse ID. [Learn more]
	//
	// [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
	Id types.String `tfsdk:"id" tf:"optional"`
	// The string name of this data source / SQL warehouse as it appears in the
	// Databricks SQL web application.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Reserved for internal use.
	PauseReason types.String `tfsdk:"pause_reason" tf:"optional"`
	// Reserved for internal use.
	Paused types.Int64 `tfsdk:"paused" tf:"optional"`
	// Reserved for internal use.
	SupportsAutoLimit types.Bool `tfsdk:"supports_auto_limit" tf:"optional"`
	// Reserved for internal use.
	Syntax types.String `tfsdk:"syntax" tf:"optional"`
	// The type of data source. For SQL warehouses, this will be
	// `databricks_internal`.
	Type types.String `tfsdk:"type" tf:"optional"`
	// Reserved for internal use.
	ViewOnly types.Bool `tfsdk:"view_only" tf:"optional"`
	// The ID of the associated SQL warehouse, if this data source is backed by
	// a SQL warehouse.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

A JSON object representing a DBSQL data source / SQL warehouse.

func (*DataSource) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DataSource) SyncEffectiveFieldsDuringCreateOrUpdate(plan DataSource)

func (*DataSource) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DataSource) SyncEffectiveFieldsDuringRead(existingState DataSource)

type DateRange 

type DateRange struct {
	End types.String `tfsdk:"end" tf:""`

	Start types.String `tfsdk:"start" tf:""`
}

func (*DateRange) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DateRange) SyncEffectiveFieldsDuringCreateOrUpdate(plan DateRange)

func (*DateRange) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DateRange) SyncEffectiveFieldsDuringRead(existingState DateRange)

type DateRangeValue 

type DateRangeValue struct {
	// Manually specified date-time range value.
	DateRangeValue []DateRange `tfsdk:"date_range_value" tf:"optional,object"`
	// Dynamic date-time range value based on current date-time.
	DynamicDateRangeValue types.String `tfsdk:"dynamic_date_range_value" tf:"optional"`
	// Date-time precision to format the value into when the query is run.
	// Defaults to DAY_PRECISION (YYYY-MM-DD).
	Precision types.String `tfsdk:"precision" tf:"optional"`

	StartDayOfWeek types.Int64 `tfsdk:"start_day_of_week" tf:"optional"`
}

func (*DateRangeValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DateRangeValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan DateRangeValue)

func (*DateRangeValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DateRangeValue) SyncEffectiveFieldsDuringRead(existingState DateRangeValue)

type DateValue 

type DateValue struct {
	// Manually specified date-time value.
	DateValue types.String `tfsdk:"date_value" tf:"optional"`
	// Dynamic date-time value based on current date-time.
	DynamicDateValue types.String `tfsdk:"dynamic_date_value" tf:"optional"`
	// Date-time precision to format the value into when the query is run.
	// Defaults to DAY_PRECISION (YYYY-MM-DD).
	Precision types.String `tfsdk:"precision" tf:"optional"`
}

func (*DateValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DateValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan DateValue)

func (*DateValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DateValue) SyncEffectiveFieldsDuringRead(existingState DateValue)

type DeleteAlertsLegacyRequest 

type DeleteAlertsLegacyRequest struct {
	AlertId types.String `tfsdk:"-"`
}

Delete an alert

func (*DeleteAlertsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteAlertsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteAlertsLegacyRequest)

func (*DeleteAlertsLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteAlertsLegacyRequest) SyncEffectiveFieldsDuringRead(existingState DeleteAlertsLegacyRequest)

type DeleteDashboardRequest 

type DeleteDashboardRequest struct {
	DashboardId types.String `tfsdk:"-"`
}

Remove a dashboard

func (*DeleteDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDashboardRequest)

func (*DeleteDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteDashboardRequest) SyncEffectiveFieldsDuringRead(existingState DeleteDashboardRequest)

type DeleteDashboardWidgetRequest 

type DeleteDashboardWidgetRequest struct {
	// Widget ID returned by :method:dashboardwidgets/create
	Id types.String `tfsdk:"-"`
}

Remove widget

func (*DeleteDashboardWidgetRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteDashboardWidgetRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDashboardWidgetRequest)

func (*DeleteDashboardWidgetRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteDashboardWidgetRequest) SyncEffectiveFieldsDuringRead(existingState DeleteDashboardWidgetRequest)

type DeleteQueriesLegacyRequest 

type DeleteQueriesLegacyRequest struct {
	QueryId types.String `tfsdk:"-"`
}

Delete a query

func (*DeleteQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteQueriesLegacyRequest)

func (*DeleteQueriesLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteQueriesLegacyRequest) SyncEffectiveFieldsDuringRead(existingState DeleteQueriesLegacyRequest)

type DeleteQueryVisualizationsLegacyRequest 

type DeleteQueryVisualizationsLegacyRequest struct {
	// Widget ID returned by :method:queryvizualisations/create
	Id types.String `tfsdk:"-"`
}

Remove visualization

func (*DeleteQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteQueryVisualizationsLegacyRequest)

func (*DeleteQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteQueryVisualizationsLegacyRequest) SyncEffectiveFieldsDuringRead(existingState DeleteQueryVisualizationsLegacyRequest)

type DeleteResponse 

type DeleteResponse struct {
}

func (*DeleteResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteResponse)

func (*DeleteResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteResponse) SyncEffectiveFieldsDuringRead(existingState DeleteResponse)

type DeleteVisualizationRequest 

type DeleteVisualizationRequest struct {
	Id types.String `tfsdk:"-"`
}

Remove a visualization

func (*DeleteVisualizationRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteVisualizationRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteVisualizationRequest)

func (*DeleteVisualizationRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteVisualizationRequest) SyncEffectiveFieldsDuringRead(existingState DeleteVisualizationRequest)

type DeleteWarehouseRequest 

type DeleteWarehouseRequest struct {
	// Required. Id of the SQL warehouse.
	Id types.String `tfsdk:"-"`
}

Delete a warehouse

func (*DeleteWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteWarehouseRequest)

func (*DeleteWarehouseRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteWarehouseRequest) SyncEffectiveFieldsDuringRead(existingState DeleteWarehouseRequest)

type DeleteWarehouseResponse 

type DeleteWarehouseResponse struct {
}

func (*DeleteWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteWarehouseResponse)

func (*DeleteWarehouseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteWarehouseResponse) SyncEffectiveFieldsDuringRead(existingState DeleteWarehouseResponse)

type EditAlert 

type EditAlert struct {
	AlertId types.String `tfsdk:"-"`
	// Name of the alert.
	Name types.String `tfsdk:"name" tf:""`
	// Alert configuration options.
	Options []AlertOptions `tfsdk:"options" tf:"object"`
	// Query ID.
	QueryId types.String `tfsdk:"query_id" tf:""`
	// Number of seconds after being triggered before the alert rearms itself
	// and can be triggered again. If `null`, alert will never be triggered
	// again.
	Rearm types.Int64 `tfsdk:"rearm" tf:"optional"`
}

func (*EditAlert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EditAlert) SyncEffectiveFieldsDuringCreateOrUpdate(plan EditAlert)

func (*EditAlert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EditAlert) SyncEffectiveFieldsDuringRead(existingState EditAlert)

type EditWarehouseRequest 

type EditWarehouseRequest struct {
	// The amount of time in minutes that a SQL warehouse must be idle (i.e., no
	// RUNNING queries) before it is automatically stopped.
	//
	// Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
	//
	// Defaults to 120 mins
	AutoStopMins types.Int64 `tfsdk:"auto_stop_mins" tf:"optional"`
	// Channel Details
	Channel []Channel `tfsdk:"channel" tf:"optional,object"`
	// Size of the clusters allocated for this warehouse. Increasing the size of
	// a spark cluster allows you to run larger queries on it. If you want to
	// increase the number of concurrent queries, please tune max_num_clusters.
	//
	// Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large
	// - 2X-Large - 3X-Large - 4X-Large
	ClusterSize types.String `tfsdk:"cluster_size" tf:"optional"`
	// warehouse creator name
	CreatorName types.String `tfsdk:"creator_name" tf:"optional"`
	// Configures whether the warehouse should use Photon optimized clusters.
	//
	// Defaults to false.
	EnablePhoton types.Bool `tfsdk:"enable_photon" tf:"optional"`
	// Configures whether the warehouse should use serverless compute.
	EnableServerlessCompute types.Bool `tfsdk:"enable_serverless_compute" tf:"optional"`
	// Required. Id of the warehouse to configure.
	Id types.String `tfsdk:"-"`
	// Deprecated. Instance profile used to pass IAM role to the cluster
	InstanceProfileArn types.String `tfsdk:"instance_profile_arn" tf:"optional"`
	// Maximum number of clusters that the autoscaler will create to handle
	// concurrent queries.
	//
	// Supported values: - Must be >= min_num_clusters - Must be <= 30.
	//
	// Defaults to min_clusters if unset.
	MaxNumClusters types.Int64 `tfsdk:"max_num_clusters" tf:"optional"`
	// Minimum number of available clusters that will be maintained for this SQL
	// warehouse. Increasing this will ensure that a larger number of clusters
	// are always running and therefore may reduce the cold start time for new
	// queries. This is similar to reserved vs. revocable cores in a resource
	// manager.
	//
	// Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30)
	//
	// Defaults to 1
	MinNumClusters types.Int64 `tfsdk:"min_num_clusters" tf:"optional"`
	// Logical name for the cluster.
	//
	// Supported values: - Must be unique within an org. - Must be less than 100
	// characters.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Configurations whether the warehouse should use spot instances.
	SpotInstancePolicy types.String `tfsdk:"spot_instance_policy" tf:"optional"`
	// A set of key-value pairs that will be tagged on all resources (e.g., AWS
	// instances and EBS volumes) associated with this SQL warehouse.
	//
	// Supported values: - Number of tags < 45.
	Tags []EndpointTags `tfsdk:"tags" tf:"optional,object"`
	// Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless
	// compute, you must set to `PRO` and also set the field
	// `enable_serverless_compute` to `true`.
	WarehouseType types.String `tfsdk:"warehouse_type" tf:"optional"`
}

func (*EditWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EditWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan EditWarehouseRequest)

func (*EditWarehouseRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EditWarehouseRequest) SyncEffectiveFieldsDuringRead(existingState EditWarehouseRequest)

type EditWarehouseResponse 

type EditWarehouseResponse struct {
}

func (*EditWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EditWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan EditWarehouseResponse)

func (*EditWarehouseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EditWarehouseResponse) SyncEffectiveFieldsDuringRead(existingState EditWarehouseResponse)

type Empty 

type Empty struct {
}

Represents an empty message, similar to google.protobuf.Empty, which is not available in the firm right now.

func (*Empty) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Empty) SyncEffectiveFieldsDuringCreateOrUpdate(plan Empty)

func (*Empty) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Empty) SyncEffectiveFieldsDuringRead(existingState Empty)

type EndpointConfPair 

type EndpointConfPair struct {
	Key types.String `tfsdk:"key" tf:"optional"`

	Value types.String `tfsdk:"value" tf:"optional"`
}

func (*EndpointConfPair) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EndpointConfPair) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointConfPair)

func (*EndpointConfPair) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EndpointConfPair) SyncEffectiveFieldsDuringRead(existingState EndpointConfPair)

type EndpointHealth 

type EndpointHealth struct {
	// Details about errors that are causing current degraded/failed status.
	Details types.String `tfsdk:"details" tf:"optional"`
	// The reason for failure to bring up clusters for this warehouse. This is
	// available when status is 'FAILED' and sometimes when it is DEGRADED.
	FailureReason []TerminationReason `tfsdk:"failure_reason" tf:"optional,object"`
	// Deprecated. split into summary and details for security
	Message types.String `tfsdk:"message" tf:"optional"`
	// Health status of the warehouse.
	Status types.String `tfsdk:"status" tf:"optional"`
	// A short summary of the health status in case of degraded/failed
	// warehouses.
	Summary types.String `tfsdk:"summary" tf:"optional"`
}

func (*EndpointHealth) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EndpointHealth) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointHealth)

func (*EndpointHealth) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EndpointHealth) SyncEffectiveFieldsDuringRead(existingState EndpointHealth)

type EndpointInfo 

type EndpointInfo struct {
	// The amount of time in minutes that a SQL warehouse must be idle (i.e., no
	// RUNNING queries) before it is automatically stopped.
	//
	// Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
	//
	// Defaults to 120 mins
	AutoStopMins types.Int64 `tfsdk:"auto_stop_mins" tf:"optional"`
	// Channel Details
	Channel []Channel `tfsdk:"channel" tf:"optional,object"`
	// Size of the clusters allocated for this warehouse. Increasing the size of
	// a spark cluster allows you to run larger queries on it. If you want to
	// increase the number of concurrent queries, please tune max_num_clusters.
	//
	// Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large
	// - 2X-Large - 3X-Large - 4X-Large
	ClusterSize types.String `tfsdk:"cluster_size" tf:"optional"`
	// warehouse creator name
	CreatorName types.String `tfsdk:"creator_name" tf:"optional"`
	// Configures whether the warehouse should use Photon optimized clusters.
	//
	// Defaults to false.
	EnablePhoton types.Bool `tfsdk:"enable_photon" tf:"optional"`
	// Configures whether the warehouse should use serverless compute
	EnableServerlessCompute types.Bool `tfsdk:"enable_serverless_compute" tf:"optional"`
	// Optional health status. Assume the warehouse is healthy if this field is
	// not set.
	Health []EndpointHealth `tfsdk:"health" tf:"optional,object"`
	// unique identifier for warehouse
	Id types.String `tfsdk:"id" tf:"optional"`
	// Deprecated. Instance profile used to pass IAM role to the cluster
	InstanceProfileArn types.String `tfsdk:"instance_profile_arn" tf:"optional"`
	// the jdbc connection string for this warehouse
	JdbcUrl types.String `tfsdk:"jdbc_url" tf:"optional"`
	// Maximum number of clusters that the autoscaler will create to handle
	// concurrent queries.
	//
	// Supported values: - Must be >= min_num_clusters - Must be <= 30.
	//
	// Defaults to min_clusters if unset.
	MaxNumClusters types.Int64 `tfsdk:"max_num_clusters" tf:"optional"`
	// Minimum number of available clusters that will be maintained for this SQL
	// warehouse. Increasing this will ensure that a larger number of clusters
	// are always running and therefore may reduce the cold start time for new
	// queries. This is similar to reserved vs. revocable cores in a resource
	// manager.
	//
	// Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30)
	//
	// Defaults to 1
	MinNumClusters types.Int64 `tfsdk:"min_num_clusters" tf:"optional"`
	// Logical name for the cluster.
	//
	// Supported values: - Must be unique within an org. - Must be less than 100
	// characters.
	Name types.String `tfsdk:"name" tf:"optional"`
	// current number of active sessions for the warehouse
	NumActiveSessions types.Int64 `tfsdk:"num_active_sessions" tf:"optional"`
	// current number of clusters running for the service
	NumClusters types.Int64 `tfsdk:"num_clusters" tf:"optional"`
	// ODBC parameters for the SQL warehouse
	OdbcParams []OdbcParams `tfsdk:"odbc_params" tf:"optional,object"`
	// Configurations whether the warehouse should use spot instances.
	SpotInstancePolicy types.String `tfsdk:"spot_instance_policy" tf:"optional"`
	// State of the warehouse
	State types.String `tfsdk:"state" tf:"optional"`
	// A set of key-value pairs that will be tagged on all resources (e.g., AWS
	// instances and EBS volumes) associated with this SQL warehouse.
	//
	// Supported values: - Number of tags < 45.
	Tags []EndpointTags `tfsdk:"tags" tf:"optional,object"`
	// Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless
	// compute, you must set to `PRO` and also set the field
	// `enable_serverless_compute` to `true`.
	WarehouseType types.String `tfsdk:"warehouse_type" tf:"optional"`
}

func (*EndpointInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EndpointInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointInfo)

func (*EndpointInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EndpointInfo) SyncEffectiveFieldsDuringRead(existingState EndpointInfo)

type EndpointTagPair 

type EndpointTagPair struct {
	Key types.String `tfsdk:"key" tf:"optional"`

	Value types.String `tfsdk:"value" tf:"optional"`
}

func (*EndpointTagPair) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EndpointTagPair) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointTagPair)

func (*EndpointTagPair) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EndpointTagPair) SyncEffectiveFieldsDuringRead(existingState EndpointTagPair)

type EndpointTags 

type EndpointTags struct {
	CustomTags []EndpointTagPair `tfsdk:"custom_tags" tf:"optional"`
}

func (*EndpointTags) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EndpointTags) SyncEffectiveFieldsDuringCreateOrUpdate(plan EndpointTags)

func (*EndpointTags) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EndpointTags) SyncEffectiveFieldsDuringRead(existingState EndpointTags)

type EnumValue 

type EnumValue struct {
	// List of valid query parameter values, newline delimited.
	EnumOptions types.String `tfsdk:"enum_options" tf:"optional"`
	// If specified, allows multiple values to be selected for this parameter.
	MultiValuesOptions []MultiValuesOptions `tfsdk:"multi_values_options" tf:"optional,object"`
	// List of selected query parameter values.
	Values []types.String `tfsdk:"values" tf:"optional"`
}

func (*EnumValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *EnumValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan EnumValue)

func (*EnumValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *EnumValue) SyncEffectiveFieldsDuringRead(existingState EnumValue)

type ExecuteStatementRequest 

type ExecuteStatementRequest struct {
	// Applies the given byte limit to the statement's result size. Byte counts
	// are based on internal data representations and might not match the final
	// size in the requested `format`. If the result was truncated due to the
	// byte limit, then `truncated` in the response is set to `true`. When using
	// `EXTERNAL_LINKS` disposition, a default `byte_limit` of 100 GiB is
	// applied if `byte_limit` is not explcitly set.
	ByteLimit types.Int64 `tfsdk:"byte_limit" tf:"optional"`
	// Sets default catalog for statement execution, similar to [`USE CATALOG`]
	// in SQL.
	//
	// [`USE CATALOG`]: https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-catalog.html
	Catalog types.String `tfsdk:"catalog" tf:"optional"`

	Disposition types.String `tfsdk:"disposition" tf:"optional"`
	// Statement execution supports three result formats: `JSON_ARRAY`
	// (default), `ARROW_STREAM`, and `CSV`.
	//
	// Important: The formats `ARROW_STREAM` and `CSV` are supported only with
	// `EXTERNAL_LINKS` disposition. `JSON_ARRAY` is supported in `INLINE` and
	// `EXTERNAL_LINKS` disposition.
	//
	// When specifying `format=JSON_ARRAY`, result data will be formatted as an
	// array of arrays of values, where each value is either the *string
	// representation* of a value, or `null`. For example, the output of `SELECT
	// concat('id-', id) AS strCol, id AS intCol, null AS nullCol FROM range(3)`
	// would look like this:
	//
	// “` [ [ "id-1", "1", null ], [ "id-2", "2", null ], [ "id-3", "3", null
	// ], ] “`
	//
	// When specifying `format=JSON_ARRAY` and `disposition=EXTERNAL_LINKS`,
	// each chunk in the result contains compact JSON with no indentation or
	// extra whitespace.
	//
	// When specifying `format=ARROW_STREAM` and `disposition=EXTERNAL_LINKS`,
	// each chunk in the result will be formatted as Apache Arrow Stream. See
	// the [Apache Arrow streaming format].
	//
	// When specifying `format=CSV` and `disposition=EXTERNAL_LINKS`, each chunk
	// in the result will be a CSV according to [RFC 4180] standard. All the
	// columns values will have *string representation* similar to the
	// `JSON_ARRAY` format, and `null` values will be encoded as “null”.
	// Only the first chunk in the result would contain a header row with column
	// names. For example, the output of `SELECT concat('id-', id) AS strCol, id
	// AS intCol, null as nullCol FROM range(3)` would look like this:
	//
	// “` strCol,intCol,nullCol id-1,1,null id-2,2,null id-3,3,null “`
	//
	// [Apache Arrow streaming format]: https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format
	// [RFC 4180]: https://www.rfc-editor.org/rfc/rfc4180
	Format types.String `tfsdk:"format" tf:"optional"`
	// When `wait_timeout > 0s`, the call will block up to the specified time.
	// If the statement execution doesn't finish within this time,
	// `on_wait_timeout` determines whether the execution should continue or be
	// canceled. When set to `CONTINUE`, the statement execution continues
	// asynchronously and the call returns a statement ID which can be used for
	// polling with :method:statementexecution/getStatement. When set to
	// `CANCEL`, the statement execution is canceled and the call returns with a
	// `CANCELED` state.
	OnWaitTimeout types.String `tfsdk:"on_wait_timeout" tf:"optional"`
	// A list of parameters to pass into a SQL statement containing parameter
	// markers. A parameter consists of a name, a value, and optionally a type.
	// To represent a NULL value, the `value` field may be omitted or set to
	// `null` explicitly. If the `type` field is omitted, the value is
	// interpreted as a string.
	//
	// If the type is given, parameters will be checked for type correctness
	// according to the given type. A value is correct if the provided string
	// can be converted to the requested type using the `cast` function. The
	// exact semantics are described in the section [`cast` function] of the SQL
	// language reference.
	//
	// For example, the following statement contains two parameters, `my_name`
	// and `my_date`:
	//
	// SELECT * FROM my_table WHERE name = :my_name AND date = :my_date
	//
	// The parameters can be passed in the request body as follows:
	//
	// { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND
	// date = :my_date", "parameters": [ { "name": "my_name", "value": "the
	// name" }, { "name": "my_date", "value": "2020-01-01", "type": "DATE" } ] }
	//
	// Currently, positional parameters denoted by a `?` marker are not
	// supported by the Databricks SQL Statement Execution API.
	//
	// Also see the section [Parameter markers] of the SQL language reference.
	//
	// [Parameter markers]: https://docs.databricks.com/sql/language-manual/sql-ref-parameter-marker.html
	// [`cast` function]: https://docs.databricks.com/sql/language-manual/functions/cast.html
	Parameters []StatementParameterListItem `tfsdk:"parameters" tf:"optional"`
	// Applies the given row limit to the statement's result set, but unlike the
	// `LIMIT` clause in SQL, it also sets the `truncated` field in the response
	// to indicate whether the result was trimmed due to the limit or not.
	RowLimit types.Int64 `tfsdk:"row_limit" tf:"optional"`
	// Sets default schema for statement execution, similar to [`USE SCHEMA`] in
	// SQL.
	//
	// [`USE SCHEMA`]: https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-schema.html
	Schema types.String `tfsdk:"schema" tf:"optional"`
	// The SQL statement to execute. The statement can optionally be
	// parameterized, see `parameters`.
	Statement types.String `tfsdk:"statement" tf:""`
	// The time in seconds the call will wait for the statement's result set as
	// `Ns`, where `N` can be set to 0 or to a value between 5 and 50.
	//
	// When set to `0s`, the statement will execute in asynchronous mode and the
	// call will not wait for the execution to finish. In this case, the call
	// returns directly with `PENDING` state and a statement ID which can be
	// used for polling with :method:statementexecution/getStatement.
	//
	// When set between 5 and 50 seconds, the call will behave synchronously up
	// to this timeout and wait for the statement execution to finish. If the
	// execution finishes within this time, the call returns immediately with a
	// manifest and result data (or a `FAILED` state in case of an execution
	// error). If the statement takes longer to execute, `on_wait_timeout`
	// determines what should happen after the timeout is reached.
	WaitTimeout types.String `tfsdk:"wait_timeout" tf:"optional"`
	// Warehouse upon which to execute a statement. See also [What are SQL
	// warehouses?]
	//
	// [What are SQL warehouses?]: https://docs.databricks.com/sql/admin/warehouse-type.html
	WarehouseId types.String `tfsdk:"warehouse_id" tf:""`
}

func (*ExecuteStatementRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ExecuteStatementRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ExecuteStatementRequest)

func (*ExecuteStatementRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ExecuteStatementRequest) SyncEffectiveFieldsDuringRead(existingState ExecuteStatementRequest)
type ExternalLink struct {
	// The number of bytes in the result chunk. This field is not available when
	// using `INLINE` disposition.
	ByteCount types.Int64 `tfsdk:"byte_count" tf:"optional"`
	// The position within the sequence of result set chunks.
	ChunkIndex types.Int64 `tfsdk:"chunk_index" tf:"optional"`
	// Indicates the date-time that the given external link will expire and
	// becomes invalid, after which point a new `external_link` must be
	// requested.
	Expiration types.String `tfsdk:"expiration" tf:"optional"`

	ExternalLink types.String `tfsdk:"external_link" tf:"optional"`
	// HTTP headers that must be included with a GET request to the
	// `external_link`. Each header is provided as a key-value pair. Headers are
	// typically used to pass a decryption key to the external service. The
	// values of these headers should be considered sensitive and the client
	// should not expose these values in a log.
	HttpHeaders map[string]types.String `tfsdk:"http_headers" tf:"optional"`
	// When fetching, provides the `chunk_index` for the _next_ chunk. If
	// absent, indicates there are no more chunks. The next chunk can be fetched
	// with a :method:statementexecution/getStatementResultChunkN request.
	NextChunkIndex types.Int64 `tfsdk:"next_chunk_index" tf:"optional"`
	// When fetching, provides a link to fetch the _next_ chunk. If absent,
	// indicates there are no more chunks. This link is an absolute `path` to be
	// joined with your `$DATABRICKS_HOST`, and should be treated as an opaque
	// link. This is an alternative to using `next_chunk_index`.
	NextChunkInternalLink types.String `tfsdk:"next_chunk_internal_link" tf:"optional"`
	// The number of rows within the result chunk.
	RowCount types.Int64 `tfsdk:"row_count" tf:"optional"`
	// The starting row offset within the result set.
	RowOffset types.Int64 `tfsdk:"row_offset" tf:"optional"`
}

func (*ExternalLink) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ExternalLink) SyncEffectiveFieldsDuringCreateOrUpdate(plan ExternalLink)

func (*ExternalLink) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ExternalLink) SyncEffectiveFieldsDuringRead(existingState ExternalLink)

type GetAlertRequest 

type GetAlertRequest struct {
	Id types.String `tfsdk:"-"`
}

Get an alert

func (*GetAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAlertRequest)

func (*GetAlertRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAlertRequest) SyncEffectiveFieldsDuringRead(existingState GetAlertRequest)

type GetAlertsLegacyRequest 

type GetAlertsLegacyRequest struct {
	AlertId types.String `tfsdk:"-"`
}

Get an alert

func (*GetAlertsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetAlertsLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetAlertsLegacyRequest)

func (*GetAlertsLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetAlertsLegacyRequest) SyncEffectiveFieldsDuringRead(existingState GetAlertsLegacyRequest)

type GetDashboardRequest 

type GetDashboardRequest struct {
	DashboardId types.String `tfsdk:"-"`
}

Retrieve a definition

func (*GetDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetDashboardRequest)

func (*GetDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetDashboardRequest) SyncEffectiveFieldsDuringRead(existingState GetDashboardRequest)

type GetDbsqlPermissionRequest 

type GetDbsqlPermissionRequest struct {
	// Object ID. An ACL is returned for the object with this UUID.
	ObjectId types.String `tfsdk:"-"`
	// The type of object permissions to check.
	ObjectType types.String `tfsdk:"-"`
}

Get object ACL

func (*GetDbsqlPermissionRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetDbsqlPermissionRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetDbsqlPermissionRequest)

func (*GetDbsqlPermissionRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetDbsqlPermissionRequest) SyncEffectiveFieldsDuringRead(existingState GetDbsqlPermissionRequest)

type GetQueriesLegacyRequest 

type GetQueriesLegacyRequest struct {
	QueryId types.String `tfsdk:"-"`
}

Get a query definition.

func (*GetQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetQueriesLegacyRequest)

func (*GetQueriesLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetQueriesLegacyRequest) SyncEffectiveFieldsDuringRead(existingState GetQueriesLegacyRequest)

type GetQueryRequest 

type GetQueryRequest struct {
	Id types.String `tfsdk:"-"`
}

Get a query

func (*GetQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetQueryRequest)

func (*GetQueryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetQueryRequest) SyncEffectiveFieldsDuringRead(existingState GetQueryRequest)

type GetResponse 

type GetResponse struct {
	AccessControlList []AccessControl `tfsdk:"access_control_list" tf:"optional"`
	// An object's type and UUID, separated by a forward slash (/) character.
	ObjectId types.String `tfsdk:"object_id" tf:"optional"`
	// A singular noun object type.
	ObjectType types.String `tfsdk:"object_type" tf:"optional"`
}

func (*GetResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetResponse)

func (*GetResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetResponse) SyncEffectiveFieldsDuringRead(existingState GetResponse)

type GetStatementRequest 

type GetStatementRequest struct {
	// The statement ID is returned upon successfully submitting a SQL
	// statement, and is a required reference for all subsequent calls.
	StatementId types.String `tfsdk:"-"`
}

Get status, manifest, and result first chunk

func (*GetStatementRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetStatementRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetStatementRequest)

func (*GetStatementRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetStatementRequest) SyncEffectiveFieldsDuringRead(existingState GetStatementRequest)

type GetStatementResultChunkNRequest 

type GetStatementResultChunkNRequest struct {
	ChunkIndex types.Int64 `tfsdk:"-"`
	// The statement ID is returned upon successfully submitting a SQL
	// statement, and is a required reference for all subsequent calls.
	StatementId types.String `tfsdk:"-"`
}

Get result chunk by index

func (*GetStatementResultChunkNRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetStatementResultChunkNRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetStatementResultChunkNRequest)

func (*GetStatementResultChunkNRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetStatementResultChunkNRequest) SyncEffectiveFieldsDuringRead(existingState GetStatementResultChunkNRequest)

type GetWarehousePermissionLevelsRequest 

type GetWarehousePermissionLevelsRequest struct {
	// The SQL warehouse for which to get or manage permissions.
	WarehouseId types.String `tfsdk:"-"`
}

Get SQL warehouse permission levels

func (*GetWarehousePermissionLevelsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWarehousePermissionLevelsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWarehousePermissionLevelsRequest)

func (*GetWarehousePermissionLevelsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWarehousePermissionLevelsRequest) SyncEffectiveFieldsDuringRead(existingState GetWarehousePermissionLevelsRequest)

type GetWarehousePermissionLevelsResponse 

type GetWarehousePermissionLevelsResponse struct {
	// Specific permission levels
	PermissionLevels []WarehousePermissionsDescription `tfsdk:"permission_levels" tf:"optional"`
}

func (*GetWarehousePermissionLevelsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWarehousePermissionLevelsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWarehousePermissionLevelsResponse)

func (*GetWarehousePermissionLevelsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWarehousePermissionLevelsResponse) SyncEffectiveFieldsDuringRead(existingState GetWarehousePermissionLevelsResponse)

type GetWarehousePermissionsRequest 

type GetWarehousePermissionsRequest struct {
	// The SQL warehouse for which to get or manage permissions.
	WarehouseId types.String `tfsdk:"-"`
}

Get SQL warehouse permissions

func (*GetWarehousePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWarehousePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWarehousePermissionsRequest)

func (*GetWarehousePermissionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWarehousePermissionsRequest) SyncEffectiveFieldsDuringRead(existingState GetWarehousePermissionsRequest)

type GetWarehouseRequest 

type GetWarehouseRequest struct {
	// Required. Id of the SQL warehouse.
	Id types.String `tfsdk:"-"`
}

Get warehouse info

func (*GetWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWarehouseRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWarehouseRequest)

func (*GetWarehouseRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWarehouseRequest) SyncEffectiveFieldsDuringRead(existingState GetWarehouseRequest)

type GetWarehouseResponse 

type GetWarehouseResponse struct {
	// The amount of time in minutes that a SQL warehouse must be idle (i.e., no
	// RUNNING queries) before it is automatically stopped.
	//
	// Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
	//
	// Defaults to 120 mins
	AutoStopMins types.Int64 `tfsdk:"auto_stop_mins" tf:"optional"`
	// Channel Details
	Channel []Channel `tfsdk:"channel" tf:"optional,object"`
	// Size of the clusters allocated for this warehouse. Increasing the size of
	// a spark cluster allows you to run larger queries on it. If you want to
	// increase the number of concurrent queries, please tune max_num_clusters.
	//
	// Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large
	// - 2X-Large - 3X-Large - 4X-Large
	ClusterSize types.String `tfsdk:"cluster_size" tf:"optional"`
	// warehouse creator name
	CreatorName types.String `tfsdk:"creator_name" tf:"optional"`
	// Configures whether the warehouse should use Photon optimized clusters.
	//
	// Defaults to false.
	EnablePhoton types.Bool `tfsdk:"enable_photon" tf:"optional"`
	// Configures whether the warehouse should use serverless compute
	EnableServerlessCompute types.Bool `tfsdk:"enable_serverless_compute" tf:"optional"`
	// Optional health status. Assume the warehouse is healthy if this field is
	// not set.
	Health []EndpointHealth `tfsdk:"health" tf:"optional,object"`
	// unique identifier for warehouse
	Id types.String `tfsdk:"id" tf:"optional"`
	// Deprecated. Instance profile used to pass IAM role to the cluster
	InstanceProfileArn types.String `tfsdk:"instance_profile_arn" tf:"optional"`
	// the jdbc connection string for this warehouse
	JdbcUrl types.String `tfsdk:"jdbc_url" tf:"optional"`
	// Maximum number of clusters that the autoscaler will create to handle
	// concurrent queries.
	//
	// Supported values: - Must be >= min_num_clusters - Must be <= 30.
	//
	// Defaults to min_clusters if unset.
	MaxNumClusters types.Int64 `tfsdk:"max_num_clusters" tf:"optional"`
	// Minimum number of available clusters that will be maintained for this SQL
	// warehouse. Increasing this will ensure that a larger number of clusters
	// are always running and therefore may reduce the cold start time for new
	// queries. This is similar to reserved vs. revocable cores in a resource
	// manager.
	//
	// Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30)
	//
	// Defaults to 1
	MinNumClusters types.Int64 `tfsdk:"min_num_clusters" tf:"optional"`
	// Logical name for the cluster.
	//
	// Supported values: - Must be unique within an org. - Must be less than 100
	// characters.
	Name types.String `tfsdk:"name" tf:"optional"`
	// current number of active sessions for the warehouse
	NumActiveSessions types.Int64 `tfsdk:"num_active_sessions" tf:"optional"`
	// current number of clusters running for the service
	NumClusters types.Int64 `tfsdk:"num_clusters" tf:"optional"`
	// ODBC parameters for the SQL warehouse
	OdbcParams []OdbcParams `tfsdk:"odbc_params" tf:"optional,object"`
	// Configurations whether the warehouse should use spot instances.
	SpotInstancePolicy types.String `tfsdk:"spot_instance_policy" tf:"optional"`
	// State of the warehouse
	State types.String `tfsdk:"state" tf:"optional"`
	// A set of key-value pairs that will be tagged on all resources (e.g., AWS
	// instances and EBS volumes) associated with this SQL warehouse.
	//
	// Supported values: - Number of tags < 45.
	Tags []EndpointTags `tfsdk:"tags" tf:"optional,object"`
	// Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless
	// compute, you must set to `PRO` and also set the field
	// `enable_serverless_compute` to `true`.
	WarehouseType types.String `tfsdk:"warehouse_type" tf:"optional"`
}

func (*GetWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWarehouseResponse)

func (*GetWarehouseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWarehouseResponse) SyncEffectiveFieldsDuringRead(existingState GetWarehouseResponse)

type GetWorkspaceWarehouseConfigResponse 

type GetWorkspaceWarehouseConfigResponse struct {
	// Optional: Channel selection details
	Channel []Channel `tfsdk:"channel" tf:"optional,object"`
	// Deprecated: Use sql_configuration_parameters
	ConfigParam []RepeatedEndpointConfPairs `tfsdk:"config_param" tf:"optional,object"`
	// Spark confs for external hive metastore configuration JSON serialized
	// size must be less than <= 512K
	DataAccessConfig []EndpointConfPair `tfsdk:"data_access_config" tf:"optional"`
	// List of Warehouse Types allowed in this workspace (limits allowed value
	// of the type field in CreateWarehouse and EditWarehouse). Note: Some types
	// cannot be disabled, they don't need to be specified in
	// SetWorkspaceWarehouseConfig. Note: Disabling a type may cause existing
	// warehouses to be converted to another type. Used by frontend to save
	// specific type availability in the warehouse create and edit form UI.
	EnabledWarehouseTypes []WarehouseTypePair `tfsdk:"enabled_warehouse_types" tf:"optional"`
	// Deprecated: Use sql_configuration_parameters
	GlobalParam []RepeatedEndpointConfPairs `tfsdk:"global_param" tf:"optional,object"`
	// GCP only: Google Service Account used to pass to cluster to access Google
	// Cloud Storage
	GoogleServiceAccount types.String `tfsdk:"google_service_account" tf:"optional"`
	// AWS Only: Instance profile used to pass IAM role to the cluster
	InstanceProfileArn types.String `tfsdk:"instance_profile_arn" tf:"optional"`
	// Security policy for warehouses
	SecurityPolicy types.String `tfsdk:"security_policy" tf:"optional"`
	// SQL configuration parameters
	SqlConfigurationParameters []RepeatedEndpointConfPairs `tfsdk:"sql_configuration_parameters" tf:"optional,object"`
}

func (*GetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetWorkspaceWarehouseConfigResponse)

func (*GetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringRead(existingState GetWorkspaceWarehouseConfigResponse)

type LegacyAlert 

type LegacyAlert struct {
	// Timestamp when the alert was created.
	CreatedAt types.String `tfsdk:"created_at" tf:"optional"`
	// Alert ID.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Timestamp when the alert was last triggered.
	LastTriggeredAt types.String `tfsdk:"last_triggered_at" tf:"optional"`
	// Name of the alert.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Alert configuration options.
	Options []AlertOptions `tfsdk:"options" tf:"optional,object"`
	// The identifier of the workspace folder containing the object.
	Parent types.String `tfsdk:"parent" tf:"optional"`

	Query []AlertQuery `tfsdk:"query" tf:"optional,object"`
	// Number of seconds after being triggered before the alert rearms itself
	// and can be triggered again. If `null`, alert will never be triggered
	// again.
	Rearm types.Int64 `tfsdk:"rearm" tf:"optional"`
	// State of the alert. Possible values are: `unknown` (yet to be evaluated),
	// `triggered` (evaluated and fulfilled trigger conditions), or `ok`
	// (evaluated and did not fulfill trigger conditions).
	State types.String `tfsdk:"state" tf:"optional"`
	// Timestamp when the alert was last updated.
	UpdatedAt types.String `tfsdk:"updated_at" tf:"optional"`

	User []User `tfsdk:"user" tf:"optional,object"`
}

func (*LegacyAlert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *LegacyAlert) SyncEffectiveFieldsDuringCreateOrUpdate(plan LegacyAlert)

func (*LegacyAlert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *LegacyAlert) SyncEffectiveFieldsDuringRead(existingState LegacyAlert)

type LegacyQuery 

type LegacyQuery struct {
	// Describes whether the authenticated user is allowed to edit the
	// definition of this query.
	CanEdit types.Bool `tfsdk:"can_edit" tf:"optional"`
	// The timestamp when this query was created.
	CreatedAt types.String `tfsdk:"created_at" tf:"optional"`
	// Data source ID maps to the ID of the data source used by the resource and
	// is distinct from the warehouse ID. [Learn more]
	//
	// [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
	DataSourceId types.String `tfsdk:"data_source_id" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// Query ID.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Indicates whether the query is trashed. Trashed queries can't be used in
	// dashboards, or appear in search results. If this boolean is `true`, the
	// `options` property for this query includes a `moved_to_trash_at`
	// timestamp. Trashed queries are permanently deleted after 30 days.
	IsArchived types.Bool `tfsdk:"is_archived" tf:"optional"`
	// Whether the query is a draft. Draft queries only appear in list views for
	// their owners. Visualizations from draft queries cannot appear on
	// dashboards.
	IsDraft types.Bool `tfsdk:"is_draft" tf:"optional"`
	// Whether this query object appears in the current user's favorites list.
	// This flag determines whether the star icon for favorites is selected.
	IsFavorite types.Bool `tfsdk:"is_favorite" tf:"optional"`
	// Text parameter types are not safe from SQL injection for all types of
	// data source. Set this Boolean parameter to `true` if a query either does
	// not use any text type parameters or uses a data source type where text
	// type parameters are handled safely.
	IsSafe types.Bool `tfsdk:"is_safe" tf:"optional"`

	LastModifiedBy []User `tfsdk:"last_modified_by" tf:"optional,object"`
	// The ID of the user who last saved changes to this query.
	LastModifiedById types.Int64 `tfsdk:"last_modified_by_id" tf:"optional"`
	// If there is a cached result for this query and user, this field includes
	// the query result ID. If this query uses parameters, this field is always
	// null.
	LatestQueryDataId types.String `tfsdk:"latest_query_data_id" tf:"optional"`
	// The title of this query that appears in list views, widget headings, and
	// on the query page.
	Name types.String `tfsdk:"name" tf:"optional"`

	Options []QueryOptions `tfsdk:"options" tf:"optional,object"`
	// The identifier of the workspace folder containing the object.
	Parent types.String `tfsdk:"parent" tf:"optional"`
	// * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query *
	// `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query
	PermissionTier types.String `tfsdk:"permission_tier" tf:"optional"`
	// The text of the query to be run.
	Query types.String `tfsdk:"query" tf:"optional"`
	// A SHA-256 hash of the query text along with the authenticated user ID.
	QueryHash types.String `tfsdk:"query_hash" tf:"optional"`
	// Sets the **Run as** role for the object. Must be set to one of `"viewer"`
	// (signifying "run as viewer" behavior) or `"owner"` (signifying "run as
	// owner" behavior)
	RunAsRole types.String `tfsdk:"run_as_role" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// The timestamp at which this query was last updated.
	UpdatedAt types.String `tfsdk:"updated_at" tf:"optional"`

	User []User `tfsdk:"user" tf:"optional,object"`
	// The ID of the user who owns the query.
	UserId types.Int64 `tfsdk:"user_id" tf:"optional"`

	Visualizations []LegacyVisualization `tfsdk:"visualizations" tf:"optional"`
}

func (*LegacyQuery) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *LegacyQuery) SyncEffectiveFieldsDuringCreateOrUpdate(plan LegacyQuery)

func (*LegacyQuery) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *LegacyQuery) SyncEffectiveFieldsDuringRead(existingState LegacyQuery)

type LegacyVisualization 

type LegacyVisualization struct {
	CreatedAt types.String `tfsdk:"created_at" tf:"optional"`
	// A short description of this visualization. This is not displayed in the
	// UI.
	Description types.String `tfsdk:"description" tf:"optional"`
	// The UUID for this visualization.
	Id types.String `tfsdk:"id" tf:"optional"`
	// The name of the visualization that appears on dashboards and the query
	// screen.
	Name types.String `tfsdk:"name" tf:"optional"`
	// The options object varies widely from one visualization type to the next
	// and is unsupported. Databricks does not recommend modifying visualization
	// settings in JSON.
	Options any `tfsdk:"options" tf:"optional"`

	Query []LegacyQuery `tfsdk:"query" tf:"optional,object"`
	// The type of visualization: chart, table, pivot table, and so on.
	Type types.String `tfsdk:"type" tf:"optional"`

	UpdatedAt types.String `tfsdk:"updated_at" tf:"optional"`
}

The visualization description API changes frequently and is unsupported. You can duplicate a visualization by copying description objects received _from the API_ and then using them to create a new one with a POST request to the same endpoint. Databricks does not recommend constructing ad-hoc visualizations entirely in JSON.

func (*LegacyVisualization) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *LegacyVisualization) SyncEffectiveFieldsDuringCreateOrUpdate(plan LegacyVisualization)

func (*LegacyVisualization) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *LegacyVisualization) SyncEffectiveFieldsDuringRead(existingState LegacyVisualization)

type ListAlertsRequest 

type ListAlertsRequest struct {
	PageSize types.Int64 `tfsdk:"-"`

	PageToken types.String `tfsdk:"-"`
}

List alerts

func (*ListAlertsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListAlertsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListAlertsRequest)

func (*ListAlertsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListAlertsRequest) SyncEffectiveFieldsDuringRead(existingState ListAlertsRequest)

type ListAlertsResponse 

type ListAlertsResponse struct {
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`

	Results []ListAlertsResponseAlert `tfsdk:"results" tf:"optional"`
}

func (*ListAlertsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListAlertsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListAlertsResponse)

func (*ListAlertsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListAlertsResponse) SyncEffectiveFieldsDuringRead(existingState ListAlertsResponse)

type ListAlertsResponseAlert 

type ListAlertsResponseAlert struct {
	// Trigger conditions of the alert.
	Condition []AlertCondition `tfsdk:"condition" tf:"optional,object"`
	// The timestamp indicating when the alert was created.
	CreateTime types.String `tfsdk:"create_time" tf:"optional"`
	// Custom body of alert notification, if it exists. See [here] for custom
	// templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomBody types.String `tfsdk:"custom_body" tf:"optional"`
	// Custom subject of alert notification, if it exists. This can include
	// email subject entries and Slack notification headers, for example. See
	// [here] for custom templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomSubject types.String `tfsdk:"custom_subject" tf:"optional"`
	// The display name of the alert.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// UUID identifying the alert.
	Id types.String `tfsdk:"id" tf:"optional"`
	// The workspace state of the alert. Used for tracking trashed status.
	LifecycleState types.String `tfsdk:"lifecycle_state" tf:"optional"`
	// Whether to notify alert subscribers when alert returns back to normal.
	NotifyOnOk types.Bool `tfsdk:"notify_on_ok" tf:"optional"`
	// The owner's username. This field is set to "Unavailable" if the user has
	// been deleted.
	OwnerUserName types.String `tfsdk:"owner_user_name" tf:"optional"`
	// UUID of the query attached to the alert.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// Number of seconds an alert must wait after being triggered to rearm
	// itself. After rearming, it can be triggered again. If 0 or not specified,
	// the alert will not be triggered again.
	SecondsToRetrigger types.Int64 `tfsdk:"seconds_to_retrigger" tf:"optional"`
	// Current state of the alert's trigger status. This field is set to UNKNOWN
	// if the alert has not yet been evaluated or ran into an error during the
	// last evaluation.
	State types.String `tfsdk:"state" tf:"optional"`
	// Timestamp when the alert was last triggered, if the alert has been
	// triggered before.
	TriggerTime types.String `tfsdk:"trigger_time" tf:"optional"`
	// The timestamp indicating when the alert was updated.
	UpdateTime types.String `tfsdk:"update_time" tf:"optional"`
}

func (*ListAlertsResponseAlert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListAlertsResponseAlert) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListAlertsResponseAlert)

func (*ListAlertsResponseAlert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListAlertsResponseAlert) SyncEffectiveFieldsDuringRead(existingState ListAlertsResponseAlert)

type ListDashboardsRequest 

type ListDashboardsRequest struct {
	// Name of dashboard attribute to order by.
	Order types.String `tfsdk:"-"`
	// Page number to retrieve.
	Page types.Int64 `tfsdk:"-"`
	// Number of dashboards to return per page.
	PageSize types.Int64 `tfsdk:"-"`
	// Full text search term.
	Q types.String `tfsdk:"-"`
}

Get dashboard objects

func (*ListDashboardsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListDashboardsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListDashboardsRequest)

func (*ListDashboardsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListDashboardsRequest) SyncEffectiveFieldsDuringRead(existingState ListDashboardsRequest)

type ListQueriesLegacyRequest 

type ListQueriesLegacyRequest struct {
	// Name of query attribute to order by. Default sort order is ascending.
	// Append a dash (`-`) to order descending instead.
	//
	// - `name`: The name of the query.
	//
	// - `created_at`: The timestamp the query was created.
	//
	// - `runtime`: The time it took to run this query. This is blank for
	// parameterized queries. A blank value is treated as the highest value for
	// sorting.
	//
	// - `executed_at`: The timestamp when the query was last run.
	//
	// - `created_by`: The user name of the user that created the query.
	Order types.String `tfsdk:"-"`
	// Page number to retrieve.
	Page types.Int64 `tfsdk:"-"`
	// Number of queries to return per page.
	PageSize types.Int64 `tfsdk:"-"`
	// Full text search term
	Q types.String `tfsdk:"-"`
}

Get a list of queries

func (*ListQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListQueriesLegacyRequest)

func (*ListQueriesLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListQueriesLegacyRequest) SyncEffectiveFieldsDuringRead(existingState ListQueriesLegacyRequest)

type ListQueriesRequest 

type ListQueriesRequest struct {
	PageSize types.Int64 `tfsdk:"-"`

	PageToken types.String `tfsdk:"-"`
}

List queries

func (*ListQueriesRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListQueriesRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListQueriesRequest)

func (*ListQueriesRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListQueriesRequest) SyncEffectiveFieldsDuringRead(existingState ListQueriesRequest)

type ListQueriesResponse 

type ListQueriesResponse struct {
	// Whether there is another page of results.
	HasNextPage types.Bool `tfsdk:"has_next_page" tf:"optional"`
	// A token that can be used to get the next page of results.
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`

	Res []QueryInfo `tfsdk:"res" tf:"optional"`
}

func (*ListQueriesResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListQueriesResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListQueriesResponse)

func (*ListQueriesResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListQueriesResponse) SyncEffectiveFieldsDuringRead(existingState ListQueriesResponse)

type ListQueryHistoryRequest 

type ListQueryHistoryRequest struct {
	// A filter to limit query history results. This field is optional.
	FilterBy []QueryFilter `tfsdk:"-"`
	// Whether to include the query metrics with each query. Only use this for a
	// small subset of queries (max_results). Defaults to false.
	IncludeMetrics types.Bool `tfsdk:"-"`
	// Limit the number of results returned in one page. Must be less than 1000
	// and the default is 100.
	MaxResults types.Int64 `tfsdk:"-"`
	// A token that can be used to get the next page of results. The token can
	// contains characters that need to be encoded before using it in a URL. For
	// example, the character '+' needs to be replaced by %2B. This field is
	// optional.
	PageToken types.String `tfsdk:"-"`
}

List Queries

func (*ListQueryHistoryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListQueryHistoryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListQueryHistoryRequest)

func (*ListQueryHistoryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListQueryHistoryRequest) SyncEffectiveFieldsDuringRead(existingState ListQueryHistoryRequest)

type ListQueryObjectsResponse 

type ListQueryObjectsResponse struct {
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`

	Results []ListQueryObjectsResponseQuery `tfsdk:"results" tf:"optional"`
}

func (*ListQueryObjectsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListQueryObjectsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListQueryObjectsResponse)

func (*ListQueryObjectsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListQueryObjectsResponse) SyncEffectiveFieldsDuringRead(existingState ListQueryObjectsResponse)

type ListQueryObjectsResponseQuery 

type ListQueryObjectsResponseQuery struct {
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit types.Bool `tfsdk:"apply_auto_limit" tf:"optional"`
	// Name of the catalog where this query will be executed.
	Catalog types.String `tfsdk:"catalog" tf:"optional"`
	// Timestamp when this query was created.
	CreateTime types.String `tfsdk:"create_time" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// Display name of the query that appears in list views, widget headings,
	// and on the query page.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// UUID identifying the query.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Username of the user who last saved changes to this query.
	LastModifierUserName types.String `tfsdk:"last_modifier_user_name" tf:"optional"`
	// Indicates whether the query is trashed.
	LifecycleState types.String `tfsdk:"lifecycle_state" tf:"optional"`
	// Username of the user that owns the query.
	OwnerUserName types.String `tfsdk:"owner_user_name" tf:"optional"`
	// List of query parameter definitions.
	Parameters []QueryParameter `tfsdk:"parameters" tf:"optional"`
	// Text of the query to be run.
	QueryText types.String `tfsdk:"query_text" tf:"optional"`
	// Sets the "Run as" role for the object.
	RunAsMode types.String `tfsdk:"run_as_mode" tf:"optional"`
	// Name of the schema where this query will be executed.
	Schema types.String `tfsdk:"schema" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// Timestamp when this query was last updated.
	UpdateTime types.String `tfsdk:"update_time" tf:"optional"`
	// ID of the SQL warehouse attached to the query.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*ListQueryObjectsResponseQuery) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListQueryObjectsResponseQuery) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListQueryObjectsResponseQuery)

func (*ListQueryObjectsResponseQuery) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListQueryObjectsResponseQuery) SyncEffectiveFieldsDuringRead(existingState ListQueryObjectsResponseQuery)

type ListResponse 

type ListResponse struct {
	// The total number of dashboards.
	Count types.Int64 `tfsdk:"count" tf:"optional"`
	// The current page being displayed.
	Page types.Int64 `tfsdk:"page" tf:"optional"`
	// The number of dashboards per page.
	PageSize types.Int64 `tfsdk:"page_size" tf:"optional"`
	// List of dashboards returned.
	Results []Dashboard `tfsdk:"results" tf:"optional"`
}

func (*ListResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListResponse)

func (*ListResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListResponse) SyncEffectiveFieldsDuringRead(existingState ListResponse)

type ListVisualizationsForQueryRequest 

type ListVisualizationsForQueryRequest struct {
	Id types.String `tfsdk:"-"`

	PageSize types.Int64 `tfsdk:"-"`

	PageToken types.String `tfsdk:"-"`
}

List visualizations on a query

func (*ListVisualizationsForQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListVisualizationsForQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListVisualizationsForQueryRequest)

func (*ListVisualizationsForQueryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListVisualizationsForQueryRequest) SyncEffectiveFieldsDuringRead(existingState ListVisualizationsForQueryRequest)

type ListVisualizationsForQueryResponse 

type ListVisualizationsForQueryResponse struct {
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`

	Results []Visualization `tfsdk:"results" tf:"optional"`
}

func (*ListVisualizationsForQueryResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListVisualizationsForQueryResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListVisualizationsForQueryResponse)

func (*ListVisualizationsForQueryResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListVisualizationsForQueryResponse) SyncEffectiveFieldsDuringRead(existingState ListVisualizationsForQueryResponse)

type ListWarehousesRequest 

type ListWarehousesRequest struct {
	// Service Principal which will be used to fetch the list of warehouses. If
	// not specified, the user from the session header is used.
	RunAsUserId types.Int64 `tfsdk:"-"`
}

List warehouses

func (*ListWarehousesRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListWarehousesRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListWarehousesRequest)

func (*ListWarehousesRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListWarehousesRequest) SyncEffectiveFieldsDuringRead(existingState ListWarehousesRequest)

type ListWarehousesResponse 

type ListWarehousesResponse struct {
	// A list of warehouses and their configurations.
	Warehouses []EndpointInfo `tfsdk:"warehouses" tf:"optional"`
}

func (*ListWarehousesResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListWarehousesResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListWarehousesResponse)

func (*ListWarehousesResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListWarehousesResponse) SyncEffectiveFieldsDuringRead(existingState ListWarehousesResponse)

type MultiValuesOptions 

type MultiValuesOptions struct {
	// Character that prefixes each selected parameter value.
	Prefix types.String `tfsdk:"prefix" tf:"optional"`
	// Character that separates each selected parameter value. Defaults to a
	// comma.
	Separator types.String `tfsdk:"separator" tf:"optional"`
	// Character that suffixes each selected parameter value.
	Suffix types.String `tfsdk:"suffix" tf:"optional"`
}

func (*MultiValuesOptions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MultiValuesOptions) SyncEffectiveFieldsDuringCreateOrUpdate(plan MultiValuesOptions)

func (*MultiValuesOptions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MultiValuesOptions) SyncEffectiveFieldsDuringRead(existingState MultiValuesOptions)

type NumericValue 

type NumericValue struct {
	Value types.Float64 `tfsdk:"value" tf:"optional"`
}

func (*NumericValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *NumericValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan NumericValue)

func (*NumericValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *NumericValue) SyncEffectiveFieldsDuringRead(existingState NumericValue)

type OdbcParams 

type OdbcParams struct {
	Hostname types.String `tfsdk:"hostname" tf:"optional"`

	Path types.String `tfsdk:"path" tf:"optional"`

	Port types.Int64 `tfsdk:"port" tf:"optional"`

	Protocol types.String `tfsdk:"protocol" tf:"optional"`
}

func (*OdbcParams) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *OdbcParams) SyncEffectiveFieldsDuringCreateOrUpdate(plan OdbcParams)

func (*OdbcParams) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *OdbcParams) SyncEffectiveFieldsDuringRead(existingState OdbcParams)

type Parameter 

type Parameter struct {
	// List of valid parameter values, newline delimited. Only applies for
	// dropdown list parameters.
	EnumOptions types.String `tfsdk:"enumOptions" tf:"optional"`
	// If specified, allows multiple values to be selected for this parameter.
	// Only applies to dropdown list and query-based dropdown list parameters.
	MultiValuesOptions []MultiValuesOptions `tfsdk:"multiValuesOptions" tf:"optional,object"`
	// The literal parameter marker that appears between double curly braces in
	// the query text.
	Name types.String `tfsdk:"name" tf:"optional"`
	// The UUID of the query that provides the parameter values. Only applies
	// for query-based dropdown list parameters.
	QueryId types.String `tfsdk:"queryId" tf:"optional"`
	// The text displayed in a parameter picking widget.
	Title types.String `tfsdk:"title" tf:"optional"`
	// Parameters can have several different types.
	Type types.String `tfsdk:"type" tf:"optional"`
	// The default value for this parameter.
	Value any `tfsdk:"value" tf:"optional"`
}

func (*Parameter) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Parameter) SyncEffectiveFieldsDuringCreateOrUpdate(plan Parameter)

func (*Parameter) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Parameter) SyncEffectiveFieldsDuringRead(existingState Parameter)

type Query 

type Query struct {
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit types.Bool `tfsdk:"apply_auto_limit" tf:"optional"`
	// Name of the catalog where this query will be executed.
	Catalog types.String `tfsdk:"catalog" tf:"optional"`
	// Timestamp when this query was created.
	CreateTime types.String `tfsdk:"create_time" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// Display name of the query that appears in list views, widget headings,
	// and on the query page.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// UUID identifying the query.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Username of the user who last saved changes to this query.
	LastModifierUserName types.String `tfsdk:"last_modifier_user_name" tf:"optional"`
	// Indicates whether the query is trashed.
	LifecycleState types.String `tfsdk:"lifecycle_state" tf:"optional"`
	// Username of the user that owns the query.
	OwnerUserName types.String `tfsdk:"owner_user_name" tf:"optional"`
	// List of query parameter definitions.
	Parameters []QueryParameter `tfsdk:"parameters" tf:"optional"`
	// Workspace path of the workspace folder containing the object.
	ParentPath types.String `tfsdk:"parent_path" tf:"optional"`
	// Text of the query to be run.
	QueryText types.String `tfsdk:"query_text" tf:"optional"`
	// Sets the "Run as" role for the object.
	RunAsMode types.String `tfsdk:"run_as_mode" tf:"optional"`
	// Name of the schema where this query will be executed.
	Schema types.String `tfsdk:"schema" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// Timestamp when this query was last updated.
	UpdateTime types.String `tfsdk:"update_time" tf:"optional"`
	// ID of the SQL warehouse attached to the query.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*Query) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Query) SyncEffectiveFieldsDuringCreateOrUpdate(plan Query)

func (*Query) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Query) SyncEffectiveFieldsDuringRead(existingState Query)

type QueryBackedValue 

type QueryBackedValue struct {
	// If specified, allows multiple values to be selected for this parameter.
	MultiValuesOptions []MultiValuesOptions `tfsdk:"multi_values_options" tf:"optional,object"`
	// UUID of the query that provides the parameter values.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// List of selected query parameter values.
	Values []types.String `tfsdk:"values" tf:"optional"`
}

func (*QueryBackedValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryBackedValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryBackedValue)

func (*QueryBackedValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryBackedValue) SyncEffectiveFieldsDuringRead(existingState QueryBackedValue)

type QueryEditContent 

type QueryEditContent struct {
	// Data source ID maps to the ID of the data source used by the resource and
	// is distinct from the warehouse ID. [Learn more]
	//
	// [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
	DataSourceId types.String `tfsdk:"data_source_id" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// The title of this query that appears in list views, widget headings, and
	// on the query page.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Exclusively used for storing a list parameter definitions. A parameter is
	// an object with `title`, `name`, `type`, and `value` properties. The
	// `value` field here is the default value. It can be overridden at runtime.
	Options any `tfsdk:"options" tf:"optional"`
	// The text of the query to be run.
	Query types.String `tfsdk:"query" tf:"optional"`

	QueryId types.String `tfsdk:"-"`
	// Sets the **Run as** role for the object. Must be set to one of `"viewer"`
	// (signifying "run as viewer" behavior) or `"owner"` (signifying "run as
	// owner" behavior)
	RunAsRole types.String `tfsdk:"run_as_role" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
}

func (*QueryEditContent) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryEditContent) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryEditContent)

func (*QueryEditContent) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryEditContent) SyncEffectiveFieldsDuringRead(existingState QueryEditContent)

type QueryFilter 

type QueryFilter struct {
	// A range filter for query submitted time. The time range must be <= 30
	// days.
	QueryStartTimeRange []TimeRange `tfsdk:"query_start_time_range" tf:"optional,object"`
	// A list of statement IDs.
	StatementIds []types.String `tfsdk:"statement_ids" tf:"optional"`

	Statuses []types.String `tfsdk:"statuses" tf:"optional"`
	// A list of user IDs who ran the queries.
	UserIds []types.Int64 `tfsdk:"user_ids" tf:"optional"`
	// A list of warehouse IDs.
	WarehouseIds []types.String `tfsdk:"warehouse_ids" tf:"optional"`
}

func (*QueryFilter) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryFilter) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryFilter)

func (*QueryFilter) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryFilter) SyncEffectiveFieldsDuringRead(existingState QueryFilter)

type QueryInfo 

type QueryInfo struct {
	// SQL Warehouse channel information at the time of query execution
	ChannelUsed []ChannelInfo `tfsdk:"channel_used" tf:"optional,object"`
	// Total execution time of the statement ( excluding result fetch time ).
	Duration types.Int64 `tfsdk:"duration" tf:"optional"`
	// Alias for `warehouse_id`.
	EndpointId types.String `tfsdk:"endpoint_id" tf:"optional"`
	// Message describing why the query could not complete.
	ErrorMessage types.String `tfsdk:"error_message" tf:"optional"`
	// The ID of the user whose credentials were used to run the query.
	ExecutedAsUserId types.Int64 `tfsdk:"executed_as_user_id" tf:"optional"`
	// The email address or username of the user whose credentials were used to
	// run the query.
	ExecutedAsUserName types.String `tfsdk:"executed_as_user_name" tf:"optional"`
	// The time execution of the query ended.
	ExecutionEndTimeMs types.Int64 `tfsdk:"execution_end_time_ms" tf:"optional"`
	// Whether more updates for the query are expected.
	IsFinal types.Bool `tfsdk:"is_final" tf:"optional"`
	// A key that can be used to look up query details.
	LookupKey types.String `tfsdk:"lookup_key" tf:"optional"`
	// Metrics about query execution.
	Metrics []QueryMetrics `tfsdk:"metrics" tf:"optional,object"`
	// Whether plans exist for the execution, or the reason why they are missing
	PlansState types.String `tfsdk:"plans_state" tf:"optional"`
	// The time the query ended.
	QueryEndTimeMs types.Int64 `tfsdk:"query_end_time_ms" tf:"optional"`
	// The query ID.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// The time the query started.
	QueryStartTimeMs types.Int64 `tfsdk:"query_start_time_ms" tf:"optional"`
	// The text of the query.
	QueryText types.String `tfsdk:"query_text" tf:"optional"`
	// The number of results returned by the query.
	RowsProduced types.Int64 `tfsdk:"rows_produced" tf:"optional"`
	// URL to the Spark UI query plan.
	SparkUiUrl types.String `tfsdk:"spark_ui_url" tf:"optional"`
	// Type of statement for this query
	StatementType types.String `tfsdk:"statement_type" tf:"optional"`
	// Query status with one the following values:
	//
	// - `QUEUED`: Query has been received and queued. - `RUNNING`: Query has
	// started. - `CANCELED`: Query has been cancelled by the user. - `FAILED`:
	// Query has failed. - `FINISHED`: Query has completed.
	Status types.String `tfsdk:"status" tf:"optional"`
	// The ID of the user who ran the query.
	UserId types.Int64 `tfsdk:"user_id" tf:"optional"`
	// The email address or username of the user who ran the query.
	UserName types.String `tfsdk:"user_name" tf:"optional"`
	// Warehouse ID.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*QueryInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryInfo)

func (*QueryInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryInfo) SyncEffectiveFieldsDuringRead(existingState QueryInfo)

type QueryList 

type QueryList struct {
	// The total number of queries.
	Count types.Int64 `tfsdk:"count" tf:"optional"`
	// The page number that is currently displayed.
	Page types.Int64 `tfsdk:"page" tf:"optional"`
	// The number of queries per page.
	PageSize types.Int64 `tfsdk:"page_size" tf:"optional"`
	// List of queries returned.
	Results []LegacyQuery `tfsdk:"results" tf:"optional"`
}

func (*QueryList) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryList) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryList)

func (*QueryList) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryList) SyncEffectiveFieldsDuringRead(existingState QueryList)

type QueryMetrics 

type QueryMetrics struct {
	// Time spent loading metadata and optimizing the query, in milliseconds.
	CompilationTimeMs types.Int64 `tfsdk:"compilation_time_ms" tf:"optional"`
	// Time spent executing the query, in milliseconds.
	ExecutionTimeMs types.Int64 `tfsdk:"execution_time_ms" tf:"optional"`
	// Total amount of data sent over the network between executor nodes during
	// shuffle, in bytes.
	NetworkSentBytes types.Int64 `tfsdk:"network_sent_bytes" tf:"optional"`
	// Timestamp of when the query was enqueued waiting while the warehouse was
	// at max load. This field is optional and will not appear if the query
	// skipped the overloading queue.
	OverloadingQueueStartTimestamp types.Int64 `tfsdk:"overloading_queue_start_timestamp" tf:"optional"`
	// Total execution time for all individual Photon query engine tasks in the
	// query, in milliseconds.
	PhotonTotalTimeMs types.Int64 `tfsdk:"photon_total_time_ms" tf:"optional"`
	// Timestamp of when the query was enqueued waiting for a cluster to be
	// provisioned for the warehouse. This field is optional and will not appear
	// if the query skipped the provisioning queue.
	ProvisioningQueueStartTimestamp types.Int64 `tfsdk:"provisioning_queue_start_timestamp" tf:"optional"`
	// Total number of bytes in all tables not read due to pruning
	PrunedBytes types.Int64 `tfsdk:"pruned_bytes" tf:"optional"`
	// Total number of files from all tables not read due to pruning
	PrunedFilesCount types.Int64 `tfsdk:"pruned_files_count" tf:"optional"`
	// Timestamp of when the underlying compute started compilation of the
	// query.
	QueryCompilationStartTimestamp types.Int64 `tfsdk:"query_compilation_start_timestamp" tf:"optional"`
	// Total size of data read by the query, in bytes.
	ReadBytes types.Int64 `tfsdk:"read_bytes" tf:"optional"`
	// Size of persistent data read from the cache, in bytes.
	ReadCacheBytes types.Int64 `tfsdk:"read_cache_bytes" tf:"optional"`
	// Number of files read after pruning
	ReadFilesCount types.Int64 `tfsdk:"read_files_count" tf:"optional"`
	// Number of partitions read after pruning.
	ReadPartitionsCount types.Int64 `tfsdk:"read_partitions_count" tf:"optional"`
	// Size of persistent data read from cloud object storage on your cloud
	// tenant, in bytes.
	ReadRemoteBytes types.Int64 `tfsdk:"read_remote_bytes" tf:"optional"`
	// Time spent fetching the query results after the execution finished, in
	// milliseconds.
	ResultFetchTimeMs types.Int64 `tfsdk:"result_fetch_time_ms" tf:"optional"`
	// `true` if the query result was fetched from cache, `false` otherwise.
	ResultFromCache types.Bool `tfsdk:"result_from_cache" tf:"optional"`
	// Total number of rows returned by the query.
	RowsProducedCount types.Int64 `tfsdk:"rows_produced_count" tf:"optional"`
	// Total number of rows read by the query.
	RowsReadCount types.Int64 `tfsdk:"rows_read_count" tf:"optional"`
	// Size of data temporarily written to disk while executing the query, in
	// bytes.
	SpillToDiskBytes types.Int64 `tfsdk:"spill_to_disk_bytes" tf:"optional"`
	// Sum of execution time for all of the query’s tasks, in milliseconds.
	TaskTotalTimeMs types.Int64 `tfsdk:"task_total_time_ms" tf:"optional"`
	// Total execution time of the query from the client’s point of view, in
	// milliseconds.
	TotalTimeMs types.Int64 `tfsdk:"total_time_ms" tf:"optional"`
	// Size pf persistent data written to cloud object storage in your cloud
	// tenant, in bytes.
	WriteRemoteBytes types.Int64 `tfsdk:"write_remote_bytes" tf:"optional"`
}

A query metric that encapsulates a set of measurements for a single query. Metrics come from the driver and are stored in the history service database.

func (*QueryMetrics) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryMetrics) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryMetrics)

func (*QueryMetrics) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryMetrics) SyncEffectiveFieldsDuringRead(existingState QueryMetrics)

type QueryOptions 

type QueryOptions struct {
	// The name of the catalog to execute this query in.
	Catalog types.String `tfsdk:"catalog" tf:"optional"`
	// The timestamp when this query was moved to trash. Only present when the
	// `is_archived` property is `true`. Trashed items are deleted after thirty
	// days.
	MovedToTrashAt types.String `tfsdk:"moved_to_trash_at" tf:"optional"`

	Parameters []Parameter `tfsdk:"parameters" tf:"optional"`
	// The name of the schema to execute this query in.
	Schema types.String `tfsdk:"schema" tf:"optional"`
}

func (*QueryOptions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryOptions) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryOptions)

func (*QueryOptions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryOptions) SyncEffectiveFieldsDuringRead(existingState QueryOptions)

type QueryParameter 

type QueryParameter struct {
	// Date-range query parameter value. Can only specify one of
	// `dynamic_date_range_value` or `date_range_value`.
	DateRangeValue []DateRangeValue `tfsdk:"date_range_value" tf:"optional,object"`
	// Date query parameter value. Can only specify one of `dynamic_date_value`
	// or `date_value`.
	DateValue []DateValue `tfsdk:"date_value" tf:"optional,object"`
	// Dropdown query parameter value.
	EnumValue []EnumValue `tfsdk:"enum_value" tf:"optional,object"`
	// Literal parameter marker that appears between double curly braces in the
	// query text.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Numeric query parameter value.
	NumericValue []NumericValue `tfsdk:"numeric_value" tf:"optional,object"`
	// Query-based dropdown query parameter value.
	QueryBackedValue []QueryBackedValue `tfsdk:"query_backed_value" tf:"optional,object"`
	// Text query parameter value.
	TextValue []TextValue `tfsdk:"text_value" tf:"optional,object"`
	// Text displayed in the user-facing parameter widget in the UI.
	Title types.String `tfsdk:"title" tf:"optional"`
}

func (*QueryParameter) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryParameter) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryParameter)

func (*QueryParameter) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryParameter) SyncEffectiveFieldsDuringRead(existingState QueryParameter)

type QueryPostContent 

type QueryPostContent struct {
	// Data source ID maps to the ID of the data source used by the resource and
	// is distinct from the warehouse ID. [Learn more]
	//
	// [Learn more]: https://docs.databricks.com/api/workspace/datasources/list
	DataSourceId types.String `tfsdk:"data_source_id" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// The title of this query that appears in list views, widget headings, and
	// on the query page.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Exclusively used for storing a list parameter definitions. A parameter is
	// an object with `title`, `name`, `type`, and `value` properties. The
	// `value` field here is the default value. It can be overridden at runtime.
	Options any `tfsdk:"options" tf:"optional"`
	// The identifier of the workspace folder containing the object.
	Parent types.String `tfsdk:"parent" tf:"optional"`
	// The text of the query to be run.
	Query types.String `tfsdk:"query" tf:"optional"`
	// Sets the **Run as** role for the object. Must be set to one of `"viewer"`
	// (signifying "run as viewer" behavior) or `"owner"` (signifying "run as
	// owner" behavior)
	RunAsRole types.String `tfsdk:"run_as_role" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
}

func (*QueryPostContent) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryPostContent) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryPostContent)

func (*QueryPostContent) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryPostContent) SyncEffectiveFieldsDuringRead(existingState QueryPostContent)

type RepeatedEndpointConfPairs 

type RepeatedEndpointConfPairs struct {
	// Deprecated: Use configuration_pairs
	ConfigPair []EndpointConfPair `tfsdk:"config_pair" tf:"optional"`

	ConfigurationPairs []EndpointConfPair `tfsdk:"configuration_pairs" tf:"optional"`
}

func (*RepeatedEndpointConfPairs) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RepeatedEndpointConfPairs) SyncEffectiveFieldsDuringCreateOrUpdate(plan RepeatedEndpointConfPairs)

func (*RepeatedEndpointConfPairs) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RepeatedEndpointConfPairs) SyncEffectiveFieldsDuringRead(existingState RepeatedEndpointConfPairs)

type RestoreDashboardRequest 

type RestoreDashboardRequest struct {
	DashboardId types.String `tfsdk:"-"`
}

Restore a dashboard

func (*RestoreDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RestoreDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan RestoreDashboardRequest)

func (*RestoreDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RestoreDashboardRequest) SyncEffectiveFieldsDuringRead(existingState RestoreDashboardRequest)

type RestoreQueriesLegacyRequest 

type RestoreQueriesLegacyRequest struct {
	QueryId types.String `tfsdk:"-"`
}

Restore a query

func (*RestoreQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RestoreQueriesLegacyRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan RestoreQueriesLegacyRequest)

func (*RestoreQueriesLegacyRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RestoreQueriesLegacyRequest) SyncEffectiveFieldsDuringRead(existingState RestoreQueriesLegacyRequest)

type RestoreResponse 

type RestoreResponse struct {
}

func (*RestoreResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RestoreResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan RestoreResponse)

func (*RestoreResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RestoreResponse) SyncEffectiveFieldsDuringRead(existingState RestoreResponse)

type ResultData 

type ResultData struct {
	// The number of bytes in the result chunk. This field is not available when
	// using `INLINE` disposition.
	ByteCount types.Int64 `tfsdk:"byte_count" tf:"optional"`
	// The position within the sequence of result set chunks.
	ChunkIndex types.Int64 `tfsdk:"chunk_index" tf:"optional"`
	// The `JSON_ARRAY` format is an array of arrays of values, where each
	// non-null value is formatted as a string. Null values are encoded as JSON
	// `null`.
	DataArray [][]types.String `tfsdk:"data_array" tf:"optional"`

	ExternalLinks []ExternalLink `tfsdk:"external_links" tf:"optional"`
	// When fetching, provides the `chunk_index` for the _next_ chunk. If
	// absent, indicates there are no more chunks. The next chunk can be fetched
	// with a :method:statementexecution/getStatementResultChunkN request.
	NextChunkIndex types.Int64 `tfsdk:"next_chunk_index" tf:"optional"`
	// When fetching, provides a link to fetch the _next_ chunk. If absent,
	// indicates there are no more chunks. This link is an absolute `path` to be
	// joined with your `$DATABRICKS_HOST`, and should be treated as an opaque
	// link. This is an alternative to using `next_chunk_index`.
	NextChunkInternalLink types.String `tfsdk:"next_chunk_internal_link" tf:"optional"`
	// The number of rows within the result chunk.
	RowCount types.Int64 `tfsdk:"row_count" tf:"optional"`
	// The starting row offset within the result set.
	RowOffset types.Int64 `tfsdk:"row_offset" tf:"optional"`
}

func (*ResultData) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ResultData) SyncEffectiveFieldsDuringCreateOrUpdate(plan ResultData)

func (*ResultData) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ResultData) SyncEffectiveFieldsDuringRead(existingState ResultData)

type ResultManifest 

type ResultManifest struct {
	// Array of result set chunk metadata.
	Chunks []BaseChunkInfo `tfsdk:"chunks" tf:"optional"`

	Format types.String `tfsdk:"format" tf:"optional"`
	// The schema is an ordered list of column descriptions.
	Schema []ResultSchema `tfsdk:"schema" tf:"optional,object"`
	// The total number of bytes in the result set. This field is not available
	// when using `INLINE` disposition.
	TotalByteCount types.Int64 `tfsdk:"total_byte_count" tf:"optional"`
	// The total number of chunks that the result set has been divided into.
	TotalChunkCount types.Int64 `tfsdk:"total_chunk_count" tf:"optional"`
	// The total number of rows in the result set.
	TotalRowCount types.Int64 `tfsdk:"total_row_count" tf:"optional"`
	// Indicates whether the result is truncated due to `row_limit` or
	// `byte_limit`.
	Truncated types.Bool `tfsdk:"truncated" tf:"optional"`
}

The result manifest provides schema and metadata for the result set.

func (*ResultManifest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ResultManifest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ResultManifest)

func (*ResultManifest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ResultManifest) SyncEffectiveFieldsDuringRead(existingState ResultManifest)

type ResultSchema 

type ResultSchema struct {
	ColumnCount types.Int64 `tfsdk:"column_count" tf:"optional"`

	Columns []ColumnInfo `tfsdk:"columns" tf:"optional"`
}

The schema is an ordered list of column descriptions.

func (*ResultSchema) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ResultSchema) SyncEffectiveFieldsDuringCreateOrUpdate(plan ResultSchema)

func (*ResultSchema) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ResultSchema) SyncEffectiveFieldsDuringRead(existingState ResultSchema)

type ServiceError 

type ServiceError struct {
	ErrorCode types.String `tfsdk:"error_code" tf:"optional"`
	// A brief summary of the error condition.
	Message types.String `tfsdk:"message" tf:"optional"`
}

func (*ServiceError) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ServiceError) SyncEffectiveFieldsDuringCreateOrUpdate(plan ServiceError)

func (*ServiceError) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ServiceError) SyncEffectiveFieldsDuringRead(existingState ServiceError)

type SetRequest 

type SetRequest struct {
	AccessControlList []AccessControl `tfsdk:"access_control_list" tf:"optional"`
	// Object ID. The ACL for the object with this UUID is overwritten by this
	// request's POST content.
	ObjectId types.String `tfsdk:"-"`
	// The type of object permission to set.
	ObjectType types.String `tfsdk:"-"`
}

Set object ACL

func (*SetRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SetRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan SetRequest)

func (*SetRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SetRequest) SyncEffectiveFieldsDuringRead(existingState SetRequest)

type SetResponse 

type SetResponse struct {
	AccessControlList []AccessControl `tfsdk:"access_control_list" tf:"optional"`
	// An object's type and UUID, separated by a forward slash (/) character.
	ObjectId types.String `tfsdk:"object_id" tf:"optional"`
	// A singular noun object type.
	ObjectType types.String `tfsdk:"object_type" tf:"optional"`
}

func (*SetResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SetResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan SetResponse)

func (*SetResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SetResponse) SyncEffectiveFieldsDuringRead(existingState SetResponse)

type SetWorkspaceWarehouseConfigRequest 

type SetWorkspaceWarehouseConfigRequest struct {
	// Optional: Channel selection details
	Channel []Channel `tfsdk:"channel" tf:"optional,object"`
	// Deprecated: Use sql_configuration_parameters
	ConfigParam []RepeatedEndpointConfPairs `tfsdk:"config_param" tf:"optional,object"`
	// Spark confs for external hive metastore configuration JSON serialized
	// size must be less than <= 512K
	DataAccessConfig []EndpointConfPair `tfsdk:"data_access_config" tf:"optional"`
	// List of Warehouse Types allowed in this workspace (limits allowed value
	// of the type field in CreateWarehouse and EditWarehouse). Note: Some types
	// cannot be disabled, they don't need to be specified in
	// SetWorkspaceWarehouseConfig. Note: Disabling a type may cause existing
	// warehouses to be converted to another type. Used by frontend to save
	// specific type availability in the warehouse create and edit form UI.
	EnabledWarehouseTypes []WarehouseTypePair `tfsdk:"enabled_warehouse_types" tf:"optional"`
	// Deprecated: Use sql_configuration_parameters
	GlobalParam []RepeatedEndpointConfPairs `tfsdk:"global_param" tf:"optional,object"`
	// GCP only: Google Service Account used to pass to cluster to access Google
	// Cloud Storage
	GoogleServiceAccount types.String `tfsdk:"google_service_account" tf:"optional"`
	// AWS Only: Instance profile used to pass IAM role to the cluster
	InstanceProfileArn types.String `tfsdk:"instance_profile_arn" tf:"optional"`
	// Security policy for warehouses
	SecurityPolicy types.String `tfsdk:"security_policy" tf:"optional"`
	// SQL configuration parameters
	SqlConfigurationParameters []RepeatedEndpointConfPairs `tfsdk:"sql_configuration_parameters" tf:"optional,object"`
}

func (*SetWorkspaceWarehouseConfigRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SetWorkspaceWarehouseConfigRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan SetWorkspaceWarehouseConfigRequest)

func (*SetWorkspaceWarehouseConfigRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SetWorkspaceWarehouseConfigRequest) SyncEffectiveFieldsDuringRead(existingState SetWorkspaceWarehouseConfigRequest)

type SetWorkspaceWarehouseConfigResponse 

type SetWorkspaceWarehouseConfigResponse struct {
}

func (*SetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan SetWorkspaceWarehouseConfigResponse)

func (*SetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SetWorkspaceWarehouseConfigResponse) SyncEffectiveFieldsDuringRead(existingState SetWorkspaceWarehouseConfigResponse)

type StartRequest 

type StartRequest struct {
	// Required. Id of the SQL warehouse.
	Id types.String `tfsdk:"-"`
}

Start a warehouse

func (*StartRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StartRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan StartRequest)

func (*StartRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StartRequest) SyncEffectiveFieldsDuringRead(existingState StartRequest)

type StartWarehouseResponse 

type StartWarehouseResponse struct {
}

func (*StartWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StartWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan StartWarehouseResponse)

func (*StartWarehouseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StartWarehouseResponse) SyncEffectiveFieldsDuringRead(existingState StartWarehouseResponse)

type StatementParameterListItem 

type StatementParameterListItem struct {
	// The name of a parameter marker to be substituted in the statement.
	Name types.String `tfsdk:"name" tf:""`
	// The data type, given as a string. For example: `INT`, `STRING`,
	// `DECIMAL(10,2)`. If no type is given the type is assumed to be `STRING`.
	// Complex types, such as `ARRAY`, `MAP`, and `STRUCT` are not supported.
	// For valid types, refer to the section [Data types] of the SQL language
	// reference.
	//
	// [Data types]: https://docs.databricks.com/sql/language-manual/functions/cast.html
	Type types.String `tfsdk:"type" tf:"optional"`
	// The value to substitute, represented as a string. If omitted, the value
	// is interpreted as NULL.
	Value types.String `tfsdk:"value" tf:"optional"`
}

func (*StatementParameterListItem) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StatementParameterListItem) SyncEffectiveFieldsDuringCreateOrUpdate(plan StatementParameterListItem)

func (*StatementParameterListItem) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StatementParameterListItem) SyncEffectiveFieldsDuringRead(existingState StatementParameterListItem)

type StatementResponse 

type StatementResponse struct {
	// The result manifest provides schema and metadata for the result set.
	Manifest []ResultManifest `tfsdk:"manifest" tf:"optional,object"`

	Result []ResultData `tfsdk:"result" tf:"optional,object"`
	// The statement ID is returned upon successfully submitting a SQL
	// statement, and is a required reference for all subsequent calls.
	StatementId types.String `tfsdk:"statement_id" tf:"optional"`
	// The status response includes execution state and if relevant, error
	// information.
	Status []StatementStatus `tfsdk:"status" tf:"optional,object"`
}

func (*StatementResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StatementResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan StatementResponse)

func (*StatementResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StatementResponse) SyncEffectiveFieldsDuringRead(existingState StatementResponse)

type StatementStatus 

type StatementStatus struct {
	Error []ServiceError `tfsdk:"error" tf:"optional,object"`
	// Statement execution state: - `PENDING`: waiting for warehouse -
	// `RUNNING`: running - `SUCCEEDED`: execution was successful, result data
	// available for fetch - `FAILED`: execution failed; reason for failure
	// described in accomanying error message - `CANCELED`: user canceled; can
	// come from explicit cancel call, or timeout with `on_wait_timeout=CANCEL`
	// - `CLOSED`: execution successful, and statement closed; result no longer
	// available for fetch
	State types.String `tfsdk:"state" tf:"optional"`
}

The status response includes execution state and if relevant, error information.

func (*StatementStatus) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StatementStatus) SyncEffectiveFieldsDuringCreateOrUpdate(plan StatementStatus)

func (*StatementStatus) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StatementStatus) SyncEffectiveFieldsDuringRead(existingState StatementStatus)

type StopRequest 

type StopRequest struct {
	// Required. Id of the SQL warehouse.
	Id types.String `tfsdk:"-"`
}

Stop a warehouse

func (*StopRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StopRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan StopRequest)

func (*StopRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StopRequest) SyncEffectiveFieldsDuringRead(existingState StopRequest)

type StopWarehouseResponse 

type StopWarehouseResponse struct {
}

func (*StopWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *StopWarehouseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan StopWarehouseResponse)

func (*StopWarehouseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *StopWarehouseResponse) SyncEffectiveFieldsDuringRead(existingState StopWarehouseResponse)

type Success 

type Success struct {
	Message types.String `tfsdk:"message" tf:"optional"`
}

func (*Success) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Success) SyncEffectiveFieldsDuringCreateOrUpdate(plan Success)

func (*Success) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Success) SyncEffectiveFieldsDuringRead(existingState Success)

type TerminationReason 

type TerminationReason struct {
	// status code indicating why the cluster was terminated
	Code types.String `tfsdk:"code" tf:"optional"`
	// list of parameters that provide additional information about why the
	// cluster was terminated
	Parameters map[string]types.String `tfsdk:"parameters" tf:"optional"`
	// type of the termination
	Type types.String `tfsdk:"type" tf:"optional"`
}

func (*TerminationReason) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TerminationReason) SyncEffectiveFieldsDuringCreateOrUpdate(plan TerminationReason)

func (*TerminationReason) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TerminationReason) SyncEffectiveFieldsDuringRead(existingState TerminationReason)

type TextValue 

type TextValue struct {
	Value types.String `tfsdk:"value" tf:"optional"`
}

func (*TextValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TextValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan TextValue)

func (*TextValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TextValue) SyncEffectiveFieldsDuringRead(existingState TextValue)

type TimeRange 

type TimeRange struct {
	// The end time in milliseconds.
	EndTimeMs types.Int64 `tfsdk:"end_time_ms" tf:"optional"`
	// The start time in milliseconds.
	StartTimeMs types.Int64 `tfsdk:"start_time_ms" tf:"optional"`
}

func (*TimeRange) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TimeRange) SyncEffectiveFieldsDuringCreateOrUpdate(plan TimeRange)

func (*TimeRange) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TimeRange) SyncEffectiveFieldsDuringRead(existingState TimeRange)

type TransferOwnershipObjectId 

type TransferOwnershipObjectId struct {
	// Email address for the new owner, who must exist in the workspace.
	NewOwner types.String `tfsdk:"new_owner" tf:"optional"`
}

func (*TransferOwnershipObjectId) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TransferOwnershipObjectId) SyncEffectiveFieldsDuringCreateOrUpdate(plan TransferOwnershipObjectId)

func (*TransferOwnershipObjectId) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TransferOwnershipObjectId) SyncEffectiveFieldsDuringRead(existingState TransferOwnershipObjectId)

type TransferOwnershipRequest 

type TransferOwnershipRequest struct {
	// Email address for the new owner, who must exist in the workspace.
	NewOwner types.String `tfsdk:"new_owner" tf:"optional"`
	// The ID of the object on which to change ownership.
	ObjectId []TransferOwnershipObjectId `tfsdk:"-"`
	// The type of object on which to change ownership.
	ObjectType types.String `tfsdk:"-"`
}

Transfer object ownership

func (*TransferOwnershipRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TransferOwnershipRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan TransferOwnershipRequest)

func (*TransferOwnershipRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TransferOwnershipRequest) SyncEffectiveFieldsDuringRead(existingState TransferOwnershipRequest)

type TrashAlertRequest 

type TrashAlertRequest struct {
	Id types.String `tfsdk:"-"`
}

Delete an alert

func (*TrashAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TrashAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan TrashAlertRequest)

func (*TrashAlertRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TrashAlertRequest) SyncEffectiveFieldsDuringRead(existingState TrashAlertRequest)

type TrashQueryRequest 

type TrashQueryRequest struct {
	Id types.String `tfsdk:"-"`
}

Delete a query

func (*TrashQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TrashQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan TrashQueryRequest)

func (*TrashQueryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TrashQueryRequest) SyncEffectiveFieldsDuringRead(existingState TrashQueryRequest)

type UpdateAlertRequest 

type UpdateAlertRequest struct {
	Alert []UpdateAlertRequestAlert `tfsdk:"alert" tf:"optional,object"`

	Id types.String `tfsdk:"-"`
	// Field mask is required to be passed into the PATCH request. Field mask
	// specifies which fields of the setting payload will be updated. The field
	// mask needs to be supplied as single string. To specify multiple fields in
	// the field mask, use comma as the separator (no space).
	UpdateMask types.String `tfsdk:"update_mask" tf:""`
}

func (*UpdateAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateAlertRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateAlertRequest)

func (*UpdateAlertRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateAlertRequest) SyncEffectiveFieldsDuringRead(existingState UpdateAlertRequest)

type UpdateAlertRequestAlert 

type UpdateAlertRequestAlert struct {
	// Trigger conditions of the alert.
	Condition []AlertCondition `tfsdk:"condition" tf:"optional,object"`
	// Custom body of alert notification, if it exists. See [here] for custom
	// templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomBody types.String `tfsdk:"custom_body" tf:"optional"`
	// Custom subject of alert notification, if it exists. This can include
	// email subject entries and Slack notification headers, for example. See
	// [here] for custom templating instructions.
	//
	// [here]: https://docs.databricks.com/sql/user/alerts/index.html
	CustomSubject types.String `tfsdk:"custom_subject" tf:"optional"`
	// The display name of the alert.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// Whether to notify alert subscribers when alert returns back to normal.
	NotifyOnOk types.Bool `tfsdk:"notify_on_ok" tf:"optional"`
	// The owner's username. This field is set to "Unavailable" if the user has
	// been deleted.
	OwnerUserName types.String `tfsdk:"owner_user_name" tf:"optional"`
	// UUID of the query attached to the alert.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// Number of seconds an alert must wait after being triggered to rearm
	// itself. After rearming, it can be triggered again. If 0 or not specified,
	// the alert will not be triggered again.
	SecondsToRetrigger types.Int64 `tfsdk:"seconds_to_retrigger" tf:"optional"`
}

func (*UpdateAlertRequestAlert) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateAlertRequestAlert) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateAlertRequestAlert)

func (*UpdateAlertRequestAlert) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateAlertRequestAlert) SyncEffectiveFieldsDuringRead(existingState UpdateAlertRequestAlert)

type UpdateQueryRequest 

type UpdateQueryRequest struct {
	Id types.String `tfsdk:"-"`

	Query []UpdateQueryRequestQuery `tfsdk:"query" tf:"optional,object"`
	// Field mask is required to be passed into the PATCH request. Field mask
	// specifies which fields of the setting payload will be updated. The field
	// mask needs to be supplied as single string. To specify multiple fields in
	// the field mask, use comma as the separator (no space).
	UpdateMask types.String `tfsdk:"update_mask" tf:""`
}

func (*UpdateQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateQueryRequest)

func (*UpdateQueryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateQueryRequest) SyncEffectiveFieldsDuringRead(existingState UpdateQueryRequest)

type UpdateQueryRequestQuery 

type UpdateQueryRequestQuery struct {
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit types.Bool `tfsdk:"apply_auto_limit" tf:"optional"`
	// Name of the catalog where this query will be executed.
	Catalog types.String `tfsdk:"catalog" tf:"optional"`
	// General description that conveys additional information about this query
	// such as usage notes.
	Description types.String `tfsdk:"description" tf:"optional"`
	// Display name of the query that appears in list views, widget headings,
	// and on the query page.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// Username of the user that owns the query.
	OwnerUserName types.String `tfsdk:"owner_user_name" tf:"optional"`
	// List of query parameter definitions.
	Parameters []QueryParameter `tfsdk:"parameters" tf:"optional"`
	// Text of the query to be run.
	QueryText types.String `tfsdk:"query_text" tf:"optional"`
	// Sets the "Run as" role for the object.
	RunAsMode types.String `tfsdk:"run_as_mode" tf:"optional"`
	// Name of the schema where this query will be executed.
	Schema types.String `tfsdk:"schema" tf:"optional"`

	Tags []types.String `tfsdk:"tags" tf:"optional"`
	// ID of the SQL warehouse attached to the query.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*UpdateQueryRequestQuery) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateQueryRequestQuery) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateQueryRequestQuery)

func (*UpdateQueryRequestQuery) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateQueryRequestQuery) SyncEffectiveFieldsDuringRead(existingState UpdateQueryRequestQuery)

type UpdateResponse 

type UpdateResponse struct {
}

func (*UpdateResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateResponse)

func (*UpdateResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateResponse) SyncEffectiveFieldsDuringRead(existingState UpdateResponse)

type UpdateVisualizationRequest 

type UpdateVisualizationRequest struct {
	Id types.String `tfsdk:"-"`
	// Field mask is required to be passed into the PATCH request. Field mask
	// specifies which fields of the setting payload will be updated. The field
	// mask needs to be supplied as single string. To specify multiple fields in
	// the field mask, use comma as the separator (no space).
	UpdateMask types.String `tfsdk:"update_mask" tf:""`

	Visualization []UpdateVisualizationRequestVisualization `tfsdk:"visualization" tf:"optional,object"`
}

func (*UpdateVisualizationRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateVisualizationRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateVisualizationRequest)

func (*UpdateVisualizationRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateVisualizationRequest) SyncEffectiveFieldsDuringRead(existingState UpdateVisualizationRequest)

type UpdateVisualizationRequestVisualization 

type UpdateVisualizationRequestVisualization struct {
	// The display name of the visualization.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// The visualization options varies widely from one visualization type to
	// the next and is unsupported. Databricks does not recommend modifying
	// visualization options directly.
	SerializedOptions types.String `tfsdk:"serialized_options" tf:"optional"`
	// The visualization query plan varies widely from one visualization type to
	// the next and is unsupported. Databricks does not recommend modifying the
	// visualization query plan directly.
	SerializedQueryPlan types.String `tfsdk:"serialized_query_plan" tf:"optional"`
	// The type of visualization: counter, table, funnel, and so on.
	Type types.String `tfsdk:"type" tf:"optional"`
}

func (*UpdateVisualizationRequestVisualization) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateVisualizationRequestVisualization) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateVisualizationRequestVisualization)

func (*UpdateVisualizationRequestVisualization) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateVisualizationRequestVisualization) SyncEffectiveFieldsDuringRead(existingState UpdateVisualizationRequestVisualization)

type User 

type User struct {
	Email types.String `tfsdk:"email" tf:"optional"`

	Id types.Int64 `tfsdk:"id" tf:"optional"`

	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*User) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *User) SyncEffectiveFieldsDuringCreateOrUpdate(plan User)

func (*User) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *User) SyncEffectiveFieldsDuringRead(existingState User)

type Visualization 

type Visualization struct {
	// The timestamp indicating when the visualization was created.
	CreateTime types.String `tfsdk:"create_time" tf:"optional"`
	// The display name of the visualization.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// UUID identifying the visualization.
	Id types.String `tfsdk:"id" tf:"optional"`
	// UUID of the query that the visualization is attached to.
	QueryId types.String `tfsdk:"query_id" tf:"optional"`
	// The visualization options varies widely from one visualization type to
	// the next and is unsupported. Databricks does not recommend modifying
	// visualization options directly.
	SerializedOptions types.String `tfsdk:"serialized_options" tf:"optional"`
	// The visualization query plan varies widely from one visualization type to
	// the next and is unsupported. Databricks does not recommend modifying the
	// visualization query plan directly.
	SerializedQueryPlan types.String `tfsdk:"serialized_query_plan" tf:"optional"`
	// The type of visualization: counter, table, funnel, and so on.
	Type types.String `tfsdk:"type" tf:"optional"`
	// The timestamp indicating when the visualization was updated.
	UpdateTime types.String `tfsdk:"update_time" tf:"optional"`
}

func (*Visualization) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Visualization) SyncEffectiveFieldsDuringCreateOrUpdate(plan Visualization)

func (*Visualization) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Visualization) SyncEffectiveFieldsDuringRead(existingState Visualization)

type WarehouseAccessControlRequest 

type WarehouseAccessControlRequest struct {
	// name of the group
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
	// application ID of a service principal
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// name of the user
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*WarehouseAccessControlRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehouseAccessControlRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehouseAccessControlRequest)

func (*WarehouseAccessControlRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehouseAccessControlRequest) SyncEffectiveFieldsDuringRead(existingState WarehouseAccessControlRequest)

type WarehouseAccessControlResponse 

type WarehouseAccessControlResponse struct {
	// All permissions.
	AllPermissions []WarehousePermission `tfsdk:"all_permissions" tf:"optional"`
	// Display name of the user or service principal.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// name of the group
	GroupName types.String `tfsdk:"group_name" tf:"optional"`
	// Name of the service principal.
	ServicePrincipalName types.String `tfsdk:"service_principal_name" tf:"optional"`
	// name of the user
	UserName types.String `tfsdk:"user_name" tf:"optional"`
}

func (*WarehouseAccessControlResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehouseAccessControlResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehouseAccessControlResponse)

func (*WarehouseAccessControlResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehouseAccessControlResponse) SyncEffectiveFieldsDuringRead(existingState WarehouseAccessControlResponse)

type WarehousePermission 

type WarehousePermission struct {
	Inherited types.Bool `tfsdk:"inherited" tf:"optional"`

	InheritedFromObject []types.String `tfsdk:"inherited_from_object" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*WarehousePermission) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehousePermission) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehousePermission)

func (*WarehousePermission) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehousePermission) SyncEffectiveFieldsDuringRead(existingState WarehousePermission)

type WarehousePermissions 

type WarehousePermissions struct {
	AccessControlList []WarehouseAccessControlResponse `tfsdk:"access_control_list" tf:"optional"`

	ObjectId types.String `tfsdk:"object_id" tf:"optional"`

	ObjectType types.String `tfsdk:"object_type" tf:"optional"`
}

func (*WarehousePermissions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehousePermissions) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehousePermissions)

func (*WarehousePermissions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehousePermissions) SyncEffectiveFieldsDuringRead(existingState WarehousePermissions)

type WarehousePermissionsDescription 

type WarehousePermissionsDescription struct {
	Description types.String `tfsdk:"description" tf:"optional"`
	// Permission level
	PermissionLevel types.String `tfsdk:"permission_level" tf:"optional"`
}

func (*WarehousePermissionsDescription) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehousePermissionsDescription) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehousePermissionsDescription)

func (*WarehousePermissionsDescription) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehousePermissionsDescription) SyncEffectiveFieldsDuringRead(existingState WarehousePermissionsDescription)

type WarehousePermissionsRequest 

type WarehousePermissionsRequest struct {
	AccessControlList []WarehouseAccessControlRequest `tfsdk:"access_control_list" tf:"optional"`
	// The SQL warehouse for which to get or manage permissions.
	WarehouseId types.String `tfsdk:"-"`
}

func (*WarehousePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehousePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehousePermissionsRequest)

func (*WarehousePermissionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehousePermissionsRequest) SyncEffectiveFieldsDuringRead(existingState WarehousePermissionsRequest)

type WarehouseTypePair 

type WarehouseTypePair struct {
	// If set to false the specific warehouse type will not be be allowed as a
	// value for warehouse_type in CreateWarehouse and EditWarehouse
	Enabled types.Bool `tfsdk:"enabled" tf:"optional"`
	// Warehouse type: `PRO` or `CLASSIC`.
	WarehouseType types.String `tfsdk:"warehouse_type" tf:"optional"`
}

func (*WarehouseTypePair) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WarehouseTypePair) SyncEffectiveFieldsDuringCreateOrUpdate(plan WarehouseTypePair)

func (*WarehouseTypePair) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WarehouseTypePair) SyncEffectiveFieldsDuringRead(existingState WarehouseTypePair)

type Widget 

type Widget struct {
	// The unique ID for this widget.
	Id types.String `tfsdk:"id" tf:"optional"`

	Options []WidgetOptions `tfsdk:"options" tf:"optional,object"`
	// The visualization description API changes frequently and is unsupported.
	// You can duplicate a visualization by copying description objects received
	// _from the API_ and then using them to create a new one with a POST
	// request to the same endpoint. Databricks does not recommend constructing
	// ad-hoc visualizations entirely in JSON.
	Visualization []LegacyVisualization `tfsdk:"visualization" tf:"optional,object"`
	// Unused field.
	Width types.Int64 `tfsdk:"width" tf:"optional"`
}

func (*Widget) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Widget) SyncEffectiveFieldsDuringCreateOrUpdate(plan Widget)

func (*Widget) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Widget) SyncEffectiveFieldsDuringRead(existingState Widget)

type WidgetOptions 

type WidgetOptions struct {
	// Timestamp when this object was created
	CreatedAt types.String `tfsdk:"created_at" tf:"optional"`
	// Custom description of the widget
	Description types.String `tfsdk:"description" tf:"optional"`
	// Whether this widget is hidden on the dashboard.
	IsHidden types.Bool `tfsdk:"isHidden" tf:"optional"`
	// How parameters used by the visualization in this widget relate to other
	// widgets on the dashboard. Databricks does not recommend modifying this
	// definition in JSON.
	ParameterMappings any `tfsdk:"parameterMappings" tf:"optional"`
	// Coordinates of this widget on a dashboard. This portion of the API
	// changes frequently and is unsupported.
	Position []WidgetPosition `tfsdk:"position" tf:"optional,object"`
	// Custom title of the widget
	Title types.String `tfsdk:"title" tf:"optional"`
	// Timestamp of the last time this object was updated.
	UpdatedAt types.String `tfsdk:"updated_at" tf:"optional"`
}

func (*WidgetOptions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WidgetOptions) SyncEffectiveFieldsDuringCreateOrUpdate(plan WidgetOptions)

func (*WidgetOptions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WidgetOptions) SyncEffectiveFieldsDuringRead(existingState WidgetOptions)

type WidgetPosition 

type WidgetPosition struct {
	// reserved for internal use
	AutoHeight types.Bool `tfsdk:"autoHeight" tf:"optional"`
	// column in the dashboard grid. Values start with 0
	Col types.Int64 `tfsdk:"col" tf:"optional"`
	// row in the dashboard grid. Values start with 0
	Row types.Int64 `tfsdk:"row" tf:"optional"`
	// width of the widget measured in dashboard grid cells
	SizeX types.Int64 `tfsdk:"sizeX" tf:"optional"`
	// height of the widget measured in dashboard grid cells
	SizeY types.Int64 `tfsdk:"sizeY" tf:"optional"`
}

Coordinates of this widget on a dashboard. This portion of the API changes frequently and is unsupported.

func (*WidgetPosition) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *WidgetPosition) SyncEffectiveFieldsDuringCreateOrUpdate(plan WidgetPosition)

func (*WidgetPosition) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *WidgetPosition) SyncEffectiveFieldsDuringRead(existingState WidgetPosition)

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.