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

com.seeq.model.SignalOutputV1 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: 64.3.0-v202405012032
 * 
 *
 * 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.FormulaParameterOutputV1;
import com.seeq.model.PermissionsV1;
import com.seeq.model.ScalarPropertyV1;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.ArrayList;
import java.util.List;
/**
 * SignalOutputV1
 */
public class SignalOutputV1 {
  @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("effectivePermissions")
  private PermissionsV1 effectivePermissions = null;

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

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

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

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

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

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

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

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

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

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

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

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

  /**
   * The location this signal is stored in, if it is stored in Seeq
   */
  public enum StorageLocationEnum {
    FILE_SIGNAL_STORAGE("FILE_SIGNAL_STORAGE"),
    POSTGRES("POSTGRES");

    private String value;

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

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

  }  @JsonProperty("storageLocation")
  private StorageLocationEnum storageLocation = null;

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

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

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

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

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

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

   /**
   * The formula for the calculated item
   * @return formula
  **/
  @Schema(description = "The formula for the calculated item")
  public String getFormula() {
    return formula;
  }

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

  public SignalOutputV1 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 SignalOutputV1 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.
   * @return interpolationMethod
  **/
  @Schema(description = "The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step.")
  public String getInterpolationMethod() {
    return interpolationMethod;
  }

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

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

   /**
   * The unit of measure for the signal's keys
   * @return keyUnitOfMeasure
  **/
  @Schema(description = "The unit of measure for the signal's keys")
  public String getKeyUnitOfMeasure() {
    return keyUnitOfMeasure;
  }

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

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

   /**
   * The name of the package that contains this function.
   * @return packageName
  **/
  @Schema(description = "The name of the package that contains this function.")
  public String getPackageName() {
    return packageName;
  }

  public void setPackageName(String packageName) {
    this.packageName = packageName;
  }

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

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

   /**
   * Parameters that are used in the context of executing the formula
   * @return parameters
  **/
  @Schema(description = "Parameters that are used in the context of executing the formula")
  public List getParameters() {
    return parameters;
  }

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

  public SignalOutputV1 permissionsFromDatasource(Boolean permissionsFromDatasource) {
    this.permissionsFromDatasource = permissionsFromDatasource;
    return this;
  }

   /**
   * True if permissions are managed by the datasource, false if they are managed in Seeq
   * @return permissionsFromDatasource
  **/
  @Schema(description = "True if permissions are managed by the datasource, false if they are managed in Seeq")
  public Boolean getPermissionsFromDatasource() {
    return permissionsFromDatasource;
  }

  public void setPermissionsFromDatasource(Boolean permissionsFromDatasource) {
    this.permissionsFromDatasource = permissionsFromDatasource;
  }

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

   /**
   * Security string in Seeq format provided by datasource
   * @return securityString
  **/
  @Schema(description = "Security string in Seeq format provided by datasource")
  public String getSecurityString() {
    return securityString;
  }

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

  public SignalOutputV1 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 SignalOutputV1 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 SignalOutputV1 storageLocation(StorageLocationEnum storageLocation) {
    this.storageLocation = storageLocation;
    return this;
  }

   /**
   * The location this signal is stored in, if it is stored in Seeq
   * @return storageLocation
  **/
  @Schema(description = "The location this signal is stored in, if it is stored in Seeq")
  public StorageLocationEnum getStorageLocation() {
    return storageLocation;
  }

  public void setStorageLocation(StorageLocationEnum storageLocation) {
    this.storageLocation = storageLocation;
  }

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

   /**
   * The unit of measure for the signal's values
   * @return valueUnitOfMeasure
  **/
  @Schema(description = "The unit of measure for the signal's values")
  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;
    }
    SignalOutputV1 signalOutputV1 = (SignalOutputV1) o;
    return Objects.equals(this.additionalProperties, signalOutputV1.additionalProperties) &&
        Objects.equals(this.dataId, signalOutputV1.dataId) &&
        Objects.equals(this.datasourceClass, signalOutputV1.datasourceClass) &&
        Objects.equals(this.datasourceId, signalOutputV1.datasourceId) &&
        Objects.equals(this.description, signalOutputV1.description) &&
        Objects.equals(this.effectivePermissions, signalOutputV1.effectivePermissions) &&
        Objects.equals(this.formula, signalOutputV1.formula) &&
        Objects.equals(this.id, signalOutputV1.id) &&
        Objects.equals(this.interpolationMethod, signalOutputV1.interpolationMethod) &&
        Objects.equals(this.isArchived, signalOutputV1.isArchived) &&
        Objects.equals(this.isRedacted, signalOutputV1.isRedacted) &&
        Objects.equals(this.keyUnitOfMeasure, signalOutputV1.keyUnitOfMeasure) &&
        Objects.equals(this.maximumInterpolation, signalOutputV1.maximumInterpolation) &&
        Objects.equals(this.name, signalOutputV1.name) &&
        Objects.equals(this.numberFormat, signalOutputV1.numberFormat) &&
        Objects.equals(this.packageName, signalOutputV1.packageName) &&
        Objects.equals(this.parameters, signalOutputV1.parameters) &&
        Objects.equals(this.permissionsFromDatasource, signalOutputV1.permissionsFromDatasource) &&
        Objects.equals(this.scopedTo, signalOutputV1.scopedTo) &&
        Objects.equals(this.securityString, signalOutputV1.securityString) &&
        Objects.equals(this.sourceSecurityString, signalOutputV1.sourceSecurityString) &&
        Objects.equals(this.statusMessage, signalOutputV1.statusMessage) &&
        Objects.equals(this.storageLocation, signalOutputV1.storageLocation) &&
        Objects.equals(this.syncToken, signalOutputV1.syncToken) &&
        Objects.equals(this.translationKey, signalOutputV1.translationKey) &&
        Objects.equals(this.type, signalOutputV1.type) &&
        Objects.equals(this.valueUnitOfMeasure, signalOutputV1.valueUnitOfMeasure);
  }

  @Override
  public int hashCode() {
    return Objects.hash(additionalProperties, dataId, datasourceClass, datasourceId, description, effectivePermissions, formula, id, interpolationMethod, isArchived, isRedacted, keyUnitOfMeasure, maximumInterpolation, name, numberFormat, packageName, parameters, permissionsFromDatasource, scopedTo, securityString, sourceSecurityString, statusMessage, storageLocation, syncToken, translationKey, type, valueUnitOfMeasure);
  }


  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SignalOutputV1 {\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("    effectivePermissions: ").append(toIndentedString(effectivePermissions)).append("\n");
    sb.append("    formula: ").append(toIndentedString(formula)).append("\n");
    sb.append("    id: ").append(toIndentedString(id)).append("\n");
    sb.append("    interpolationMethod: ").append(toIndentedString(interpolationMethod)).append("\n");
    sb.append("    isArchived: ").append(toIndentedString(isArchived)).append("\n");
    sb.append("    isRedacted: ").append(toIndentedString(isRedacted)).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("    packageName: ").append(toIndentedString(packageName)).append("\n");
    sb.append("    parameters: ").append(toIndentedString(parameters)).append("\n");
    sb.append("    permissionsFromDatasource: ").append(toIndentedString(permissionsFromDatasource)).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("    statusMessage: ").append(toIndentedString(statusMessage)).append("\n");
    sb.append("    storageLocation: ").append(toIndentedString(storageLocation)).append("\n");
    sb.append("    syncToken: ").append(toIndentedString(syncToken)).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