dashboards_tf

package
v1.57.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CronSchedule 

type CronSchedule struct {
	// A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents
	// everyday at 8am. See [Cron Trigger] for details.
	//
	// [Cron Trigger]: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
	QuartzCronExpression types.String `tfsdk:"quartz_cron_expression" tf:""`
	// A Java timezone id. The schedule will be resolved with respect to this
	// timezone. See [Java TimeZone] for details.
	//
	// [Java TimeZone]: https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html
	TimezoneId types.String `tfsdk:"timezone_id" tf:""`
}

func (*CronSchedule) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CronSchedule) SyncEffectiveFieldsDuringCreateOrUpdate(plan CronSchedule)

func (*CronSchedule) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CronSchedule) SyncEffectiveFieldsDuringRead(existingState CronSchedule)

type Dashboard 

type Dashboard struct {
	// The timestamp of when the dashboard was created.
	CreateTime          types.String `tfsdk:"create_time" tf:"optional"`
	EffectiveCreateTime types.String `tfsdk:"effective_create_time" tf:"computed,optional"`
	// UUID identifying the dashboard.
	DashboardId          types.String `tfsdk:"dashboard_id" tf:"optional"`
	EffectiveDashboardId types.String `tfsdk:"effective_dashboard_id" tf:"computed,optional"`
	// The display name of the dashboard.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// The etag for the dashboard. Can be optionally provided on updates to
	// ensure that the dashboard has not been modified since the last read. This
	// field is excluded in List Dashboards responses.
	Etag          types.String `tfsdk:"etag" tf:"optional"`
	EffectiveEtag types.String `tfsdk:"effective_etag" tf:"computed,optional"`
	// The state of the dashboard resource. Used for tracking trashed status.
	LifecycleState types.String `tfsdk:"lifecycle_state" tf:"optional"`
	// The workspace path of the folder containing the dashboard. Includes
	// leading slash and no trailing slash. This field is excluded in List
	// Dashboards responses.
	ParentPath          types.String `tfsdk:"parent_path" tf:"optional"`
	EffectiveParentPath types.String `tfsdk:"effective_parent_path" tf:"computed,optional"`
	// The workspace path of the dashboard asset, including the file name.
	// Exported dashboards always have the file extension `.lvdash.json`. This
	// field is excluded in List Dashboards responses.
	Path          types.String `tfsdk:"path" tf:"optional"`
	EffectivePath types.String `tfsdk:"effective_path" tf:"computed,optional"`
	// The contents of the dashboard in serialized string form. This field is
	// excluded in List Dashboards responses. Use the [get dashboard API] to
	// retrieve an example response, which includes the `serialized_dashboard`
	// field. This field provides the structure of the JSON string that
	// represents the dashboard's layout and components.
	//
	// [get dashboard API]: https://docs.databricks.com/api/workspace/lakeview/get
	SerializedDashboard types.String `tfsdk:"serialized_dashboard" tf:"optional"`
	// The timestamp of when the dashboard was last updated by the user. This
	// field is excluded in List Dashboards responses.
	UpdateTime          types.String `tfsdk:"update_time" tf:"optional"`
	EffectiveUpdateTime types.String `tfsdk:"effective_update_time" tf:"computed,optional"`
	// The warehouse ID used to run the dashboard.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

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 DeleteScheduleRequest 

type DeleteScheduleRequest struct {
	// UUID identifying the dashboard to which the schedule belongs.
	DashboardId          types.String `tfsdk:"-"`
	EffectiveDashboardId types.String `tfsdk:"-"`
	// The etag for the schedule. Optionally, it can be provided to verify that
	// the schedule has not been modified from its last retrieval.
	Etag          types.String `tfsdk:"-"`
	EffectiveEtag types.String `tfsdk:"-"`
	// UUID identifying the schedule.
	ScheduleId          types.String `tfsdk:"-"`
	EffectiveScheduleId types.String `tfsdk:"-"`
}

Delete dashboard schedule

func (*DeleteScheduleRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteScheduleRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteScheduleRequest)

func (*DeleteScheduleRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteScheduleRequest) SyncEffectiveFieldsDuringRead(existingState DeleteScheduleRequest)

type DeleteScheduleResponse 

type DeleteScheduleResponse struct {
}

func (*DeleteScheduleResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteScheduleResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteScheduleResponse)

func (*DeleteScheduleResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteScheduleResponse) SyncEffectiveFieldsDuringRead(existingState DeleteScheduleResponse)

type DeleteSubscriptionRequest 

type DeleteSubscriptionRequest struct {
	// UUID identifying the dashboard which the subscription belongs.
	DashboardId          types.String `tfsdk:"-"`
	EffectiveDashboardId types.String `tfsdk:"-"`
	// The etag for the subscription. Can be optionally provided to ensure that
	// the subscription has not been modified since the last read.
	Etag          types.String `tfsdk:"-"`
	EffectiveEtag types.String `tfsdk:"-"`
	// UUID identifying the schedule which the subscription belongs.
	ScheduleId          types.String `tfsdk:"-"`
	EffectiveScheduleId types.String `tfsdk:"-"`
	// UUID identifying the subscription.
	SubscriptionId          types.String `tfsdk:"-"`
	EffectiveSubscriptionId types.String `tfsdk:"-"`
}

Delete schedule subscription

func (*DeleteSubscriptionRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteSubscriptionRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteSubscriptionRequest)

func (*DeleteSubscriptionRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteSubscriptionRequest) SyncEffectiveFieldsDuringRead(existingState DeleteSubscriptionRequest)

type DeleteSubscriptionResponse 

type DeleteSubscriptionResponse struct {
}

func (*DeleteSubscriptionResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteSubscriptionResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteSubscriptionResponse)

func (*DeleteSubscriptionResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteSubscriptionResponse) SyncEffectiveFieldsDuringRead(existingState DeleteSubscriptionResponse)

type GenieAttachment 

type GenieAttachment struct {
	Query []QueryAttachment `tfsdk:"query" tf:"optional,object"`

	Text []TextAttachment `tfsdk:"text" tf:"optional,object"`
}

Genie AI Response

func (*GenieAttachment) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieAttachment) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieAttachment)

func (*GenieAttachment) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieAttachment) SyncEffectiveFieldsDuringRead(existingState GenieAttachment)

type GenieConversation 

type GenieConversation struct {
	// Timestamp when the message was created
	CreatedTimestamp types.Int64 `tfsdk:"created_timestamp" tf:"optional"`
	// Conversation ID
	Id types.String `tfsdk:"id" tf:""`
	// Timestamp when the message was last updated
	LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"`
	// Genie space ID
	SpaceId types.String `tfsdk:"space_id" tf:""`
	// Conversation title
	Title types.String `tfsdk:"title" tf:""`
	// ID of the user who created the conversation
	UserId types.Int64 `tfsdk:"user_id" tf:""`
}

func (*GenieConversation) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieConversation) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieConversation)

func (*GenieConversation) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieConversation) SyncEffectiveFieldsDuringRead(existingState GenieConversation)

type GenieCreateConversationMessageRequest 

type GenieCreateConversationMessageRequest struct {
	// User message content.
	Content types.String `tfsdk:"content" tf:""`
	// The ID associated with the conversation.
	ConversationId types.String `tfsdk:"-"`
	// The ID associated with the Genie space where the conversation is started.
	SpaceId types.String `tfsdk:"-"`
}

func (*GenieCreateConversationMessageRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieCreateConversationMessageRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieCreateConversationMessageRequest)

func (*GenieCreateConversationMessageRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieCreateConversationMessageRequest) SyncEffectiveFieldsDuringRead(existingState GenieCreateConversationMessageRequest)

type GenieExecuteMessageQueryRequest added in v1.57.0 

type GenieExecuteMessageQueryRequest struct {
	// Conversation ID
	ConversationId types.String `tfsdk:"-"`
	// Message ID
	MessageId types.String `tfsdk:"-"`
	// Genie space ID
	SpaceId types.String `tfsdk:"-"`
}

Execute SQL query in a conversation message

func (*GenieExecuteMessageQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.57.0 

func (newState *GenieExecuteMessageQueryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieExecuteMessageQueryRequest)

func (*GenieExecuteMessageQueryRequest) SyncEffectiveFieldsDuringRead added in v1.57.0 

func (newState *GenieExecuteMessageQueryRequest) SyncEffectiveFieldsDuringRead(existingState GenieExecuteMessageQueryRequest)

type GenieGetConversationMessageRequest 

type GenieGetConversationMessageRequest struct {
	// The ID associated with the target conversation.
	ConversationId types.String `tfsdk:"-"`
	// The ID associated with the target message from the identified
	// conversation.
	MessageId types.String `tfsdk:"-"`
	// The ID associated with the Genie space where the target conversation is
	// located.
	SpaceId types.String `tfsdk:"-"`
}

Get conversation message

func (*GenieGetConversationMessageRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieGetConversationMessageRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieGetConversationMessageRequest)

func (*GenieGetConversationMessageRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieGetConversationMessageRequest) SyncEffectiveFieldsDuringRead(existingState GenieGetConversationMessageRequest)

type GenieGetMessageQueryResultRequest 

type GenieGetMessageQueryResultRequest struct {
	// Conversation ID
	ConversationId types.String `tfsdk:"-"`
	// Message ID
	MessageId types.String `tfsdk:"-"`
	// Genie space ID
	SpaceId types.String `tfsdk:"-"`
}

Get conversation message SQL query result

func (*GenieGetMessageQueryResultRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieGetMessageQueryResultRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieGetMessageQueryResultRequest)

func (*GenieGetMessageQueryResultRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieGetMessageQueryResultRequest) SyncEffectiveFieldsDuringRead(existingState GenieGetMessageQueryResultRequest)

type GenieGetMessageQueryResultResponse 

type GenieGetMessageQueryResultResponse struct {
	// SQL Statement Execution response. See [Get status, manifest, and result
	// first chunk](:method:statementexecution/getstatement) for more details.
	StatementResponse sql.StatementResponse `tfsdk:"statement_response" tf:"optional,object"`
}

func (*GenieGetMessageQueryResultResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieGetMessageQueryResultResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieGetMessageQueryResultResponse)

func (*GenieGetMessageQueryResultResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieGetMessageQueryResultResponse) SyncEffectiveFieldsDuringRead(existingState GenieGetMessageQueryResultResponse)

type GenieMessage 

type GenieMessage struct {
	// AI produced response to the message
	Attachments []GenieAttachment `tfsdk:"attachments" tf:"optional"`
	// User message content
	Content types.String `tfsdk:"content" tf:""`
	// Conversation ID
	ConversationId types.String `tfsdk:"conversation_id" tf:""`
	// Timestamp when the message was created
	CreatedTimestamp types.Int64 `tfsdk:"created_timestamp" tf:"optional"`
	// Error message if AI failed to respond to the message
	Error []MessageError `tfsdk:"error" tf:"optional,object"`
	// Message ID
	Id types.String `tfsdk:"id" tf:""`
	// Timestamp when the message was last updated
	LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"`
	// The result of SQL query if the message has a query attachment
	QueryResult []Result `tfsdk:"query_result" tf:"optional,object"`
	// Genie space ID
	SpaceId types.String `tfsdk:"space_id" tf:""`
	// MesssageStatus. The possible values are: * `FETCHING_METADATA`: Fetching
	// metadata from the data sources. * `FILTERING_CONTEXT`: Running smart
	// context step to determine relevant context. * `ASKING_AI`: Waiting for
	// the LLM to respond to the users question. * `EXECUTING_QUERY`: Executing
	// AI provided SQL query. Get the SQL query result by calling
	// [getMessageQueryResult](:method:genie/getMessageQueryResult) API.
	// **Important: The message status will stay in the `EXECUTING_QUERY` until
	// a client calls
	// [getMessageQueryResult](:method:genie/getMessageQueryResult)**. *
	// `FAILED`: Generating a response or the executing the query failed. Please
	// see `error` field. * `COMPLETED`: Message processing is completed.
	// Results are in the `attachments` field. Get the SQL query result by
	// calling [getMessageQueryResult](:method:genie/getMessageQueryResult) API.
	// * `SUBMITTED`: Message has been submitted. * `QUERY_RESULT_EXPIRED`: SQL
	// result is not available anymore. The user needs to execute the query
	// again. * `CANCELLED`: Message has been cancelled.
	Status types.String `tfsdk:"status" tf:"optional"`
	// ID of the user who created the message
	UserId types.Int64 `tfsdk:"user_id" tf:"optional"`
}

func (*GenieMessage) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieMessage) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieMessage)

func (*GenieMessage) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieMessage) SyncEffectiveFieldsDuringRead(existingState GenieMessage)

type GenieStartConversationMessageRequest 

type GenieStartConversationMessageRequest struct {
	// The text of the message that starts the conversation.
	Content types.String `tfsdk:"content" tf:""`
	// The ID associated with the Genie space where you want to start a
	// conversation.
	SpaceId types.String `tfsdk:"-"`
}

func (*GenieStartConversationMessageRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieStartConversationMessageRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieStartConversationMessageRequest)

func (*GenieStartConversationMessageRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieStartConversationMessageRequest) SyncEffectiveFieldsDuringRead(existingState GenieStartConversationMessageRequest)

type GenieStartConversationResponse 

type GenieStartConversationResponse struct {
	Conversation []GenieConversation `tfsdk:"conversation" tf:"optional,object"`
	// Conversation ID
	ConversationId types.String `tfsdk:"conversation_id" tf:""`

	Message []GenieMessage `tfsdk:"message" tf:"optional,object"`
	// Message ID
	MessageId types.String `tfsdk:"message_id" tf:""`
}

func (*GenieStartConversationResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GenieStartConversationResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GenieStartConversationResponse)

func (*GenieStartConversationResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GenieStartConversationResponse) SyncEffectiveFieldsDuringRead(existingState GenieStartConversationResponse)

type GetDashboardRequest 

type GetDashboardRequest struct {
	// UUID identifying the dashboard.
	DashboardId types.String `tfsdk:"-"`
}

Get dashboard

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 GetPublishedDashboardRequest 

type GetPublishedDashboardRequest struct {
	// UUID identifying the dashboard to be published.
	DashboardId types.String `tfsdk:"-"`
}

Get published dashboard

func (*GetPublishedDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetPublishedDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetPublishedDashboardRequest)

func (*GetPublishedDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetPublishedDashboardRequest) SyncEffectiveFieldsDuringRead(existingState GetPublishedDashboardRequest)

type GetScheduleRequest 

type GetScheduleRequest struct {
	// UUID identifying the dashboard to which the schedule belongs.
	DashboardId          types.String `tfsdk:"-"`
	EffectiveDashboardId types.String `tfsdk:"-"`
	// UUID identifying the schedule.
	ScheduleId          types.String `tfsdk:"-"`
	EffectiveScheduleId types.String `tfsdk:"-"`
}

Get dashboard schedule

func (*GetScheduleRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetScheduleRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetScheduleRequest)

func (*GetScheduleRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetScheduleRequest) SyncEffectiveFieldsDuringRead(existingState GetScheduleRequest)

type GetSubscriptionRequest 

type GetSubscriptionRequest struct {
	// UUID identifying the dashboard which the subscription belongs.
	DashboardId          types.String `tfsdk:"-"`
	EffectiveDashboardId types.String `tfsdk:"-"`
	// UUID identifying the schedule which the subscription belongs.
	ScheduleId          types.String `tfsdk:"-"`
	EffectiveScheduleId types.String `tfsdk:"-"`
	// UUID identifying the subscription.
	SubscriptionId          types.String `tfsdk:"-"`
	EffectiveSubscriptionId types.String `tfsdk:"-"`
}

Get schedule subscription

func (*GetSubscriptionRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetSubscriptionRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetSubscriptionRequest)

func (*GetSubscriptionRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetSubscriptionRequest) SyncEffectiveFieldsDuringRead(existingState GetSubscriptionRequest)

type ListDashboardsRequest 

type ListDashboardsRequest struct {
	// The number of dashboards to return per page.
	PageSize types.Int64 `tfsdk:"-"`
	// A page token, received from a previous `ListDashboards` call. This token
	// can be used to retrieve the subsequent page.
	PageToken          types.String `tfsdk:"-"`
	EffectivePageToken types.String `tfsdk:"-"`
	// The flag to include dashboards located in the trash. If unspecified, only
	// active dashboards will be returned.
	ShowTrashed types.Bool `tfsdk:"-"`
	// `DASHBOARD_VIEW_BASIC`only includes summary metadata from the dashboard.
	View types.String `tfsdk:"-"`
}

List dashboards

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 ListDashboardsResponse 

type ListDashboardsResponse struct {
	Dashboards []Dashboard `tfsdk:"dashboards" tf:"optional"`
	// A token, which can be sent as `page_token` to retrieve the next page. If
	// this field is omitted, there are no subsequent dashboards.
	NextPageToken          types.String `tfsdk:"next_page_token" tf:"optional"`
	EffectiveNextPageToken types.String `tfsdk:"effective_next_page_token" tf:"computed,optional"`
}

func (*ListDashboardsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListDashboardsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListDashboardsResponse)

func (*ListDashboardsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListDashboardsResponse) SyncEffectiveFieldsDuringRead(existingState ListDashboardsResponse)

type ListSchedulesRequest 

type ListSchedulesRequest struct {
	// UUID identifying the dashboard to which the schedule belongs.
	DashboardId          types.String `tfsdk:"-"`
	EffectiveDashboardId types.String `tfsdk:"-"`
	// The number of schedules to return per page.
	PageSize types.Int64 `tfsdk:"-"`
	// A page token, received from a previous `ListSchedules` call. Use this to
	// retrieve the subsequent page.
	PageToken          types.String `tfsdk:"-"`
	EffectivePageToken types.String `tfsdk:"-"`
}

List dashboard schedules

func (*ListSchedulesRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListSchedulesRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListSchedulesRequest)

func (*ListSchedulesRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListSchedulesRequest) SyncEffectiveFieldsDuringRead(existingState ListSchedulesRequest)

type ListSchedulesResponse 

type ListSchedulesResponse struct {
	// A token that can be used as a `page_token` in subsequent requests to
	// retrieve the next page of results. If this field is omitted, there are no
	// subsequent schedules.
	NextPageToken          types.String `tfsdk:"next_page_token" tf:"optional"`
	EffectiveNextPageToken types.String `tfsdk:"effective_next_page_token" tf:"computed,optional"`

	Schedules []Schedule `tfsdk:"schedules" tf:"optional"`
}

func (*ListSchedulesResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListSchedulesResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListSchedulesResponse)

func (*ListSchedulesResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListSchedulesResponse) SyncEffectiveFieldsDuringRead(existingState ListSchedulesResponse)

type ListSubscriptionsRequest 

type ListSubscriptionsRequest struct {
	// UUID identifying the dashboard to which the subscription belongs.
	DashboardId          types.String `tfsdk:"-"`
	EffectiveDashboardId types.String `tfsdk:"-"`
	// The number of subscriptions to return per page.
	PageSize types.Int64 `tfsdk:"-"`
	// A page token, received from a previous `ListSubscriptions` call. Use this
	// to retrieve the subsequent page.
	PageToken          types.String `tfsdk:"-"`
	EffectivePageToken types.String `tfsdk:"-"`
	// UUID identifying the schedule to which the subscription belongs.
	ScheduleId          types.String `tfsdk:"-"`
	EffectiveScheduleId types.String `tfsdk:"-"`
}

List schedule subscriptions

func (*ListSubscriptionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListSubscriptionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListSubscriptionsRequest)

func (*ListSubscriptionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListSubscriptionsRequest) SyncEffectiveFieldsDuringRead(existingState ListSubscriptionsRequest)

type ListSubscriptionsResponse 

type ListSubscriptionsResponse struct {
	// A token that can be used as a `page_token` in subsequent requests to
	// retrieve the next page of results. If this field is omitted, there are no
	// subsequent subscriptions.
	NextPageToken          types.String `tfsdk:"next_page_token" tf:"optional"`
	EffectiveNextPageToken types.String `tfsdk:"effective_next_page_token" tf:"computed,optional"`

	Subscriptions []Subscription `tfsdk:"subscriptions" tf:"optional"`
}

func (*ListSubscriptionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListSubscriptionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListSubscriptionsResponse)

func (*ListSubscriptionsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListSubscriptionsResponse) SyncEffectiveFieldsDuringRead(existingState ListSubscriptionsResponse)

type MessageError 

type MessageError struct {
	Error types.String `tfsdk:"error" tf:"optional"`

	Type types.String `tfsdk:"type" tf:"optional"`
}

func (*MessageError) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MessageError) SyncEffectiveFieldsDuringCreateOrUpdate(plan MessageError)

func (*MessageError) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MessageError) SyncEffectiveFieldsDuringRead(existingState MessageError)

type MigrateDashboardRequest 

type MigrateDashboardRequest struct {
	// Display name for the new Lakeview dashboard.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// The workspace path of the folder to contain the migrated Lakeview
	// dashboard.
	ParentPath types.String `tfsdk:"parent_path" tf:"optional"`
	// UUID of the dashboard to be migrated.
	SourceDashboardId types.String `tfsdk:"source_dashboard_id" tf:""`
}

func (*MigrateDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MigrateDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan MigrateDashboardRequest)

func (*MigrateDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MigrateDashboardRequest) SyncEffectiveFieldsDuringRead(existingState MigrateDashboardRequest)

type PublishRequest 

type PublishRequest struct {
	// UUID identifying the dashboard to be published.
	DashboardId types.String `tfsdk:"-"`
	// Flag to indicate if the publisher's credentials should be embedded in the
	// published dashboard. These embedded credentials will be used to execute
	// the published dashboard's queries.
	EmbedCredentials types.Bool `tfsdk:"embed_credentials" tf:"optional"`
	// The ID of the warehouse that can be used to override the warehouse which
	// was set in the draft.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*PublishRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PublishRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan PublishRequest)

func (*PublishRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PublishRequest) SyncEffectiveFieldsDuringRead(existingState PublishRequest)

type PublishedDashboard 

type PublishedDashboard struct {
	// The display name of the published dashboard.
	DisplayName          types.String `tfsdk:"display_name" tf:"optional"`
	EffectiveDisplayName types.String `tfsdk:"effective_display_name" tf:"computed,optional"`
	// Indicates whether credentials are embedded in the published dashboard.
	EmbedCredentials types.Bool `tfsdk:"embed_credentials" tf:"optional"`
	// The timestamp of when the published dashboard was last revised.
	RevisionCreateTime          types.String `tfsdk:"revision_create_time" tf:"optional"`
	EffectiveRevisionCreateTime types.String `tfsdk:"effective_revision_create_time" tf:"computed,optional"`
	// The warehouse ID used to run the published dashboard.
	WarehouseId types.String `tfsdk:"warehouse_id" tf:"optional"`
}

func (*PublishedDashboard) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PublishedDashboard) SyncEffectiveFieldsDuringCreateOrUpdate(plan PublishedDashboard)

func (*PublishedDashboard) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PublishedDashboard) SyncEffectiveFieldsDuringRead(existingState PublishedDashboard)

type QueryAttachment 

type QueryAttachment struct {
	// Description of the query
	Description types.String `tfsdk:"description" tf:"optional"`

	Id types.String `tfsdk:"id" tf:"optional"`
	// If the query was created on an instruction (trusted asset) we link to the
	// id
	InstructionId types.String `tfsdk:"instruction_id" tf:"optional"`
	// Always store the title next to the id in case the original instruction
	// title changes or the instruction is deleted.
	InstructionTitle types.String `tfsdk:"instruction_title" tf:"optional"`
	// Time when the user updated the query last
	LastUpdatedTimestamp types.Int64 `tfsdk:"last_updated_timestamp" tf:"optional"`
	// AI generated SQL query
	Query types.String `tfsdk:"query" tf:"optional"`
	// Name of the query
	Title types.String `tfsdk:"title" tf:"optional"`
}

func (*QueryAttachment) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *QueryAttachment) SyncEffectiveFieldsDuringCreateOrUpdate(plan QueryAttachment)

func (*QueryAttachment) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *QueryAttachment) SyncEffectiveFieldsDuringRead(existingState QueryAttachment)

type Result 

type Result struct {
	// If result is truncated
	IsTruncated types.Bool `tfsdk:"is_truncated" tf:"optional"`
	// Row count of the result
	RowCount types.Int64 `tfsdk:"row_count" tf:"optional"`
	// Statement Execution API statement id. Use [Get status, manifest, and
	// result first chunk](:method:statementexecution/getstatement) to get the
	// full result data.
	StatementId types.String `tfsdk:"statement_id" tf:"optional"`
}

func (*Result) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Result) SyncEffectiveFieldsDuringCreateOrUpdate(plan Result)

func (*Result) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Result) SyncEffectiveFieldsDuringRead(existingState Result)

type Schedule 

type Schedule struct {
	// A timestamp indicating when the schedule was created.
	CreateTime          types.String `tfsdk:"create_time" tf:"optional"`
	EffectiveCreateTime types.String `tfsdk:"effective_create_time" tf:"computed,optional"`
	// The cron expression describing the frequency of the periodic refresh for
	// this schedule.
	CronSchedule []CronSchedule `tfsdk:"cron_schedule" tf:"object"`
	// UUID identifying the dashboard to which the schedule belongs.
	DashboardId          types.String `tfsdk:"dashboard_id" tf:"optional"`
	EffectiveDashboardId types.String `tfsdk:"effective_dashboard_id" tf:"computed,optional"`
	// The display name for schedule.
	DisplayName types.String `tfsdk:"display_name" tf:"optional"`
	// The etag for the schedule. Must be left empty on create, must be provided
	// on updates to ensure that the schedule has not been modified since the
	// last read, and can be optionally provided on delete.
	Etag          types.String `tfsdk:"etag" tf:"optional"`
	EffectiveEtag types.String `tfsdk:"effective_etag" tf:"computed,optional"`
	// The status indicates whether this schedule is paused or not.
	PauseStatus types.String `tfsdk:"pause_status" tf:"optional"`
	// UUID identifying the schedule.
	ScheduleId          types.String `tfsdk:"schedule_id" tf:"optional"`
	EffectiveScheduleId types.String `tfsdk:"effective_schedule_id" tf:"computed,optional"`
	// A timestamp indicating when the schedule was last updated.
	UpdateTime          types.String `tfsdk:"update_time" tf:"optional"`
	EffectiveUpdateTime types.String `tfsdk:"effective_update_time" tf:"computed,optional"`
}

func (*Schedule) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Schedule) SyncEffectiveFieldsDuringCreateOrUpdate(plan Schedule)

func (*Schedule) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Schedule) SyncEffectiveFieldsDuringRead(existingState Schedule)

type Subscriber 

type Subscriber struct {
	// The destination to receive the subscription email. This parameter is
	// mutually exclusive with `user_subscriber`.
	DestinationSubscriber []SubscriptionSubscriberDestination `tfsdk:"destination_subscriber" tf:"optional,object"`
	// The user to receive the subscription email. This parameter is mutually
	// exclusive with `destination_subscriber`.
	UserSubscriber []SubscriptionSubscriberUser `tfsdk:"user_subscriber" tf:"optional,object"`
}

func (*Subscriber) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Subscriber) SyncEffectiveFieldsDuringCreateOrUpdate(plan Subscriber)

func (*Subscriber) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Subscriber) SyncEffectiveFieldsDuringRead(existingState Subscriber)

type Subscription 

type Subscription struct {
	// A timestamp indicating when the subscription was created.
	CreateTime          types.String `tfsdk:"create_time" tf:"optional"`
	EffectiveCreateTime types.String `tfsdk:"effective_create_time" tf:"computed,optional"`
	// UserId of the user who adds subscribers (users or notification
	// destinations) to the dashboard's schedule.
	CreatedByUserId          types.Int64 `tfsdk:"created_by_user_id" tf:"optional"`
	EffectiveCreatedByUserId types.Int64 `tfsdk:"effective_created_by_user_id" tf:"computed,optional"`
	// UUID identifying the dashboard to which the subscription belongs.
	DashboardId          types.String `tfsdk:"dashboard_id" tf:"optional"`
	EffectiveDashboardId types.String `tfsdk:"effective_dashboard_id" tf:"computed,optional"`
	// The etag for the subscription. Must be left empty on create, can be
	// optionally provided on delete to ensure that the subscription has not
	// been deleted since the last read.
	Etag          types.String `tfsdk:"etag" tf:"optional"`
	EffectiveEtag types.String `tfsdk:"effective_etag" tf:"computed,optional"`
	// UUID identifying the schedule to which the subscription belongs.
	ScheduleId          types.String `tfsdk:"schedule_id" tf:"optional"`
	EffectiveScheduleId types.String `tfsdk:"effective_schedule_id" tf:"computed,optional"`
	// Subscriber details for users and destinations to be added as subscribers
	// to the schedule.
	Subscriber []Subscriber `tfsdk:"subscriber" tf:"object"`
	// UUID identifying the subscription.
	SubscriptionId          types.String `tfsdk:"subscription_id" tf:"optional"`
	EffectiveSubscriptionId types.String `tfsdk:"effective_subscription_id" tf:"computed,optional"`
	// A timestamp indicating when the subscription was last updated.
	UpdateTime          types.String `tfsdk:"update_time" tf:"optional"`
	EffectiveUpdateTime types.String `tfsdk:"effective_update_time" tf:"computed,optional"`
}

func (*Subscription) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Subscription) SyncEffectiveFieldsDuringCreateOrUpdate(plan Subscription)

func (*Subscription) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Subscription) SyncEffectiveFieldsDuringRead(existingState Subscription)

type SubscriptionSubscriberDestination 

type SubscriptionSubscriberDestination struct {
	// The canonical identifier of the destination to receive email
	// notification.
	DestinationId          types.String `tfsdk:"destination_id" tf:""`
	EffectiveDestinationId types.String `tfsdk:"effective_destination_id" tf:"computed,optional"`
}

func (*SubscriptionSubscriberDestination) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SubscriptionSubscriberDestination) SyncEffectiveFieldsDuringCreateOrUpdate(plan SubscriptionSubscriberDestination)

func (*SubscriptionSubscriberDestination) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SubscriptionSubscriberDestination) SyncEffectiveFieldsDuringRead(existingState SubscriptionSubscriberDestination)

type SubscriptionSubscriberUser 

type SubscriptionSubscriberUser struct {
	// UserId of the subscriber.
	UserId          types.Int64 `tfsdk:"user_id" tf:""`
	EffectiveUserId types.Int64 `tfsdk:"effective_user_id" tf:"computed,optional"`
}

func (*SubscriptionSubscriberUser) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SubscriptionSubscriberUser) SyncEffectiveFieldsDuringCreateOrUpdate(plan SubscriptionSubscriberUser)

func (*SubscriptionSubscriberUser) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SubscriptionSubscriberUser) SyncEffectiveFieldsDuringRead(existingState SubscriptionSubscriberUser)

type TextAttachment 

type TextAttachment struct {
	// AI generated message
	Content types.String `tfsdk:"content" tf:"optional"`

	Id types.String `tfsdk:"id" tf:"optional"`
}

func (*TextAttachment) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TextAttachment) SyncEffectiveFieldsDuringCreateOrUpdate(plan TextAttachment)

func (*TextAttachment) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TextAttachment) SyncEffectiveFieldsDuringRead(existingState TextAttachment)

type TrashDashboardRequest 

type TrashDashboardRequest struct {
	// UUID identifying the dashboard.
	DashboardId types.String `tfsdk:"-"`
}

Trash dashboard

func (*TrashDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TrashDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan TrashDashboardRequest)

func (*TrashDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TrashDashboardRequest) SyncEffectiveFieldsDuringRead(existingState TrashDashboardRequest)

type TrashDashboardResponse 

type TrashDashboardResponse struct {
}

func (*TrashDashboardResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *TrashDashboardResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan TrashDashboardResponse)

func (*TrashDashboardResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *TrashDashboardResponse) SyncEffectiveFieldsDuringRead(existingState TrashDashboardResponse)

type UnpublishDashboardRequest 

type UnpublishDashboardRequest struct {
	// UUID identifying the dashboard to be published.
	DashboardId types.String `tfsdk:"-"`
}

Unpublish dashboard

func (*UnpublishDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UnpublishDashboardRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UnpublishDashboardRequest)

func (*UnpublishDashboardRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UnpublishDashboardRequest) SyncEffectiveFieldsDuringRead(existingState UnpublishDashboardRequest)

type UnpublishDashboardResponse 

type UnpublishDashboardResponse struct {
}

func (*UnpublishDashboardResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UnpublishDashboardResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UnpublishDashboardResponse)

func (*UnpublishDashboardResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UnpublishDashboardResponse) SyncEffectiveFieldsDuringRead(existingState UnpublishDashboardResponse)

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.