Class DatafileInputV1

java.lang.Object
com.seeq.model.DatafileInputV1

public class DatafileInputV1 extends Object
DatafileInputV1
  • Constructor Details

    • DatafileInputV1

      public DatafileInputV1()
  • Method Details

    • additionalProperties

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

      public DatafileInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

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

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

      public DatafileInputV1 append(Boolean append)
    • getAppend

      public Boolean getAppend()
      If true, append the data in this CSV file to the signals or condition.
      Returns:
      append
    • setAppend

      public void setAppend(Boolean append)
    • conditionName

      public DatafileInputV1 conditionName(String conditionName)
    • getConditionName

      public String getConditionName()
      The name to use for the condition being imported. If this datafile already has a condition by this name, the import will modify the already existing condition rather than creating another condition with the same name. This setting is ignored when importing signals.
      Returns:
      conditionName
    • setConditionName

      public void setConditionName(String conditionName)
    • dataId

      public DatafileInputV1 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)
    • dayFirstDefault

      public DatafileInputV1 dayFirstDefault(Boolean dayFirstDefault)
    • getDayFirstDefault

      public Boolean getDayFirstDefault()
      If true, assume day first dates when ambiguous. If false (default), assume month first dates when ambiguous. For example, 07/01/16 is ambiguous and could be a day first or month first date. This setting is only used when there is not enough information in the column to distinguish month first from day first dates.
      Returns:
      dayFirstDefault
    • setDayFirstDefault

      public void setDayFirstDefault(Boolean dayFirstDefault)
    • description

      public DatafileInputV1 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)
    • descriptionRow

      public DatafileInputV1 descriptionRow(Integer descriptionRow)
    • getDescriptionRow

      public Integer getDescriptionRow()
      Integer that identifies the row containing the description for each signal. If there is no such row, set to 0. If not specified, defaults to 0. (Row 1 is the first row of the file.) If importing a condition, the content of this row is ignored.
      Returns:
      descriptionRow
    • setDescriptionRow

      public void setDescriptionRow(Integer descriptionRow)
    • endColumnIndex

      public DatafileInputV1 endColumnIndex(Integer endColumnIndex)
    • getEndColumnIndex

      public Integer getEndColumnIndex()
      Integer that identifies the column containing the capsule end key for the condition. If not specified, defaults to keyColumnIndex + 1. If endColumnName is specified, this setting will be ignored. If importing a signal, this setting is ignored.
      Returns:
      endColumnIndex
    • setEndColumnIndex

      public void setEndColumnIndex(Integer endColumnIndex)
    • endColumnName

      public DatafileInputV1 endColumnName(String endColumnName)
    • getEndColumnName

      public String getEndColumnName()
      The name of the column containing the capsule end key for the condition. If not specified or whitespace, the endColumnIndex will be used. If specified, the endColumnIndex will be ignored.
      Returns:
      endColumnName
    • setEndColumnName

      public void setEndColumnName(String endColumnName)
    • fieldDelimiter

      public DatafileInputV1 fieldDelimiter(DatafileInputV1.FieldDelimiterEnum fieldDelimiter)
    • getFieldDelimiter

      public DatafileInputV1.FieldDelimiterEnum getFieldDelimiter()
      The character used as the CSV field delimiter. The possibilities are comma, semicolon, and tab. If not specified, defaults to comma.
      Returns:
      fieldDelimiter
    • setFieldDelimiter

      public void setFieldDelimiter(DatafileInputV1.FieldDelimiterEnum fieldDelimiter)
    • filename

      public DatafileInputV1 filename(String filename)
    • getFilename

      public String getFilename()
      The name of the file that the client uploaded. Useful for keeping track of what file was used to create the Datafile.
      Returns:
      filename
    • setFilename

      public void setFilename(String filename)
    • firstDataRow

      public DatafileInputV1 firstDataRow(Integer firstDataRow)
    • getFirstDataRow

      public Integer getFirstDataRow()
      Integer that identifies the row at which to start reading the data. If not specified, defaults to 2. (Row 1 is the first row of the file.)
      Returns:
      firstDataRow
    • setFirstDataRow

      public void setFirstDataRow(Integer firstDataRow)
    • hostId

      public DatafileInputV1 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)
    • interpolationMethod

      public DatafileInputV1 interpolationMethod(String interpolationMethod)
    • getInterpolationMethod

      public String getInterpolationMethod()
      The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step. If not specified, defaults to Linear. If an interpolation method row is specified, the information in that row overrides this setting. If importing a condition, this setting is ignored.
      Returns:
      interpolationMethod
    • setInterpolationMethod

      public void setInterpolationMethod(String interpolationMethod)
    • interpolationMethodRow

      public DatafileInputV1 interpolationMethodRow(Integer interpolationMethodRow)
    • getInterpolationMethodRow

      public Integer getInterpolationMethodRow()
      Integer that identifies the row containing the interpolation method for each signal. If there is no such row, set to 0. If not specified, defaults to 0. If an interpolation method in the row is not recognized, the import will fail. If an interpolation method in the row is blank, the interpolationMethod setting will be used as the default. (Row 1 is the first row of the file.)If importing a condition, the content of this row is ignored.
      Returns:
      interpolationMethodRow
    • setInterpolationMethodRow

      public void setInterpolationMethodRow(Integer interpolationMethodRow)
    • itemType

      public DatafileInputV1 itemType(DatafileInputV1.ItemTypeEnum itemType)
    • getItemType

      public DatafileInputV1.ItemTypeEnum getItemType()
      The type of item to be imported from the CSV file. Supported types include signal and condition.
      Returns:
      itemType
    • setItemType

      public void setItemType(DatafileInputV1.ItemTypeEnum itemType)
    • keyColumnIndex

      public DatafileInputV1 keyColumnIndex(Integer keyColumnIndex)
    • getKeyColumnIndex

      public Integer getKeyColumnIndex()
      Integer that identifies the column containing the sample timestamps for the signal(s) or the column containing the capsule start key for the condition. If not specified, defaults to 1, the first column. If keyColumnName is specified, this setting will be ignored.
      Returns:
      keyColumnIndex
    • setKeyColumnIndex

      public void setKeyColumnIndex(Integer keyColumnIndex)
    • keyColumnName

      public DatafileInputV1 keyColumnName(String keyColumnName)
    • getKeyColumnName

      public String getKeyColumnName()
      The name of the column containing the signal timestamps for the signal(s) or the column containing the capsule start key for the condition. If not specified or whitespace, the keyColumnIndex will be used. If specified, the keyColumnIndex will be ignored.
      Returns:
      keyColumnName
    • setKeyColumnName

      public void setKeyColumnName(String keyColumnName)
    • keyFormat

      public DatafileInputV1 keyFormat(DatafileInputV1.KeyFormatEnum keyFormat)
    • getKeyFormat

      public DatafileInputV1.KeyFormatEnum getKeyFormat()
      The format of the sample timestamps for signals or the format of the capsule start and end times for a condition. If not specified, defaults to ISO8601.
      Returns:
      keyFormat
    • setKeyFormat

      public void setKeyFormat(DatafileInputV1.KeyFormatEnum keyFormat)
    • lenientDaylightSavings

      public DatafileInputV1 lenientDaylightSavings(Boolean lenientDaylightSavings)
    • getLenientDaylightSavings

      public Boolean getLenientDaylightSavings()
      If true, hours are allowed that don't exist due to the spring forward daylight savings transition. They are interpreted as occurring in the following hour. The true setting should not be needed if the data was logged appropriately for its time zone. If false (default), data in hours that don't exist will cause the import to fail.
      Returns:
      lenientDaylightSavings
    • setLenientDaylightSavings

      public void setLenientDaylightSavings(Boolean lenientDaylightSavings)
    • maximumDuration

      public DatafileInputV1 maximumDuration(String maximumDuration)
    • getMaximumDuration

      public String getMaximumDuration()
      The maximum duration of the capsules in the condition. Capsules greater than this duration will be imported but will not returned when data from the condition is requested. If importing a signal, this setting is ignored.
      Returns:
      maximumDuration
    • setMaximumDuration

      public void setMaximumDuration(String maximumDuration)
    • maximumInterpolation

      public DatafileInputV1 maximumInterpolation(String maximumInterpolation)
    • getMaximumInterpolation

      public String getMaximumInterpolation()
      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. If not specified, defaults to 40h. If a maximum interpolation row is specified, the information in that row overrides this setting. If importing a condition, this setting is ignored.
      Returns:
      maximumInterpolation
    • setMaximumInterpolation

      public void setMaximumInterpolation(String maximumInterpolation)
    • maximumInterpolationRow

      public DatafileInputV1 maximumInterpolationRow(Integer maximumInterpolationRow)
    • getMaximumInterpolationRow

      public Integer getMaximumInterpolationRow()
      Integer that identifies the row containing the maximum interpolation for each signal. If there is no such row, set to 0. If not specified, defaults to 0. If a maximum duration in the row is not recognized, the import will fail. If an maximum interpolation in the row is blank, the maximumInterpolation setting will be used as the default. (Row 1 is the first row of the file.)If importing a condition, the content of this row is ignored.
      Returns:
      maximumInterpolationRow
    • setMaximumInterpolationRow

      public void setMaximumInterpolationRow(Integer maximumInterpolationRow)
    • name

      public DatafileInputV1 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)
    • namePrefix

      public DatafileInputV1 namePrefix(String namePrefix)
    • getNamePrefix

      public String getNamePrefix()
      Prefix prepended to the name of each signal when importing signal(s) and prepended to the name of each capsule property when importing a condition. Leading whitespace is ignored.
      Returns:
      namePrefix
    • setNamePrefix

      public void setNamePrefix(String namePrefix)
    • nameRow

      public DatafileInputV1 nameRow(Integer nameRow)
    • getNameRow

      public Integer getNameRow()
      Integer that identifies the header row used to name the signal(s) when importing signal(s) and used to name the capsule properties when importing a condition. If not specified, defaults to 1 (first row). The name row is required and must have unique non-whitespace entries.
      Returns:
      nameRow
    • setNameRow

      public void setNameRow(Integer nameRow)
    • nameSuffix

      public DatafileInputV1 nameSuffix(String nameSuffix)
    • getNameSuffix

      public String getNameSuffix()
      Suffix appended to the name of each signal when importing signal(s) and appended to the name of each capsule property when importing a condition. Trailing whitespace is ignored.
      Returns:
      nameSuffix
    • setNameSuffix

      public void setNameSuffix(String nameSuffix)
    • properties

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

      public DatafileInputV1 addPropertiesItem(ScalarPropertyV1 propertiesItem)
    • getProperties

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

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

      public DatafileInputV1 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)
    • timeZone

      public DatafileInputV1 timeZone(String timeZone)
    • getTimeZone

      public String getTimeZone()
      If the timestamps (key for signals, start/end for a condition) contain no time zone information, they will be interpreted as being in this time zone. If not specified and the timestamps contain no time zone information, the time zone of the Seeq server is used. If the timestamps contain time zone information, this setting is ignored.
      Returns:
      timeZone
    • setTimeZone

      public void setTimeZone(String timeZone)
    • uploadFilename

      public DatafileInputV1 uploadFilename(String uploadFilename)
    • getUploadFilename

      public String getUploadFilename()
      The server-side name of the CSV file that is returned from the upload endpoint.
      Returns:
      uploadFilename
    • setUploadFilename

      public void setUploadFilename(String uploadFilename)
    • validationMode

      public DatafileInputV1 validationMode(DatafileInputV1.ValidationModeEnum validationMode)
    • getValidationMode

      public DatafileInputV1.ValidationModeEnum getValidationMode()
      The approach to use when CSV data cannot be parsed. Choices are Fail, Skip, Invalid. If Fail (default), then cells that cannot be parsed will cause the import to fail with error messages.If Skip, those cells will be skipped meaning that no sample will be created for signals from that row of the file. For conditions, if it is the start or end cell, no capsule will be created from that row. If the cell is a capsule property, the capsule is still created but without that capsule property. If Invalid and the cell is a sample key or capsule start/end, no sample or capsule is created from that row of the file. If the cell is a sample value or capsule property, the sample or capsule property is created with the value INVALID.
      Returns:
      validationMode
    • setValidationMode

      public void setValidationMode(DatafileInputV1.ValidationModeEnum validationMode)
    • valueColumnIndices

      public DatafileInputV1 valueColumnIndices(String valueColumnIndices)
    • getValueColumnIndices

      public String getValueColumnIndices()
      List of integers identifying the columns to import. When importing signals, these columns will be combined with the key column to create signals. When importing a condition, these columns will become the capsule properties. Valid formats are a comma separated list of 'N' or 'N-M' where N and M are integers greater than zero and M >= N. Example: '2, 5-7, 10, 12-14'. The first column of the file is column 1. If the column(s) representing a signal key or condition start/end is included in the list, it will be ignored. If neither valueColumnNames nor valueColumnIndices are specified, all columns other than the key/start/end column will result in signals when importing signals and will result in capsule properties when importing a condition. An entry of 0 alone indicates that no columns should be imported as capsule properties. If a column in this list cannot be found in the file, the import will fail. Any column is only imported once no matter how many times it is listed.
      Returns:
      valueColumnIndices
    • setValueColumnIndices

      public void setValueColumnIndices(String valueColumnIndices)
    • valueColumnNames

      public DatafileInputV1 valueColumnNames(String valueColumnNames)
    • getValueColumnNames

      public String getValueColumnNames()
      List of comma separated case sensitive names of the columns to import. When importing signals, these columns will be combined with the key column to create signals. When importing a condition, these columns will become the capsule properties. If the column(s) representing a signal key or condition start/end is included in the list, it will be ignored. If not specified, valueColumnIndices will be used. If specified, valueColumnIndices will be ignored. If a column name in this list cannot be found in the file, the import will fail. Any column is only imported once no matter how many times it is listed.
      Returns:
      valueColumnNames
    • setValueColumnNames

      public void setValueColumnNames(String valueColumnNames)
    • valueUom

      public DatafileInputV1 valueUom(String valueUom)
    • getValueUom

      public String getValueUom()
      The unit of measure to be used for every signal when importing signals and for every capsule property when importing a condition. If not specified, defaults to unitless. If a unit of measure row is specified, the information in that row overrides this setting. If this unit of measure is not recognized, the import will fail.
      Returns:
      valueUom
    • setValueUom

      public void setValueUom(String valueUom)
    • valueUomRow

      public DatafileInputV1 valueUomRow(Integer valueUomRow)
    • getValueUomRow

      public Integer getValueUomRow()
      Integer that identifies the row containing the unit of measure for each signal when importing signal(s) or for each capsule property when importing a condition. If there is no such row, set to 0. If not specified, defaults to 0. If a unit of measure in the row is not recognized, unitless will be used instead. (Row 1 is the first row of the file.)
      Returns:
      valueUomRow
    • setValueUomRow

      public void setValueUomRow(Integer valueUomRow)
    • 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