Class DatafileOutputV1

java.lang.Object
com.seeq.model.DatafileOutputV1

public class DatafileOutputV1 extends Object
DatafileOutputV1
  • Constructor Details

    • DatafileOutputV1

      public DatafileOutputV1()
  • Method Details

    • additionalProperties

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

      public DatafileOutputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem)
    • getAdditionalProperties

      public List<ScalarPropertyV1> getAdditionalProperties()
      Additional properties of the item
      Returns:
      additionalProperties
    • setAdditionalProperties

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

      public DatafileOutputV1 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 DatafileOutputV1 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)
    • createdAt

      public DatafileOutputV1 createdAt(String createdAt)
    • getCreatedAt

      public String getCreatedAt()
      The ISO 8601 date of when the datafile was created (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)
      Returns:
      createdAt
    • setCreatedAt

      public void setCreatedAt(String createdAt)
    • dataId

      public DatafileOutputV1 dataId(String dataId)
    • getDataId

      public String getDataId()
      The data ID of this asset. 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 DatafileOutputV1 datasourceClass(String datasourceClass)
    • getDatasourceClass

      public String getDatasourceClass()
      The datasource class, which is the type of system holding the item, such as OSIsoft PI
      Returns:
      datasourceClass
    • setDatasourceClass

      public void setDatasourceClass(String datasourceClass)
    • datasourceId

      public DatafileOutputV1 datasourceId(String datasourceId)
    • getDatasourceId

      public String getDatasourceId()
      The datasource identifier, which is how the datasource holding this item identifies itself
      Returns:
      datasourceId
    • setDatasourceId

      public void setDatasourceId(String datasourceId)
    • dayFirstDefault

      public DatafileOutputV1 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 DatafileOutputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • descriptionRow

      public DatafileOutputV1 descriptionRow(Long descriptionRow)
    • getDescriptionRow

      public Long getDescriptionRow()
      Integer that identifies the row containing the description for each signal. A setting of 0 indicates that there is no description header row. (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(Long descriptionRow)
    • effectivePermissions

      public DatafileOutputV1 effectivePermissions(PermissionsV1 effectivePermissions)
    • getEffectivePermissions

      public PermissionsV1 getEffectivePermissions()
      Get effectivePermissions
      Returns:
      effectivePermissions
    • setEffectivePermissions

      public void setEffectivePermissions(PermissionsV1 effectivePermissions)
    • endColumnIndex

      public DatafileOutputV1 endColumnIndex(Long endColumnIndex)
    • getEndColumnIndex

      public Long getEndColumnIndex()
      Integer that identifies the column containing the capsule end key for the condition. If importing a signal, this setting is ignored.
      Returns:
      endColumnIndex
    • setEndColumnIndex

      public void setEndColumnIndex(Long endColumnIndex)
    • endColumnName

      public DatafileOutputV1 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.
      Returns:
      endColumnName
    • setEndColumnName

      public void setEndColumnName(String endColumnName)
    • fieldDelimiter

      public DatafileOutputV1 fieldDelimiter(DatafileOutputV1.FieldDelimiterEnum fieldDelimiter)
    • getFieldDelimiter

      public DatafileOutputV1.FieldDelimiterEnum getFieldDelimiter()
      The character used as the CSV field delimiter.
      Returns:
      fieldDelimiter
    • setFieldDelimiter

      public void setFieldDelimiter(DatafileOutputV1.FieldDelimiterEnum fieldDelimiter)
    • filename

      public DatafileOutputV1 filename(String filename)
    • getFilename

      public String getFilename()
      The name and path of the CSV file used to generate the content
      Returns:
      filename
    • setFilename

      public void setFilename(String filename)
    • firstDataRow

      public DatafileOutputV1 firstDataRow(Long firstDataRow)
    • getFirstDataRow

      public Long getFirstDataRow()
      Integer that identifies the row at which to start reading the data. (Row 1 is the first row of the file.)
      Returns:
      firstDataRow
    • setFirstDataRow

      public void setFirstDataRow(Long firstDataRow)
    • id

      public DatafileOutputV1 id(String id)
    • getId

      public String getId()
      The ID that can be used to interact with the item
      Returns:
      id
    • setId

      public void setId(String id)
    • interpolationMethod

      public DatafileOutputV1 interpolationMethod(String interpolationMethod)
    • getInterpolationMethod

      public String getInterpolationMethod()
      The interpolation method used to represent the values between samples in the signal. If a maximum interpolation 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 DatafileOutputV1 interpolationMethodRow(Long interpolationMethodRow)
    • getInterpolationMethodRow

      public Long getInterpolationMethodRow()
      Integer that identifies the row containing the interpolation method for each signal. A setting of 0 indicates that there is no interpolation method header row. (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(Long interpolationMethodRow)
    • isArchived

      public DatafileOutputV1 isArchived(Boolean isArchived)
    • getIsArchived

      public Boolean getIsArchived()
      Whether item is archived
      Returns:
      isArchived
    • setIsArchived

      public void setIsArchived(Boolean isArchived)
    • isRedacted

      public DatafileOutputV1 isRedacted(Boolean isRedacted)
    • getIsRedacted

      public Boolean getIsRedacted()
      Whether item is redacted
      Returns:
      isRedacted
    • setIsRedacted

      public void setIsRedacted(Boolean isRedacted)
    • itemType

      public DatafileOutputV1 itemType(DatafileOutputV1.ItemTypeEnum itemType)
    • getItemType

      public DatafileOutputV1.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(DatafileOutputV1.ItemTypeEnum itemType)
    • keyColumnIndex

      public DatafileOutputV1 keyColumnIndex(Long keyColumnIndex)
    • getKeyColumnIndex

      public Long 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. Column 1 is the first column of the file.
      Returns:
      keyColumnIndex
    • setKeyColumnIndex

      public void setKeyColumnIndex(Long keyColumnIndex)
    • keyColumnName

      public DatafileOutputV1 keyColumnName(String keyColumnName)
    • getKeyColumnName

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

      public void setKeyColumnName(String keyColumnName)
    • keyFormat

      public DatafileOutputV1 keyFormat(DatafileOutputV1.KeyFormatEnum keyFormat)
    • getKeyFormat

      public DatafileOutputV1.KeyFormatEnum getKeyFormat()
      The format of the sample timestamps for signals or the format of the capsule start and end times for a condition.
      Returns:
      keyFormat
    • setKeyFormat

      public void setKeyFormat(DatafileOutputV1.KeyFormatEnum keyFormat)
    • lenientDaylightSavings

      public DatafileOutputV1 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 DatafileOutputV1 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 DatafileOutputV1 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 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 DatafileOutputV1 maximumInterpolationRow(Long maximumInterpolationRow)
    • getMaximumInterpolationRow

      public Long getMaximumInterpolationRow()
      Integer that identifies the row containing tje maximum interpolation for each signal. A setting of 0 indicates that there is no maximum interpolation header row. (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(Long maximumInterpolationRow)
    • name

      public DatafileOutputV1 name(String name)
    • getName

      public String getName()
      The human readable name
      Returns:
      name
    • setName

      public void setName(String name)
    • namePrefix

      public DatafileOutputV1 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.
      Returns:
      namePrefix
    • setNamePrefix

      public void setNamePrefix(String namePrefix)
    • nameRow

      public DatafileOutputV1 nameRow(Long nameRow)
    • getNameRow

      public Long 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. A setting of 0 indicates that there is no name header row. (Row 1 is the first row of the file.)
      Returns:
      nameRow
    • setNameRow

      public void setNameRow(Long nameRow)
    • nameSuffix

      public DatafileOutputV1 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.
      Returns:
      nameSuffix
    • setNameSuffix

      public void setNameSuffix(String nameSuffix)
    • scopedTo

      public DatafileOutputV1 scopedTo(String scopedTo)
    • getScopedTo

      public String getScopedTo()
      The ID of the workbook to which this item is scoped or null if it is in the global scope.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(String scopedTo)
    • statusMessage

      public DatafileOutputV1 statusMessage(String statusMessage)
    • getStatusMessage

      public String getStatusMessage()
      A plain language status message with information about any issues that may have been encountered during an operation
      Returns:
      statusMessage
    • setStatusMessage

      public void setStatusMessage(String statusMessage)
    • timeZone

      public DatafileOutputV1 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.
      Returns:
      timeZone
    • setTimeZone

      public void setTimeZone(String timeZone)
    • translationKey

      public DatafileOutputV1 translationKey(String translationKey)
    • getTranslationKey

      public String getTranslationKey()
      The item's translation key, if any
      Returns:
      translationKey
    • setTranslationKey

      public void setTranslationKey(String translationKey)
    • type

      public DatafileOutputV1 type(String type)
    • getType

      public String getType()
      The type of the item
      Returns:
      type
    • setType

      public void setType(String type)
    • updatedAt

      public DatafileOutputV1 updatedAt(String updatedAt)
    • getUpdatedAt

      public String getUpdatedAt()
      The ISO 8601 date of when the datafile was updated (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)
      Returns:
      updatedAt
    • setUpdatedAt

      public void setUpdatedAt(String updatedAt)
    • validationMode

      public DatafileOutputV1 validationMode(DatafileOutputV1.ValidationModeEnum validationMode)
    • getValidationMode

      public DatafileOutputV1.ValidationModeEnum getValidationMode()
      The approach to use when CSV data cannot be parsed. 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(DatafileOutputV1.ValidationModeEnum validationMode)
    • valueColumnIndices

      public DatafileOutputV1 valueColumnIndices(String valueColumnIndices)
    • getValueColumnIndices

      public String getValueColumnIndices()
      List of integers identifying columns. 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. Any column is only imported once no matter how many times it is listed.
      Returns:
      valueColumnIndices
    • setValueColumnIndices

      public void setValueColumnIndices(String valueColumnIndices)
    • valueColumnNames

      public DatafileOutputV1 valueColumnNames(String valueColumnNames)
    • getValueColumnNames

      public String getValueColumnNames()
      List of comma separated case sensitive names of the columns. 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. Any column is only imported once no matter how many times it is listed.
      Returns:
      valueColumnNames
    • setValueColumnNames

      public void setValueColumnNames(String valueColumnNames)
    • valueUom

      public DatafileOutputV1 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.
      Returns:
      valueUom
    • setValueUom

      public void setValueUom(String valueUom)
    • valueUomRow

      public DatafileOutputV1 valueUomRow(Long valueUomRow)
    • getValueUomRow

      public Long 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. A setting of 0 indicates that there is no unit of measure header row. (Row 1 is the first row of the file.)
      Returns:
      valueUomRow
    • setValueUomRow

      public void setValueUomRow(Long 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