com.databricks.sdk.service.sql.DashboardWidgetsAPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of databricks-sdk-java Show documentation

There is a newer version: 0.38.0

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

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

/**
 * This is an evolving API that facilitates the addition and removal of widgets from existing
 * dashboards within the Databricks Workspace. Data structures may change over time.
 */
@Generated
public class DashboardWidgetsAPI {
  private static final Logger LOG = LoggerFactory.getLogger(DashboardWidgetsAPI.class);

  private final DashboardWidgetsService impl;

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

  /** Constructor for mocks */
  public DashboardWidgetsAPI(DashboardWidgetsService mock) {
    impl = mock;
  }

  public Widget create(String dashboardId, WidgetOptions options, long width) {
    return create(
        new CreateWidget().setDashboardId(dashboardId).setOptions(options).setWidth(width));
  }

  /** Add widget to a dashboard. */
  public Widget create(CreateWidget request) {
    return impl.create(request);
  }

  public void delete(String id) {
    delete(new DeleteDashboardWidgetRequest().setId(id));
  }

  /** Remove widget. */
  public void delete(DeleteDashboardWidgetRequest request) {
    impl.delete(request);
  }

  public Widget update(String id, String dashboardId, WidgetOptions options, long width) {
    return update(
        new CreateWidget()
            .setId(id)
            .setDashboardId(dashboardId)
            .setOptions(options)
            .setWidth(width));
  }

  /** Update existing widget. */
  public Widget update(CreateWidget request) {
    return impl.update(request);
  }

  public DashboardWidgetsService impl() {
    return impl;
  }
}