com.databricks.sdk.service.ml.SearchRuns 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.ml;

import com.databricks.sdk.support.Generated;
import com.databricks.sdk.support.ToStringer;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Collection;
import java.util.Objects;

@Generated
public class SearchRuns {
  /** List of experiment IDs to search over. */
  @JsonProperty("experiment_ids")
  private Collection experimentIds;

  /**
   * A filter expression over params, metrics, and tags, that allows returning a subset of runs. The
   * syntax is a subset of SQL that supports ANDing together binary operations between a param,
   * metric, or tag and a constant.
   *
   * Example: `metrics.rmse < 1 and params.model_class = 'LogisticRegression'`
   *
   * 
You can select columns with special characters (hyphen, space, period, etc.) by using double
   * quotes: `metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'`
   *
   * Supported operators are `=`, `!=`, `>`, `>=`, `<`, and `<=`.
   */
  @JsonProperty("filter")
  private String filter;

  /** Maximum number of runs desired. Max threshold is 50000 */
  @JsonProperty("max_results")
  private Long maxResults;

  /**
   * List of columns to be ordered by, including attributes, params, metrics, and tags with an
   * optional "DESC" or "ASC" annotation, where "ASC" is the default. Example: ["params.input DESC",
   * "metrics.alpha ASC", "metrics.rmse"] Tiebreaks are done by start_time DESC followed by run_id
   * for runs with the same start time (and this is the default ordering criterion if order_by is
   * not provided).
   */
  @JsonProperty("order_by")
  private Collection orderBy;

  /** Token for the current page of runs. */
  @JsonProperty("page_token")
  private String pageToken;

  /** Whether to display only active, only deleted, or all runs. Defaults to only active runs. */
  @JsonProperty("run_view_type")
  private SearchRunsRunViewType runViewType;

  public SearchRuns setExperimentIds(Collection experimentIds) {
    this.experimentIds = experimentIds;
    return this;
  }

  public Collection getExperimentIds() {
    return experimentIds;
  }

  public SearchRuns setFilter(String filter) {
    this.filter = filter;
    return this;
  }

  public String getFilter() {
    return filter;
  }

  public SearchRuns setMaxResults(Long maxResults) {
    this.maxResults = maxResults;
    return this;
  }

  public Long getMaxResults() {
    return maxResults;
  }

  public SearchRuns setOrderBy(Collection orderBy) {
    this.orderBy = orderBy;
    return this;
  }

  public Collection getOrderBy() {
    return orderBy;
  }

  public SearchRuns setPageToken(String pageToken) {
    this.pageToken = pageToken;
    return this;
  }

  public String getPageToken() {
    return pageToken;
  }

  public SearchRuns setRunViewType(SearchRunsRunViewType runViewType) {
    this.runViewType = runViewType;
    return this;
  }

  public SearchRunsRunViewType getRunViewType() {
    return runViewType;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    SearchRuns that = (SearchRuns) o;
    return Objects.equals(experimentIds, that.experimentIds)
        && Objects.equals(filter, that.filter)
        && Objects.equals(maxResults, that.maxResults)
        && Objects.equals(orderBy, that.orderBy)
        && Objects.equals(pageToken, that.pageToken)
        && Objects.equals(runViewType, that.runViewType);
  }

  @Override
  public int hashCode() {
    return Objects.hash(experimentIds, filter, maxResults, orderBy, pageToken, runViewType);
  }

  @Override
  public String toString() {
    return new ToStringer(SearchRuns.class)
        .add("experimentIds", experimentIds)
        .add("filter", filter)
        .add("maxResults", maxResults)
        .add("orderBy", orderBy)
        .add("pageToken", pageToken)
        .add("runViewType", runViewType)
        .toString();
  }
}