Package com.seeq.api
Class ScalarsApi
java.lang.Object
com.seeq.api.ScalarsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionarchiveScalar
(String id) Archive a scalararchiveScalarWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a scalarArchive a scalarCreate a calculated scalarcreateCalculatedScalarWithHeadersAndHttpInfo
(ScalarInputV1 body, Map<String, String> customHeaders) Create a calculated scalarCreate a calculated scalarlong
Get a scalargetScalars
(Integer offset, Integer limit) Get a collection of scalarsGet a collection of scalarsgetScalarsWithHttpInfo
(Integer offset, Integer limit) Get a collection of scalarsgetScalarValue
(String id) Get the resulting value from a scalargetScalarValueWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get the resulting value from a scalarGet the resulting value from a scalargetScalarWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a scalarGet a scalarputScalars
(PutScalarsInputV1 body) Create or update multiple scalars at one timeputScalarsWithHeadersAndHttpInfo
(PutScalarsInputV1 body, Map<String, String> customHeaders) Create or update multiple scalars at one timeCreate or update multiple scalars at one timevoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout)
-
Constructor Details
-
ScalarsApi
public ScalarsApi() -
ScalarsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveScalar
Archive a scalar- Parameters:
id
- ID of the scalar to archived (required)- Returns:
- ArchiveOutputV1
- Throws:
ApiException
- if fails to make API call
-
archiveScalarWithHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveScalarWithHttpInfo(String id) throws ApiException Archive a scalar- Parameters:
id
- ID of the scalar to archived (required)- Throws:
ApiException
- if fails to make API call
-
archiveScalarWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ArchiveOutputV1> archiveScalarWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive a scalar- Parameters:
id
- ID of the scalar to archived (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createCalculatedScalar
Create a calculated scalar- Parameters:
body
- Calculated scalar information (required)- Returns:
- CalculatedItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
createCalculatedScalarWithHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> createCalculatedScalarWithHttpInfo(ScalarInputV1 body) throws ApiException Create a calculated scalar- Parameters:
body
- Calculated scalar information (required)- Throws:
ApiException
- if fails to make API call
-
createCalculatedScalarWithHeadersAndHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> createCalculatedScalarWithHeadersAndHttpInfo(ScalarInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate a calculated scalar- Parameters:
body
- Calculated scalar information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getScalar
Get a scalar- Parameters:
id
- ID of the scalar to retrieve (required)- Returns:
- CalculatedItemOutputV1
- Throws:
ApiException
- if fails to make API call
-
getScalarWithHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> getScalarWithHttpInfo(String id) throws ApiException Get a scalar- Parameters:
id
- ID of the scalar to retrieve (required)- Throws:
ApiException
- if fails to make API call
-
getScalarWithHeadersAndHttpInfo
public ApiClient.ApiResponse<CalculatedItemOutputV1> getScalarWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a scalar- Parameters:
id
- ID of the scalar to retrieve (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getScalarValue
Get the resulting value from a scalar- Parameters:
id
- ID of the scalar to find the value of (required)- Returns:
- ScalarEvaluateOutputV1
- Throws:
ApiException
- if fails to make API call
-
getScalarValueWithHttpInfo
public ApiClient.ApiResponse<ScalarEvaluateOutputV1> getScalarValueWithHttpInfo(String id) throws ApiException Get the resulting value from a scalar- Parameters:
id
- ID of the scalar to find the value of (required)- Throws:
ApiException
- if fails to make API call
-
getScalarValueWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ScalarEvaluateOutputV1> getScalarValueWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet the resulting value from a scalar- Parameters:
id
- ID of the scalar to find the value of (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getScalars
Get a collection of scalars- 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
-
getScalarsWithHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getScalarsWithHttpInfo(Integer offset, Integer limit) throws ApiException Get a collection of scalars- 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
-
getScalarsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemPreviewListV1> getScalarsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of scalars- 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
-
putScalars
Create or update multiple scalars at one time- Parameters:
body
- (optional)- Returns:
- ItemBatchOutputV1
- Throws:
ApiException
- if fails to make API call
-
putScalarsWithHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putScalarsWithHttpInfo(PutScalarsInputV1 body) throws ApiException Create or update multiple scalars at one time- Parameters:
body
- (optional)- Throws:
ApiException
- if fails to make API call
-
putScalarsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ItemBatchOutputV1> putScalarsWithHeadersAndHttpInfo(PutScalarsInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update multiple scalars at one time- Parameters:
body
- (optional)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-