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

com.seeq.model.ConditionUpdateInputV1 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.CapsulePropertyInputV1;
import com.seeq.model.ScalarPropertyV1;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
 * ConditionUpdateInputV1
 */
public class ConditionUpdateInputV1 {
  @JsonProperty("additionalProperties")
  private List additionalProperties = new ArrayList();

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

  @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("formula")
  private String formula = null;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  public ConditionUpdateInputV1 capsuleProperties(List capsuleProperties) {
    this.capsuleProperties = capsuleProperties;
    return this;
  }

  public ConditionUpdateInputV1 addCapsulePropertiesItem(CapsulePropertyInputV1 capsulePropertiesItem) {
    if (this.capsuleProperties == null) {
      this.capsuleProperties = new ArrayList();
    }
    this.capsuleProperties.add(capsulePropertiesItem);
    return this;
  }

   /**
   * Property metadata for capsules on this condition. Only applicable to stored conditions.
   * @return capsuleProperties
  **/
  @Schema(description = "Property metadata for capsules on this condition. Only applicable to stored conditions.")
  public List getCapsuleProperties() {
    return capsuleProperties;
  }

  public void setCapsuleProperties(List capsuleProperties) {
    this.capsuleProperties = capsuleProperties;
  }

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

   /**
   * The data ID of this item. 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 item. 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 ConditionUpdateInputV1 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 ConditionUpdateInputV1 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 ConditionUpdateInputV1 description(String description) {
    this.description = description;
    return this;
  }

   /**
   * Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.
   * @return description
  **/
  @Schema(description = "Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.")
  public String getDescription() {
    return description;
  }

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

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

   /**
   * Information about the formula used to create a calculated item. Not marked as required because this class is extended by classes where it is optional
   * @return formula
  **/
  @Schema(description = "Information about the formula used to create a calculated item. Not marked as required because this class is extended by classes where it is optional")
  public String getFormula() {
    return formula;
  }

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

  public ConditionUpdateInputV1 historicalDataVersion(String historicalDataVersion) {
    this.historicalDataVersion = historicalDataVersion;
    return this;
  }

   /**
   * This property tells Seeq that certain, and thus potentially cached, capsules in the past have been changed. Changing the value of this property will will clear the cache of this condition and all formulas that depend on it. It should not be changed when new uncached capsules are coming in. Changes to this property have no effect on calculated conditions.
   * @return historicalDataVersion
  **/
  @Schema(description = "This property tells Seeq that certain, and thus potentially cached, capsules in the past have been changed. Changing the value of this property will will clear the cache of this condition and all formulas that depend on it. It should not be changed when new uncached capsules are coming in. Changes to this property have no effect on calculated conditions.")
  public String getHistoricalDataVersion() {
    return historicalDataVersion;
  }

  public void setHistoricalDataVersion(String historicalDataVersion) {
    this.historicalDataVersion = historicalDataVersion;
  }

  public ConditionUpdateInputV1 hostId(String hostId) {
    this.hostId = hostId;
    return this;
  }

   /**
   * The ID of the datasource hosting this item. Note that this is a Seeq-generated ID, not the way that the datasource identifies itself.
   * @return hostId
  **/
  @Schema(description = "The ID of the datasource hosting this item. Note that this is a Seeq-generated ID, not the way that the datasource identifies itself.")
  public String getHostId() {
    return hostId;
  }

  public void setHostId(String hostId) {
    this.hostId = hostId;
  }

  public ConditionUpdateInputV1 maximumDuration(String maximumDuration) {
    this.maximumDuration = maximumDuration;
    return this;
  }

   /**
   * The maximum duration of capsules in this series. Required for stored conditions.
   * @return maximumDuration
  **/
  @Schema(required = true, description = "The maximum duration of capsules in this series. Required for stored conditions.")
  public String getMaximumDuration() {
    return maximumDuration;
  }

  public void setMaximumDuration(String maximumDuration) {
    this.maximumDuration = maximumDuration;
  }

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

   /**
   * Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.
   * @return name
  **/
  @Schema(required = true, description = "Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.")
  public String getName() {
    return name;
  }

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

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

  public ConditionUpdateInputV1 addParametersItem(String parametersItem) {
    if (this.parameters == null) {
      this.parameters = new ArrayList();
    }
    this.parameters.add(parametersItem);
    return this;
  }

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

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

  public ConditionUpdateInputV1 previousDataId(String previousDataId) {
    this.previousDataId = previousDataId;
    return this;
  }

   /**
   * Previous Data ID for the item within its datasource; ignored if null. It should only be used when the Data ID of an item in a datasource is being changed but should still map to the same item in Seeq - this could be because a datasource item has been moved or to improve logic related to the use of Data IDs
   * @return previousDataId
  **/
  @Schema(description = "Previous Data ID for the item within its datasource; ignored if null. It should only be used when the Data ID of an item in a datasource is being changed but should still map to the same item in Seeq - this could be because a datasource item has been moved or to improve logic related to the use of Data IDs")
  public String getPreviousDataId() {
    return previousDataId;
  }

  public void setPreviousDataId(String previousDataId) {
    this.previousDataId = previousDataId;
  }

  public ConditionUpdateInputV1 properties(List properties) {
    this.properties = properties;
    return this;
  }

  public ConditionUpdateInputV1 addPropertiesItem(ScalarPropertyV1 propertiesItem) {
    if (this.properties == null) {
      this.properties = new ArrayList();
    }
    this.properties.add(propertiesItem);
    return this;
  }

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

  public void setProperties(List properties) {
    this.properties = properties;
  }

  public ConditionUpdateInputV1 replaceCapsuleProperties(Boolean replaceCapsuleProperties) {
    this.replaceCapsuleProperties = replaceCapsuleProperties;
    return this;
  }

   /**
   * When true, remove all capsule properties that are not specified incapsuleProperties on the condition input; not used for calculated or stored-in-Seeq conditions
   * @return replaceCapsuleProperties
  **/
  @Schema(description = "When true, remove all capsule properties that are not specified incapsuleProperties on the condition input; not used for calculated or stored-in-Seeq conditions")
  public Boolean getReplaceCapsuleProperties() {
    return replaceCapsuleProperties;
  }

  public void setReplaceCapsuleProperties(Boolean replaceCapsuleProperties) {
    this.replaceCapsuleProperties = replaceCapsuleProperties;
  }

  public ConditionUpdateInputV1 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 ConditionUpdateInputV1 securityString(String securityString) {
    this.securityString = securityString;
    return this;
  }

   /**
   * Security string containing all identities and their permissions for the item. If set, permissions can only be managed by the connector and not in Seeq.
   * @return securityString
  **/
  @Schema(description = "Security string containing all identities and their permissions for the item. If set, permissions can only be managed by the connector and not in Seeq.")
  public String getSecurityString() {
    return securityString;
  }

  public void setSecurityString(String securityString) {
    this.securityString = securityString;
  }

  public ConditionUpdateInputV1 sourceSecurityString(String sourceSecurityString) {
    this.sourceSecurityString = sourceSecurityString;
    return this;
  }

   /**
   * The security string as it was originally found on the source (for debugging ACLs only)
   * @return sourceSecurityString
  **/
  @Schema(description = "The security string as it was originally found on the source (for debugging ACLs only)")
  public String getSourceSecurityString() {
    return sourceSecurityString;
  }

  public void setSourceSecurityString(String sourceSecurityString) {
    this.sourceSecurityString = sourceSecurityString;
  }

  public ConditionUpdateInputV1 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 may 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 may be archived using the Datasources clean-up API.")
  public String getSyncToken() {
    return syncToken;
  }

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

  public ConditionUpdateInputV1 unitOfMeasure(String unitOfMeasure) {
    this.unitOfMeasure = unitOfMeasure;
    return this;
  }

   /**
   * Get unitOfMeasure
   * @return unitOfMeasure
  **/
  @Schema(description = "")
  public String getUnitOfMeasure() {
    return unitOfMeasure;
  }

  public void setUnitOfMeasure(String unitOfMeasure) {
    this.unitOfMeasure = unitOfMeasure;
  }


  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ConditionUpdateInputV1 conditionUpdateInputV1 = (ConditionUpdateInputV1) o;
    return Objects.equals(this.additionalProperties, conditionUpdateInputV1.additionalProperties) &&
        Objects.equals(this.capsuleProperties, conditionUpdateInputV1.capsuleProperties) &&
        Objects.equals(this.dataId, conditionUpdateInputV1.dataId) &&
        Objects.equals(this.datasourceClass, conditionUpdateInputV1.datasourceClass) &&
        Objects.equals(this.datasourceId, conditionUpdateInputV1.datasourceId) &&
        Objects.equals(this.description, conditionUpdateInputV1.description) &&
        Objects.equals(this.formula, conditionUpdateInputV1.formula) &&
        Objects.equals(this.historicalDataVersion, conditionUpdateInputV1.historicalDataVersion) &&
        Objects.equals(this.hostId, conditionUpdateInputV1.hostId) &&
        Objects.equals(this.maximumDuration, conditionUpdateInputV1.maximumDuration) &&
        Objects.equals(this.name, conditionUpdateInputV1.name) &&
        Objects.equals(this.parameters, conditionUpdateInputV1.parameters) &&
        Objects.equals(this.previousDataId, conditionUpdateInputV1.previousDataId) &&
        Objects.equals(this.properties, conditionUpdateInputV1.properties) &&
        Objects.equals(this.replaceCapsuleProperties, conditionUpdateInputV1.replaceCapsuleProperties) &&
        Objects.equals(this.scopedTo, conditionUpdateInputV1.scopedTo) &&
        Objects.equals(this.securityString, conditionUpdateInputV1.securityString) &&
        Objects.equals(this.sourceSecurityString, conditionUpdateInputV1.sourceSecurityString) &&
        Objects.equals(this.syncToken, conditionUpdateInputV1.syncToken) &&
        Objects.equals(this.unitOfMeasure, conditionUpdateInputV1.unitOfMeasure);
  }

  @Override
  public int hashCode() {
    return Objects.hash(additionalProperties, capsuleProperties, dataId, datasourceClass, datasourceId, description, formula, historicalDataVersion, hostId, maximumDuration, name, parameters, previousDataId, properties, replaceCapsuleProperties, scopedTo, securityString, sourceSecurityString, syncToken, unitOfMeasure);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ConditionUpdateInputV1 {\n");
    
    sb.append("    additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
    sb.append("    capsuleProperties: ").append(toIndentedString(capsuleProperties)).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("    formula: ").append(toIndentedString(formula)).append("\n");
    sb.append("    historicalDataVersion: ").append(toIndentedString(historicalDataVersion)).append("\n");
    sb.append("    hostId: ").append(toIndentedString(hostId)).append("\n");
    sb.append("    maximumDuration: ").append(toIndentedString(maximumDuration)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    parameters: ").append(toIndentedString(parameters)).append("\n");
    sb.append("    previousDataId: ").append(toIndentedString(previousDataId)).append("\n");
    sb.append("    properties: ").append(toIndentedString(properties)).append("\n");
    sb.append("    replaceCapsuleProperties: ").append(toIndentedString(replaceCapsuleProperties)).append("\n");
    sb.append("    scopedTo: ").append(toIndentedString(scopedTo)).append("\n");
    sb.append("    securityString: ").append(toIndentedString(securityString)).append("\n");
    sb.append("    sourceSecurityString: ").append(toIndentedString(sourceSecurityString)).append("\n");
    sb.append("    syncToken: ").append(toIndentedString(syncToken)).append("\n");
    sb.append("    unitOfMeasure: ").append(toIndentedString(unitOfMeasure)).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