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

com.seeq.model.SignalWithIdInputV1 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: 64.4.1-v202409112255
 * 
 *
 * 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;
/**
 * The signals to create or update
 */
@Schema(description = "The signals to create or update")
public class SignalWithIdInputV1 {
  @JsonProperty("additionalProperties")
  private List additionalProperties = 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("formulaParameters")
  private List formulaParameters = new ArrayList();

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

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

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

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

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

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

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

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

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

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

   /**
   * Additional properties to set on this signal. A property consists of a name, a value, and a unit of measure.
   * @return additionalProperties
  **/
  @Schema(description = "Additional properties to set on this signal. 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 SignalWithIdInputV1 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 SignalWithIdInputV1 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 SignalWithIdInputV1 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 SignalWithIdInputV1 description(String description) {
    this.description = description;
    return this;
  }

   /**
   * A description of the signal.
   * @return description
  **/
  @Schema(description = "A description of the signal.")
  public String getDescription() {
    return description;
  }

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

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

   /**
   * For a calculated signal, the Seeq Formula defining the signal.
   * @return formula
  **/
  @Schema(description = "For a calculated signal, the Seeq Formula defining the signal.")
  public String getFormula() {
    return formula;
  }

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

  public SignalWithIdInputV1 formulaParameters(List formulaParameters) {
    this.formulaParameters = formulaParameters;
    return this;
  }

  public SignalWithIdInputV1 addFormulaParametersItem(String formulaParametersItem) {
    if (this.formulaParameters == null) {
      this.formulaParameters = new ArrayList();
    }
    this.formulaParameters.add(formulaParametersItem);
    return this;
  }

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

  public void setFormulaParameters(List formulaParameters) {
    this.formulaParameters = formulaParameters;
  }

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

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

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

  public SignalWithIdInputV1 interpolationMethod(String interpolationMethod) {
    this.interpolationMethod = interpolationMethod;
    return this;
  }

   /**
   * The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step. If not specified, Linear will be used.
   * @return interpolationMethod
  **/
  @Schema(description = "The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step. If not specified, Linear will be used.")
  public String getInterpolationMethod() {
    return interpolationMethod;
  }

  public void setInterpolationMethod(String interpolationMethod) {
    this.interpolationMethod = interpolationMethod;
  }

  public SignalWithIdInputV1 keyUnitOfMeasure(String keyUnitOfMeasure) {
    this.keyUnitOfMeasure = keyUnitOfMeasure;
    return this;
  }

   /**
   * The unit of measure for the signal's keys. The default is a time-keyed signal, with key units of 'ns'.
   * @return keyUnitOfMeasure
  **/
  @Schema(description = "The unit of measure for the signal's keys. The default is a time-keyed signal, with key units of 'ns'.")
  public String getKeyUnitOfMeasure() {
    return keyUnitOfMeasure;
  }

  public void setKeyUnitOfMeasure(String keyUnitOfMeasure) {
    this.keyUnitOfMeasure = keyUnitOfMeasure;
  }

  public SignalWithIdInputV1 maximumInterpolation(String maximumInterpolation) {
    this.maximumInterpolation = maximumInterpolation;
    return this;
  }

   /**
   * The maximum spacing between adjacent sample keys that can be interpolated across. If two samples are spaced by more than maximum interpolation, there will be a hole in the signal between them.
   * @return maximumInterpolation
  **/
  @Schema(description = "The maximum spacing between adjacent sample keys that can be interpolated across. If two samples are spaced by more than maximum interpolation, there will be a hole in the signal between them.")
  public String getMaximumInterpolation() {
    return maximumInterpolation;
  }

  public void setMaximumInterpolation(String maximumInterpolation) {
    this.maximumInterpolation = maximumInterpolation;
  }

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

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

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

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

   /**
   * The ID of the workbook to which this item will be scoped. If not provided, the signal will have global scope.
   * @return scopedTo
  **/
  @Schema(description = "The ID of the workbook to which this item will be scoped. If not provided, the signal will have global scope.")
  public String getScopedTo() {
    return scopedTo;
  }

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

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

   /**
   * The unit of measure for the signal's values. The default is unitless.
   * @return valueUnitOfMeasure
  **/
  @Schema(description = "The unit of measure for the signal's values. The default is unitless.")
  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;
    }
    SignalWithIdInputV1 signalWithIdInputV1 = (SignalWithIdInputV1) o;
    return Objects.equals(this.additionalProperties, signalWithIdInputV1.additionalProperties) &&
        Objects.equals(this.dataId, signalWithIdInputV1.dataId) &&
        Objects.equals(this.datasourceClass, signalWithIdInputV1.datasourceClass) &&
        Objects.equals(this.datasourceId, signalWithIdInputV1.datasourceId) &&
        Objects.equals(this.description, signalWithIdInputV1.description) &&
        Objects.equals(this.formula, signalWithIdInputV1.formula) &&
        Objects.equals(this.formulaParameters, signalWithIdInputV1.formulaParameters) &&
        Objects.equals(this.historicalDataVersion, signalWithIdInputV1.historicalDataVersion) &&
        Objects.equals(this.interpolationMethod, signalWithIdInputV1.interpolationMethod) &&
        Objects.equals(this.keyUnitOfMeasure, signalWithIdInputV1.keyUnitOfMeasure) &&
        Objects.equals(this.maximumInterpolation, signalWithIdInputV1.maximumInterpolation) &&
        Objects.equals(this.name, signalWithIdInputV1.name) &&
        Objects.equals(this.numberFormat, signalWithIdInputV1.numberFormat) &&
        Objects.equals(this.previousDataId, signalWithIdInputV1.previousDataId) &&
        Objects.equals(this.scopedTo, signalWithIdInputV1.scopedTo) &&
        Objects.equals(this.securityString, signalWithIdInputV1.securityString) &&
        Objects.equals(this.sourceSecurityString, signalWithIdInputV1.sourceSecurityString) &&
        Objects.equals(this.syncToken, signalWithIdInputV1.syncToken) &&
        Objects.equals(this.valueUnitOfMeasure, signalWithIdInputV1.valueUnitOfMeasure);
  }

  @Override
  public int hashCode() {
    return Objects.hash(additionalProperties, dataId, datasourceClass, datasourceId, description, formula, formulaParameters, historicalDataVersion, interpolationMethod, keyUnitOfMeasure, maximumInterpolation, name, numberFormat, previousDataId, scopedTo, securityString, sourceSecurityString, syncToken, valueUnitOfMeasure);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SignalWithIdInputV1 {\n");
    
    sb.append("    additionalProperties: ").append(toIndentedString(additionalProperties)).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("    formulaParameters: ").append(toIndentedString(formulaParameters)).append("\n");
    sb.append("    historicalDataVersion: ").append(toIndentedString(historicalDataVersion)).append("\n");
    sb.append("    interpolationMethod: ").append(toIndentedString(interpolationMethod)).append("\n");
    sb.append("    keyUnitOfMeasure: ").append(toIndentedString(keyUnitOfMeasure)).append("\n");
    sb.append("    maximumInterpolation: ").append(toIndentedString(maximumInterpolation)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    numberFormat: ").append(toIndentedString(numberFormat)).append("\n");
    sb.append("    previousDataId: ").append(toIndentedString(previousDataId)).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("    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