com.databricks.sdk.service.dashboards.LakeviewAPI Maven / Gradle / Ivy

Go to download
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.dashboards;

import com.databricks.sdk.core.ApiClient;
import com.databricks.sdk.support.Generated;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * These APIs provide specific management operations for Lakeview dashboards. Generic resource
 * management can be done with Workspace API (import, export, get-status, list, delete).
 */
@Generated
public class LakeviewAPI {
  private static final Logger LOG = LoggerFactory.getLogger(LakeviewAPI.class);

  private final LakeviewService impl;

  /** Regular-use constructor */
  public LakeviewAPI(ApiClient apiClient) {
    impl = new LakeviewImpl(apiClient);
  }

  /** Constructor for mocks */
  public LakeviewAPI(LakeviewService mock) {
    impl = mock;
  }

  public Dashboard create(String displayName) {
    return create(new CreateDashboardRequest().setDisplayName(displayName));
  }

  /**
   * Create dashboard.
   *
   * Create a draft dashboard.
   */
  public Dashboard create(CreateDashboardRequest request) {
    return impl.create(request);
  }

  public Dashboard get(String dashboardId) {
    return get(new GetDashboardRequest().setDashboardId(dashboardId));
  }

  /**
   * Get dashboard.
   *
   * 
Get a draft dashboard.
   */
  public Dashboard get(GetDashboardRequest request) {
    return impl.get(request);
  }

  public PublishedDashboard getPublished(String dashboardId) {
    return getPublished(new GetPublishedDashboardRequest().setDashboardId(dashboardId));
  }

  /**
   * Get published dashboard.
   *
   * 
Get the current published dashboard.
   */
  public PublishedDashboard getPublished(GetPublishedDashboardRequest request) {
    return impl.getPublished(request);
  }

  public PublishedDashboard publish(String dashboardId) {
    return publish(new PublishRequest().setDashboardId(dashboardId));
  }

  /**
   * Publish dashboard.
   *
   * 
Publish the current draft dashboard.
   */
  public PublishedDashboard publish(PublishRequest request) {
    return impl.publish(request);
  }

  public void trash(String dashboardId) {
    trash(new TrashDashboardRequest().setDashboardId(dashboardId));
  }

  /**
   * Trash dashboard.
   *
   * 
Trash a dashboard.
   */
  public void trash(TrashDashboardRequest request) {
    impl.trash(request);
  }

  public Dashboard update(String dashboardId) {
    return update(new UpdateDashboardRequest().setDashboardId(dashboardId));
  }

  /**
   * Update dashboard.
   *
   * Update a draft dashboard.
   */
  public Dashboard update(UpdateDashboardRequest request) {
    return impl.update(request);
  }

  public LakeviewService impl() {
    return impl;
  }
}