Documentation
¶
Overview ¶
These APIs provide specific management operations for Lakeview dashboards.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LakeviewAPI ¶
type LakeviewAPI struct {
// contains filtered or unexported fields
}
These APIs provide specific management operations for Lakeview dashboards. Generic resource management can be done with Workspace API (import, export, get-status, list, delete).
func NewLakeview ¶
func NewLakeview(client *client.DatabricksClient) *LakeviewAPI
func (*LakeviewAPI) Impl ¶
func (a *LakeviewAPI) Impl() LakeviewService
Impl returns low-level Lakeview API implementation Deprecated: use MockLakeviewInterface instead.
func (*LakeviewAPI) Publish ¶
func (a *LakeviewAPI) Publish(ctx context.Context, request PublishRequest) error
Publish dashboard.
Publish the current draft dashboard.
func (*LakeviewAPI) WithImpl ¶
func (a *LakeviewAPI) WithImpl(impl LakeviewService) LakeviewInterface
WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockLakeviewInterface instead.
type LakeviewInterface ¶
type LakeviewInterface interface {
// WithImpl could be used to override low-level API implementations for unit
// testing purposes with [github.com/golang/mock] or other mocking frameworks.
// Deprecated: use MockLakeviewInterface instead.
WithImpl(impl LakeviewService) LakeviewInterface
// Impl returns low-level Lakeview API implementation
// Deprecated: use MockLakeviewInterface instead.
Impl() LakeviewService
// Publish dashboard.
//
// Publish the current draft dashboard.
Publish(ctx context.Context, request PublishRequest) error
}
type LakeviewService ¶
type LakeviewService interface {
// Publish dashboard.
//
// Publish the current draft dashboard.
Publish(ctx context.Context, request PublishRequest) error
}
These APIs provide specific management operations for Lakeview dashboards. Generic resource management can be done with Workspace API (import, export, get-status, list, delete).
type PublishRequest ¶
type PublishRequest struct {
// UUID identifying the dashboard to be published.
DashboardId string `json:"-" url:"-"`
// 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 bool `json:"embed_credentials,omitempty"`
// The ID of the warehouse that can be used to override the warehouse which
// was set in the draft.
WarehouseId string `json:"warehouse_id,omitempty"`
ForceSendFields []string `json:"-"`
}
func (PublishRequest) MarshalJSON ¶
func (s PublishRequest) MarshalJSON() ([]byte, error)
func (*PublishRequest) UnmarshalJSON ¶
func (s *PublishRequest) UnmarshalJSON(b []byte) error
type PublishResponse ¶ added in v0.34.0
type PublishResponse struct {
}