Package com.seeq.model
Class ConditionUpdateInputV1
java.lang.Object
com.seeq.model.ConditionUpdateInputV1
ConditionUpdateInputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) addCapsulePropertiesItem
(CapsulePropertyInputV1 capsulePropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addParametersItem
(String parametersItem) addPropertiesItem
(ScalarPropertyV1 propertiesItem) capsuleProperties
(List<CapsulePropertyInputV1> capsuleProperties) datasourceClass
(String datasourceClass) datasourceId
(String datasourceId) description
(String description) boolean
Get additionalPropertiesProperty metadata for capsules on this condition.The data ID of this item.Along with the Datasource ID, the Datasource Class uniquely identifies a datasource.Along with the Datasource Class, the Datasource ID uniquely identifies a datasource.Clarifying information or other plain language description of this item.Information about the formula used to create a calculated item.This property tells Seeq that certain, and thus potentially cached, capsules in the past have been changed.The ID of the datasource hosting this item.The maximum duration of capsules in this series.getName()
Human readable name.Get parametersPrevious Data ID for the item within its datasource; ignored if null.Get propertiesWhen true, remove all capsule properties that are not specified incapsuleProperties on the condition input; not used for calculated or stored-in-Seeq conditionsThe ID of the workbook to which this item will be scoped.Security string containing all identities and their permissions for the item.The security string as it was originally found on the source (for debugging ACLs only)An arbitrary token (often a date or random ID) that is used during metadata syncs.Get unitOfMeasureint
hashCode()
historicalDataVersion
(String historicalDataVersion) maximumDuration
(String maximumDuration) parameters
(List<String> parameters) previousDataId
(String previousDataId) properties
(List<ScalarPropertyV1> properties) replaceCapsuleProperties
(Boolean replaceCapsuleProperties) securityString
(String securityString) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
setCapsuleProperties
(List<CapsulePropertyInputV1> capsuleProperties) void
void
setDatasourceClass
(String datasourceClass) void
setDatasourceId
(String datasourceId) void
setDescription
(String description) void
setFormula
(String formula) void
setHistoricalDataVersion
(String historicalDataVersion) void
void
setMaximumDuration
(String maximumDuration) void
void
setParameters
(List<String> parameters) void
setPreviousDataId
(String previousDataId) void
setProperties
(List<ScalarPropertyV1> properties) void
setReplaceCapsuleProperties
(Boolean replaceCapsuleProperties) void
setScopedTo
(String scopedTo) void
setSecurityString
(String securityString) void
setSourceSecurityString
(String sourceSecurityString) void
setSyncToken
(String syncToken) void
setUnitOfMeasure
(String unitOfMeasure) sourceSecurityString
(String sourceSecurityString) toString()
unitOfMeasure
(String unitOfMeasure)
-
Constructor Details
-
ConditionUpdateInputV1
public ConditionUpdateInputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
public ConditionUpdateInputV1 addAdditionalPropertiesItem(ScalarPropertyV1 additionalPropertiesItem) -
getAdditionalProperties
Get additionalProperties- Returns:
- additionalProperties
-
setAdditionalProperties
-
capsuleProperties
-
addCapsulePropertiesItem
public ConditionUpdateInputV1 addCapsulePropertiesItem(CapsulePropertyInputV1 capsulePropertiesItem) -
getCapsuleProperties
Property metadata for capsules on this condition. Only applicable to stored conditions.- Returns:
- capsuleProperties
-
setCapsuleProperties
-
dataId
-
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
-
datasourceClass
-
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
-
datasourceId
-
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
-
description
-
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
-
formula
-
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
-
historicalDataVersion
-
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
-
hostId
-
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
-
maximumDuration
-
getMaximumDuration
The maximum duration of capsules in this series. Required for stored conditions.- Returns:
- maximumDuration
-
setMaximumDuration
-
name
-
getName
Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.- Returns:
- name
-
setName
-
parameters
-
addParametersItem
-
getParameters
Get parameters- Returns:
- parameters
-
setParameters
-
previousDataId
-
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
-
properties
-
addPropertiesItem
-
getProperties
Get properties- Returns:
- properties
-
setProperties
-
replaceCapsuleProperties
-
getReplaceCapsuleProperties
When true, remove all capsule properties that are not specified incapsuleProperties on the condition input; not used for calculated or stored-in-Seeq conditions- Returns:
- replaceCapsuleProperties
-
setReplaceCapsuleProperties
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item will be scoped.- Returns:
- scopedTo
-
setScopedTo
-
securityString
-
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
-
sourceSecurityString
-
getSourceSecurityString
The security string as it was originally found on the source (for debugging ACLs only)- Returns:
- sourceSecurityString
-
setSourceSecurityString
-
syncToken
-
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
-
unitOfMeasure
-
getUnitOfMeasure
Get unitOfMeasure- Returns:
- unitOfMeasure
-
setUnitOfMeasure
-
equals
-
hashCode
public int hashCode() -
toString
-