Class PutScalarInputV1

java.lang.Object
com.seeq.model.PutScalarInputV1

public class PutScalarInputV1 extends Object
A list of scalars to create or update
  • Constructor Details

    • PutScalarInputV1

      public PutScalarInputV1()
  • Method Details

    • additionalProperties

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

      public PutScalarInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

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

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

      public PutScalarInputV1 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 PutScalarInputV1 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 PutScalarInputV1 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 PutScalarInputV1 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 PutScalarInputV1 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)
    • hostId

      public PutScalarInputV1 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)
    • name

      public PutScalarInputV1 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)
    • numberFormat

      public PutScalarInputV1 numberFormat(String numberFormat)
    • getNumberFormat

      public String getNumberFormat()
      The format string used for numbers associated with this signal. The format for the string follows ECMA-376 spreadsheet format standards.
      Returns:
      numberFormat
    • setNumberFormat

      public void setNumberFormat(String numberFormat)
    • parameters

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

      public PutScalarInputV1 addParametersItem(String parametersItem)
    • getParameters

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

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

      public PutScalarInputV1 previousDataId(String previousDataId)
    • getPreviousDataId

      public String getPreviousDataId()
      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
      Returns:
      previousDataId
    • setPreviousDataId

      public void setPreviousDataId(String previousDataId)
    • properties

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

      public PutScalarInputV1 addPropertiesItem(ScalarPropertyV1 propertiesItem)
    • getProperties

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

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

      public PutScalarInputV1 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 PutScalarInputV1 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 PutScalarInputV1 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 PutScalarInputV1 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 PutScalarInputV1 unitOfMeasure(String unitOfMeasure)
    • getUnitOfMeasure

      public String getUnitOfMeasure()
      The unit of measure for this Scalar. Added to its formula if parsable by Seeq
      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