Class ConditionInputV1

java.lang.Object
com.seeq.model.ConditionInputV1

public class ConditionInputV1 extends Object
ConditionInputV1
  • Constructor Details

    • ConditionInputV1

      public ConditionInputV1()
  • Method Details

    • additionalProperties

      public ConditionInputV1 additionalProperties(List<ScalarPropertyV1> additionalProperties)
    • addAdditionalPropertiesItem

      public ConditionInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

      public List<ScalarPropertyV1> getAdditionalProperties()
      Get additionalProperties
      Returns:
      additionalProperties
    • setAdditionalProperties

      public void setAdditionalProperties(List<ScalarPropertyV1> additionalProperties)
    • capsuleProperties

      public ConditionInputV1 capsuleProperties(List<CapsulePropertyInputV1> capsuleProperties)
    • addCapsulePropertiesItem

      public ConditionInputV1 addCapsulePropertiesItem(CapsulePropertyInputV1 capsulePropertiesItem)
    • getCapsuleProperties

      public List<CapsulePropertyInputV1> getCapsuleProperties()
      Property metadata for capsules on this condition. Only applicable to stored conditions.
      Returns:
      capsuleProperties
    • setCapsuleProperties

      public void setCapsuleProperties(List<CapsulePropertyInputV1> capsuleProperties)
    • dataId

      public ConditionInputV1 dataId(String dataId)
    • getDataId

      public String getDataId()
      The data ID of this item. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.
      Returns:
      dataId
    • setDataId

      public void setDataId(String dataId)
    • datasourceClass

      public ConditionInputV1 datasourceClass(String datasourceClass)
    • getDatasourceClass

      public String getDatasourceClass()
      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.
      Returns:
      datasourceClass
    • setDatasourceClass

      public void setDatasourceClass(String datasourceClass)
    • datasourceId

      public ConditionInputV1 datasourceId(String datasourceId)
    • getDatasourceId

      public String getDatasourceId()
      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.
      Returns:
      datasourceId
    • setDatasourceId

      public void setDatasourceId(String datasourceId)
    • description

      public ConditionInputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • formula

      public ConditionInputV1 formula(String formula)
    • getFormula

      public String getFormula()
      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
      Returns:
      formula
    • setFormula

      public void setFormula(String formula)
    • historicalDataVersion

      public ConditionInputV1 historicalDataVersion(String historicalDataVersion)
    • getHistoricalDataVersion

      public String getHistoricalDataVersion()
      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.
      Returns:
      historicalDataVersion
    • setHistoricalDataVersion

      public void setHistoricalDataVersion(String historicalDataVersion)
    • hostId

      public ConditionInputV1 hostId(String hostId)
    • getHostId

      public String getHostId()
      The ID of the datasource hosting this item. Note that this is a Seeq-generated ID, not the way that the datasource identifies itself.
      Returns:
      hostId
    • setHostId

      public void setHostId(String hostId)
    • maximumDuration

      public ConditionInputV1 maximumDuration(String maximumDuration)
    • getMaximumDuration

      public String getMaximumDuration()
      The maximum duration of capsules in this series. Required for stored conditions.
      Returns:
      maximumDuration
    • setMaximumDuration

      public void setMaximumDuration(String maximumDuration)
    • name

      public ConditionInputV1 name(String name)
    • getName

      public String getName()
      Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.
      Returns:
      name
    • setName

      public void setName(String name)
    • parameters

      public ConditionInputV1 parameters(List<String> parameters)
    • addParametersItem

      public ConditionInputV1 addParametersItem(String parametersItem)
    • getParameters

      public List<String> getParameters()
      Get parameters
      Returns:
      parameters
    • setParameters

      public void setParameters(List<String> parameters)
    • properties

      public ConditionInputV1 properties(List<ScalarPropertyV1> properties)
    • addPropertiesItem

      public ConditionInputV1 addPropertiesItem(ScalarPropertyV1 propertiesItem)
    • getProperties

      public List<ScalarPropertyV1> getProperties()
      Get properties
      Returns:
      properties
    • setProperties

      public void setProperties(List<ScalarPropertyV1> properties)
    • scopedTo

      public ConditionInputV1 scopedTo(String scopedTo)
    • getScopedTo

      public String getScopedTo()
      The ID of the workbook to which this item will be scoped.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(String scopedTo)
    • securityString

      public ConditionInputV1 securityString(String securityString)
    • getSecurityString

      public String getSecurityString()
      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.
      Returns:
      securityString
    • setSecurityString

      public void setSecurityString(String securityString)
    • sourceSecurityString

      public ConditionInputV1 sourceSecurityString(String sourceSecurityString)
    • getSourceSecurityString

      public String getSourceSecurityString()
      The security string as it was originally found on the source (for debugging ACLs only)
      Returns:
      sourceSecurityString
    • setSourceSecurityString

      public void setSourceSecurityString(String sourceSecurityString)
    • syncToken

      public ConditionInputV1 syncToken(String syncToken)
    • getSyncToken

      public String getSyncToken()
      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.
      Returns:
      syncToken
    • setSyncToken

      public void setSyncToken(String syncToken)
    • unitOfMeasure

      public ConditionInputV1 unitOfMeasure(String unitOfMeasure)
    • getUnitOfMeasure

      public String getUnitOfMeasure()
      Get unitOfMeasure
      Returns:
      unitOfMeasure
    • setUnitOfMeasure

      public void setUnitOfMeasure(String unitOfMeasure)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object