Package com.seeq.api
Class ConditionsApi
java.lang.Object
com.seeq.api.ConditionsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCapsules
(String id, CapsulesInputV1 body) Add capsules to a stored conditionaddCapsulesWithHeadersAndHttpInfo
(String id, CapsulesInputV1 body, Map<String, String> customHeaders) Add capsules to a stored conditionaddCapsulesWithHttpInfo
(String id, CapsulesInputV1 body) Add capsules to a stored conditionArchive a condition and its capsulesarchiveConditionWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a condition and its capsulesArchive a condition and its capsulesCreate a conditioncreateConditionWithHeadersAndHttpInfo
(ConditionInputV1 body, Map<String, String> customHeaders) Create a conditionCreate a conditiondeleteCapsules
(String id, Boolean clearCapsuleProperties) Delete all capsules in a conditiondeleteCapsulesWithHeadersAndHttpInfo
(String id, Boolean clearCapsuleProperties, Map<String, String> customHeaders) Delete all capsules in a conditiondeleteCapsulesWithHttpInfo
(String id, Boolean clearCapsuleProperties) Delete all capsules in a conditiongetCapsules
(String id, String start, String end, String unitOfMeasure, String timeFormat, Integer offset, Integer limit) Get capsules from a conditiongetCapsulesWithHeadersAndHttpInfo
(String id, String start, String end, String unitOfMeasure, String timeFormat, Integer offset, Integer limit, Map<String, String> customHeaders) Get capsules from a conditiongetCapsulesWithHttpInfo
(String id, String start, String end, String unitOfMeasure, String timeFormat, Integer offset, Integer limit) Get capsules from a conditiongetCondition
(String id) Get a conditiongetConditions
(Integer offset, Integer limit) Get a collection of conditionsgetConditionsWithHeadersAndHttpInfo
(Integer offset, Integer limit, Map<String, String> customHeaders) Get a collection of conditionsgetConditionsWithHttpInfo
(Integer offset, Integer limit) Get a collection of conditionsgetConditionWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a conditionGet a conditionlong
putCapsules
(String id, CapsulesOverwriteInputV1 body) Replace any capsules in the same time rangeputCapsulesWithHeadersAndHttpInfo
(String id, CapsulesOverwriteInputV1 body, Map<String, String> customHeaders) Replace any capsules in the same time rangeReplace any capsules in the same time rangeCreate or update multiple conditionsputConditionsWithHeadersAndHttpInfo
(ConditionBatchInputV1 body, Map<String, String> customHeaders) Create or update multiple conditionsCreate or update multiple conditionsvoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) Update an existing conditionupdateExistingConditionWithHeadersAndHttpInfo
(String id, ConditionUpdateInputV1 body, Map<String, String> customHeaders) Update an existing conditionUpdate an existing condition
-
Constructor Details
-
ConditionsApi
public ConditionsApi() -
ConditionsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
addCapsules
Add capsules to a stored condition- Parameters:
id
- ID of the stored condition that will receive the capsules (required)body
- Capsules to be added to the stored condition (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
addCapsulesWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> addCapsulesWithHttpInfo(String id, CapsulesInputV1 body) throws ApiException Add capsules to a stored condition- Parameters:
id
- ID of the stored condition that will receive the capsules (required)body
- Capsules to be added to the stored condition (required)- Throws:
ApiException
- if fails to make API call
-
addCapsulesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> addCapsulesWithHeadersAndHttpInfo(String id, CapsulesInputV1 body, Map<String, String> customHeaders) throws ApiExceptionAdd capsules to a stored condition- Parameters:
id
- ID of the stored condition that will receive the capsules (required)body
- Capsules to be added to the stored condition (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
archiveCondition
Archive a condition and its capsules- Parameters:
id
- ID of the condition to archive (required)- Returns:
- ArchiveOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveConditionWithHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveConditionWithHttpInfo(String id) throws ApiException Archive a condition and its capsules- Parameters:
id
- ID of the condition to archive (required)- Throws:
ApiException
- if fails to make API call
-
archiveConditionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveConditionWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive a condition and its capsules- Parameters:
id
- ID of the condition to archive (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createCondition
Create a condition- Parameters:
body
- Condition information (required)- Returns:
- ConditionOutputV1
- Throws:
ApiException
- if fails to make API call
-
createConditionWithHttpInfo
public ApiClient.ApiResponse<ConditionOutputV1> createConditionWithHttpInfo(ConditionInputV1 body) throws ApiException Create a condition- Parameters:
body
- Condition information (required)- Throws:
ApiException
- if fails to make API call
-
createConditionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ConditionOutputV1> createConditionWithHeadersAndHttpInfo(ConditionInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a condition- Parameters:
body
- Condition information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
deleteCapsules
public StatusMessageBase deleteCapsules(String id, Boolean clearCapsuleProperties) throws ApiException Delete all capsules in a condition- Parameters:
id
- The Seeq ID for the signal (required)clearCapsuleProperties
- When true, clears capsule property definitions from the condition after deleting the capsules. (optional, default to false)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
deleteCapsulesWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteCapsulesWithHttpInfo(String id, Boolean clearCapsuleProperties) throws ApiException Delete all capsules in a condition- Parameters:
id
- The Seeq ID for the signal (required)clearCapsuleProperties
- When true, clears capsule property definitions from the condition after deleting the capsules. (optional, default to false)- Throws:
ApiException
- if fails to make API call
-
deleteCapsulesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteCapsulesWithHeadersAndHttpInfo(String id, Boolean clearCapsuleProperties, Map<String, String> customHeaders) throws ApiExceptionDelete all capsules in a condition- Parameters:
id
- The Seeq ID for the signal (required)clearCapsuleProperties
- When true, clears capsule property definitions from the condition after deleting the capsules. (optional, default to false)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getCapsules
public CapsulesOutputV1 getCapsules(String id, String start, String end, String unitOfMeasure, String timeFormat, Integer offset, Integer limit) throws ApiException Get capsules from a condition- Parameters:
id
- ID of the condition from which to retrieve capsules (required)start
- A string representing the start of the range of the capsules to be returned. The contents vary based on the condition type. For time conditions: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). (required)end
- A string representing the end of the range of the capsules to be returned. The contents vary based on the condition type. For time conditions: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). (required)unitOfMeasure
- The unit of measure in which to return the condition's capsules' starts and ends. If none is supplied, the data is returned in the condition's default unit of measure. (optional)timeFormat
- The timestamp format. (optional, default to ISO8601)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 1000)- Returns:
- CapsulesOutputV1
- Throws:
ApiException
- if fails to make API call
-
getCapsulesWithHttpInfo
public ApiClient.ApiResponse<CapsulesOutputV1> getCapsulesWithHttpInfo(String id, String start, String end, String unitOfMeasure, String timeFormat, Integer offset, Integer limit) throws ApiException Get capsules from a condition- Parameters:
id
- ID of the condition from which to retrieve capsules (required)start
- A string representing the start of the range of the capsules to be returned. The contents vary based on the condition type. For time conditions: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). (required)end
- A string representing the end of the range of the capsules to be returned. The contents vary based on the condition type. For time conditions: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). (required)unitOfMeasure
- The unit of measure in which to return the condition's capsules' starts and ends. If none is supplied, the data is returned in the condition's default unit of measure. (optional)timeFormat
- The timestamp format. (optional, default to ISO8601)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 1000)- Throws:
ApiException
- if fails to make API call
-
getCapsulesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<CapsulesOutputV1> getCapsulesWithHeadersAndHttpInfo(String id, String start, String end, String unitOfMeasure, String timeFormat, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet capsules from a condition- Parameters:
id
- ID of the condition from which to retrieve capsules (required)start
- A string representing the start of the range of the capsules to be returned. The contents vary based on the condition type. For time conditions: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). (required)end
- A string representing the end of the range of the capsules to be returned. The contents vary based on the condition type. For time conditions: a ISO 8601 timestamp (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm). (required)unitOfMeasure
- The unit of measure in which to return the condition's capsules' starts and ends. If none is supplied, the data is returned in the condition's default unit of measure. (optional)timeFormat
- The timestamp format. (optional, default to ISO8601)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 1000)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getCondition
Get a condition- Parameters:
id
- ID of the condition to retrieve (required)- Returns:
- ConditionOutputV1
- Throws:
ApiException
- if fails to make API call
-
getConditionWithHttpInfo
public ApiClient.ApiResponse<ConditionOutputV1> getConditionWithHttpInfo(String id) throws ApiException Get a condition- Parameters:
id
- ID of the condition to retrieve (required)- Throws:
ApiException
- if fails to make API call
-
getConditionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ConditionOutputV1> getConditionWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a condition- Parameters:
id
- ID of the condition to retrieve (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getConditions
Get a collection of conditions- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- ItemPreviewListV1
- Throws:
ApiException
- if fails to make API call
-
getConditionsWithHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getConditionsWithHttpInfo(Integer offset, Integer limit) throws ApiException Get a collection of conditions- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getConditionsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getConditionsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of conditions- Parameters:
offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putCapsules
Replace any capsules in the same time range- Parameters:
id
- ID of the stored condition that will receive the capsules (required)body
- Capsules to be added to the stored condition (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
putCapsulesWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> putCapsulesWithHttpInfo(String id, CapsulesOverwriteInputV1 body) throws ApiException Replace any capsules in the same time range- Parameters:
id
- ID of the stored condition that will receive the capsules (required)body
- Capsules to be added to the stored condition (required)- Throws:
ApiException
- if fails to make API call
-
putCapsulesWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> putCapsulesWithHeadersAndHttpInfo(String id, CapsulesOverwriteInputV1 body, Map<String, String> customHeaders) throws ApiExceptionReplace any capsules in the same time range- Parameters:
id
- ID of the stored condition that will receive the capsules (required)body
- Capsules to be added to the stored condition (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
putConditions
Create or update multiple conditions- Parameters:
body
- (optional)- Returns:
- ItemBatchOutputV1
- Throws:
ApiException
- if fails to make API call
-
putConditionsWithHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putConditionsWithHttpInfo(ConditionBatchInputV1 body) throws ApiException Create or update multiple conditions- Parameters:
body
- (optional)- Throws:
ApiException
- if fails to make API call
-
putConditionsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putConditionsWithHeadersAndHttpInfo(ConditionBatchInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update multiple conditions- Parameters:
body
- (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateExistingCondition
public ConditionOutputV1 updateExistingCondition(String id, ConditionUpdateInputV1 body) throws ApiException Update an existing condition- Parameters:
id
- The id for the condition to be updated (required)body
- (required)- Returns:
- ConditionOutputV1
- Throws:
ApiException
- if fails to make API call
-
updateExistingConditionWithHttpInfo
public ApiClient.ApiResponse<ConditionOutputV1> updateExistingConditionWithHttpInfo(String id, ConditionUpdateInputV1 body) throws ApiException Update an existing condition- Parameters:
id
- The id for the condition to be updated (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
updateExistingConditionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ConditionOutputV1> updateExistingConditionWithHeadersAndHttpInfo(String id, ConditionUpdateInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate an existing condition- Parameters:
id
- The id for the condition to be updated (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-