Package com.seeq.model
Class DatafileOutputV1
java.lang.Object
com.seeq.model.DatafileOutputV1
DatafileOutputV1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The character used as the CSV field delimiter.static enum
The type of item to be imported from the CSV file.static enum
The format of the sample timestamps for signals or the format of the capsule start and end times for a condition.static enum
The approach to use when CSV data cannot be parsed. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) conditionName
(String conditionName) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) dayFirstDefault
(Boolean dayFirstDefault) description
(String description) descriptionRow
(Long descriptionRow) effectivePermissions
(PermissionsV1 effectivePermissions) endColumnIndex
(Long endColumnIndex) endColumnName
(String endColumnName) boolean
fieldDelimiter
(DatafileOutputV1.FieldDelimiterEnum fieldDelimiter) firstDataRow
(Long firstDataRow) Additional properties of the itemIf true, append the data in this CSV file to the signals or condition.The name to use for the condition being imported.The ISO 8601 date of when the datafile was created (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)The data ID of this asset.The datasource class, which is the type of system holding the item, such as OSIsoft PIThe datasource identifier, which is how the datasource holding this item identifies itselfIf true, assume day first dates when ambiguous.Clarifying information or other plain language description of this itemInteger that identifies the row containing the description for each signal.Get effectivePermissionsInteger that identifies the column containing the capsule end key for the condition.The name of the column containing the capsule end key for the condition.The character used as the CSV field delimiter.The name and path of the CSV file used to generate the contentInteger that identifies the row at which to start reading the data.getId()
The ID that can be used to interact with the itemThe interpolation method used to represent the values between samples in the signal.Integer that identifies the row containing the interpolation method for each signal.Whether item is archivedWhether item is redactedThe type of item to be imported from the CSV file.Integer that identifies the column containing the sample timestamps for the signal(s) or the column containing the capsule start key for the condition.The name of the column containing the signal timestamps for the signal(s) orthe column containing the capsule start key for the condition.The format of the sample timestamps for signals or the format of the capsule start and end times for a condition.If true, hours are allowed that don't exist due to the spring forward daylight savings transition.The maximum duration of the capsules in the condition.The maximum spacing between adjacent sample keys that can be interpolated across.Integer that identifies the row containing tje maximum interpolation for each signal.getName()
The human readable namePrefix prepended to the name of each signal when importing signal(s) and prepended to the name of each capsule property when importing a condition.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.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.The ID of the workbook to which this item is scoped or null if it is in the global scope.A plain language status message with information about any issues that may have been encountered during an operationIf 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.The item's translation key, if anygetType()
The type of the itemThe ISO 8601 date of when the datafile was updated (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)The approach to use when CSV data cannot be parsed.List of integers identifying columns.List of comma separated case sensitive names of the columns.The unit of measure to be used for every signal when importing signals and for every capsule property when importing a condition.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.int
hashCode()
interpolationMethod
(String interpolationMethod) interpolationMethodRow
(Long interpolationMethodRow) isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) itemType
(DatafileOutputV1.ItemTypeEnum itemType) keyColumnIndex
(Long keyColumnIndex) keyColumnName
(String keyColumnName) keyFormat
(DatafileOutputV1.KeyFormatEnum keyFormat) lenientDaylightSavings
(Boolean lenientDaylightSavings) maximumDuration
(String maximumDuration) maximumInterpolation
(String maximumInterpolation) maximumInterpolationRow
(Long maximumInterpolationRow) namePrefix
(String namePrefix) nameSuffix
(String nameSuffix) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setConditionName
(String conditionName) void
setCreatedAt
(String createdAt) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDayFirstDefault
(Boolean dayFirstDefault) void
setDescription
(String description) void
setDescriptionRow
(Long descriptionRow) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
setEndColumnIndex
(Long endColumnIndex) void
setEndColumnName
(String endColumnName) void
setFieldDelimiter
(DatafileOutputV1.FieldDelimiterEnum fieldDelimiter) void
setFilename
(String filename) void
setFirstDataRow
(Long firstDataRow) void
void
setInterpolationMethod
(String interpolationMethod) void
setInterpolationMethodRow
(Long interpolationMethodRow) void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
setItemType
(DatafileOutputV1.ItemTypeEnum itemType) void
setKeyColumnIndex
(Long keyColumnIndex) void
setKeyColumnName
(String keyColumnName) void
setKeyFormat
(DatafileOutputV1.KeyFormatEnum keyFormat) void
setLenientDaylightSavings
(Boolean lenientDaylightSavings) void
setMaximumDuration
(String maximumDuration) void
setMaximumInterpolation
(String maximumInterpolation) void
setMaximumInterpolationRow
(Long maximumInterpolationRow) void
void
setNamePrefix
(String namePrefix) void
setNameRow
(Long nameRow) void
setNameSuffix
(String nameSuffix) void
setScopedTo
(String scopedTo) void
setStatusMessage
(String statusMessage) void
setTimeZone
(String timeZone) void
setTranslationKey
(String translationKey) void
void
setUpdatedAt
(String updatedAt) void
setValidationMode
(DatafileOutputV1.ValidationModeEnum validationMode) void
setValueColumnIndices
(String valueColumnIndices) void
setValueColumnNames
(String valueColumnNames) void
setValueUom
(String valueUom) void
setValueUomRow
(Long valueUomRow) statusMessage
(String statusMessage) toString()
translationKey
(String translationKey) validationMode
(DatafileOutputV1.ValidationModeEnum validationMode) valueColumnIndices
(String valueColumnIndices) valueColumnNames
(String valueColumnNames) valueUomRow
(Long valueUomRow)
-
Constructor Details
-
DatafileOutputV1
public DatafileOutputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
-
getAdditionalProperties
Additional properties of the item- Returns:
- additionalProperties
-
setAdditionalProperties
-
append
-
getAppend
If true, append the data in this CSV file to the signals or condition.- Returns:
- append
-
setAppend
-
conditionName
-
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
-
createdAt
-
getCreatedAt
The ISO 8601 date of when the datafile was created (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)- Returns:
- createdAt
-
setCreatedAt
-
dataId
-
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
-
datasourceClass
-
getDatasourceClass
The datasource class, which is the type of system holding the item, such as OSIsoft PI- Returns:
- datasourceClass
-
setDatasourceClass
-
datasourceId
-
getDatasourceId
The datasource identifier, which is how the datasource holding this item identifies itself- Returns:
- datasourceId
-
setDatasourceId
-
dayFirstDefault
-
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
-
description
-
getDescription
Clarifying information or other plain language description of this item- Returns:
- description
-
setDescription
-
descriptionRow
-
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
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
endColumnIndex
-
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
-
endColumnName
-
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
-
fieldDelimiter
-
getFieldDelimiter
The character used as the CSV field delimiter.- Returns:
- fieldDelimiter
-
setFieldDelimiter
-
filename
-
getFilename
The name and path of the CSV file used to generate the content- Returns:
- filename
-
setFilename
-
firstDataRow
-
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
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
interpolationMethod
-
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
-
interpolationMethodRow
-
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
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
itemType
-
getItemType
The type of item to be imported from the CSV file. Supported types include signal and condition.- Returns:
- itemType
-
setItemType
-
keyColumnIndex
-
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
-
keyColumnName
-
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
-
keyFormat
-
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
-
lenientDaylightSavings
-
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
-
maximumDuration
-
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
-
maximumInterpolation
-
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
-
maximumInterpolationRow
-
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
-
name
-
getName
The human readable name- Returns:
- name
-
setName
-
namePrefix
-
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
-
nameRow
-
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
-
nameSuffix
-
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
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item is scoped or null if it is in the global scope.- Returns:
- scopedTo
-
setScopedTo
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
timeZone
-
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
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
updatedAt
-
getUpdatedAt
The ISO 8601 date of when the datafile was updated (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)- Returns:
- updatedAt
-
setUpdatedAt
-
validationMode
-
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
-
valueColumnIndices
-
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
-
valueColumnNames
-
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
-
valueUom
-
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
-
valueUomRow
-
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
-
equals
-
hashCode
public int hashCode() -
toString
-