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

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

There is a newer version: 66.0.0-v202410141803
Show newest version
/*
 * Seeq REST API
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: 63.1.6-v202409101657
 * 
 *
 * 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 com.seeq.model.ScalarPropertyV1;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
 * ThresholdMetricInputV1
 */
public class ThresholdMetricInputV1 {
  @JsonProperty("additionalProperties")
  private List additionalProperties = new ArrayList();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  public ThresholdMetricInputV1 additionalProperties(List additionalProperties) {
    this.additionalProperties = additionalProperties;
    return this;
  }

  public ThresholdMetricInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem) {
    if (this.additionalProperties == null) {
      this.additionalProperties = new ArrayList();
    }
    this.additionalProperties.add(additionalPropertiesItem);
    return this;
  }

   /**
   * Additional properties to set on this threshold metric. A property consists of a name, a value, and a unit of measure.
   * @return additionalProperties
  **/
  @Schema(description = "Additional properties to set on this threshold metric. A property consists of a name, a value, and a unit of measure.")
  public List getAdditionalProperties() {
    return additionalProperties;
  }

  public void setAdditionalProperties(List additionalProperties) {
    this.additionalProperties = additionalProperties;
  }

  public ThresholdMetricInputV1 aggregationFunction(String aggregationFunction) {
    this.aggregationFunction = aggregationFunction;
    return this;
  }

   /**
   * Aggregation formula function that can aggregate the measured item and used when evaluating the thresholds as well as for display in outputs such as scorecard.
   * @return aggregationFunction
  **/
  @Schema(description = "Aggregation formula function that can aggregate the measured item and used when evaluating the thresholds as well as for display in outputs such as scorecard.")
  public String getAggregationFunction() {
    return aggregationFunction;
  }

  public void setAggregationFunction(String aggregationFunction) {
    this.aggregationFunction = aggregationFunction;
  }

  public ThresholdMetricInputV1 boundingCondition(String boundingCondition) {
    this.boundingCondition = boundingCondition;
    return this;
  }

   /**
   * Used when measuring a batch process, the ID of a condition that will be used to aggregate the measured item and to break scorecard output into multiple columns, one per capsule.
   * @return boundingCondition
  **/
  @Schema(description = "Used when measuring a batch process, the ID of a condition that will be used to aggregate the measured item and to break scorecard output into multiple columns, one per capsule.")
  public String getBoundingCondition() {
    return boundingCondition;
  }

  public void setBoundingCondition(String boundingCondition) {
    this.boundingCondition = boundingCondition;
  }

  public ThresholdMetricInputV1 boundingConditionMaximumDuration(String boundingConditionMaximumDuration) {
    this.boundingConditionMaximumDuration = boundingConditionMaximumDuration;
    return this;
  }

   /**
   * If bounding condition is used and does not have a Maximum Capsule Duration this value must be supplied to allow aggregation.
   * @return boundingConditionMaximumDuration
  **/
  @Schema(description = "If bounding condition is used and does not have a Maximum Capsule Duration this value must be supplied to allow aggregation.")
  public String getBoundingConditionMaximumDuration() {
    return boundingConditionMaximumDuration;
  }

  public void setBoundingConditionMaximumDuration(String boundingConditionMaximumDuration) {
    this.boundingConditionMaximumDuration = boundingConditionMaximumDuration;
  }

  public ThresholdMetricInputV1 dataId(String dataId) {
    this.dataId = dataId;
    return this;
  }

   /**
   * A unique identifier for the metric within its datasource.
   * @return dataId
  **/
  @Schema(description = "A unique identifier for the metric within its datasource.")
  public String getDataId() {
    return dataId;
  }

  public void setDataId(String dataId) {
    this.dataId = dataId;
  }

  public ThresholdMetricInputV1 datasourceClass(String datasourceClass) {
    this.datasourceClass = datasourceClass;
    return this;
  }

   /**
   * Along with the Datasource ID, the Datasource Class uniquely identifies a datasource. For example, a datasource may be a particular instance of an OSIsoft PI historian.
   * @return datasourceClass
  **/
  @Schema(description = "Along with the Datasource ID, the Datasource Class uniquely identifies a datasource. For example, a datasource may be a particular instance of an OSIsoft PI historian.")
  public String getDatasourceClass() {
    return datasourceClass;
  }

  public void setDatasourceClass(String datasourceClass) {
    this.datasourceClass = datasourceClass;
  }

  public ThresholdMetricInputV1 datasourceId(String datasourceId) {
    this.datasourceId = datasourceId;
    return this;
  }

   /**
   * Along with the Datasource Class, the Datasource ID uniquely identifies a datasource. For example, a datasource may be a particular instance of an OSIsoft PI historian.
   * @return datasourceId
  **/
  @Schema(description = "Along with the Datasource Class, the Datasource ID uniquely identifies a datasource. For example, a datasource may be a particular instance of an OSIsoft PI historian.")
  public String getDatasourceId() {
    return datasourceId;
  }

  public void setDatasourceId(String datasourceId) {
    this.datasourceId = datasourceId;
  }

  public ThresholdMetricInputV1 duration(String duration) {
    this.duration = duration;
    return this;
  }

   /**
   * Used when measuring a continuous process, the duration over which to calculate a moving aggregation. Example: 1day
   * @return duration
  **/
  @Schema(description = "Used when measuring a continuous process, the duration over which to calculate a moving aggregation. Example: 1day")
  public String getDuration() {
    return duration;
  }

  public void setDuration(String duration) {
    this.duration = duration;
  }

  public ThresholdMetricInputV1 measuredItem(String measuredItem) {
    this.measuredItem = measuredItem;
    return this;
  }

   /**
   * ID of an input Signal or Condition to measure. This item is measured using the thresholds to find deviations.
   * @return measuredItem
  **/
  @Schema(required = true, description = "ID of an input Signal or Condition to measure. This item is measured using the thresholds to find deviations.")
  public String getMeasuredItem() {
    return measuredItem;
  }

  public void setMeasuredItem(String measuredItem) {
    this.measuredItem = measuredItem;
  }

  public ThresholdMetricInputV1 name(String name) {
    this.name = name;
    return this;
  }

   /**
   * The name of the metric.
   * @return name
  **/
  @Schema(required = true, description = "The name of the metric.")
  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public ThresholdMetricInputV1 neutralColor(String neutralColor) {
    this.neutralColor = neutralColor;
    return this;
  }

   /**
   * A hex code that specifies a color that will override the neutral (level 0) priority color
   * @return neutralColor
  **/
  @Schema(description = "A hex code that specifies a color that will override the neutral (level 0) priority color")
  public String getNeutralColor() {
    return neutralColor;
  }

  public void setNeutralColor(String neutralColor) {
    this.neutralColor = neutralColor;
  }

  public ThresholdMetricInputV1 numberFormat(String numberFormat) {
    this.numberFormat = numberFormat;
    return this;
  }

   /**
   * The format string used for numbers associated with this signal. The format for the string follows ECMA-376 spreadsheet format standards.
   * @return numberFormat
  **/
  @Schema(description = "The format string used for numbers associated with this signal. The format for the string follows ECMA-376 spreadsheet format standards.")
  public String getNumberFormat() {
    return numberFormat;
  }

  public void setNumberFormat(String numberFormat) {
    this.numberFormat = numberFormat;
  }

  public ThresholdMetricInputV1 period(String period) {
    this.period = period;
    return this;
  }

   /**
   * Used when measuring a continuous process, the period at which to sample when creating the moving aggregation. Example: 30min
   * @return period
  **/
  @Schema(description = "Used when measuring a continuous process, the period at which to sample when creating the moving aggregation. Example: 30min")
  public String getPeriod() {
    return period;
  }

  public void setPeriod(String period) {
    this.period = period;
  }

  public ThresholdMetricInputV1 scopedTo(String scopedTo) {
    this.scopedTo = scopedTo;
    return this;
  }

   /**
   * The ID of the workbook to which this item will be scoped.
   * @return scopedTo
  **/
  @Schema(description = "The ID of the workbook to which this item will be scoped.")
  public String getScopedTo() {
    return scopedTo;
  }

  public void setScopedTo(String scopedTo) {
    this.scopedTo = scopedTo;
  }

  public ThresholdMetricInputV1 syncToken(String syncToken) {
    this.syncToken = syncToken;
    return this;
  }

   /**
   * An arbitrary token (often a date or random ID) that is used during metadata syncs. At the end of a full sync, items with mismatching sync tokens are identified as stale and will be archived using the Datasources clean-up API.
   * @return syncToken
  **/
  @Schema(description = "An arbitrary token (often a date or random ID) that is used during metadata syncs. At the end of a full sync, items with mismatching sync tokens are identified as stale and will be archived using the Datasources clean-up API.")
  public String getSyncToken() {
    return syncToken;
  }

  public void setSyncToken(String syncToken) {
    this.syncToken = syncToken;
  }

  public ThresholdMetricInputV1 thresholds(List thresholds) {
    this.thresholds = thresholds;
    return this;
  }

  public ThresholdMetricInputV1 addThresholdsItem(String thresholdsItem) {
    if (this.thresholds == null) {
      this.thresholds = new ArrayList();
    }
    this.thresholds.add(thresholdsItem);
    return this;
  }

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

  public void setThresholds(List thresholds) {
    this.thresholds = thresholds;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ThresholdMetricInputV1 thresholdMetricInputV1 = (ThresholdMetricInputV1) o;
    return Objects.equals(this.additionalProperties, thresholdMetricInputV1.additionalProperties) &&
        Objects.equals(this.aggregationFunction, thresholdMetricInputV1.aggregationFunction) &&
        Objects.equals(this.boundingCondition, thresholdMetricInputV1.boundingCondition) &&
        Objects.equals(this.boundingConditionMaximumDuration, thresholdMetricInputV1.boundingConditionMaximumDuration) &&
        Objects.equals(this.dataId, thresholdMetricInputV1.dataId) &&
        Objects.equals(this.datasourceClass, thresholdMetricInputV1.datasourceClass) &&
        Objects.equals(this.datasourceId, thresholdMetricInputV1.datasourceId) &&
        Objects.equals(this.duration, thresholdMetricInputV1.duration) &&
        Objects.equals(this.measuredItem, thresholdMetricInputV1.measuredItem) &&
        Objects.equals(this.name, thresholdMetricInputV1.name) &&
        Objects.equals(this.neutralColor, thresholdMetricInputV1.neutralColor) &&
        Objects.equals(this.numberFormat, thresholdMetricInputV1.numberFormat) &&
        Objects.equals(this.period, thresholdMetricInputV1.period) &&
        Objects.equals(this.scopedTo, thresholdMetricInputV1.scopedTo) &&
        Objects.equals(this.syncToken, thresholdMetricInputV1.syncToken) &&
        Objects.equals(this.thresholds, thresholdMetricInputV1.thresholds);
  }

  @Override
  public int hashCode() {
    return Objects.hash(additionalProperties, aggregationFunction, boundingCondition, boundingConditionMaximumDuration, dataId, datasourceClass, datasourceId, duration, measuredItem, name, neutralColor, numberFormat, period, scopedTo, syncToken, thresholds);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ThresholdMetricInputV1 {\n");
    
    sb.append("    additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
    sb.append("    aggregationFunction: ").append(toIndentedString(aggregationFunction)).append("\n");
    sb.append("    boundingCondition: ").append(toIndentedString(boundingCondition)).append("\n");
    sb.append("    boundingConditionMaximumDuration: ").append(toIndentedString(boundingConditionMaximumDuration)).append("\n");
    sb.append("    dataId: ").append(toIndentedString(dataId)).append("\n");
    sb.append("    datasourceClass: ").append(toIndentedString(datasourceClass)).append("\n");
    sb.append("    datasourceId: ").append(toIndentedString(datasourceId)).append("\n");
    sb.append("    duration: ").append(toIndentedString(duration)).append("\n");
    sb.append("    measuredItem: ").append(toIndentedString(measuredItem)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    neutralColor: ").append(toIndentedString(neutralColor)).append("\n");
    sb.append("    numberFormat: ").append(toIndentedString(numberFormat)).append("\n");
    sb.append("    period: ").append(toIndentedString(period)).append("\n");
    sb.append("    scopedTo: ").append(toIndentedString(scopedTo)).append("\n");
    sb.append("    syncToken: ").append(toIndentedString(syncToken)).append("\n");
    sb.append("    thresholds: ").append(toIndentedString(thresholds)).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