All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.seeq.model.FormulaRunInputV1 Maven / Gradle / Ivy

There is a newer version: 66.0.0-v202407310200
Show newest version
/*
 * Seeq REST API
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: 60.1.3-v202304250417
 * 
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */

package com.seeq.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
 * FormulaRunInputV1
 */
public class FormulaRunInputV1 {
  @JsonProperty("end")
  private String end = null;

  @JsonProperty("formula")
  private String formula = null;

  @JsonProperty("fragments")
  private List fragments = new ArrayList();

  @JsonProperty("function")
  private String function = null;

  @JsonProperty("limit")
  private Integer limit = null;

  @JsonProperty("offset")
  private Integer offset = null;

  @JsonProperty("parameters")
  private List parameters = new ArrayList();

  @JsonProperty("reduceFormula")
  private String reduceFormula = null;

  @JsonProperty("root")
  private String root = null;

  @JsonProperty("start")
  private String start = null;

  /**
   * The format to output time fields as. One of ISO8601, Nanoseconds, or Legacy, which          outputs whatever the default was before this field was added. Defaults to \"Legacy\".
   */
  public enum TimeFormatEnum {
    LEGACY("Legacy"),
    ISO8601("ISO8601"),
    NANOSECONDS("Nanoseconds");

    private String value;

    TimeFormatEnum(String value) {
      this.value = value;
    }
    @JsonValue
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }
    @JsonCreator
    public static TimeFormatEnum fromValue(String input) {
      for (TimeFormatEnum b : TimeFormatEnum.values()) {
        if (b.value.equals(input)) {
          return b;
        }
      }
      return null;
    }

  }  @JsonProperty("timeFormat")
  private TimeFormatEnum timeFormat = null;

  public FormulaRunInputV1 end(String end) {
    this.end = end;
    return this;
  }

   /**
   * A string representing the ending index of the data to be returned.             The contents and whether or not it is required depends on the series type. For time series: a ISO 8601             timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) keys: a double-precision             number, optionally including units. For example: \"2.5ft\" or \"10 °C\"
   * @return end
  **/
  @Schema(description = "A string representing the ending index of the data to be returned.             The contents and whether or not it is required depends on the series type. For time series: a ISO 8601             timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) keys: a double-precision             number, optionally including units. For example: \"2.5ft\" or \"10 °C\"")
  public String getEnd() {
    return end;
  }

  public void setEnd(String end) {
    this.end = end;
  }

  public FormulaRunInputV1 formula(String formula) {
    this.formula = formula;
    return this;
  }

   /**
   * The formula to be applied
   * @return formula
  **/
  @Schema(required = true, description = "The formula to be applied")
  public String getFormula() {
    return formula;
  }

  public void setFormula(String formula) {
    this.formula = formula;
  }

  public FormulaRunInputV1 fragments(List fragments) {
    this.fragments = fragments;
    return this;
  }

  public FormulaRunInputV1 addFragmentsItem(String fragmentsItem) {
    if (this.fragments == null) {
      this.fragments = new ArrayList();
    }
    this.fragments.add(fragmentsItem);
    return this;
  }

   /**
   * Get fragments
   * @return fragments
  **/
  @Schema(description = "")
  public List getFragments() {
    return fragments;
  }

  public void setFragments(List fragments) {
    this.fragments = fragments;
  }

  public FormulaRunInputV1 function(String function) {
    this.function = function;
    return this;
  }

   /**
   * The ID of a function item for calling formulas with unbound values
   * @return function
  **/
  @Schema(description = "The ID of a function item for calling formulas with unbound values")
  public String getFunction() {
    return function;
  }

  public void setFunction(String function) {
    this.function = function;
  }

  public FormulaRunInputV1 limit(Integer limit) {
    this.limit = limit;
    return this;
  }

   /**
   * The pagination limit, the total number of collection items that will be returned              in this page of results. Defaults to 1000
   * @return limit
  **/
  @Schema(description = "The pagination limit, the total number of collection items that will be returned              in this page of results. Defaults to 1000")
  public Integer getLimit() {
    return limit;
  }

  public void setLimit(Integer limit) {
    this.limit = limit;
  }

  public FormulaRunInputV1 offset(Integer offset) {
    this.offset = offset;
    return this;
  }

   /**
   * The pagination offset, the index of the first collection item that             will be returned in this page of results. Defaults to 0
   * @return offset
  **/
  @Schema(description = "The pagination offset, the index of the first collection item that             will be returned in this page of results. Defaults to 0")
  public Integer getOffset() {
    return offset;
  }

  public void setOffset(Integer offset) {
    this.offset = offset;
  }

  public FormulaRunInputV1 parameters(List parameters) {
    this.parameters = parameters;
    return this;
  }

  public FormulaRunInputV1 addParametersItem(String parametersItem) {
    this.parameters.add(parametersItem);
    return this;
  }

   /**
   * Get parameters
   * @return parameters
  **/
  @Schema(required = true, description = "")
  public List getParameters() {
    return parameters;
  }

  public void setParameters(List parameters) {
    this.parameters = parameters;
  }

  public FormulaRunInputV1 reduceFormula(String reduceFormula) {
    this.reduceFormula = reduceFormula;
    return this;
  }

   /**
   * Used when running a formula across assets, this is a formula that can further reduce the              results of each asset result. The variable $result             must be used to reference the data. Example of sorting the aggregated results:             $result.sort('temperature')'
   * @return reduceFormula
  **/
  @Schema(description = "Used when running a formula across assets, this is a formula that can further reduce the              results of each asset result. The variable $result             must be used to reference the data. Example of sorting the aggregated results:             $result.sort('temperature')'")
  public String getReduceFormula() {
    return reduceFormula;
  }

  public void setReduceFormula(String reduceFormula) {
    this.reduceFormula = reduceFormula;
  }

  public FormulaRunInputV1 root(String root) {
    this.root = root;
    return this;
  }

   /**
   * Used to run a formula across assets, this is the ID of the root asset whose immediate             children will be iterated. The formula must produce a table.
   * @return root
  **/
  @Schema(description = "Used to run a formula across assets, this is the ID of the root asset whose immediate             children will be iterated. The formula must produce a table.")
  public String getRoot() {
    return root;
  }

  public void setRoot(String root) {
    this.root = root;
  }

  public FormulaRunInputV1 start(String start) {
    this.start = start;
    return this;
  }

   /**
   * A string representing the starting index of the data to be returned.             The contents and whether or not it is required depends on the series type. For time series: a ISO 8601             timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) keys: a double-precision             number, optionally including units. For example: \"2.5ft\" or \"10 °C\"
   * @return start
  **/
  @Schema(description = "A string representing the starting index of the data to be returned.             The contents and whether or not it is required depends on the series type. For time series: a ISO 8601             timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). For numeric (non-time) keys: a double-precision             number, optionally including units. For example: \"2.5ft\" or \"10 °C\"")
  public String getStart() {
    return start;
  }

  public void setStart(String start) {
    this.start = start;
  }

  public FormulaRunInputV1 timeFormat(TimeFormatEnum timeFormat) {
    this.timeFormat = timeFormat;
    return this;
  }

   /**
   * The format to output time fields as. One of ISO8601, Nanoseconds, or Legacy, which          outputs whatever the default was before this field was added. Defaults to \"Legacy\".
   * @return timeFormat
  **/
  @Schema(description = "The format to output time fields as. One of ISO8601, Nanoseconds, or Legacy, which          outputs whatever the default was before this field was added. Defaults to \"Legacy\".")
  public TimeFormatEnum getTimeFormat() {
    return timeFormat;
  }

  public void setTimeFormat(TimeFormatEnum timeFormat) {
    this.timeFormat = timeFormat;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    FormulaRunInputV1 formulaRunInputV1 = (FormulaRunInputV1) o;
    return Objects.equals(this.end, formulaRunInputV1.end) &&
        Objects.equals(this.formula, formulaRunInputV1.formula) &&
        Objects.equals(this.fragments, formulaRunInputV1.fragments) &&
        Objects.equals(this.function, formulaRunInputV1.function) &&
        Objects.equals(this.limit, formulaRunInputV1.limit) &&
        Objects.equals(this.offset, formulaRunInputV1.offset) &&
        Objects.equals(this.parameters, formulaRunInputV1.parameters) &&
        Objects.equals(this.reduceFormula, formulaRunInputV1.reduceFormula) &&
        Objects.equals(this.root, formulaRunInputV1.root) &&
        Objects.equals(this.start, formulaRunInputV1.start) &&
        Objects.equals(this.timeFormat, formulaRunInputV1.timeFormat);
  }

  @Override
  public int hashCode() {
    return Objects.hash(end, formula, fragments, function, limit, offset, parameters, reduceFormula, root, start, timeFormat);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class FormulaRunInputV1 {\n");
    
    sb.append("    end: ").append(toIndentedString(end)).append("\n");
    sb.append("    formula: ").append(toIndentedString(formula)).append("\n");
    sb.append("    fragments: ").append(toIndentedString(fragments)).append("\n");
    sb.append("    function: ").append(toIndentedString(function)).append("\n");
    sb.append("    limit: ").append(toIndentedString(limit)).append("\n");
    sb.append("    offset: ").append(toIndentedString(offset)).append("\n");
    sb.append("    parameters: ").append(toIndentedString(parameters)).append("\n");
    sb.append("    reduceFormula: ").append(toIndentedString(reduceFormula)).append("\n");
    sb.append("    root: ").append(toIndentedString(root)).append("\n");
    sb.append("    start: ").append(toIndentedString(start)).append("\n");
    sb.append("    timeFormat: ").append(toIndentedString(timeFormat)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
  
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy