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

com.seeq.model.ThresholdMetricOutputV1 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: 65.1.3-v202408082312
 * 
 *
 * 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.ItemPreviewV1;
import com.seeq.model.ItemPreviewWithAssetsV1;
import com.seeq.model.PermissionsV1;
import com.seeq.model.ScalarPropertyV1;
import com.seeq.model.ScalarValueOutputV1;
import com.seeq.model.ThresholdOutputV1;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
 * ThresholdMetricOutputV1
 */
public class ThresholdMetricOutputV1 {
  @JsonProperty("additionalProperties")
  private List additionalProperties = new ArrayList();

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

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

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

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

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

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

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

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

  @JsonProperty("displayItem")
  private ItemPreviewV1 displayItem = null;

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

  @JsonProperty("effectivePermissions")
  private PermissionsV1 effectivePermissions = null;

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

  @JsonProperty("isArchived")
  private Boolean isArchived = false;

  @JsonProperty("isRedacted")
  private Boolean isRedacted = false;

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

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

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

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

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

  /**
   * The process type of threshold metric. Will be Continuous if duration and period are specified, Condition if boundingCondition is specified, and otherwise Simple.
   */
  public enum ProcessTypeEnum {
    SIMPLE("Simple"),
    CONDITION("Condition"),
    CONTINUOUS("Continuous");

    private String value;

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

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

  }  @JsonProperty("processType")
  private ProcessTypeEnum processType = null;

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

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

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

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

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

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

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

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

   /**
   * Additional properties of the item
   * @return additionalProperties
  **/
  @Schema(description = "Additional properties of the item")
  public List getAdditionalProperties() {
    return additionalProperties;
  }

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

  public ThresholdMetricOutputV1 aggregationConditionId(String aggregationConditionId) {
    this.aggregationConditionId = aggregationConditionId;
    return this;
  }

   /**
   * The ID of the aggregation condition representing metric value information
   * @return aggregationConditionId
  **/
  @Schema(description = "The ID of the aggregation condition representing metric value information")
  public String getAggregationConditionId() {
    return aggregationConditionId;
  }

  public void setAggregationConditionId(String aggregationConditionId) {
    this.aggregationConditionId = aggregationConditionId;
  }

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

   /**
   * Aggregation formula that aggregates the measured item
   * @return aggregationFunction
  **/
  @Schema(description = "Aggregation formula that aggregates the measured item")
  public String getAggregationFunction() {
    return aggregationFunction;
  }

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

  public ThresholdMetricOutputV1 boundingCondition(ItemPreviewWithAssetsV1 boundingCondition) {
    this.boundingCondition = boundingCondition;
    return this;
  }

   /**
   * Get boundingCondition
   * @return boundingCondition
  **/
  @Schema(description = "")
  public ItemPreviewWithAssetsV1 getBoundingCondition() {
    return boundingCondition;
  }

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

  public ThresholdMetricOutputV1 boundingConditionMaximumDuration(ScalarValueOutputV1 boundingConditionMaximumDuration) {
    this.boundingConditionMaximumDuration = boundingConditionMaximumDuration;
    return this;
  }

   /**
   * Get boundingConditionMaximumDuration
   * @return boundingConditionMaximumDuration
  **/
  @Schema(description = "")
  public ScalarValueOutputV1 getBoundingConditionMaximumDuration() {
    return boundingConditionMaximumDuration;
  }

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

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

   /**
   * The data ID of this asset. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.
   * @return dataId
  **/
  @Schema(description = "The data ID of this asset. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.")
  public String getDataId() {
    return dataId;
  }

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

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

   /**
   * The datasource class, which is the type of system holding the item, such as OSIsoft PI
   * @return datasourceClass
  **/
  @Schema(description = "The datasource class, which is the type of system holding the item, such as OSIsoft PI")
  public String getDatasourceClass() {
    return datasourceClass;
  }

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

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

   /**
   * The datasource identifier, which is how the datasource holding this item identifies itself
   * @return datasourceId
  **/
  @Schema(description = "The datasource identifier, which is how the datasource holding this item identifies itself")
  public String getDatasourceId() {
    return datasourceId;
  }

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

  public ThresholdMetricOutputV1 description(String description) {
    this.description = description;
    return this;
  }

   /**
   * Clarifying information or other plain language description of this item
   * @return description
  **/
  @Schema(description = "Clarifying information or other plain language description of this item")
  public String getDescription() {
    return description;
  }

  public void setDescription(String description) {
    this.description = description;
  }

  public ThresholdMetricOutputV1 displayItem(ItemPreviewV1 displayItem) {
    this.displayItem = displayItem;
    return this;
  }

   /**
   * Get displayItem
   * @return displayItem
  **/
  @Schema(required = true, description = "")
  public ItemPreviewV1 getDisplayItem() {
    return displayItem;
  }

  public void setDisplayItem(ItemPreviewV1 displayItem) {
    this.displayItem = displayItem;
  }

  public ThresholdMetricOutputV1 duration(ScalarValueOutputV1 duration) {
    this.duration = duration;
    return this;
  }

   /**
   * Get duration
   * @return duration
  **/
  @Schema(description = "")
  public ScalarValueOutputV1 getDuration() {
    return duration;
  }

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

  public ThresholdMetricOutputV1 effectivePermissions(PermissionsV1 effectivePermissions) {
    this.effectivePermissions = effectivePermissions;
    return this;
  }

   /**
   * Get effectivePermissions
   * @return effectivePermissions
  **/
  @Schema(description = "")
  public PermissionsV1 getEffectivePermissions() {
    return effectivePermissions;
  }

  public void setEffectivePermissions(PermissionsV1 effectivePermissions) {
    this.effectivePermissions = effectivePermissions;
  }

  public ThresholdMetricOutputV1 id(String id) {
    this.id = id;
    return this;
  }

   /**
   * The ID that can be used to interact with the item
   * @return id
  **/
  @Schema(required = true, description = "The ID that can be used to interact with the item")
  public String getId() {
    return id;
  }

  public void setId(String id) {
    this.id = id;
  }

  public ThresholdMetricOutputV1 isArchived(Boolean isArchived) {
    this.isArchived = isArchived;
    return this;
  }

   /**
   * Whether item is archived
   * @return isArchived
  **/
  @Schema(description = "Whether item is archived")
  public Boolean getIsArchived() {
    return isArchived;
  }

  public void setIsArchived(Boolean isArchived) {
    this.isArchived = isArchived;
  }

  public ThresholdMetricOutputV1 isRedacted(Boolean isRedacted) {
    this.isRedacted = isRedacted;
    return this;
  }

   /**
   * Whether item is redacted
   * @return isRedacted
  **/
  @Schema(description = "Whether item is redacted")
  public Boolean getIsRedacted() {
    return isRedacted;
  }

  public void setIsRedacted(Boolean isRedacted) {
    this.isRedacted = isRedacted;
  }

  public ThresholdMetricOutputV1 measuredItem(ItemPreviewWithAssetsV1 measuredItem) {
    this.measuredItem = measuredItem;
    return this;
  }

   /**
   * Get measuredItem
   * @return measuredItem
  **/
  @Schema(required = true, description = "")
  public ItemPreviewWithAssetsV1 getMeasuredItem() {
    return measuredItem;
  }

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

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

   /**
   * The human readable name
   * @return name
  **/
  @Schema(required = true, description = "The human readable name")
  public String getName() {
    return name;
  }

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

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

   /**
   * Either the custom-set neutral color for this metric or the color of the neutral Priority
   * @return neutralColor
  **/
  @Schema(description = "Either the custom-set neutral color for this metric or the color of the neutral Priority")
  public String getNeutralColor() {
    return neutralColor;
  }

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

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

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

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

  public ThresholdMetricOutputV1 period(ScalarValueOutputV1 period) {
    this.period = period;
    return this;
  }

   /**
   * Get period
   * @return period
  **/
  @Schema(description = "")
  public ScalarValueOutputV1 getPeriod() {
    return period;
  }

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

  public ThresholdMetricOutputV1 processType(ProcessTypeEnum processType) {
    this.processType = processType;
    return this;
  }

   /**
   * The process type of threshold metric. Will be Continuous if duration and period are specified, Condition if boundingCondition is specified, and otherwise Simple.
   * @return processType
  **/
  @Schema(required = true, description = "The process type of threshold metric. Will be Continuous if duration and period are specified, Condition if boundingCondition is specified, and otherwise Simple.")
  public ProcessTypeEnum getProcessType() {
    return processType;
  }

  public void setProcessType(ProcessTypeEnum processType) {
    this.processType = processType;
  }

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

   /**
   * The ID of the workbook to which this item is scoped or null if it is in the global scope.
   * @return scopedTo
  **/
  @Schema(description = "The ID of the workbook to which this item is scoped or null if it is in the global scope.")
  public String getScopedTo() {
    return scopedTo;
  }

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

  public ThresholdMetricOutputV1 statusMessage(String statusMessage) {
    this.statusMessage = statusMessage;
    return this;
  }

   /**
   * A plain language status message with information about any issues that may have been encountered during an operation
   * @return statusMessage
  **/
  @Schema(description = "A plain language status message with information about any issues that may have been encountered during an operation")
  public String getStatusMessage() {
    return statusMessage;
  }

  public void setStatusMessage(String statusMessage) {
    this.statusMessage = statusMessage;
  }

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

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

   /**
   * The list of thresholds that are scalars, signals, or conditions along with the associated priority. These thresholds are those that were used as inputs and which are used to generate the condition thresholds
   * @return thresholds
  **/
  @Schema(description = "The list of thresholds that are scalars, signals, or conditions along with the associated priority. These thresholds are those that were used as inputs and which are used to generate the condition thresholds")
  public List getThresholds() {
    return thresholds;
  }

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

  public ThresholdMetricOutputV1 translationKey(String translationKey) {
    this.translationKey = translationKey;
    return this;
  }

   /**
   * The item's translation key, if any
   * @return translationKey
  **/
  @Schema(description = "The item's translation key, if any")
  public String getTranslationKey() {
    return translationKey;
  }

  public void setTranslationKey(String translationKey) {
    this.translationKey = translationKey;
  }

  public ThresholdMetricOutputV1 type(String type) {
    this.type = type;
    return this;
  }

   /**
   * The type of the item
   * @return type
  **/
  @Schema(required = true, description = "The type of the item")
  public String getType() {
    return type;
  }

  public void setType(String type) {
    this.type = type;
  }

  public ThresholdMetricOutputV1 valueUnitOfMeasure(String valueUnitOfMeasure) {
    this.valueUnitOfMeasure = valueUnitOfMeasure;
    return this;
  }

   /**
   * The unit of measure of the metric
   * @return valueUnitOfMeasure
  **/
  @Schema(description = "The unit of measure of the metric")
  public String getValueUnitOfMeasure() {
    return valueUnitOfMeasure;
  }

  public void setValueUnitOfMeasure(String valueUnitOfMeasure) {
    this.valueUnitOfMeasure = valueUnitOfMeasure;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ThresholdMetricOutputV1 thresholdMetricOutputV1 = (ThresholdMetricOutputV1) o;
    return Objects.equals(this.additionalProperties, thresholdMetricOutputV1.additionalProperties) &&
        Objects.equals(this.aggregationConditionId, thresholdMetricOutputV1.aggregationConditionId) &&
        Objects.equals(this.aggregationFunction, thresholdMetricOutputV1.aggregationFunction) &&
        Objects.equals(this.boundingCondition, thresholdMetricOutputV1.boundingCondition) &&
        Objects.equals(this.boundingConditionMaximumDuration, thresholdMetricOutputV1.boundingConditionMaximumDuration) &&
        Objects.equals(this.dataId, thresholdMetricOutputV1.dataId) &&
        Objects.equals(this.datasourceClass, thresholdMetricOutputV1.datasourceClass) &&
        Objects.equals(this.datasourceId, thresholdMetricOutputV1.datasourceId) &&
        Objects.equals(this.description, thresholdMetricOutputV1.description) &&
        Objects.equals(this.displayItem, thresholdMetricOutputV1.displayItem) &&
        Objects.equals(this.duration, thresholdMetricOutputV1.duration) &&
        Objects.equals(this.effectivePermissions, thresholdMetricOutputV1.effectivePermissions) &&
        Objects.equals(this.id, thresholdMetricOutputV1.id) &&
        Objects.equals(this.isArchived, thresholdMetricOutputV1.isArchived) &&
        Objects.equals(this.isRedacted, thresholdMetricOutputV1.isRedacted) &&
        Objects.equals(this.measuredItem, thresholdMetricOutputV1.measuredItem) &&
        Objects.equals(this.name, thresholdMetricOutputV1.name) &&
        Objects.equals(this.neutralColor, thresholdMetricOutputV1.neutralColor) &&
        Objects.equals(this.numberFormat, thresholdMetricOutputV1.numberFormat) &&
        Objects.equals(this.period, thresholdMetricOutputV1.period) &&
        Objects.equals(this.processType, thresholdMetricOutputV1.processType) &&
        Objects.equals(this.scopedTo, thresholdMetricOutputV1.scopedTo) &&
        Objects.equals(this.statusMessage, thresholdMetricOutputV1.statusMessage) &&
        Objects.equals(this.thresholds, thresholdMetricOutputV1.thresholds) &&
        Objects.equals(this.translationKey, thresholdMetricOutputV1.translationKey) &&
        Objects.equals(this.type, thresholdMetricOutputV1.type) &&
        Objects.equals(this.valueUnitOfMeasure, thresholdMetricOutputV1.valueUnitOfMeasure);
  }

  @Override
  public int hashCode() {
    return Objects.hash(additionalProperties, aggregationConditionId, aggregationFunction, boundingCondition, boundingConditionMaximumDuration, dataId, datasourceClass, datasourceId, description, displayItem, duration, effectivePermissions, id, isArchived, isRedacted, measuredItem, name, neutralColor, numberFormat, period, processType, scopedTo, statusMessage, thresholds, translationKey, type, valueUnitOfMeasure);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ThresholdMetricOutputV1 {\n");
    
    sb.append("    additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
    sb.append("    aggregationConditionId: ").append(toIndentedString(aggregationConditionId)).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("    description: ").append(toIndentedString(description)).append("\n");
    sb.append("    displayItem: ").append(toIndentedString(displayItem)).append("\n");
    sb.append("    duration: ").append(toIndentedString(duration)).append("\n");
    sb.append("    effectivePermissions: ").append(toIndentedString(effectivePermissions)).append("\n");
    sb.append("    id: ").append(toIndentedString(id)).append("\n");
    sb.append("    isArchived: ").append(toIndentedString(isArchived)).append("\n");
    sb.append("    isRedacted: ").append(toIndentedString(isRedacted)).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("    processType: ").append(toIndentedString(processType)).append("\n");
    sb.append("    scopedTo: ").append(toIndentedString(scopedTo)).append("\n");
    sb.append("    statusMessage: ").append(toIndentedString(statusMessage)).append("\n");
    sb.append("    thresholds: ").append(toIndentedString(thresholds)).append("\n");
    sb.append("    translationKey: ").append(toIndentedString(translationKey)).append("\n");
    sb.append("    type: ").append(toIndentedString(type)).append("\n");
    sb.append("    valueUnitOfMeasure: ").append(toIndentedString(valueUnitOfMeasure)).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