queries

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

type CreateQueryRequest struct {
	Query *CreateQueryRequestQuery
	// If true, automatically resolve query display name conflicts. Otherwise, fail
	// the request if the query's display name conflicts with an existing query's
	// display name.
	AutoResolveDisplayName *bool
}

type CreateQueryRequestQuery struct {
	// UUID identifying the query.
	Id *string
	// Display name of the query that appears in list views, widget headings, and on
	// the query page.
	DisplayName *string
	// General description that conveys additional information about this query such
	// as usage notes.
	Description *string
	// Username of the user that owns the query.
	OwnerUserName *string
	// ID of the SQL warehouse attached to the query.
	WarehouseId *string
	// Text of the query to be run.
	QueryText *string
	// Sets the "Run as" role for the object.
	RunAsMode RunAsMode
	// Indicates whether the query is trashed.
	LifecycleState LifecycleState
	// Username of the user who last saved changes to this query.
	LastModifierUserName *string
	// Workspace path of the workspace folder containing the object.
	ParentPath *string
	Tags       []string
	// Timestamp when this query was created.
	CreateTime *types.Time
	// Timestamp when this query was last updated.
	UpdateTime *types.Time
	// List of query parameter definitions.
	Parameters []QueryParameter
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit *bool
	// Name of the catalog where this query will be executed.
	Catalog *string
	// Name of the schema where this query will be executed.
	Schema *string
}

type DatePrecision string

type DateRange struct {
	Start *string
	End   *string
}

type DateRangeValue struct {
	Value isDateRangeValue_Value
	// Date-time precision to format the value into when the query is run. Defaults
	// to DAY_PRECISION (YYYY-MM-DD).
	Precision      DatePrecision
	StartDayOfWeek *int
}

type DateRangeValue_DynamicDateRange string

type DateRangeValue_Value_DateRangeValue struct {
	DateRangeValue DateRange
}

type DateRangeValue_Value_DynamicDateRangeValue struct {
	DynamicDateRangeValue DateRangeValue_DynamicDateRange
}

type DateValue struct {
	Value isDateValue_Value
	// Date-time precision to format the value into when the query is run. Defaults
	// to DAY_PRECISION (YYYY-MM-DD).
	Precision DatePrecision
}

type DateValue_DynamicDate string

type DateValue_Value_DateValue struct {
	DateValue string
}

type DateValue_Value_DynamicDateValue struct {
	DynamicDateValue DateValue_DynamicDate
}

type Empty struct {
}

type EnumValue struct {
	// List of selected query parameter values.
	Values []string
	// List of valid query parameter values, newline delimited.
	EnumOptions *string
	// If specified, allows multiple values to be selected for this parameter.
	MultiValuesOptions *MultiValuesOptions
}

type GetQueryRequest struct {
	Id *string
}

type LifecycleState string

type ListQueriesRequest struct {
	PageToken *string
	PageSize  *int
}

type ListQueriesResponse struct {
	Results       []ListQueryObjectsResponseQuery
	NextPageToken *string
}

type ListQueryObjectsResponseQuery struct {
	// UUID identifying the query.
	Id *string
	// Display name of the query that appears in list views, widget headings, and on
	// the query page.
	DisplayName *string
	// General description that conveys additional information about this query such
	// as usage notes.
	Description *string
	// Username of the user that owns the query.
	OwnerUserName *string
	// ID of the SQL warehouse attached to the query.
	WarehouseId *string
	// Text of the query to be run.
	QueryText *string
	// Sets the "Run as" role for the object.
	RunAsMode RunAsMode
	// Indicates whether the query is trashed.
	LifecycleState LifecycleState
	// Username of the user who last saved changes to this query.
	LastModifierUserName *string
	// Workspace path of the workspace folder containing the object.
	ParentPath *string
	Tags       []string
	// Timestamp when this query was created.
	CreateTime *types.Time
	// Timestamp when this query was last updated.
	UpdateTime *types.Time
	// List of query parameter definitions.
	Parameters []QueryParameter
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit *bool
	// Name of the catalog where this query will be executed.
	Catalog *string
	// Name of the schema where this query will be executed.
	Schema *string
}

type ListVisualizationsForQueryRequest struct {
	Id        *string
	PageToken *string
	PageSize  *int
}

type ListVisualizationsForQueryResponse struct {
	Results       []Visualization
	NextPageToken *string
}

type MultiValuesOptions struct {
	// Character that prefixes each selected parameter value.
	Prefix *string
	// Character that separates each selected parameter value. Defaults to a comma.
	Separator *string
	// Character that suffixes each selected parameter value.
	Suffix *string
}

type NumericValue struct {
	Value *float64
}

type Query struct {
	// UUID identifying the query.
	Id *string
	// Display name of the query that appears in list views, widget headings, and on
	// the query page.
	DisplayName *string
	// General description that conveys additional information about this query such
	// as usage notes.
	Description *string
	// Username of the user that owns the query.
	OwnerUserName *string
	// ID of the SQL warehouse attached to the query.
	WarehouseId *string
	// Text of the query to be run.
	QueryText *string
	// Sets the "Run as" role for the object.
	RunAsMode RunAsMode
	// Indicates whether the query is trashed.
	LifecycleState LifecycleState
	// Username of the user who last saved changes to this query.
	LastModifierUserName *string
	// Workspace path of the workspace folder containing the object.
	ParentPath *string
	Tags       []string
	// Timestamp when this query was created.
	CreateTime *types.Time
	// Timestamp when this query was last updated.
	UpdateTime *types.Time
	// List of query parameter definitions.
	Parameters []QueryParameter
	// Whether to apply a 1000 row limit to the query result.
	ApplyAutoLimit *bool
	// Name of the catalog where this query will be executed.
	Catalog *string
	// Name of the schema where this query will be executed.
	Schema *string
}

type QueryBackedValue struct {
	// List of selected query parameter values.
	Values []string
	// UUID of the query that provides the parameter values.
	QueryId *string
	// If specified, allows multiple values to be selected for this parameter.
	MultiValuesOptions *MultiValuesOptions
}

type QueryParameter struct {
	// Text displayed in the user-facing parameter widget in the UI.
	Title *string
	// Literal parameter marker that appears between double curly braces in the
	// query text.
	Name *string
	// Only one of the following fields may be set, depending on the type of
	// parameter.
	ParameterValue isQueryParameter_ParameterValue
}

type QueryParameter_ParameterValue_DateRangeValue struct {
	DateRangeValue DateRangeValue
}

type QueryParameter_ParameterValue_DateValue struct {
	DateValue DateValue
}

type QueryParameter_ParameterValue_EnumValue struct {
	EnumValue EnumValue
}

type QueryParameter_ParameterValue_NumericValue struct {
	NumericValue NumericValue
}

type QueryParameter_ParameterValue_QueryBackedValue struct {
	QueryBackedValue QueryBackedValue
}

type QueryParameter_ParameterValue_TextValue struct {
	TextValue TextValue
}

type RunAsMode string

type TextValue struct {
	Value *string
}

type TrashQueryRequest struct {
	Id *string
}

type UpdateQueryRequest struct {
	Query      *UpdateQueryRequestQuery
	UpdateMask *types.FieldMask[UpdateQueryRequestQuery]
	Id         *string
	// If true, automatically resolve alert display name conflicts. Otherwise, fail
	// the request if the alert's display name conflicts with an existing alert's
	// display name.
	AutoResolveDisplayName *bool
}

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

type Visualization struct {
	// UUID identifying the visualization.
	Id *string
	// The display name of the visualization.
	DisplayName *string
	// The type of visualization: counter, table, funnel, and so on.
	Type *string
	// The timestamp indicating when the visualization was created.
	CreateTime *types.Time
	// The timestamp indicating when the visualization was updated.
	UpdateTime *types.Time
	// 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 *string
	// The visualization options varies widely from one visualization type to the
	// next and is unsupported. Databricks does not recommend modifying
	// visualization options directly.
	SerializedOptions *string
	// UUID of the query that the visualization is attached to.
	QueryId *string
}